Amazon GuardDuty 2017-11-28

AcceptAdministratorInvitation

$result = $client->acceptAdministratorInvitation([/* ... */]);
$promise = $client->acceptAdministratorInvitationAsync([/* ... */]);

Parameter Syntax

$result = $client->acceptAdministratorInvitation([
    'AdministratorId' => '<string>', // REQUIRED
    'DetectorId' => '<string>', // REQUIRED
    'InvitationId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

• BadRequestException:

  A bad request exception object.

• InternalServerErrorException:

  An internal server error exception object.

AcceptInvitation

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

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

• BadRequestException:

  A bad request exception object.

• InternalServerErrorException:

  An internal server error exception object.

ArchiveFindings

$result = $client->archiveFindings([/* ... */]);
$promise = $client->archiveFindingsAsync([/* ... */]);

Parameter Syntax

$result = $client->archiveFindings([
    'DetectorId' => '<string>', // REQUIRED
    'FindingIds' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

• BadRequestException:

  A bad request exception object.

• InternalServerErrorException:

  An internal server error exception object.

CreateDetector

$result = $client->createDetector([/* ... */]);
$promise = $client->createDetectorAsync([/* ... */]);

Parameter Syntax

$result = $client->createDetector([
    'ClientToken' => '<string>',
    'DataSources' => [
        'Kubernetes' => [
            'AuditLogs' => [ // REQUIRED
                'Enable' => true || false, // REQUIRED
            ],
        ],
        'MalwareProtection' => [
            'ScanEc2InstanceWithFindings' => [
                'EbsVolumes' => true || false,
            ],
        ],
        'S3Logs' => [
            'Enable' => true || false, // REQUIRED
        ],
    ],
    'Enable' => true || false, // REQUIRED
    'Features' => [
        [
            'AdditionalConfiguration' => [
                [
                    'Name' => 'EKS_ADDON_MANAGEMENT',
                    'Status' => 'ENABLED|DISABLED',
                ],
                // ...
            ],
            'Name' => 'S3_DATA_EVENTS|EKS_AUDIT_LOGS|EBS_MALWARE_PROTECTION|RDS_LOGIN_EVENTS|EKS_RUNTIME_MONITORING',
            'Status' => 'ENABLED|DISABLED',
        ],
        // ...
    ],
    'FindingPublishingFrequency' => 'FIFTEEN_MINUTES|ONE_HOUR|SIX_HOURS',
    'Tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'DetectorId' => '<string>',
    'UnprocessedDataSources' => [
        'MalwareProtection' => [
            'ScanEc2InstanceWithFindings' => [
                'EbsVolumes' => [
                    'Reason' => '<string>',
                    'Status' => 'ENABLED|DISABLED',
                ],
            ],
            'ServiceRole' => '<string>',
        ],
    ],
]

Result Details

Errors

• BadRequestException:

  A bad request exception object.

• InternalServerErrorException:

  An internal server error exception object.

CreateFilter

$result = $client->createFilter([/* ... */]);
$promise = $client->createFilterAsync([/* ... */]);

Parameter Syntax

$result = $client->createFilter([
    'Action' => 'NOOP|ARCHIVE',
    'ClientToken' => '<string>',
    'Description' => '<string>',
    'DetectorId' => '<string>', // REQUIRED
    'FindingCriteria' => [ // REQUIRED
        'Criterion' => [
            '<String>' => [
                'Eq' => ['<string>', ...],
                'Equals' => ['<string>', ...],
                'GreaterThan' => <integer>,
                'GreaterThanOrEqual' => <integer>,
                'Gt' => <integer>,
                'Gte' => <integer>,
                'LessThan' => <integer>,
                'LessThanOrEqual' => <integer>,
                'Lt' => <integer>,
                'Lte' => <integer>,
                'Neq' => ['<string>', ...],
                'NotEquals' => ['<string>', ...],
            ],
            // ...
        ],
    ],
    'Name' => '<string>', // REQUIRED
    'Rank' => <integer>,
    'Tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

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

Result Details

Errors

• BadRequestException:

  A bad request exception object.

• InternalServerErrorException:

  An internal server error exception object.

CreateIPSet

$result = $client->createIPSet([/* ... */]);
$promise = $client->createIPSetAsync([/* ... */]);

Parameter Syntax

$result = $client->createIPSet([
    'Activate' => true || false, // REQUIRED
    'ClientToken' => '<string>',
    'DetectorId' => '<string>', // REQUIRED
    'Format' => 'TXT|STIX|OTX_CSV|ALIEN_VAULT|PROOF_POINT|FIRE_EYE', // REQUIRED
    'Location' => '<string>', // REQUIRED
    'Name' => '<string>', // REQUIRED
    'Tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

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

Result Details

Errors

• BadRequestException:

  A bad request exception object.

• InternalServerErrorException:

  An internal server error exception object.

CreateMembers

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

Parameter Syntax

$result = $client->createMembers([
    'AccountDetails' => [ // REQUIRED
        [
            'AccountId' => '<string>', // REQUIRED
            'Email' => '<string>', // REQUIRED
        ],
        // ...
    ],
    'DetectorId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

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

Result Details

Errors

• BadRequestException:

  A bad request exception object.

• InternalServerErrorException:

  An internal server error exception object.

CreatePublishingDestination

$result = $client->createPublishingDestination([/* ... */]);
$promise = $client->createPublishingDestinationAsync([/* ... */]);

Parameter Syntax

$result = $client->createPublishingDestination([
    'ClientToken' => '<string>',
    'DestinationProperties' => [ // REQUIRED
        'DestinationArn' => '<string>',
        'KmsKeyArn' => '<string>',
    ],
    'DestinationType' => 'S3', // REQUIRED
    'DetectorId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

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

Result Details

Errors

• BadRequestException:

  A bad request exception object.

• InternalServerErrorException:

  An internal server error exception object.

CreateSampleFindings

$result = $client->createSampleFindings([/* ... */]);
$promise = $client->createSampleFindingsAsync([/* ... */]);

Parameter Syntax

$result = $client->createSampleFindings([
    'DetectorId' => '<string>', // REQUIRED
    'FindingTypes' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

• BadRequestException:

  A bad request exception object.

• InternalServerErrorException:

  An internal server error exception object.

CreateThreatIntelSet

$result = $client->createThreatIntelSet([/* ... */]);
$promise = $client->createThreatIntelSetAsync([/* ... */]);

Parameter Syntax

$result = $client->createThreatIntelSet([
    'Activate' => true || false, // REQUIRED
    'ClientToken' => '<string>',
    'DetectorId' => '<string>', // REQUIRED
    'Format' => 'TXT|STIX|OTX_CSV|ALIEN_VAULT|PROOF_POINT|FIRE_EYE', // REQUIRED
    'Location' => '<string>', // REQUIRED
    'Name' => '<string>', // REQUIRED
    'Tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

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

Result Details

Errors

• BadRequestException:

  A bad request exception object.

• InternalServerErrorException:

  An internal server error exception object.

DeclineInvitations

$result = $client->declineInvitations([/* ... */]);
$promise = $client->declineInvitationsAsync([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

• BadRequestException:

  A bad request exception object.

• InternalServerErrorException:

  An internal server error exception object.

DeleteDetector

$result = $client->deleteDetector([/* ... */]);
$promise = $client->deleteDetectorAsync([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

• BadRequestException:

  A bad request exception object.

• InternalServerErrorException:

  An internal server error exception object.

DeleteFilter

$result = $client->deleteFilter([/* ... */]);
$promise = $client->deleteFilterAsync([/* ... */]);

Parameter Syntax

$result = $client->deleteFilter([
    'DetectorId' => '<string>', // REQUIRED
    'FilterName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

• BadRequestException:

  A bad request exception object.

• InternalServerErrorException:

  An internal server error exception object.

DeleteIPSet

$result = $client->deleteIPSet([/* ... */]);
$promise = $client->deleteIPSetAsync([/* ... */]);

Parameter Syntax

$result = $client->deleteIPSet([
    'DetectorId' => '<string>', // REQUIRED
    'IpSetId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

• BadRequestException:

  A bad request exception object.

• InternalServerErrorException:

  An internal server error exception object.

DeleteInvitations

$result = $client->deleteInvitations([/* ... */]);
$promise = $client->deleteInvitationsAsync([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

• BadRequestException:

  A bad request exception object.

• InternalServerErrorException:

  An internal server error exception object.

DeleteMembers

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

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

• BadRequestException:

  A bad request exception object.

• InternalServerErrorException:

  An internal server error exception object.

DeletePublishingDestination

$result = $client->deletePublishingDestination([/* ... */]);
$promise = $client->deletePublishingDestinationAsync([/* ... */]);

Parameter Syntax

$result = $client->deletePublishingDestination([
    'DestinationId' => '<string>', // REQUIRED
    'DetectorId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

• BadRequestException:

  A bad request exception object.

• InternalServerErrorException:

  An internal server error exception object.

DeleteThreatIntelSet

$result = $client->deleteThreatIntelSet([/* ... */]);
$promise = $client->deleteThreatIntelSetAsync([/* ... */]);

Parameter Syntax

$result = $client->deleteThreatIntelSet([
    'DetectorId' => '<string>', // REQUIRED
    'ThreatIntelSetId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

• BadRequestException:

  A bad request exception object.

• InternalServerErrorException:

  An internal server error exception object.

DescribeMalwareScans

$result = $client->describeMalwareScans([/* ... */]);
$promise = $client->describeMalwareScansAsync([/* ... */]);

Parameter Syntax

$result = $client->describeMalwareScans([
    'DetectorId' => '<string>', // REQUIRED
    'FilterCriteria' => [
        'FilterCriterion' => [
            [
                'CriterionKey' => 'EC2_INSTANCE_ARN|SCAN_ID|ACCOUNT_ID|GUARDDUTY_FINDING_ID|SCAN_START_TIME|SCAN_STATUS',
                'FilterCondition' => [
                    'EqualsValue' => '<string>',
                    'GreaterThan' => <integer>,
                    'LessThan' => <integer>,
                ],
            ],
            // ...
        ],
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'SortCriteria' => [
        'AttributeName' => '<string>',
        'OrderBy' => 'ASC|DESC',
    ],
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'Scans' => [
        [
            'AccountId' => '<string>',
            'AdminDetectorId' => '<string>',
            'AttachedVolumes' => [
                [
                    'DeviceName' => '<string>',
                    'EncryptionType' => '<string>',
                    'KmsKeyArn' => '<string>',
                    'SnapshotArn' => '<string>',
                    'VolumeArn' => '<string>',
                    'VolumeSizeInGB' => <integer>,
                    'VolumeType' => '<string>',
                ],
                // ...
            ],
            'DetectorId' => '<string>',
            'FailureReason' => '<string>',
            'FileCount' => <integer>,
            'ResourceDetails' => [
                'InstanceArn' => '<string>',
            ],
            'ScanEndTime' => <DateTime>,
            'ScanId' => '<string>',
            'ScanResultDetails' => [
                'ScanResult' => 'CLEAN|INFECTED',
            ],
            'ScanStartTime' => <DateTime>,
            'ScanStatus' => 'RUNNING|COMPLETED|FAILED',
            'TotalBytes' => <integer>,
            'TriggerDetails' => [
                'Description' => '<string>',
                'GuardDutyFindingId' => '<string>',
            ],
        ],
        // ...
    ],
]

Result Details

Errors

• BadRequestException:

  A bad request exception object.

• InternalServerErrorException:

  An internal server error exception object.

DescribeOrganizationConfiguration

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

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'AutoEnable' => true || false,
    'AutoEnableOrganizationMembers' => 'NEW|ALL|NONE',
    'DataSources' => [
        'Kubernetes' => [
            'AuditLogs' => [
                'AutoEnable' => true || false,
            ],
        ],
        'MalwareProtection' => [
            'ScanEc2InstanceWithFindings' => [
                'EbsVolumes' => [
                    'AutoEnable' => true || false,
                ],
            ],
        ],
        'S3Logs' => [
            'AutoEnable' => true || false,
        ],
    ],
    'Features' => [
        [
            'AdditionalConfiguration' => [
                [
                    'AutoEnable' => 'NEW|NONE',
                    'Name' => 'EKS_ADDON_MANAGEMENT',
                ],
                // ...
            ],
            'AutoEnable' => 'NEW|NONE',
            'Name' => 'S3_DATA_EVENTS|EKS_AUDIT_LOGS|EBS_MALWARE_PROTECTION|RDS_LOGIN_EVENTS|EKS_RUNTIME_MONITORING',
        ],
        // ...
    ],
    'MemberAccountLimitReached' => true || false,
    'NextToken' => '<string>',
]

Result Details

Errors

• BadRequestException:

  A bad request exception object.

• InternalServerErrorException:

  An internal server error exception object.

DescribePublishingDestination

$result = $client->describePublishingDestination([/* ... */]);
$promise = $client->describePublishingDestinationAsync([/* ... */]);

Parameter Syntax

$result = $client->describePublishingDestination([
    'DestinationId' => '<string>', // REQUIRED
    'DetectorId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'DestinationId' => '<string>',
    'DestinationProperties' => [
        'DestinationArn' => '<string>',
        'KmsKeyArn' => '<string>',
    ],
    'DestinationType' => 'S3',
    'PublishingFailureStartTimestamp' => <integer>,
    'Status' => 'PENDING_VERIFICATION|PUBLISHING|UNABLE_TO_PUBLISH_FIX_DESTINATION_PROPERTY|STOPPED',
]

Result Details

Errors

• BadRequestException:

  A bad request exception object.

• InternalServerErrorException:

  An internal server error exception object.

DisableOrganizationAdminAccount

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

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

• BadRequestException:

  A bad request exception object.

• InternalServerErrorException:

  An internal server error exception object.

DisassociateFromAdministratorAccount

$result = $client->disassociateFromAdministratorAccount([/* ... */]);
$promise = $client->disassociateFromAdministratorAccountAsync([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

• BadRequestException:

  A bad request exception object.

• InternalServerErrorException:

  An internal server error exception object.

DisassociateFromMasterAccount

$result = $client->disassociateFromMasterAccount([/* ... */]);
$promise = $client->disassociateFromMasterAccountAsync([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

• BadRequestException:

  A bad request exception object.

• InternalServerErrorException:

  An internal server error exception object.

DisassociateMembers

$result = $client->disassociateMembers([/* ... */]);
$promise = $client->disassociateMembersAsync([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

• BadRequestException:

  A bad request exception object.

• InternalServerErrorException:

  An internal server error exception object.

EnableOrganizationAdminAccount

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

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

• BadRequestException:

  A bad request exception object.

• InternalServerErrorException:

  An internal server error exception object.

GetAdministratorAccount

$result = $client->getAdministratorAccount([/* ... */]);
$promise = $client->getAdministratorAccountAsync([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'Administrator' => [
        'AccountId' => '<string>',
        'InvitationId' => '<string>',
        'InvitedAt' => '<string>',
        'RelationshipStatus' => '<string>',
    ],
]

Result Details

Errors

• BadRequestException:

  A bad request exception object.

• InternalServerErrorException:

  An internal server error exception object.

GetCoverageStatistics

$result = $client->getCoverageStatistics([/* ... */]);
$promise = $client->getCoverageStatisticsAsync([/* ... */]);

Parameter Syntax

$result = $client->getCoverageStatistics([
    'DetectorId' => '<string>', // REQUIRED
    'FilterCriteria' => [
        'FilterCriterion' => [
            [
                'CriterionKey' => 'ACCOUNT_ID|CLUSTER_NAME|RESOURCE_TYPE|COVERAGE_STATUS|ADDON_VERSION',
                'FilterCondition' => [
                    'Equals' => ['<string>', ...],
                    'NotEquals' => ['<string>', ...],
                ],
            ],
            // ...
        ],
    ],
    'StatisticsType' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[
    'CoverageStatistics' => [
        'CountByCoverageStatus' => [<integer>, ...],
        'CountByResourceType' => [<integer>, ...],
    ],
]

Result Details

Errors

• BadRequestException:

  A bad request exception object.

• InternalServerErrorException:

  An internal server error exception object.

GetDetector

$result = $client->getDetector([/* ... */]);
$promise = $client->getDetectorAsync([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'CreatedAt' => '<string>',
    'DataSources' => [
        'CloudTrail' => [
            'Status' => 'ENABLED|DISABLED',
        ],
        'DNSLogs' => [
            'Status' => 'ENABLED|DISABLED',
        ],
        'FlowLogs' => [
            'Status' => 'ENABLED|DISABLED',
        ],
        'Kubernetes' => [
            'AuditLogs' => [
                'Status' => 'ENABLED|DISABLED',
            ],
        ],
        'MalwareProtection' => [
            'ScanEc2InstanceWithFindings' => [
                'EbsVolumes' => [
                    'Reason' => '<string>',
                    'Status' => 'ENABLED|DISABLED',
                ],
            ],
            'ServiceRole' => '<string>',
        ],
        'S3Logs' => [
            'Status' => 'ENABLED|DISABLED',
        ],
    ],
    'Features' => [
        [
            'AdditionalConfiguration' => [
                [
                    'Name' => 'EKS_ADDON_MANAGEMENT',
                    'Status' => 'ENABLED|DISABLED',
                    'UpdatedAt' => <DateTime>,
                ],
                // ...
            ],
            'Name' => 'FLOW_LOGS|CLOUD_TRAIL|DNS_LOGS|S3_DATA_EVENTS|EKS_AUDIT_LOGS|EBS_MALWARE_PROTECTION|RDS_LOGIN_EVENTS|EKS_RUNTIME_MONITORING',
            'Status' => 'ENABLED|DISABLED',
            'UpdatedAt' => <DateTime>,
        ],
        // ...
    ],
    'FindingPublishingFrequency' => 'FIFTEEN_MINUTES|ONE_HOUR|SIX_HOURS',
    'ServiceRole' => '<string>',
    'Status' => 'ENABLED|DISABLED',
    'Tags' => ['<string>', ...],
    'UpdatedAt' => '<string>',
]

Result Details

Errors

• BadRequestException:

  A bad request exception object.

• InternalServerErrorException:

  An internal server error exception object.

GetFilter

$result = $client->getFilter([/* ... */]);
$promise = $client->getFilterAsync([/* ... */]);

Parameter Syntax

$result = $client->getFilter([
    'DetectorId' => '<string>', // REQUIRED
    'FilterName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Action' => 'NOOP|ARCHIVE',
    'Description' => '<string>',
    'FindingCriteria' => [
        'Criterion' => [
            '<String>' => [
                'Eq' => ['<string>', ...],
                'Equals' => ['<string>', ...],
                'GreaterThan' => <integer>,
                'GreaterThanOrEqual' => <integer>,
                'Gt' => <integer>,
                'Gte' => <integer>,
                'LessThan' => <integer>,
                'LessThanOrEqual' => <integer>,
                'Lt' => <integer>,
                'Lte' => <integer>,
                'Neq' => ['<string>', ...],
                'NotEquals' => ['<string>', ...],
            ],
            // ...
        ],
    ],
    'Name' => '<string>',
    'Rank' => <integer>,
    'Tags' => ['<string>', ...],
]

Result Details

Errors

• BadRequestException:

  A bad request exception object.

• InternalServerErrorException:

  An internal server error exception object.

GetFindings

$result = $client->getFindings([/* ... */]);
$promise = $client->getFindingsAsync([/* ... */]);

Parameter Syntax

$result = $client->getFindings([
    'DetectorId' => '<string>', // REQUIRED
    'FindingIds' => ['<string>', ...], // REQUIRED
    'SortCriteria' => [
        'AttributeName' => '<string>',
        'OrderBy' => 'ASC|DESC',
    ],
]);

Parameter Details

Result Syntax

[
    'Findings' => [
        [
            'AccountId' => '<string>',
            'Arn' => '<string>',
            'Confidence' => <float>,
            'CreatedAt' => '<string>',
            'Description' => '<string>',
            'Id' => '<string>',
            'Partition' => '<string>',
            'Region' => '<string>',
            'Resource' => [
                'AccessKeyDetails' => [
                    'AccessKeyId' => '<string>',
                    'PrincipalId' => '<string>',
                    'UserName' => '<string>',
                    'UserType' => '<string>',
                ],
                'ContainerDetails' => [
                    'ContainerRuntime' => '<string>',
                    'Id' => '<string>',
                    'Image' => '<string>',
                    'ImagePrefix' => '<string>',
                    'Name' => '<string>',
                    'SecurityContext' => [
                        'Privileged' => true || false,
                    ],
                    'VolumeMounts' => [
                        [
                            'MountPath' => '<string>',
                            'Name' => '<string>',
                        ],
                        // ...
                    ],
                ],
                'EbsVolumeDetails' => [
                    'ScannedVolumeDetails' => [
                        [
                            'DeviceName' => '<string>',
                            'EncryptionType' => '<string>',
                            'KmsKeyArn' => '<string>',
                            'SnapshotArn' => '<string>',
                            'VolumeArn' => '<string>',
                            'VolumeSizeInGB' => <integer>,
                            'VolumeType' => '<string>',
                        ],
                        // ...
                    ],
                    'SkippedVolumeDetails' => [
                        [
                            'DeviceName' => '<string>',
                            'EncryptionType' => '<string>',
                            'KmsKeyArn' => '<string>',
                            'SnapshotArn' => '<string>',
                            'VolumeArn' => '<string>',
                            'VolumeSizeInGB' => <integer>,
                            'VolumeType' => '<string>',
                        ],
                        // ...
                    ],
                ],
                'EcsClusterDetails' => [
                    'ActiveServicesCount' => <integer>,
                    'Arn' => '<string>',
                    'Name' => '<string>',
                    'RegisteredContainerInstancesCount' => <integer>,
                    'RunningTasksCount' => <integer>,
                    'Status' => '<string>',
                    'Tags' => [
                        [
                            'Key' => '<string>',
                            'Value' => '<string>',
                        ],
                        // ...
                    ],
                    'TaskDetails' => [
                        'Arn' => '<string>',
                        'Containers' => [
                            [
                                'ContainerRuntime' => '<string>',
                                'Id' => '<string>',
                                'Image' => '<string>',
                                'ImagePrefix' => '<string>',
                                'Name' => '<string>',
                                'SecurityContext' => [
                                    'Privileged' => true || false,
                                ],
                                'VolumeMounts' => [
                                    [
                                        'MountPath' => '<string>',
                                        'Name' => '<string>',
                                    ],
                                    // ...
                                ],
                            ],
                            // ...
                        ],
                        'DefinitionArn' => '<string>',
                        'Group' => '<string>',
                        'StartedAt' => <DateTime>,
                        'StartedBy' => '<string>',
                        'Tags' => [
                            [
                                'Key' => '<string>',
                                'Value' => '<string>',
                            ],
                            // ...
                        ],
                        'TaskCreatedAt' => <DateTime>,
                        'Version' => '<string>',
                        'Volumes' => [
                            [
                                'HostPath' => [
                                    'Path' => '<string>',
                                ],
                                'Name' => '<string>',
                            ],
                            // ...
                        ],
                    ],
                ],
                'EksClusterDetails' => [
                    'Arn' => '<string>',
                    'CreatedAt' => <DateTime>,
                    'Name' => '<string>',
                    'Status' => '<string>',
                    'Tags' => [
                        [
                            'Key' => '<string>',
                            'Value' => '<string>',
                        ],
                        // ...
                    ],
                    'VpcId' => '<string>',
                ],
                'InstanceDetails' => [
                    'AvailabilityZone' => '<string>',
                    'IamInstanceProfile' => [
                        'Arn' => '<string>',
                        'Id' => '<string>',
                    ],
                    'ImageDescription' => '<string>',
                    'ImageId' => '<string>',
                    'InstanceId' => '<string>',
                    'InstanceState' => '<string>',
                    'InstanceType' => '<string>',
                    'LaunchTime' => '<string>',
                    'NetworkInterfaces' => [
                        [
                            'Ipv6Addresses' => ['<string>', ...],
                            'NetworkInterfaceId' => '<string>',
                            'PrivateDnsName' => '<string>',
                            'PrivateIpAddress' => '<string>',
                            'PrivateIpAddresses' => [
                                [
                                    'PrivateDnsName' => '<string>',
                                    'PrivateIpAddress' => '<string>',
                                ],
                                // ...
                            ],
                            'PublicDnsName' => '<string>',
                            'PublicIp' => '<string>',
                            'SecurityGroups' => [
                                [
                                    'GroupId' => '<string>',
                                    'GroupName' => '<string>',
                                ],
                                // ...
                            ],
                            'SubnetId' => '<string>',
                            'VpcId' => '<string>',
                        ],
                        // ...
                    ],
                    'OutpostArn' => '<string>',
                    'Platform' => '<string>',
                    'ProductCodes' => [
                        [
                            'Code' => '<string>',
                            'ProductType' => '<string>',
                        ],
                        // ...
                    ],
                    'Tags' => [
                        [
                            'Key' => '<string>',
                            'Value' => '<string>',
                        ],
                        // ...
                    ],
                ],
                'KubernetesDetails' => [
                    'KubernetesUserDetails' => [
                        'Groups' => ['<string>', ...],
                        'Uid' => '<string>',
                        'Username' => '<string>',
                    ],
                    'KubernetesWorkloadDetails' => [
                        'Containers' => [
                            [
                                'ContainerRuntime' => '<string>',
                                'Id' => '<string>',
                                'Image' => '<string>',
                                'ImagePrefix' => '<string>',
                                'Name' => '<string>',
                                'SecurityContext' => [
                                    'Privileged' => true || false,
                                ],
                                'VolumeMounts' => [
                                    [
                                        'MountPath' => '<string>',
                                        'Name' => '<string>',
                                    ],
                                    // ...
                                ],
                            ],
                            // ...
                        ],
                        'HostNetwork' => true || false,
                        'Name' => '<string>',
                        'Namespace' => '<string>',
                        'Type' => '<string>',
                        'Uid' => '<string>',
                        'Volumes' => [
                            [
                                'HostPath' => [
                                    'Path' => '<string>',
                                ],
                                'Name' => '<string>',
                            ],
                            // ...
                        ],
                    ],
                ],
                'RdsDbInstanceDetails' => [
                    'DbClusterIdentifier' => '<string>',
                    'DbInstanceArn' => '<string>',
                    'DbInstanceIdentifier' => '<string>',
                    'Engine' => '<string>',
                    'EngineVersion' => '<string>',
                    'Tags' => [
                        [
                            'Key' => '<string>',
                            'Value' => '<string>',
                        ],
                        // ...
                    ],
                ],
                'RdsDbUserDetails' => [
                    'Application' => '<string>',
                    'AuthMethod' => '<string>',
                    'Database' => '<string>',
                    'Ssl' => '<string>',
                    'User' => '<string>',
                ],
                'ResourceType' => '<string>',
                'S3BucketDetails' => [
                    [
                        'Arn' => '<string>',
                        'CreatedAt' => <DateTime>,
                        'DefaultServerSideEncryption' => [
                            'EncryptionType' => '<string>',
                            'KmsMasterKeyArn' => '<string>',
                        ],
                        'Name' => '<string>',
                        'Owner' => [
                            'Id' => '<string>',
                        ],
                        'PublicAccess' => [
                            'EffectivePermission' => '<string>',
                            'PermissionConfiguration' => [
                                'AccountLevelPermissions' => [
                                    'BlockPublicAccess' => [
                                        'BlockPublicAcls' => true || false,
                                        'BlockPublicPolicy' => true || false,
                                        'IgnorePublicAcls' => true || false,
                                        'RestrictPublicBuckets' => true || false,
                                    ],
                                ],
                                'BucketLevelPermissions' => [
                                    'AccessControlList' => [
                                        'AllowsPublicReadAccess' => true || false,
                                        'AllowsPublicWriteAccess' => true || false,
                                    ],
                                    'BlockPublicAccess' => [
                                        'BlockPublicAcls' => true || false,
                                        'BlockPublicPolicy' => true || false,
                                        'IgnorePublicAcls' => true || false,
                                        'RestrictPublicBuckets' => true || false,
                                    ],
                                    'BucketPolicy' => [
                                        'AllowsPublicReadAccess' => true || false,
                                        'AllowsPublicWriteAccess' => true || false,
                                    ],
                                ],
                            ],
                        ],
                        'Tags' => [
                            [
                                'Key' => '<string>',
                                'Value' => '<string>',
                            ],
                            // ...
                        ],
                        'Type' => '<string>',
                    ],
                    // ...
                ],
            ],
            'SchemaVersion' => '<string>',
            'Service' => [
                'Action' => [
                    'ActionType' => '<string>',
                    'AwsApiCallAction' => [
                        'AffectedResources' => ['<string>', ...],
                        'Api' => '<string>',
                        'CallerType' => '<string>',
                        'DomainDetails' => [
                            'Domain' => '<string>',
                        ],
                        'ErrorCode' => '<string>',
                        'RemoteAccountDetails' => [
                            'AccountId' => '<string>',
                            'Affiliated' => true || false,
                        ],
                        'RemoteIpDetails' => [
                            'City' => [
                                'CityName' => '<string>',
                            ],
                            'Country' => [
                                'CountryCode' => '<string>',
                                'CountryName' => '<string>',
                            ],
                            'GeoLocation' => [
                                'Lat' => <float>,
                                'Lon' => <float>,
                            ],
                            'IpAddressV4' => '<string>',
                            'Organization' => [
                                'Asn' => '<string>',
                                'AsnOrg' => '<string>',
                                'Isp' => '<string>',
                                'Org' => '<string>',
                            ],
                        ],
                        'ServiceName' => '<string>',
                        'UserAgent' => '<string>',
                    ],
                    'DnsRequestAction' => [
                        'Blocked' => true || false,
                        'Domain' => '<string>',
                        'Protocol' => '<string>',
                    ],
                    'KubernetesApiCallAction' => [
                        'Parameters' => '<string>',
                        'RemoteIpDetails' => [
                            'City' => [
                                'CityName' => '<string>',
                            ],
                            'Country' => [
                                'CountryCode' => '<string>',
                                'CountryName' => '<string>',
                            ],
                            'GeoLocation' => [
                                'Lat' => <float>,
                                'Lon' => <float>,
                            ],
                            'IpAddressV4' => '<string>',
                            'Organization' => [
                                'Asn' => '<string>',
                                'AsnOrg' => '<string>',
                                'Isp' => '<string>',
                                'Org' => '<string>',
                            ],
                        ],
                        'RequestUri' => '<string>',
                        'SourceIps' => ['<string>', ...],
                        'StatusCode' => <integer>,
                        'UserAgent' => '<string>',
                        'Verb' => '<string>',
                    ],
                    'NetworkConnectionAction' => [
                        'Blocked' => true || false,
                        'ConnectionDirection' => '<string>',
                        'LocalIpDetails' => [
                            'IpAddressV4' => '<string>',
                        ],
                        'LocalPortDetails' => [
                            'Port' => <integer>,
                            'PortName' => '<string>',
                        ],
                        'Protocol' => '<string>',
                        'RemoteIpDetails' => [
                            'City' => [
                                'CityName' => '<string>',
                            ],
                            'Country' => [
                                'CountryCode' => '<string>',
                                'CountryName' => '<string>',
                            ],
                            'GeoLocation' => [
                                'Lat' => <float>,
                                'Lon' => <float>,
                            ],
                            'IpAddressV4' => '<string>',
                            'Organization' => [
                                'Asn' => '<string>',
                                'AsnOrg' => '<string>',
                                'Isp' => '<string>',
                                'Org' => '<string>',
                            ],
                        ],
                        'RemotePortDetails' => [
                            'Port' => <integer>,
                            'PortName' => '<string>',
                        ],
                    ],
                    'PortProbeAction' => [
                        'Blocked' => true || false,
                        'PortProbeDetails' => [
                            [
                                'LocalIpDetails' => [
                                    'IpAddressV4' => '<string>',
                                ],
                                'LocalPortDetails' => [
                                    'Port' => <integer>,
                                    'PortName' => '<string>',
                                ],
                                'RemoteIpDetails' => [
                                    'City' => [
                                        'CityName' => '<string>',
                                    ],
                                    'Country' => [
                                        'CountryCode' => '<string>',
                                        'CountryName' => '<string>',
                                    ],
                                    'GeoLocation' => [
                                        'Lat' => <float>,
                                        'Lon' => <float>,
                                    ],
                                    'IpAddressV4' => '<string>',
                                    'Organization' => [
                                        'Asn' => '<string>',
                                        'AsnOrg' => '<string>',
                                        'Isp' => '<string>',
                                        'Org' => '<string>',
                                    ],
                                ],
                            ],
                            // ...
                        ],
                    ],
                    'RdsLoginAttemptAction' => [
                        'LoginAttributes' => [
                            [
                                'Application' => '<string>',
                                'FailedLoginAttempts' => <integer>,
                                'SuccessfulLoginAttempts' => <integer>,
                                'User' => '<string>',
                            ],
                            // ...
                        ],
                        'RemoteIpDetails' => [
                            'City' => [
                                'CityName' => '<string>',
                            ],
                            'Country' => [
                                'CountryCode' => '<string>',
                                'CountryName' => '<string>',
                            ],
                            'GeoLocation' => [
                                'Lat' => <float>,
                                'Lon' => <float>,
                            ],
                            'IpAddressV4' => '<string>',
                            'Organization' => [
                                'Asn' => '<string>',
                                'AsnOrg' => '<string>',
                                'Isp' => '<string>',
                                'Org' => '<string>',
                            ],
                        ],
                    ],
                ],
                'AdditionalInfo' => [
                    'Type' => '<string>',
                    'Value' => '<string>',
                ],
                'Archived' => true || false,
                'Count' => <integer>,
                'DetectorId' => '<string>',
                'EbsVolumeScanDetails' => [
                    'ScanCompletedAt' => <DateTime>,
                    'ScanDetections' => [
                        'HighestSeverityThreatDetails' => [
                            'Count' => <integer>,
                            'Severity' => '<string>',
                            'ThreatName' => '<string>',
                        ],
                        'ScannedItemCount' => [
                            'Files' => <integer>,
                            'TotalGb' => <integer>,
                            'Volumes' => <integer>,
                        ],
                        'ThreatDetectedByName' => [
                            'ItemCount' => <integer>,
                            'Shortened' => true || false,
                            'ThreatNames' => [
                                [
                                    'FilePaths' => [
                                        [
                                            'FileName' => '<string>',
                                            'FilePath' => '<string>',
                                            'Hash' => '<string>',
                                            'VolumeArn' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'ItemCount' => <integer>,
                                    'Name' => '<string>',
                                    'Severity' => '<string>',
                                ],
                                // ...
                            ],
                            'UniqueThreatNameCount' => <integer>,
                        ],
                        'ThreatsDetectedItemCount' => [
                            'Files' => <integer>,
                        ],
                    ],
                    'ScanId' => '<string>',
                    'ScanStartedAt' => <DateTime>,
                    'Sources' => ['<string>', ...],
                    'TriggerFindingId' => '<string>',
                ],
                'EventFirstSeen' => '<string>',
                'EventLastSeen' => '<string>',
                'Evidence' => [
                    'ThreatIntelligenceDetails' => [
                        [
                            'ThreatListName' => '<string>',
                            'ThreatNames' => ['<string>', ...],
                        ],
                        // ...
                    ],
                ],
                'FeatureName' => '<string>',
                'ResourceRole' => '<string>',
                'RuntimeDetails' => [
                    'Context' => [
                        'AddressFamily' => '<string>',
                        'FileSystemType' => '<string>',
                        'Flags' => ['<string>', ...],
                        'IanaProtocolNumber' => <integer>,
                        'LdPreloadValue' => '<string>',
                        'LibraryPath' => '<string>',
                        'MemoryRegions' => ['<string>', ...],
                        'ModifiedAt' => <DateTime>,
                        'ModifyingProcess' => [
                            'Euid' => <integer>,
                            'ExecutablePath' => '<string>',
                            'ExecutableSha256' => '<string>',
                            'Lineage' => [
                                [
                                    'Euid' => <integer>,
                                    'ExecutablePath' => '<string>',
                                    'Name' => '<string>',
                                    'NamespacePid' => <integer>,
                                    'ParentUuid' => '<string>',
                                    'Pid' => <integer>,
                                    'StartTime' => <DateTime>,
                                    'UserId' => <integer>,
                                    'Uuid' => '<string>',
                                ],
                                // ...
                            ],
                            'Name' => '<string>',
                            'NamespacePid' => <integer>,
                            'ParentUuid' => '<string>',
                            'Pid' => <integer>,
                            'Pwd' => '<string>',
                            'StartTime' => <DateTime>,
                            'User' => '<string>',
                            'UserId' => <integer>,
                            'Uuid' => '<string>',
                        ],
                        'ModuleFilePath' => '<string>',
                        'ModuleName' => '<string>',
                        'ModuleSha256' => '<string>',
                        'MountSource' => '<string>',
                        'MountTarget' => '<string>',
                        'ReleaseAgentPath' => '<string>',
                        'RuncBinaryPath' => '<string>',
                        'ScriptPath' => '<string>',
                        'ShellHistoryFilePath' => '<string>',
                        'SocketPath' => '<string>',
                        'TargetProcess' => [
                            'Euid' => <integer>,
                            'ExecutablePath' => '<string>',
                            'ExecutableSha256' => '<string>',
                            'Lineage' => [
                                [
                                    'Euid' => <integer>,
                                    'ExecutablePath' => '<string>',
                                    'Name' => '<string>',
                                    'NamespacePid' => <integer>,
                                    'ParentUuid' => '<string>',
                                    'Pid' => <integer>,
                                    'StartTime' => <DateTime>,
                                    'UserId' => <integer>,
                                    'Uuid' => '<string>',
                                ],
                                // ...
                            ],
                            'Name' => '<string>',
                            'NamespacePid' => <integer>,
                            'ParentUuid' => '<string>',
                            'Pid' => <integer>,
                            'Pwd' => '<string>',
                            'StartTime' => <DateTime>,
                            'User' => '<string>',
                            'UserId' => <integer>,
                            'Uuid' => '<string>',
                        ],
                    ],
                    'Process' => [
                        'Euid' => <integer>,
                        'ExecutablePath' => '<string>',
                        'ExecutableSha256' => '<string>',
                        'Lineage' => [
                            [
                                'Euid' => <integer>,
                                'ExecutablePath' => '<string>',
                                'Name' => '<string>',
                                'NamespacePid' => <integer>,
                                'ParentUuid' => '<string>',
                                'Pid' => <integer>,
                                'StartTime' => <DateTime>,
                                'UserId' => <integer>,
                                'Uuid' => '<string>',
                            ],
                            // ...
                        ],
                        'Name' => '<string>',
                        'NamespacePid' => <integer>,
                        'ParentUuid' => '<string>',
                        'Pid' => <integer>,
                        'Pwd' => '<string>',
                        'StartTime' => <DateTime>,
                        'User' => '<string>',
                        'UserId' => <integer>,
                        'Uuid' => '<string>',
                    ],
                ],
                'ServiceName' => '<string>',
                'UserFeedback' => '<string>',
            ],
            'Severity' => <float>,
            'Title' => '<string>',
            'Type' => '<string>',
            'UpdatedAt' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

• BadRequestException:

  A bad request exception object.

• InternalServerErrorException:

  An internal server error exception object.

GetFindingsStatistics

$result = $client->getFindingsStatistics([/* ... */]);
$promise = $client->getFindingsStatisticsAsync([/* ... */]);

Parameter Syntax

$result = $client->getFindingsStatistics([
    'DetectorId' => '<string>', // REQUIRED
    'FindingCriteria' => [
        'Criterion' => [
            '<String>' => [
                'Eq' => ['<string>', ...],
                'Equals' => ['<string>', ...],
                'GreaterThan' => <integer>,
                'GreaterThanOrEqual' => <integer>,
                'Gt' => <integer>,
                'Gte' => <integer>,
                'LessThan' => <integer>,
                'LessThanOrEqual' => <integer>,
                'Lt' => <integer>,
                'Lte' => <integer>,
                'Neq' => ['<string>', ...],
                'NotEquals' => ['<string>', ...],
            ],
            // ...
        ],
    ],
    'FindingStatisticTypes' => ['<string>', ...], // REQUIRED
]);

Parameter Details

Result Syntax

[
    'FindingStatistics' => [
        'CountBySeverity' => [<integer>, ...],
    ],
]

Result Details

Errors

• BadRequestException:

  A bad request exception object.

• InternalServerErrorException:

  An internal server error exception object.

GetIPSet

$result = $client->getIPSet([/* ... */]);
$promise = $client->getIPSetAsync([/* ... */]);

Parameter Syntax

$result = $client->getIPSet([
    'DetectorId' => '<string>', // REQUIRED
    'IpSetId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Format' => 'TXT|STIX|OTX_CSV|ALIEN_VAULT|PROOF_POINT|FIRE_EYE',
    'Location' => '<string>',
    'Name' => '<string>',
    'Status' => 'INACTIVE|ACTIVATING|ACTIVE|DEACTIVATING|ERROR|DELETE_PENDING|DELETED',
    'Tags' => ['<string>', ...],
]

Result Details

Errors

• BadRequestException:

  A bad request exception object.

• InternalServerErrorException:

  An internal server error exception object.

GetInvitationsCount

$result = $client->getInvitationsCount([/* ... */]);
$promise = $client->getInvitationsCountAsync([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'InvitationsCount' => <integer>,
]

Result Details

Errors

• BadRequestException:

  A bad request exception object.

• InternalServerErrorException:

  An internal server error exception object.

GetMalwareScanSettings

$result = $client->getMalwareScanSettings([/* ... */]);
$promise = $client->getMalwareScanSettingsAsync([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'EbsSnapshotPreservation' => 'NO_RETENTION|RETENTION_WITH_FINDING',
    'ScanResourceCriteria' => [
        'Exclude' => [
            '<ScanCriterionKey>' => [
                'MapEquals' => [
                    [
                        'Key' => '<string>',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
            ],
            // ...
        ],
        'Include' => [
            '<ScanCriterionKey>' => [
                'MapEquals' => [
                    [
                        'Key' => '<string>',
                        'Value' => '<string>',
                    ],
                    // ...
                ],
            ],
            // ...
        ],
    ],
]

Result Details

Errors

• BadRequestException:

  A bad request exception object.

• InternalServerErrorException:

  An internal server error exception object.

GetMasterAccount

$result = $client->getMasterAccount([/* ... */]);
$promise = $client->getMasterAccountAsync([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'Master' => [
        'AccountId' => '<string>',
        'InvitationId' => '<string>',
        'InvitedAt' => '<string>',
        'RelationshipStatus' => '<string>',
    ],
]

Result Details

Errors

• BadRequestException:

  A bad request exception object.

• InternalServerErrorException:

  An internal server error exception object.

GetMemberDetectors

$result = $client->getMemberDetectors([/* ... */]);
$promise = $client->getMemberDetectorsAsync([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'MemberDataSourceConfigurations' => [
        [
            'AccountId' => '<string>',
            'DataSources' => [
                'CloudTrail' => [
                    'Status' => 'ENABLED|DISABLED',
                ],
                'DNSLogs' => [
                    'Status' => 'ENABLED|DISABLED',
                ],
                'FlowLogs' => [
                    'Status' => 'ENABLED|DISABLED',
                ],
                'Kubernetes' => [
                    'AuditLogs' => [
                        'Status' => 'ENABLED|DISABLED',
                    ],
                ],
                'MalwareProtection' => [
                    'ScanEc2InstanceWithFindings' => [
                        'EbsVolumes' => [
                            'Reason' => '<string>',
                            'Status' => 'ENABLED|DISABLED',
                        ],
                    ],
                    'ServiceRole' => '<string>',
                ],
                'S3Logs' => [
                    'Status' => 'ENABLED|DISABLED',
                ],
            ],
            'Features' => [
                [
                    'AdditionalConfiguration' => [
                        [
                            'Name' => 'EKS_ADDON_MANAGEMENT',
                            'Status' => 'ENABLED|DISABLED',
                            'UpdatedAt' => <DateTime>,
                        ],
                        // ...
                    ],
                    'Name' => 'S3_DATA_EVENTS|EKS_AUDIT_LOGS|EBS_MALWARE_PROTECTION|RDS_LOGIN_EVENTS|EKS_RUNTIME_MONITORING',
                    'Status' => 'ENABLED|DISABLED',
                    'UpdatedAt' => <DateTime>,
                ],
                // ...
            ],
        ],
        // ...
    ],
    'UnprocessedAccounts' => [
        [
            'AccountId' => '<string>',
            'Result' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

• BadRequestException:

  A bad request exception object.

• InternalServerErrorException:

  An internal server error exception object.

GetMembers

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

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'Members' => [
        [
            'AccountId' => '<string>',
            'AdministratorId' => '<string>',
            'DetectorId' => '<string>',
            'Email' => '<string>',
            'InvitedAt' => '<string>',
            'MasterId' => '<string>',
            'RelationshipStatus' => '<string>',
            'UpdatedAt' => '<string>',
        ],
        // ...
    ],
    'UnprocessedAccounts' => [
        [
            'AccountId' => '<string>',
            'Result' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

• BadRequestException:

  A bad request exception object.

• InternalServerErrorException:

  An internal server error exception object.

GetRemainingFreeTrialDays

$result = $client->getRemainingFreeTrialDays([/* ... */]);
$promise = $client->getRemainingFreeTrialDaysAsync([/* ... */]);

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'Accounts' => [
        [
            'AccountId' => '<string>',
            'DataSources' => [
                'CloudTrail' => [
                    'FreeTrialDaysRemaining' => <integer>,
                ],
                'DnsLogs' => [
                    'FreeTrialDaysRemaining' => <integer>,
                ],
                'FlowLogs' => [
                    'FreeTrialDaysRemaining' => <integer>,
                ],
                'Kubernetes' => [
                    'AuditLogs' => [
                        'FreeTrialDaysRemaining' => <integer>,
                    ],
                ],
                'MalwareProtection' => [
                    'ScanEc2InstanceWithFindings' => [
                        'FreeTrialDaysRemaining' => <integer>,
                    ],
                ],
                'S3Logs' => [
                    'FreeTrialDaysRemaining' => <integer>,
                ],
            ],
            'Features' => [
                [
                    'FreeTrialDaysRemaining' => <integer>,
                    'Name' => 'FLOW_LOGS|CLOUD_TRAIL|DNS_LOGS|S3_DATA_EVENTS|EKS_AUDIT_LOGS|EBS_MALWARE_PROTECTION|RDS_LOGIN_EVENTS|EKS_RUNTIME_MONITORING',
                ],
                // ...
            ],
        ],
        // ...
    ],
    'UnprocessedAccounts' => [
        [
            'AccountId' => '<string>',
            'Result' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

• BadRequestException:

  A bad request exception object.

• InternalServerErrorException:

  An internal server error exception object.

GetThreatIntelSet

$result = $client->getThreatIntelSet([/* ... */]);
$promise = $client->getThreatIntelSetAsync([/* ... */]);

Parameter Syntax

$result = $client->getThreatIntelSet([
    'DetectorId' => '<string>', // REQUIRED
    'ThreatIntelSetId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Format' => 'TXT|STIX|OTX_CSV|ALIEN_VAULT|PROOF_POINT|FIRE_EYE',
    'Location' => '<string>',
    'Name' => '<string>',
    'Status' => 'INACTIVE|ACTIVATING|ACTIVE|DEACTIVATING|ERROR|DELETE_PENDING|DELETED',
    'Tags' => ['<string>', ...],
]

Result Details

Errors

• BadRequestException:

  A bad request exception object.

• InternalServerErrorException:

  An internal server error exception object.

GetUsageStatistics

$result = $client->getUsageStatistics([/* ... */]);
$promise = $client->getUsageStatisticsAsync([/* ... */]);

Parameter Syntax

$result = $client->getUsageStatistics([
    'DetectorId' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'Unit' => '<string>',
    'UsageCriteria' => [ // REQUIRED
        'AccountIds' => ['<string>', ...],
        'DataSources' => ['<string>', ...],
        'Features' => ['<string>', ...],
        'Resources' => ['<string>', ...],
    ],
    'UsageStatisticType' => 'SUM_BY_ACCOUNT|SUM_BY_DATA_SOURCE|SUM_BY_RESOURCE|TOP_RESOURCES|SUM_BY_FEATURES', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'UsageStatistics' => [
        'SumByAccount' => [
            [
                'AccountId' => '<string>',
                'Total' => [
                    'Amount' => '<string>',
                    'Unit' => '<string>',
                ],
            ],
            // ...
        ],
        'SumByDataSource' => [
            [
                'DataSource' => 'FLOW_LOGS|CLOUD_TRAIL|DNS_LOGS|S3_LOGS|KUBERNETES_AUDIT_LOGS|EC2_MALWARE_SCAN',
                'Total' => [
                    'Amount' => '<string>',
                    'Unit' => '<string>',
                ],
            ],
            // ...
        ],
        'SumByFeature' => [
            [
                'Feature' => 'FLOW_LOGS|CLOUD_TRAIL|DNS_LOGS|S3_DATA_EVENTS|EKS_AUDIT_LOGS|EBS_MALWARE_PROTECTION|RDS_LOGIN_EVENTS|LAMBDA_NETWORK_LOGS|EKS_RUNTIME_MONITORING',
                'Total' => [
                    'Amount' => '<string>',
                    'Unit' => '<string>',
                ],
            ],
            // ...
        ],
        'SumByResource' => [
            [
                'Resource' => '<string>',
                'Total' => [
                    'Amount' => '<string>',
                    'Unit' => '<string>',
                ],
            ],
            // ...
        ],
        'TopResources' => [
            [
                'Resource' => '<string>',
                'Total' => [
                    'Amount' => '<string>',
                    'Unit' => '<string>',
                ],
            ],
            // ...
        ],
    ],
]

Result Details

Errors

• BadRequestException:

  A bad request exception object.

• InternalServerErrorException:

  An internal server error exception object.

InviteMembers

$result = $client->inviteMembers([/* ... */]);
$promise = $client->inviteMembersAsync([/* ... */]);

Parameter Syntax

$result = $client->inviteMembers([
    'AccountIds' => ['<string>', ...], // REQUIRED
    'DetectorId' => '<string>', // REQUIRED
    'DisableEmailNotification' => true || false,
    'Message' => '<string>',
]);

Parameter Details

Result Syntax

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

Result Details

Errors

• BadRequestException:

  A bad request exception object.

• InternalServerErrorException:

  An internal server error exception object.

ListCoverage

$result = $client->listCoverage([/* ... */]);
$promise = $client->listCoverageAsync([/* ... */]);

Parameter Syntax

$result = $client->listCoverage([
    'DetectorId' => '<string>', // REQUIRED
    'FilterCriteria' => [
        'FilterCriterion' => [
            [
                'CriterionKey' => 'ACCOUNT_ID|CLUSTER_NAME|RESOURCE_TYPE|COVERAGE_STATUS|ADDON_VERSION',
                'FilterCondition' => [
                    'Equals' => ['<string>', ...],
                    'NotEquals' => ['<string>', ...],
                ],
            ],
            // ...
        ],
    ],
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'SortCriteria' => [
        'AttributeName' => 'ACCOUNT_ID|CLUSTER_NAME|COVERAGE_STATUS|ISSUE|ADDON_VERSION|UPDATED_AT',
        'OrderBy' => 'ASC|DESC',
    ],
]);

Parameter Details