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

Result Syntax

[]

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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.

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

Result Syntax

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

Result Details

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.

• This request cannot be completed if it would cause the number of member accounts in the behavior graph to exceed the maximum allowed. A behavior graph cannot have more than 1,200 member accounts.

• This request cannot be completed if the current volume ingested is above the limit of 10 TB per day. Detective will not allow you to add additional member accounts.

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

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

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.

• This request cannot be completed if it would cause the number of member accounts in the behavior graph to exceed the maximum allowed. A behavior graph cannot have more than 1,200 member accounts.

• This request cannot be completed if the current volume ingested is above the limit of 10 TB per day. Detective will not allow you to add additional member accounts.

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

Result Syntax

[]

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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([/* ... */]);

Detective investigations lets you investigate IAM users and IAM roles using indicators of compromise. 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. GetInvestigation returns the investigation results of an investigation for a behavior graph.

Parameter Syntax

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

Parameter Details

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

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

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

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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([/* ... */]);

Gets the indicators from an investigation. You can use the information from the indicators to determine if an IAM user and/or IAM role is involved in an unusual activity that could indicate malicious behavior and its impact.

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

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

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([/* ... */]);

Detective investigations lets you investigate IAM users and IAM roles using indicators of compromise. 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. ListInvestigations lists all active Detective 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

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

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

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

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

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

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

Result Syntax

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

Result Details

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

Result Syntax

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

Result Details

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

Result Syntax

[]

Result Details

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([/* ... */]);

Detective investigations lets you investigate IAM users and IAM roles using indicators of compromise. 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. StartInvestigation initiates an investigation on an entity in a behavior graph.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

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

Result Syntax

[]

Result Details

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.

• This request cannot be completed if it would cause the number of member accounts in the behavior graph to exceed the maximum allowed. A behavior graph cannot have more than 1,200 member accounts.

• This request cannot be completed if the current volume ingested is above the limit of 10 TB per day. Detective will not allow you to add additional member accounts.

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

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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 package for the Detective behavior graph.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

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.

• This request cannot be completed if it would cause the number of member accounts in the behavior graph to exceed the maximum allowed. A behavior graph cannot have more than 1,200 member accounts.

• This request cannot be completed if the current volume ingested is above the limit of 10 TB per day. Detective will not allow you to add additional member accounts.

ValidationException:

The request parameters are invalid.

UpdateInvestigationState

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

Updates the state of an investigation.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

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

Result Syntax

[]

Result Details

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.