AWS SDK for PHP 3.x

Client: Aws\Detective\DetectiveClient

Service ID: detective

Version: 2018-10-26

This page describes the parameters and results for the operations of the Amazon Detective (2018-10-26), and shows how to use the Aws\Detective\DetectiveClient object to call the described operations. This documentation is specific to the 2018-10-26 API version of the service.

Operation Summary

Each of the following operations can be created from a client using $client->getCommand('CommandName'), where "CommandName" is the name of one of the following operations. Note: a command is a value that encapsulates an operation and the parameters used to create an HTTP request.

You can also create and send a command immediately using the magic methods available on a client object: $client->commandName(/* parameters */). You can send the command asynchronously (returning a promise) by appending the word "Async" to the operation name: $client->commandNameAsync(/* parameters */).

AcceptInvitation ( array $params = [] )
Accepts an invitation for the member account to contribute data to a behavior graph.
BatchGetGraphMemberDatasources ( array $params = [] )
Gets data source package information for the behavior graph.
BatchGetMembershipDatasources ( array $params = [] )
Gets information on the data source package history for an account.
CreateGraph ( array $params = [] )
Creates a new behavior graph for the calling account, and sets that account as the administrator account.
CreateMembers ( array $params = [] )
CreateMembers is used to send invitations to accounts.
DeleteGraph ( array $params = [] )
Disables the specified behavior graph and queues it to be deleted.
DeleteMembers ( array $params = [] )
Removes the specified member accounts from the behavior graph.
DescribeOrganizationConfiguration ( array $params = [] )
Returns information about the configuration for the organization behavior graph.
DisableOrganizationAdminAccount ( array $params = [] )
Removes the Detective administrator account in the current Region.
DisassociateMembership ( array $params = [] )
Removes the member account from the specified behavior graph.
EnableOrganizationAdminAccount ( array $params = [] )
Designates the Detective administrator account for the organization in the current Region.
GetInvestigation ( array $params = [] )
Returns the investigation results of an investigation for a behavior graph.
GetMembers ( array $params = [] )
Returns the membership details for specified member accounts for a behavior graph.
ListDatasourcePackages ( array $params = [] )
Lists data source packages in the behavior graph.
ListGraphs ( array $params = [] )
Returns the list of behavior graphs that the calling account is an administrator account of.
ListIndicators ( array $params = [] )
Get the indicators from an investigation
ListInvestigations ( array $params = [] )
List all Investigations.
ListInvitations ( array $params = [] )
Retrieves the list of open and accepted behavior graph invitations for the member account.
ListMembers ( array $params = [] )
Retrieves the list of member accounts for a behavior graph.
ListOrganizationAdminAccounts ( array $params = [] )
Returns information about the Detective administrator account for an organization.
ListTagsForResource ( array $params = [] )
Returns the tag values that are assigned to a behavior graph.
RejectInvitation ( array $params = [] )
Rejects an invitation to contribute the account data to a behavior graph.
StartInvestigation ( array $params = [] )
initiate an investigation on an entity in a graph
StartMonitoringMember ( array $params = [] )
Sends a request to enable data ingest for a member account that has a status of ACCEPTED_BUT_DISABLED.
TagResource ( array $params = [] )
Applies tag values to a behavior graph.
UntagResource ( array $params = [] )
Removes tags from a behavior graph.
UpdateDatasourcePackages ( array $params = [] )
Starts a data source packages for the behavior graph.
UpdateInvestigationState ( array $params = [] )
Update the state of an investigation.
UpdateOrganizationConfiguration ( array $params = [] )
Updates the configuration for the Organizations integration in the current Region.

Paginators

Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:

ListDatasourcePackages
ListGraphs
ListInvitations
ListMembers
ListOrganizationAdminAccounts

Operations

AcceptInvitation

$result = $client->acceptInvitation([/* ... */]);
$promise = $client->acceptInvitationAsync([/* ... */]);

Accepts an invitation for the member account to contribute data to a behavior graph. This operation can only be called by an invited member account.

The request provides the ARN of behavior graph.

The member account status in the graph must be INVITED.

Parameter Syntax

$result = $client->acceptInvitation([
    'GraphArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

GraphArn

Required: Yes
Type: string

The ARN of the behavior graph that the member account is accepting the invitation for.

The member account status in the behavior graph must be INVITED.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

AccessDeniedException:
The request issuer does not have permission to access this resource or perform this operation.
ConflictException:
The request attempted an invalid action.
InternalServerException:
The request was valid but failed because of a problem with the service.
ResourceNotFoundException:
The request refers to a nonexistent resource.
ValidationException:
The request parameters are invalid.

BatchGetGraphMemberDatasources

$result = $client->batchGetGraphMemberDatasources([/* ... */]);
$promise = $client->batchGetGraphMemberDatasourcesAsync([/* ... */]);

Gets data source package information for the behavior graph.

Parameter Syntax

$result = $client->batchGetGraphMemberDatasources([
    'AccountIds' => ['<string>', ...], // REQUIRED
    'GraphArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

AccountIds

Required: Yes
Type: Array of strings

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

GraphArn

Required: Yes
Type: string

The ARN of the behavior graph.

Result Syntax

[
    'MemberDatasources' => [
        [
            'AccountId' => '<string>',
            'DatasourcePackageIngestHistory' => [
                '<DatasourcePackage>' => [
                    '<DatasourcePackageIngestState>' => [
                        'Timestamp' => <DateTime>,
                    ],
                    // ...
                ],
                // ...
            ],
            'GraphArn' => '<string>',
        ],
        // ...
    ],
    'UnprocessedAccounts' => [
        [
            'AccountId' => '<string>',
            'Reason' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

MemberDatasources

Type: Array of MembershipDatasources structures

Details on the status of data source packages for members of the behavior graph.

UnprocessedAccounts

Type: Array of UnprocessedAccount structures

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

Errors

AccessDeniedException:
The request issuer does not have permission to access this resource or perform this operation.
InternalServerException:
The request was valid but failed because of a problem with the service.
ResourceNotFoundException:
The request refers to a nonexistent resource.
ValidationException:
The request parameters are invalid.

BatchGetMembershipDatasources

$result = $client->batchGetMembershipDatasources([/* ... */]);
$promise = $client->batchGetMembershipDatasourcesAsync([/* ... */]);

Gets information on the data source package history for an account.

Parameter Syntax

$result = $client->batchGetMembershipDatasources([
    'GraphArns' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members

GraphArns

Required: Yes
Type: Array of strings

The ARN of the behavior graph.

Result Syntax

[
    'MembershipDatasources' => [
        [
            'AccountId' => '<string>',
            'DatasourcePackageIngestHistory' => [
                '<DatasourcePackage>' => [
                    '<DatasourcePackageIngestState>' => [
                        'Timestamp' => <DateTime>,
                    ],
                    // ...
                ],
                // ...
            ],
            'GraphArn' => '<string>',
        ],
        // ...
    ],
    'UnprocessedGraphs' => [
        [
            'GraphArn' => '<string>',
            'Reason' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

MembershipDatasources

Type: Array of MembershipDatasources structures

Details on the data source package history for an member of the behavior graph.

UnprocessedGraphs

Type: Array of UnprocessedGraph structures

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

Errors

AccessDeniedException:
The request issuer does not have permission to access this resource or perform this operation.
InternalServerException:
The request was valid but failed because of a problem with the service.
ResourceNotFoundException:
The request refers to a nonexistent resource.
ValidationException:
The request parameters are invalid.

CreateGraph

$result = $client->createGraph([/* ... */]);
$promise = $client->createGraphAsync([/* ... */]);

Creates a new behavior graph for the calling account, and sets that account as the administrator account. This operation is called by the account that is enabling Detective.

Before you try to enable Detective, make sure that your account has been enrolled in Amazon GuardDuty for at least 48 hours. If you do not meet this requirement, you cannot enable Detective. If you do meet the GuardDuty prerequisite, then when you make the request to enable Detective, it checks whether your data volume is within the Detective quota. If it exceeds the quota, then you cannot enable Detective.

The operation also enables Detective for the calling account in the currently selected Region. It returns the ARN of the new behavior graph.

CreateGraph triggers a process to create the corresponding data tables for the new behavior graph.

An account can only be the administrator account for one behavior graph within a Region. If the same account calls CreateGraph with the same administrator account, it always returns the same behavior graph ARN. It does not create a new behavior graph.

Parameter Syntax

$result = $client->createGraph([
    'Tags' => ['<string>', ...],
]);

Parameter Details

Members

Tags

Type: Associative array of custom strings keys (TagKey) to strings

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.

Result Syntax

[
    'GraphArn' => '<string>',
]

Result Details

Members

GraphArn

Type: string

The ARN of the new behavior graph.

Errors

AccessDeniedException:
The request issuer does not have permission to access this resource or perform this operation.
ConflictException:
The request attempted an invalid action.
InternalServerException:
The request was valid but failed because of a problem with the service.
ServiceQuotaExceededException:
This request cannot be completed for one of the following reasons.
- The request would cause the number of member accounts in the behavior graph to exceed the maximum allowed. A behavior graph cannot have more than 1200 member accounts.
- The request would cause the data rate for the behavior graph to exceed the maximum allowed.
- Detective is unable to verify the data rate for the member account. This is usually because the member account is not enrolled in Amazon GuardDuty.

CreateMembers

$result = $client->createMembers([/* ... */]);
$promise = $client->createMembersAsync([/* ... */]);

CreateMembers is used to send invitations to accounts. For the organization behavior graph, the Detective administrator account uses CreateMembers to enable organization accounts as member accounts.

For invited accounts, CreateMembers sends a request to invite the specified Amazon Web Services accounts to be member accounts in the behavior graph. This operation can only be called by the administrator account for a behavior graph.

CreateMembers verifies the accounts and then invites the verified accounts. The administrator can optionally specify to not send invitation emails to the member accounts. This would be used when the administrator manages their member accounts centrally.

For organization accounts in the organization behavior graph, CreateMembers attempts to enable the accounts. The organization accounts do not receive invitations.

The request provides the behavior graph ARN and the list of accounts to invite or to enable.

The response separates the requested accounts into two lists:

The accounts that CreateMembers was able to process. For invited accounts, includes member accounts that are being verified, that have passed verification and are to be invited, and that have failed verification. For organization accounts in the organization behavior graph, includes accounts that can be enabled and that cannot be enabled.
The accounts that CreateMembers was unable to process. This list includes accounts that were already invited to be member accounts in the behavior graph.

Parameter Syntax

$result = $client->createMembers([
    'Accounts' => [ // REQUIRED
        [
            'AccountId' => '<string>', // REQUIRED
            'EmailAddress' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'DisableEmailNotification' => true || false,
    'GraphArn' => '<string>', // REQUIRED
    'Message' => '<string>',
]);

Parameter Details

Members

Accounts

Required: Yes
Type: Array of Account structures

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.

DisableEmailNotification

Type: 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.

GraphArn

Required: Yes
Type: string

The ARN of the behavior graph.

Message

Type: string

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

Result Syntax

[
    'Members' => [
        [
            'AccountId' => '<string>',
            'AdministratorId' => '<string>',
            'DatasourcePackageIngestStates' => ['<string>', ...],
            'DisabledReason' => 'VOLUME_TOO_HIGH|VOLUME_UNKNOWN',
            'EmailAddress' => '<string>',
            'GraphArn' => '<string>',
            'InvitationType' => 'INVITATION|ORGANIZATION',
            'InvitedTime' => <DateTime>,
            'MasterId' => '<string>',
            'PercentOfGraphUtilization' => <float>,
            'PercentOfGraphUtilizationUpdatedTime' => <DateTime>,
            'Status' => 'INVITED|VERIFICATION_IN_PROGRESS|VERIFICATION_FAILED|ENABLED|ACCEPTED_BUT_DISABLED',
            'UpdatedTime' => <DateTime>,
            'VolumeUsageByDatasourcePackage' => [
                '<DatasourcePackage>' => [
                    'VolumeUsageInBytes' => <integer>,
                    'VolumeUsageUpdateTime' => <DateTime>,
                ],
                // ...
            ],
            'VolumeUsageInBytes' => <integer>,
            'VolumeUsageUpdatedTime' => <DateTime>,
        ],
        // ...
    ],
    'UnprocessedAccounts' => [
        [
            'AccountId' => '<string>',
            'Reason' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

Members

Type: Array of MemberDetail structures

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.

UnprocessedAccounts

Type: Array of UnprocessedAccount structures

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.

Errors

AccessDeniedException:
The request issuer does not have permission to access this resource or perform this operation.
InternalServerException:
The request was valid but failed because of a problem with the service.
ResourceNotFoundException:
The request refers to a nonexistent resource.
ValidationException:
The request parameters are invalid.
ServiceQuotaExceededException:
This request cannot be completed for one of the following reasons.
- The request would cause the number of member accounts in the behavior graph to exceed the maximum allowed. A behavior graph cannot have more than 1200 member accounts.
- The request would cause the data rate for the behavior graph to exceed the maximum allowed.
- Detective is unable to verify the data rate for the member account. This is usually because the member account is not enrolled in Amazon GuardDuty.

DeleteGraph

$result = $client->deleteGraph([/* ... */]);
$promise = $client->deleteGraphAsync([/* ... */]);

Disables the specified behavior graph and queues it to be deleted. This operation removes the behavior graph from each member account's list of behavior graphs.

DeleteGraph can only be called by the administrator account for a behavior graph.

Parameter Syntax

$result = $client->deleteGraph([
    'GraphArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

GraphArn

Required: Yes
Type: string

The ARN of the behavior graph to disable.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

AccessDeniedException:
The request issuer does not have permission to access this resource or perform this operation.
InternalServerException:
The request was valid but failed because of a problem with the service.
ResourceNotFoundException:
The request refers to a nonexistent resource.
ValidationException:
The request parameters are invalid.

DeleteMembers

$result = $client->deleteMembers([/* ... */]);
$promise = $client->deleteMembersAsync([/* ... */]);

Removes the specified member accounts from the behavior graph. The removed accounts no longer contribute data to the behavior graph. This operation can only be called by the administrator account for the behavior graph.

For invited accounts, the removed accounts are deleted from the list of accounts in the behavior graph. To restore the account, the administrator account must send another invitation.

For organization accounts in the organization behavior graph, the Detective administrator account can always enable the organization account again. Organization accounts that are not enabled as member accounts are not included in the ListMembers results for the organization behavior graph.

An administrator account cannot use DeleteMembers to remove their own account from the behavior graph. To disable a behavior graph, the administrator account uses the DeleteGraph API method.

Parameter Syntax

$result = $client->deleteMembers([
    'AccountIds' => ['<string>', ...], // REQUIRED
    'GraphArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

AccountIds

Required: Yes
Type: Array of strings

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.

GraphArn

Required: Yes
Type: string

The ARN of the behavior graph to remove members from.

Result Syntax

[
    'AccountIds' => ['<string>', ...],
    'UnprocessedAccounts' => [
        [
            'AccountId' => '<string>',
            'Reason' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

AccountIds

Type: Array of strings

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

UnprocessedAccounts

Type: Array of UnprocessedAccount structures

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.

Errors

AccessDeniedException:
The request issuer does not have permission to access this resource or perform this operation.
ConflictException:
The request attempted an invalid action.
InternalServerException:
The request was valid but failed because of a problem with the service.
ResourceNotFoundException:
The request refers to a nonexistent resource.
ValidationException:
The request parameters are invalid.

DescribeOrganizationConfiguration

$result = $client->describeOrganizationConfiguration([/* ... */]);
$promise = $client->describeOrganizationConfigurationAsync([/* ... */]);

Returns information about the configuration for the organization behavior graph. Currently indicates whether to automatically enable new organization accounts as member accounts.

Can only be called by the Detective administrator account for the organization.

Parameter Syntax

$result = $client->describeOrganizationConfiguration([
    'GraphArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

GraphArn

Required: Yes
Type: string

The ARN of the organization behavior graph.

Result Syntax

[
    'AutoEnable' => true || false,
]

Result Details

Members

AutoEnable

Type: boolean

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

Errors

AccessDeniedException:
The request issuer does not have permission to access this resource or perform this operation.
InternalServerException:
The request was valid but failed because of a problem with the service.
ValidationException:
The request parameters are invalid.
TooManyRequestsException:
The request cannot be completed because too many other requests are occurring at the same time.

DisableOrganizationAdminAccount

$result = $client->disableOrganizationAdminAccount([/* ... */]);
$promise = $client->disableOrganizationAdminAccountAsync([/* ... */]);

Removes the Detective administrator account in the current Region. Deletes the organization behavior graph.

Can only be called by the organization management account.

Removing the Detective administrator account does not affect the delegated administrator account for Detective in Organizations.

To remove the delegated administrator account in Organizations, use the Organizations API. Removing the delegated administrator account also removes the Detective administrator account in all Regions, except for Regions where the Detective administrator account is the organization management account.

Parameter Syntax

$result = $client->disableOrganizationAdminAccount([
]);

Parameter Details

Members

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

AccessDeniedException:
The request issuer does not have permission to access this resource or perform this operation.
InternalServerException:
The request was valid but failed because of a problem with the service.
ValidationException:
The request parameters are invalid.
TooManyRequestsException:
The request cannot be completed because too many other requests are occurring at the same time.

DisassociateMembership

$result = $client->disassociateMembership([/* ... */]);
$promise = $client->disassociateMembershipAsync([/* ... */]);

Removes the member account from the specified behavior graph. This operation can only be called by an invited member account that has the ENABLED status.

DisassociateMembership cannot be called by an organization account in the organization behavior graph. For the organization behavior graph, the Detective administrator account determines which organization accounts to enable or disable as member accounts.

Parameter Syntax

$result = $client->disassociateMembership([
    'GraphArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

GraphArn

Required: Yes
Type: 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.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

AccessDeniedException:
The request issuer does not have permission to access this resource or perform this operation.
ConflictException:
The request attempted an invalid action.
InternalServerException:
The request was valid but failed because of a problem with the service.
ResourceNotFoundException:
The request refers to a nonexistent resource.
ValidationException:
The request parameters are invalid.

EnableOrganizationAdminAccount

$result = $client->enableOrganizationAdminAccount([/* ... */]);
$promise = $client->enableOrganizationAdminAccountAsync([/* ... */]);

Designates the Detective administrator account for the organization in the current Region.

If the account does not have Detective enabled, then enables Detective for that account and creates a new behavior graph.

Can only be called by the organization management account.

If the organization has a delegated administrator account in Organizations, then the Detective administrator account must be either the delegated administrator account or the organization management account.

If the organization does not have a delegated administrator account in Organizations, then you can choose any account in the organization. If you choose an account other than the organization management account, Detective calls Organizations to make that account the delegated administrator account for Detective. The organization management account cannot be the delegated administrator account.

Parameter Syntax

$result = $client->enableOrganizationAdminAccount([
    'AccountId' => '<string>', // REQUIRED
]);

Parameter Details

Members

AccountId

Required: Yes
Type: string

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

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

AccessDeniedException:
The request issuer does not have permission to access this resource or perform this operation.
InternalServerException:
The request was valid but failed because of a problem with the service.
ValidationException:
The request parameters are invalid.
TooManyRequestsException:
The request cannot be completed because too many other requests are occurring at the same time.

GetInvestigation

$result = $client->getInvestigation([/* ... */]);
$promise = $client->getInvestigationAsync([/* ... */]);

Returns the investigation results of an investigation for a behavior graph.

Parameter Syntax

$result = $client->getInvestigation([
    'GraphArn' => '<string>', // REQUIRED
    'InvestigationId' => '<string>', // REQUIRED
]);

Parameter Details

Members

GraphArn

Required: Yes
Type: string

The ARN of the behavior graph.

InvestigationId

Required: Yes
Type: string

The investigation ID of the investigation report.

Result Syntax

[
    'CreatedTime' => <DateTime>,
    'EntityArn' => '<string>',
    'EntityType' => 'IAM_ROLE|IAM_USER',
    'GraphArn' => '<string>',
    'InvestigationId' => '<string>',
    'ScopeEndTime' => <DateTime>,
    'ScopeStartTime' => <DateTime>,
    'Severity' => 'INFORMATIONAL|LOW|MEDIUM|HIGH|CRITICAL',
    'State' => 'ACTIVE|ARCHIVED',
    'Status' => 'RUNNING|FAILED|SUCCESSFUL',
]

Result Details

Members

CreatedTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

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

EntityArn

Type: string

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

EntityType

Type: string

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

GraphArn

Type: string

The ARN of the behavior graph.

InvestigationId

Type: string

The investigation ID of the investigation report.

ScopeEndTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

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

ScopeStartTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

The start date and time for the scope time set to generate the investigation report.

Severity

Type: string

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

State

Type: string

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

Status

Type: string

Status based on the completion status of the investigation.

Errors

AccessDeniedException:
The request issuer does not have permission to access this resource or perform this operation.
InternalServerException:
The request was valid but failed because of a problem with the service.
ValidationException:
The request parameters are invalid.
ResourceNotFoundException:
The request refers to a nonexistent resource.
TooManyRequestsException:
The request cannot be completed because too many other requests are occurring at the same time.

GetMembers

$result = $client->getMembers([/* ... */]);
$promise = $client->getMembersAsync([/* ... */]);

Returns the membership details for specified member accounts for a behavior graph.

Parameter Syntax

$result = $client->getMembers([
    'AccountIds' => ['<string>', ...], // REQUIRED
    'GraphArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

AccountIds

Required: Yes
Type: Array of strings

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.

GraphArn

Required: Yes
Type: string

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

Result Syntax

[
    'MemberDetails' => [
        [
            'AccountId' => '<string>',
            'AdministratorId' => '<string>',
            'DatasourcePackageIngestStates' => ['<string>', ...],
            'DisabledReason' => 'VOLUME_TOO_HIGH|VOLUME_UNKNOWN',
            'EmailAddress' => '<string>',
            'GraphArn' => '<string>',
            'InvitationType' => 'INVITATION|ORGANIZATION',
            'InvitedTime' => <DateTime>,
            'MasterId' => '<string>',
            'PercentOfGraphUtilization' => <float>,
            'PercentOfGraphUtilizationUpdatedTime' => <DateTime>,
            'Status' => 'INVITED|VERIFICATION_IN_PROGRESS|VERIFICATION_FAILED|ENABLED|ACCEPTED_BUT_DISABLED',
            'UpdatedTime' => <DateTime>,
            'VolumeUsageByDatasourcePackage' => [
                '<DatasourcePackage>' => [
                    'VolumeUsageInBytes' => <integer>,
                    'VolumeUsageUpdateTime' => <DateTime>,
                ],
                // ...
            ],
            'VolumeUsageInBytes' => <integer>,
            'VolumeUsageUpdatedTime' => <DateTime>,
        ],
        // ...
    ],
    'UnprocessedAccounts' => [
        [
            'AccountId' => '<string>',
            'Reason' => '<string>',
        ],
        // ...
    ],
]

Result Details

Members

MemberDetails

Type: Array of MemberDetail structures

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

UnprocessedAccounts

Type: Array of UnprocessedAccount structures

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.

Errors

AccessDeniedException:
The request issuer does not have permission to access this resource or perform this operation.
InternalServerException:
The request was valid but failed because of a problem with the service.
ResourceNotFoundException:
The request refers to a nonexistent resource.
ValidationException:
The request parameters are invalid.

ListDatasourcePackages

$result = $client->listDatasourcePackages([/* ... */]);
$promise = $client->listDatasourcePackagesAsync([/* ... */]);

Lists data source packages in the behavior graph.

Parameter Syntax

$result = $client->listDatasourcePackages([
    'GraphArn' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

GraphArn

Required: Yes
Type: string

The ARN of the behavior graph.

MaxResults

Type: int

The maximum number of results to return.

NextToken

Type: 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.

Result Syntax

[
    'DatasourcePackages' => [
        '<DatasourcePackage>' => [
            'DatasourcePackageIngestState' => 'STARTED|STOPPED|DISABLED',
            'LastIngestStateChange' => [
                '<DatasourcePackageIngestState>' => [
                    'Timestamp' => <DateTime>,
                ],
                // ...
            ],
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

DatasourcePackages

Type: Associative array of custom strings keys (DatasourcePackage) to DatasourcePackageIngestDetail structures

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

NextToken

Type: 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.

Errors

AccessDeniedException:
The request issuer does not have permission to access this resource or perform this operation.
InternalServerException:
The request was valid but failed because of a problem with the service.
ResourceNotFoundException:
The request refers to a nonexistent resource.
ValidationException:
The request parameters are invalid.

ListGraphs

$result = $client->listGraphs([/* ... */]);
$promise = $client->listGraphsAsync([/* ... */]);

Returns the list of behavior graphs that the calling account is an administrator account of. This operation can only be called by an administrator account.

Because an account can currently only be the administrator of one behavior graph within a Region, the results always contain a single behavior graph.

Parameter Syntax

$result = $client->listGraphs([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

MaxResults

Type: int

The maximum number of graphs to return at a time. The total must be less than the overall limit on the number of results to return, which is currently 200.

NextToken

Type: 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.

Result Syntax

[
    'GraphList' => [
        [
            'Arn' => '<string>',
            'CreatedTime' => <DateTime>,
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

GraphList

Type: Array of Graph structures

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

NextToken

Type: 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.

Errors

AccessDeniedException:
The request issuer does not have permission to access this resource or perform this operation.
InternalServerException:
The request was valid but failed because of a problem with the service.
ValidationException:
The request parameters are invalid.

ListIndicators

$result = $client->listIndicators([/* ... */]);
$promise = $client->listIndicatorsAsync([/* ... */]);

Get the indicators from an investigation

Parameter Syntax

$result = $client->listIndicators([
    'GraphArn' => '<string>', // REQUIRED
    'IndicatorType' => 'TTP_OBSERVED|IMPOSSIBLE_TRAVEL|FLAGGED_IP_ADDRESS|NEW_GEOLOCATION|NEW_ASO|NEW_USER_AGENT|RELATED_FINDING|RELATED_FINDING_GROUP',
    'InvestigationId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

GraphArn

Required: Yes
Type: string

The ARN of the behavior graph.

IndicatorType

Type: string

See Detective investigations..

InvestigationId

Required: Yes
Type: string

The investigation ID of the investigation report.

MaxResults

Type: int

List the maximum number of indicators in a page.

NextToken

Type: string

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

Result Syntax

[
    'GraphArn' => '<string>',
    'Indicators' => [
        [
            'IndicatorDetail' => [
                'FlaggedIpAddressDetail' => [
                    'IpAddress' => '<string>',
                    'Reason' => 'AWS_THREAT_INTELLIGENCE',
                ],
                'ImpossibleTravelDetail' => [
                    'EndingIpAddress' => '<string>',
                    'EndingLocation' => '<string>',
                    'HourlyTimeDelta' => <integer>,
                    'StartingIpAddress' => '<string>',
                    'StartingLocation' => '<string>',
                ],
                'NewAsoDetail' => [
                    'Aso' => '<string>',
                    'IsNewForEntireAccount' => true || false,
                ],
                'NewGeolocationDetail' => [
                    'IpAddress' => '<string>',
                    'IsNewForEntireAccount' => true || false,
                    'Location' => '<string>',
                ],
                'NewUserAgentDetail' => [
                    'IsNewForEntireAccount' => true || false,
                    'UserAgent' => '<string>',
                ],
                'RelatedFindingDetail' => [
                    'Arn' => '<string>',
                    'IpAddress' => '<string>',
                    'Type' => '<string>',
                ],
                'RelatedFindingGroupDetail' => [
                    'Id' => '<string>',
                ],
                'TTPsObservedDetail' => [
                    'APIFailureCount' => <integer>,
                    'APIName' => '<string>',
                    'APISuccessCount' => <integer>,
                    'IpAddress' => '<string>',
                    'Procedure' => '<string>',
                    'Tactic' => '<string>',
                    'Technique' => '<string>',
                ],
            ],
            'IndicatorType' => 'TTP_OBSERVED|IMPOSSIBLE_TRAVEL|FLAGGED_IP_ADDRESS|NEW_GEOLOCATION|NEW_ASO|NEW_USER_AGENT|RELATED_FINDING|RELATED_FINDING_GROUP',
        ],
        // ...
    ],
    'InvestigationId' => '<string>',
    'NextToken' => '<string>',
]

Result Details

Members

GraphArn

Type: string

The ARN of the behavior graph.

Indicators

Type: Array of Indicator structures

Indicators of compromise listed based on severity.

InvestigationId

Type: string

The investigation ID of the investigation report.

NextToken

Type: string

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

Errors

AccessDeniedException:
The request issuer does not have permission to access this resource or perform this operation.
InternalServerException:
The request was valid but failed because of a problem with the service.
ValidationException:
The request parameters are invalid.
ResourceNotFoundException:
The request refers to a nonexistent resource.
TooManyRequestsException:
The request cannot be completed because too many other requests are occurring at the same time.

ListInvestigations

$result = $client->listInvestigations([/* ... */]);
$promise = $client->listInvestigationsAsync([/* ... */]);

List all Investigations.

Parameter Syntax

$result = $client->listInvestigations([
    'FilterCriteria' => [
        'CreatedTime' => [
            'EndInclusive' => <integer || string || DateTime>, // REQUIRED
            'StartInclusive' => <integer || string || DateTime>, // REQUIRED
        ],
        'EntityArn' => [
            'Value' => '<string>', // REQUIRED
        ],
        'Severity' => [
            'Value' => '<string>', // REQUIRED
        ],
        'State' => [
            'Value' => '<string>', // REQUIRED
        ],
        'Status' => [
            'Value' => '<string>', // REQUIRED
        ],
    ],
    'GraphArn' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'SortCriteria' => [
        'Field' => 'SEVERITY|STATUS|CREATED_TIME',
        'SortOrder' => 'ASC|DESC',
    ],
]);

Parameter Details

Members

FilterCriteria

Type: FilterCriteria structure

Filter the investigation results based on a criteria.

GraphArn

Required: Yes
Type: string

The ARN of the behavior graph.

MaxResults

Type: int

List the maximum number of investigations in a page.

NextToken

Type: string

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

SortCriteria

Type: SortCriteria structure

Sorts the investigation results based on a criteria.

Result Syntax

[
    'InvestigationDetails' => [
        [
            'CreatedTime' => <DateTime>,
            'EntityArn' => '<string>',
            'EntityType' => 'IAM_ROLE|IAM_USER',
            'InvestigationId' => '<string>',
            'Severity' => 'INFORMATIONAL|LOW|MEDIUM|HIGH|CRITICAL',
            'State' => 'ACTIVE|ARCHIVED',
            'Status' => 'RUNNING|FAILED|SUCCESSFUL',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

InvestigationDetails

Type: Array of InvestigationDetail structures

Investigations details lists the summary of uncommon behavior or malicious activity which indicates a compromise.

NextToken

Type: string

Each pagination token expires after 24 hours. Using an expired pagination token will return an HTTP 400 InvalidToken error.

Errors

AccessDeniedException:
The request issuer does not have permission to access this resource or perform this operation.
InternalServerException:
The request was valid but failed because of a problem with the service.
ValidationException:
The request parameters are invalid.
ResourceNotFoundException:
The request refers to a nonexistent resource.
TooManyRequestsException:
The request cannot be completed because too many other requests are occurring at the same time.

ListInvitations

$result = $client->listInvitations([/* ... */]);
$promise = $client->listInvitationsAsync([/* ... */]);

Retrieves the list of open and accepted behavior graph invitations for the member account. This operation can only be called by an invited member account.

Open invitations are invitations that the member account has not responded to.

The results do not include behavior graphs for which the member account declined the invitation. The results also do not include behavior graphs that the member account resigned from or was removed from.

Parameter Syntax

$result = $client->listInvitations([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

MaxResults

Type: int

The maximum number of behavior graph invitations to return in the response. The total must be less than the overall limit on the number of results to return, which is currently 200.

NextToken

Type: 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.

Result Syntax

[
    'Invitations' => [
        [
            'AccountId' => '<string>',
            'AdministratorId' => '<string>',
            'DatasourcePackageIngestStates' => ['<string>', ...],
            'DisabledReason' => 'VOLUME_TOO_HIGH|VOLUME_UNKNOWN',
            'EmailAddress' => '<string>',
            'GraphArn' => '<string>',
            'InvitationType' => 'INVITATION|ORGANIZATION',
            'InvitedTime' => <DateTime>,
            'MasterId' => '<string>',
            'PercentOfGraphUtilization' => <float>,
            'PercentOfGraphUtilizationUpdatedTime' => <DateTime>,
            'Status' => 'INVITED|VERIFICATION_IN_PROGRESS|VERIFICATION_FAILED|ENABLED|ACCEPTED_BUT_DISABLED',
            'UpdatedTime' => <DateTime>,
            'VolumeUsageByDatasourcePackage' => [
                '<DatasourcePackage>' => [
                    'VolumeUsageInBytes' => <integer>,
                    'VolumeUsageUpdateTime' => <DateTime>,
                ],
                // ...
            ],
            'VolumeUsageInBytes' => <integer>,
            'VolumeUsageUpdatedTime' => <DateTime>,
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

Invitations

Type: Array of MemberDetail structures

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

NextToken

Type: 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.

Errors

AccessDeniedException:
The request issuer does not have permission to access this resource or perform this operation.
InternalServerException:
The request was valid but failed because of a problem with the service.
ValidationException:
The request parameters are invalid.

ListMembers

$result = $client->listMembers([/* ... */]);
$promise = $client->listMembersAsync([/* ... */]);

Retrieves the list of member accounts for a behavior graph.

For invited accounts, the results do not include member accounts that were removed from the behavior graph.

For the organization behavior graph, the results do not include organization accounts that the Detective administrator account has not enabled as member accounts.

Parameter Syntax

$result = $client->listMembers([
    'GraphArn' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

GraphArn

Required: Yes
Type: string

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

MaxResults

Type: int

The maximum number of member accounts to include in the response. The total must be less than the overall limit on the number of results to return, which is currently 200.

NextToken

Type: 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.

Result Syntax

[
    'MemberDetails' => [
        [
            'AccountId' => '<string>',
            'AdministratorId' => '<string>',
            'DatasourcePackageIngestStates' => ['<string>', ...],
            'DisabledReason' => 'VOLUME_TOO_HIGH|VOLUME_UNKNOWN',
            'EmailAddress' => '<string>',
            'GraphArn' => '<string>',
            'InvitationType' => 'INVITATION|ORGANIZATION',
            'InvitedTime' => <DateTime>,
            'MasterId' => '<string>',
            'PercentOfGraphUtilization' => <float>,
            'PercentOfGraphUtilizationUpdatedTime' => <DateTime>,
            'Status' => 'INVITED|VERIFICATION_IN_PROGRESS|VERIFICATION_FAILED|ENABLED|ACCEPTED_BUT_DISABLED',
            'UpdatedTime' => <DateTime>,
            'VolumeUsageByDatasourcePackage' => [
                '<DatasourcePackage>' => [
                    'VolumeUsageInBytes' => <integer>,
                    'VolumeUsageUpdateTime' => <DateTime>,
                ],
                // ...
            ],
            'VolumeUsageInBytes' => <integer>,
            'VolumeUsageUpdatedTime' => <DateTime>,
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

MemberDetails

Type: Array of MemberDetail structures

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.

NextToken

Type: string

If there are more member accounts remaining in the results, then use this pagination token to request the next page of member accounts.

Errors

AccessDeniedException:
The request issuer does not have permission to access this resource or perform this operation.
InternalServerException:
The request was valid but failed because of a problem with the service.
ResourceNotFoundException:
The request refers to a nonexistent resource.
ValidationException:
The request parameters are invalid.

ListOrganizationAdminAccounts

$result = $client->listOrganizationAdminAccounts([/* ... */]);
$promise = $client->listOrganizationAdminAccountsAsync([/* ... */]);

Returns information about the Detective administrator account for an organization. Can only be called by the organization management account.

Parameter Syntax

$result = $client->listOrganizationAdminAccounts([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Members

MaxResults

Type: int

The maximum number of results to return.

NextToken

Type: 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.

Result Syntax

[
    'Administrators' => [
        [
            'AccountId' => '<string>',
            'DelegationTime' => <DateTime>,
            'GraphArn' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Members

Administrators

Type: Array of Administrator structures

The list of Detective administrator accounts.

NextToken

Type: 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.

Errors

AccessDeniedException:
The request issuer does not have permission to access this resource or perform this operation.
InternalServerException:
The request was valid but failed because of a problem with the service.
ValidationException:
The request parameters are invalid.
TooManyRequestsException:
The request cannot be completed because too many other requests are occurring at the same time.

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

Returns the tag values that are assigned to a behavior graph.

Parameter Syntax

$result = $client->listTagsForResource([
    'ResourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

ResourceArn

Required: Yes
Type: string

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

Result Syntax

[
    'Tags' => ['<string>', ...],
]

Result Details

Members

Tags

Type: Associative array of custom strings keys (TagKey) to strings

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

Errors

AccessDeniedException:
The request issuer does not have permission to access this resource or perform this operation.
InternalServerException:
The request was valid but failed because of a problem with the service.
ValidationException:
The request parameters are invalid.
ResourceNotFoundException:
The request refers to a nonexistent resource.

RejectInvitation

$result = $client->rejectInvitation([/* ... */]);
$promise = $client->rejectInvitationAsync([/* ... */]);

Rejects an invitation to contribute the account data to a behavior graph. This operation must be called by an invited member account that has the INVITED status.

RejectInvitation cannot be called by an organization account in the organization behavior graph. In the organization behavior graph, organization accounts do not receive an invitation.

Parameter Syntax

$result = $client->rejectInvitation([
    'GraphArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

GraphArn

Required: Yes
Type: 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.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

AccessDeniedException:
The request issuer does not have permission to access this resource or perform this operation.
ConflictException:
The request attempted an invalid action.
InternalServerException:
The request was valid but failed because of a problem with the service.
ResourceNotFoundException:
The request refers to a nonexistent resource.
ValidationException:
The request parameters are invalid.

StartInvestigation

$result = $client->startInvestigation([/* ... */]);
$promise = $client->startInvestigationAsync([/* ... */]);

initiate an investigation on an entity in a graph

Parameter Syntax

$result = $client->startInvestigation([
    'EntityArn' => '<string>', // REQUIRED
    'GraphArn' => '<string>', // REQUIRED
    'ScopeEndTime' => <integer || string || DateTime>, // REQUIRED
    'ScopeStartTime' => <integer || string || DateTime>, // REQUIRED
]);

Parameter Details

Members

EntityArn

Required: Yes
Type: string

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

GraphArn

Required: Yes
Type: string

The ARN of the behavior graph.

ScopeEndTime

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

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

ScopeStartTime

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

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

Result Syntax

[
    'InvestigationId' => '<string>',
]

Result Details

Members

InvestigationId

Type: string

The investigation ID of the investigation report.

Errors

AccessDeniedException:
The request issuer does not have permission to access this resource or perform this operation.
InternalServerException:
The request was valid but failed because of a problem with the service.
ValidationException:
The request parameters are invalid.
TooManyRequestsException:
The request cannot be completed because too many other requests are occurring at the same time.
ResourceNotFoundException:
The request refers to a nonexistent resource.

StartMonitoringMember

$result = $client->startMonitoringMember([/* ... */]);
$promise = $client->startMonitoringMemberAsync([/* ... */]);

Sends a request to enable data ingest for a member account that has a status of ACCEPTED_BUT_DISABLED.

For valid member accounts, the status is updated as follows.

If Detective enabled the member account, then the new status is ENABLED.
If Detective cannot enable the member account, the status remains ACCEPTED_BUT_DISABLED.

Parameter Syntax

$result = $client->startMonitoringMember([
    'AccountId' => '<string>', // REQUIRED
    'GraphArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

AccountId

Required: Yes
Type: 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.

GraphArn

Required: Yes
Type: string

The ARN of the behavior graph.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

AccessDeniedException:
The request issuer does not have permission to access this resource or perform this operation.
ConflictException:
The request attempted an invalid action.
InternalServerException:
The request was valid but failed because of a problem with the service.
ResourceNotFoundException:
The request refers to a nonexistent resource.
ServiceQuotaExceededException:
This request cannot be completed for one of the following reasons.
- The request would cause the number of member accounts in the behavior graph to exceed the maximum allowed. A behavior graph cannot have more than 1200 member accounts.
- The request would cause the data rate for the behavior graph to exceed the maximum allowed.
- Detective is unable to verify the data rate for the member account. This is usually because the member account is not enrolled in Amazon GuardDuty.
ValidationException:
The request parameters are invalid.

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

Applies tag values to a behavior graph.

Parameter Syntax

$result = $client->tagResource([
    'ResourceArn' => '<string>', // REQUIRED
    'Tags' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members

ResourceArn

Required: Yes
Type: string

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

Tags

Required: Yes
Type: Associative array of custom strings keys (TagKey) to strings

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.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

AccessDeniedException:
The request issuer does not have permission to access this resource or perform this operation.
InternalServerException:
The request was valid but failed because of a problem with the service.
ValidationException:
The request parameters are invalid.
ResourceNotFoundException:
The request refers to a nonexistent resource.

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Removes tags from a behavior graph.

Parameter Syntax

$result = $client->untagResource([
    'ResourceArn' => '<string>', // REQUIRED
    'TagKeys' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Members

ResourceArn

Required: Yes
Type: string

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

TagKeys

Required: Yes
Type: Array of strings

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

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

AccessDeniedException:
The request issuer does not have permission to access this resource or perform this operation.
InternalServerException:
The request was valid but failed because of a problem with the service.
ValidationException:
The request parameters are invalid.
ResourceNotFoundException:
The request refers to a nonexistent resource.

UpdateDatasourcePackages

$result = $client->updateDatasourcePackages([/* ... */]);
$promise = $client->updateDatasourcePackagesAsync([/* ... */]);

Starts a data source packages for the behavior graph.

Parameter Syntax

$result = $client->updateDatasourcePackages([
    'DatasourcePackages' => ['<string>', ...], // REQUIRED
    'GraphArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

DatasourcePackages

Required: Yes
Type: Array of strings

The data source package start for the behavior graph.

GraphArn

Required: Yes
Type: string

The ARN of the behavior graph.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

AccessDeniedException:
The request issuer does not have permission to access this resource or perform this operation.
InternalServerException:
The request was valid but failed because of a problem with the service.
ResourceNotFoundException:
The request refers to a nonexistent resource.
ServiceQuotaExceededException:
This request cannot be completed for one of the following reasons.
- The request would cause the number of member accounts in the behavior graph to exceed the maximum allowed. A behavior graph cannot have more than 1200 member accounts.
- The request would cause the data rate for the behavior graph to exceed the maximum allowed.
- Detective is unable to verify the data rate for the member account. This is usually because the member account is not enrolled in Amazon GuardDuty.
ValidationException:
The request parameters are invalid.

UpdateInvestigationState

$result = $client->updateInvestigationState([/* ... */]);
$promise = $client->updateInvestigationStateAsync([/* ... */]);

Update the state of an investigation.

Parameter Syntax

$result = $client->updateInvestigationState([
    'GraphArn' => '<string>', // REQUIRED
    'InvestigationId' => '<string>', // REQUIRED
    'State' => 'ACTIVE|ARCHIVED', // REQUIRED
]);

Parameter Details

Members

GraphArn

Required: Yes
Type: string

The ARN of the behavior graph.

InvestigationId

Required: Yes
Type: string

The investigation ID of the investigation report.

State

Required: Yes
Type: string

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

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

AccessDeniedException:
The request issuer does not have permission to access this resource or perform this operation.
InternalServerException:
The request was valid but failed because of a problem with the service.
ValidationException:
The request parameters are invalid.
ResourceNotFoundException:
The request refers to a nonexistent resource.
TooManyRequestsException:
The request cannot be completed because too many other requests are occurring at the same time.

UpdateOrganizationConfiguration

$result = $client->updateOrganizationConfiguration([/* ... */]);
$promise = $client->updateOrganizationConfigurationAsync([/* ... */]);

Updates the configuration for the Organizations integration in the current Region. Can only be called by the Detective administrator account for the organization.

Parameter Syntax

$result = $client->updateOrganizationConfiguration([
    'AutoEnable' => true || false,
    'GraphArn' => '<string>', // REQUIRED
]);

Parameter Details

Members

AutoEnable

Type: boolean

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

GraphArn

Required: Yes
Type: string

The ARN of the organization behavior graph.

Result Syntax

[]

Result Details

The results for this operation are always empty.

Errors

AccessDeniedException:
The request issuer does not have permission to access this resource or perform this operation.
InternalServerException:
The request was valid but failed because of a problem with the service.
ValidationException:
The request parameters are invalid.
TooManyRequestsException:
The request cannot be completed because too many other requests are occurring at the same time.

Shapes

AccessDeniedException

Description

The request issuer does not have permission to access this resource or perform this operation.

Members

ErrorCode

Type: string

The SDK default error code associated with the access denied exception.

ErrorCodeReason

Type: string

The SDK default explanation of why access was denied.

Message

Type: string

SubErrorCode

Type: string

The error code associated with the access denied exception.

SubErrorCodeReason

Type: string

An explanation of why access was denied.

Account

Description

An Amazon Web Services account that is the administrator account of or a member of a behavior graph.

Members

AccountId

Required: Yes
Type: string

The account identifier of the Amazon Web Services account.

EmailAddress

Required: Yes
Type: string

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

Administrator

Description

Information about the Detective administrator account for an organization.

Members

AccountId

Type: string

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

DelegationTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

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.

GraphArn

Type: string

The ARN of the organization behavior graph.

ConflictException

Description

The request attempted an invalid action.

Members

Message

Type: string

DatasourcePackageIngestDetail

Description

Details about the data source packages ingested by your behavior graph.

Members

DatasourcePackageIngestState

Type: string

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

LastIngestStateChange

Type: Associative array of custom strings keys (DatasourcePackageIngestState) to TimestampForCollection structures

The date a data source package was enabled for this account

DatasourcePackageUsageInfo

Description

Information on the usage of a data source package in the behavior graph.

Members

VolumeUsageInBytes

Type: long (int|float)

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

VolumeUsageUpdateTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

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.

DateFilter

Description

Contains details on the time range used to filter data.

Members

EndInclusive

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

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

StartInclusive

Required: Yes
Type: timestamp (string|DateTime or anything parsable by strtotime)

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

FilterCriteria

Description

Details on the criteria used to define the filter for investigation results.

Members

CreatedTime

Type: DateFilter structure

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

EntityArn

Type: StringFilter structure

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

Severity

Type: StringFilter structure

Filter the investigation results based on the severity.

State

Type: StringFilter structure

Filter the investigation results based on the state.

Status

Type: StringFilter structure

Filter the investigation results based on the status.

FlaggedIpAddressDetail

Description

Contains information on suspicious IP addresses identified as indicators of compromise. This indicator is derived from Amazon Web Services threat intelligence.

Members

IpAddress

Type: string

IP address of the suspicious entity.

Reason

Type: string

Details the reason the IP address was flagged as suspicious.

Graph

Description

A behavior graph in Detective.

Members

Arn

Type: string

The ARN of the behavior graph.

CreatedTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

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.

ImpossibleTravelDetail

Description

Contains information on unusual and impossible travel in an account.

Members

EndingIpAddress

Type: string

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

EndingLocation

Type: string

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

HourlyTimeDelta

Type: int

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

StartingIpAddress

Type: string

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

StartingLocation

Type: string

Location where the resource was first used in the impossible travel

Indicator

Description

Investigations triages indicators of compromises such as a finding and surfaces only the most critical and suspicious issues, so you can focus on high-level investigations.

Members

IndicatorDetail

Type: IndicatorDetail structure

Details about the indicator of compromise.

IndicatorType

Type: string

The type of indicator.

IndicatorDetail

Description

Details about the indicators of compromise which are used to determine if a resource is involved in a security incident.

Members

FlaggedIpAddressDetail

Type: FlaggedIpAddressDetail structure

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

ImpossibleTravelDetail

Type: ImpossibleTravelDetail structure

Identifies unusual and impossible user activity for an account.

NewAsoDetail

Type: NewAsoDetail structure

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

NewGeolocationDetail

Type: NewGeolocationDetail structure

Contains details about the new geographic location.

NewUserAgentDetail

Type: NewUserAgentDetail structure

Contains details about the new user agent.

RelatedFindingDetail

Type: RelatedFindingDetail structure

Contains details about related findings.

RelatedFindingGroupDetail

Type: RelatedFindingGroupDetail structure

Contains details about related finding groups.

TTPsObservedDetail

Type: TTPsObservedDetail structure

Details about the indicator of compromise.

InternalServerException

Description

The request was valid but failed because of a problem with the service.

Members

Message

Type: string

InvestigationDetail

Description

Details about the investigation related to a potential security event identified by Detective

Members

CreatedTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

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

EntityArn

Type: string

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

EntityType

Type: string

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

InvestigationId

Type: string

The investigation ID of the investigation report.

Severity

Type: string

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

State

Type: string

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

Status

Type: string

Status based on the completion status of the investigation.

MemberDetail

Description

Details about a member account in a behavior graph.

Members

AccountId

Type: string

The Amazon Web Services account identifier for the member account.

AdministratorId

Type: string

The Amazon Web Services account identifier of the administrator account for the behavior graph.

DatasourcePackageIngestStates

Type: Associative array of custom strings keys (DatasourcePackage) to strings

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

DisabledReason

Type: 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.

EmailAddress

Type: string

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

GraphArn

Type: string

The ARN of the behavior graph.

InvitationType

Type: 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.

InvitedTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

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.

MasterId

Type: string

The Amazon Web Services account identifier of the administrator account for the behavior graph.

PercentOfGraphUtilization

Type: double

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

Type: timestamp (string|DateTime or anything parsable by strtotime)

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.

Status

Type: 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.

UpdatedTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

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.

VolumeUsageByDatasourcePackage

Type: Associative array of custom strings keys (DatasourcePackage) to DatasourcePackageUsageInfo structures

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

VolumeUsageInBytes

Type: long (int|float)

The data volume in bytes per day for the member account.

VolumeUsageUpdatedTime

Type: timestamp (string|DateTime or anything parsable by strtotime)

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.

MembershipDatasources

Description

Details on data source packages for members of the behavior graph.

Members

AccountId

Type: string

The account identifier of the Amazon Web Services account.

DatasourcePackageIngestHistory

Type: Associative array of custom strings keys (DatasourcePackage) to TimestampForCollection structuress

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

GraphArn

Type: string

The ARN of the organization behavior graph.

NewAsoDetail

Description

Details new Autonomous System Organizations (ASOs) used either at the resource or account level.

Members

Aso

Type: string

Details about the new Autonomous System Organization (ASO).

IsNewForEntireAccount

Type: boolean

Checks if the ASO is for new for the entire account.

NewGeolocationDetail

Description

Details new geolocations used either at the resource or account level. For example, lists an observed geolocation that is an infrequent or unused location based on previous user activity.

Members

IpAddress

Type: string

IP address using which the resource was accessed.

IsNewForEntireAccount

Type: boolean

Checks if the gelocation is new for the entire account.

Location

Type: string

Location where the resource was accessed.

NewUserAgentDetail

Description

Details new user agents used either at the resource or account level.

Members

IsNewForEntireAccount

Type: boolean

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

UserAgent

Type: string

New user agent which accessed the resource.

RelatedFindingDetail

Description

Details related activities associated with a potential security event. Lists all distinct categories of evidence that are connected to the resource or the finding group.

Members

Arn

Type: string

The ARN of the related finding.

IpAddress

Type: string

The IP address of the finding.

Type

Type: string

The type of finding.

RelatedFindingGroupDetail

Description

Details multiple activities as they related to a potential security event. Detective uses graph analysis technique that infers relationships between findings and entities, and groups them together as a finding group.

Members

Id

Type: string

The unique identifier for the finding group.

ResourceNotFoundException

Description

The request refers to a nonexistent resource.

Members

Message

Type: string

ServiceQuotaExceededException

Description

This request cannot be completed for one of the following reasons.

The request would cause the number of member accounts in the behavior graph to exceed the maximum allowed. A behavior graph cannot have more than 1200 member accounts.
The request would cause the data rate for the behavior graph to exceed the maximum allowed.
Detective is unable to verify the data rate for the member account. This is usually because the member account is not enrolled in Amazon GuardDuty.

Members

Message

Type: string

Resources

Type: Array of strings

The type of resource that has exceeded the service quota.

SortCriteria

Description

Details about the criteria used for sorting investigations.

Members

Field

Type: string

Represents the Field attribute to sort investigations.

SortOrder

Type: string

The order by which the sorted findings are displayed.

StringFilter

Description

A string for filtering Detective investigations.

Members

Value

Required: Yes
Type: string

The string filter value.

TTPsObservedDetail

Description

Details tactics, techniques, and procedures (TTPs) used in a potential security event. Tactics are based on MITRE ATT&CK Matrix for Enterprise.

Members

APIFailureCount

Type: long (int|float)

The total number of failed API requests.

APIName

Type: string

The name of the API where the TTP was observed.

APISuccessCount

Type: long (int|float)

The total number of successful API requests.

IpAddress

Type: string

The IP address where the TTP was observed.

Procedure

Type: string

The procedure used, identified by the investigation.

Tactic

Type: string

The tactic used, identified by the investigation.

Technique

Type: string

The technique used, identified by the investigation.

TimestampForCollection

Description

Details on when data collection began for a source package.

Members

Timestamp

Type: timestamp (string|DateTime or anything parsable by strtotime)

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.

TooManyRequestsException

Description

The request cannot be completed because too many other requests are occurring at the same time.

Members

Message

Type: string

UnprocessedAccount

Description

A member account that was included in a request but for which the request could not be processed.

Members

AccountId

Type: string

The Amazon Web Services account identifier of the member account that was not processed.

Reason

Type: string

The reason that the member account request could not be processed.

UnprocessedGraph

Description

Behavior graphs that could not be processed in the request.

Members

GraphArn

Type: string

The ARN of the organization behavior graph.

Reason

Type: string

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

ValidationException

Description

The request parameters are invalid.

Members

ErrorCode

Type: string

The error code associated with the validation failure.

ErrorCodeReason

Type: string

An explanation of why validation failed.

Message

Type: string

Namespaces

Classes

Interfaces

Traits

Exceptions

Functions

Amazon Detective 2018-10-26

Operation Summary

Paginators

Operations

AcceptInvitation

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

BatchGetGraphMemberDatasources

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

BatchGetMembershipDatasources

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateGraph

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

CreateMembers

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DeleteGraph

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

DeleteMembers

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DescribeOrganizationConfiguration

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Members

Errors

DisableOrganizationAdminAccount

Parameter Syntax

Parameter Details

Members

Result Syntax

Result Details

Errors

DisassociateMembership