AcceptInvitation

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

Accepts an Amazon Macie membership invitation that was received from a specific account.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

Provides information about an error that occurred due to a syntax error in a request.

InternalServerException:

Provides information about an error that occurred due to an unknown internal server error, exception, or failure.

ServiceQuotaExceededException:

Provides information about an error that occurred due to one or more service quotas for an account.

AccessDeniedException:

Provides information about an error that occurred due to insufficient access to a specified resource.

ResourceNotFoundException:

Provides information about an error that occurred because a specified resource wasn't found.

ThrottlingException:

Provides information about an error that occurred because too many requests were sent during a certain amount of time.

ConflictException:

Provides information about an error that occurred due to a versioning conflict for a specified resource.

BatchGetCustomDataIdentifiers

$result = $client->batchGetCustomDataIdentifiers([/* ... */]);
$promise = $client->batchGetCustomDataIdentifiersAsync([/* ... */]);

Retrieves information about one or more custom data identifiers.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'customDataIdentifiers' => [
        [
            'arn' => '<string>',
            'createdAt' => <DateTime>,
            'deleted' => true || false,
            'description' => '<string>',
            'id' => '<string>',
            'name' => '<string>',
        ],
        // ...
    ],
    'notFoundIdentifierIds' => ['<string>', ...],
]

Result Details

Errors

ValidationException:

Provides information about an error that occurred due to a syntax error in a request.

InternalServerException:

Provides information about an error that occurred due to an unknown internal server error, exception, or failure.

ServiceQuotaExceededException:

Provides information about an error that occurred due to one or more service quotas for an account.

AccessDeniedException:

Provides information about an error that occurred due to insufficient access to a specified resource.

ResourceNotFoundException:

Provides information about an error that occurred because a specified resource wasn't found.

ThrottlingException:

Provides information about an error that occurred because too many requests were sent during a certain amount of time.

ConflictException:

Provides information about an error that occurred due to a versioning conflict for a specified resource.

CreateAllowList

$result = $client->createAllowList([/* ... */]);
$promise = $client->createAllowListAsync([/* ... */]);

Creates and defines the settings for an allow list.

Parameter Syntax

$result = $client->createAllowList([
    'clientToken' => '<string>', // REQUIRED
    'criteria' => [ // REQUIRED
        'regex' => '<string>',
        's3WordsList' => [
            'bucketName' => '<string>', // REQUIRED
            'objectKey' => '<string>', // REQUIRED
        ],
    ],
    'description' => '<string>',
    'name' => '<string>', // REQUIRED
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'arn' => '<string>',
    'id' => '<string>',
]

Result Details

Errors

ValidationException:

Provides information about an error that occurred due to a syntax error in a request.

InternalServerException:

Provides information about an error that occurred due to an unknown internal server error, exception, or failure.

ServiceQuotaExceededException:

Provides information about an error that occurred due to one or more service quotas for an account.

AccessDeniedException:

Provides information about an error that occurred due to insufficient access to a specified resource.

ResourceNotFoundException:

Provides information about an error that occurred because a specified resource wasn't found.

ThrottlingException:

Provides information about an error that occurred because too many requests were sent during a certain amount of time.

ConflictException:

Provides information about an error that occurred due to a versioning conflict for a specified resource.

CreateClassificationJob

$result = $client->createClassificationJob([/* ... */]);
$promise = $client->createClassificationJobAsync([/* ... */]);

Creates and defines the settings for a classification job.

Parameter Syntax

$result = $client->createClassificationJob([
    'allowListIds' => ['<string>', ...],
    'clientToken' => '<string>', // REQUIRED
    'customDataIdentifierIds' => ['<string>', ...],
    'description' => '<string>',
    'initialRun' => true || false,
    'jobType' => 'ONE_TIME|SCHEDULED', // REQUIRED
    'managedDataIdentifierIds' => ['<string>', ...],
    'managedDataIdentifierSelector' => 'ALL|EXCLUDE|INCLUDE|NONE|RECOMMENDED',
    'name' => '<string>', // REQUIRED
    's3JobDefinition' => [ // REQUIRED
        'bucketCriteria' => [
            'excludes' => [
                'and' => [
                    [
                        'simpleCriterion' => [
                            'comparator' => 'EQ|GT|GTE|LT|LTE|NE|CONTAINS|STARTS_WITH',
                            'key' => 'ACCOUNT_ID|S3_BUCKET_NAME|S3_BUCKET_EFFECTIVE_PERMISSION|S3_BUCKET_SHARED_ACCESS',
                            'values' => ['<string>', ...],
                        ],
                        'tagCriterion' => [
                            'comparator' => 'EQ|GT|GTE|LT|LTE|NE|CONTAINS|STARTS_WITH',
                            'tagValues' => [
                                [
                                    'key' => '<string>',
                                    'value' => '<string>',
                                ],
                                // ...
                            ],
                        ],
                    ],
                    // ...
                ],
            ],
            'includes' => [
                'and' => [
                    [
                        'simpleCriterion' => [
                            'comparator' => 'EQ|GT|GTE|LT|LTE|NE|CONTAINS|STARTS_WITH',
                            'key' => 'ACCOUNT_ID|S3_BUCKET_NAME|S3_BUCKET_EFFECTIVE_PERMISSION|S3_BUCKET_SHARED_ACCESS',
                            'values' => ['<string>', ...],
                        ],
                        'tagCriterion' => [
                            'comparator' => 'EQ|GT|GTE|LT|LTE|NE|CONTAINS|STARTS_WITH',
                            'tagValues' => [
                                [
                                    'key' => '<string>',
                                    'value' => '<string>',
                                ],
                                // ...
                            ],
                        ],
                    ],
                    // ...
                ],
            ],
        ],
        'bucketDefinitions' => [
            [
                'accountId' => '<string>', // REQUIRED
                'buckets' => ['<string>', ...], // REQUIRED
            ],
            // ...
        ],
        'scoping' => [
            'excludes' => [
                'and' => [
                    [
                        'simpleScopeTerm' => [
                            'comparator' => 'EQ|GT|GTE|LT|LTE|NE|CONTAINS|STARTS_WITH',
                            'key' => 'OBJECT_EXTENSION|OBJECT_LAST_MODIFIED_DATE|OBJECT_SIZE|OBJECT_KEY',
                            'values' => ['<string>', ...],
                        ],
                        'tagScopeTerm' => [
                            'comparator' => 'EQ|GT|GTE|LT|LTE|NE|CONTAINS|STARTS_WITH',
                            'key' => '<string>',
                            'tagValues' => [
                                [
                                    'key' => '<string>',
                                    'value' => '<string>',
                                ],
                                // ...
                            ],
                            'target' => 'S3_OBJECT',
                        ],
                    ],
                    // ...
                ],
            ],
            'includes' => [
                'and' => [
                    [
                        'simpleScopeTerm' => [
                            'comparator' => 'EQ|GT|GTE|LT|LTE|NE|CONTAINS|STARTS_WITH',
                            'key' => 'OBJECT_EXTENSION|OBJECT_LAST_MODIFIED_DATE|OBJECT_SIZE|OBJECT_KEY',
                            'values' => ['<string>', ...],
                        ],
                        'tagScopeTerm' => [
                            'comparator' => 'EQ|GT|GTE|LT|LTE|NE|CONTAINS|STARTS_WITH',
                            'key' => '<string>',
                            'tagValues' => [
                                [
                                    'key' => '<string>',
                                    'value' => '<string>',
                                ],
                                // ...
                            ],
                            'target' => 'S3_OBJECT',
                        ],
                    ],
                    // ...
                ],
            ],
        ],
    ],
    'samplingPercentage' => <integer>,
    'scheduleFrequency' => [
        'dailySchedule' => [
        ],
        'monthlySchedule' => [
            'dayOfMonth' => <integer>,
        ],
        'weeklySchedule' => [
            'dayOfWeek' => 'SUNDAY|MONDAY|TUESDAY|WEDNESDAY|THURSDAY|FRIDAY|SATURDAY',
        ],
    ],
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'jobArn' => '<string>',
    'jobId' => '<string>',
]

Result Details

Errors

ValidationException:

Provides information about an error that occurred due to a syntax error in a request.

InternalServerException:

Provides information about an error that occurred due to an unknown internal server error, exception, or failure.

ServiceQuotaExceededException:

Provides information about an error that occurred due to one or more service quotas for an account.

AccessDeniedException:

Provides information about an error that occurred due to insufficient access to a specified resource.

ResourceNotFoundException:

Provides information about an error that occurred because a specified resource wasn't found.

ThrottlingException:

Provides information about an error that occurred because too many requests were sent during a certain amount of time.

ConflictException:

Provides information about an error that occurred due to a versioning conflict for a specified resource.

CreateCustomDataIdentifier

$result = $client->createCustomDataIdentifier([/* ... */]);
$promise = $client->createCustomDataIdentifierAsync([/* ... */]);

Creates and defines the criteria and other settings for a custom data identifier.

Parameter Syntax

$result = $client->createCustomDataIdentifier([
    'clientToken' => '<string>',
    'description' => '<string>',
    'ignoreWords' => ['<string>', ...],
    'keywords' => ['<string>', ...],
    'maximumMatchDistance' => <integer>,
    'name' => '<string>', // REQUIRED
    'regex' => '<string>', // REQUIRED
    'severityLevels' => [
        [
            'occurrencesThreshold' => <integer>, // REQUIRED
            'severity' => 'LOW|MEDIUM|HIGH', // REQUIRED
        ],
        // ...
    ],
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

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

Result Details

Errors

ValidationException:

Provides information about an error that occurred due to a syntax error in a request.

InternalServerException:

Provides information about an error that occurred due to an unknown internal server error, exception, or failure.

ServiceQuotaExceededException:

Provides information about an error that occurred due to one or more service quotas for an account.

AccessDeniedException:

Provides information about an error that occurred due to insufficient access to a specified resource.

ResourceNotFoundException:

Provides information about an error that occurred because a specified resource wasn't found.

ThrottlingException:

Provides information about an error that occurred because too many requests were sent during a certain amount of time.

ConflictException:

Provides information about an error that occurred due to a versioning conflict for a specified resource.

CreateFindingsFilter

$result = $client->createFindingsFilter([/* ... */]);
$promise = $client->createFindingsFilterAsync([/* ... */]);

Creates and defines the criteria and other settings for a findings filter.

Parameter Syntax

$result = $client->createFindingsFilter([
    'action' => 'ARCHIVE|NOOP', // REQUIRED
    'clientToken' => '<string>',
    'description' => '<string>',
    'findingCriteria' => [ // REQUIRED
        'criterion' => [
            '<__string>' => [
                'eq' => ['<string>', ...],
                'eqExactMatch' => ['<string>', ...],
                'gt' => <integer>,
                'gte' => <integer>,
                'lt' => <integer>,
                'lte' => <integer>,
                'neq' => ['<string>', ...],
            ],
            // ...
        ],
    ],
    'name' => '<string>', // REQUIRED
    'position' => <integer>,
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'arn' => '<string>',
    'id' => '<string>',
]

Result Details

Errors

ValidationException:

Provides information about an error that occurred due to a syntax error in a request.

InternalServerException:

Provides information about an error that occurred due to an unknown internal server error, exception, or failure.

ServiceQuotaExceededException:

Provides information about an error that occurred due to one or more service quotas for an account.

AccessDeniedException:

Provides information about an error that occurred due to insufficient access to a specified resource.

ResourceNotFoundException:

Provides information about an error that occurred because a specified resource wasn't found.

ThrottlingException:

Provides information about an error that occurred because too many requests were sent during a certain amount of time.

ConflictException:

Provides information about an error that occurred due to a versioning conflict for a specified resource.

CreateInvitations

$result = $client->createInvitations([/* ... */]);
$promise = $client->createInvitationsAsync([/* ... */]);

Sends an Amazon Macie membership invitation to one or more accounts.

Parameter Syntax

$result = $client->createInvitations([
    'accountIds' => ['<string>', ...], // REQUIRED
    'disableEmailNotification' => true || false,
    'message' => '<string>',
]);

Parameter Details

Result Syntax

[
    'unprocessedAccounts' => [
        [
            'accountId' => '<string>',
            'errorCode' => 'ClientError|InternalError',
            'errorMessage' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ValidationException:

Provides information about an error that occurred due to a syntax error in a request.

InternalServerException:

Provides information about an error that occurred due to an unknown internal server error, exception, or failure.

ServiceQuotaExceededException:

Provides information about an error that occurred due to one or more service quotas for an account.

AccessDeniedException:

Provides information about an error that occurred due to insufficient access to a specified resource.

ResourceNotFoundException:

Provides information about an error that occurred because a specified resource wasn't found.

ThrottlingException:

Provides information about an error that occurred because too many requests were sent during a certain amount of time.

ConflictException:

Provides information about an error that occurred due to a versioning conflict for a specified resource.

CreateMember

$result = $client->createMember([/* ... */]);
$promise = $client->createMemberAsync([/* ... */]);

Associates an account with an Amazon Macie administrator account.

Parameter Syntax

$result = $client->createMember([
    'account' => [ // REQUIRED
        'accountId' => '<string>', // REQUIRED
        'email' => '<string>', // REQUIRED
    ],
    'tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

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

Result Details

Errors

ValidationException:

Provides information about an error that occurred due to a syntax error in a request.

InternalServerException:

Provides information about an error that occurred due to an unknown internal server error, exception, or failure.

ServiceQuotaExceededException:

Provides information about an error that occurred due to one or more service quotas for an account.

AccessDeniedException:

Provides information about an error that occurred due to insufficient access to a specified resource.

ResourceNotFoundException:

Provides information about an error that occurred because a specified resource wasn't found.

ThrottlingException:

Provides information about an error that occurred because too many requests were sent during a certain amount of time.

ConflictException:

Provides information about an error that occurred due to a versioning conflict for a specified resource.

CreateSampleFindings

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

Creates sample findings.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

Provides information about an error that occurred due to a syntax error in a request.

InternalServerException:

Provides information about an error that occurred due to an unknown internal server error, exception, or failure.

ServiceQuotaExceededException:

Provides information about an error that occurred due to one or more service quotas for an account.

AccessDeniedException:

Provides information about an error that occurred due to insufficient access to a specified resource.

ResourceNotFoundException:

Provides information about an error that occurred because a specified resource wasn't found.

ThrottlingException:

Provides information about an error that occurred because too many requests were sent during a certain amount of time.

ConflictException:

Provides information about an error that occurred due to a versioning conflict for a specified resource.

DeclineInvitations

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

Declines Amazon Macie membership invitations that were received from specific accounts.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'unprocessedAccounts' => [
        [
            'accountId' => '<string>',
            'errorCode' => 'ClientError|InternalError',
            'errorMessage' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ValidationException:

Provides information about an error that occurred due to a syntax error in a request.

InternalServerException:

Provides information about an error that occurred due to an unknown internal server error, exception, or failure.

ServiceQuotaExceededException:

Provides information about an error that occurred due to one or more service quotas for an account.

AccessDeniedException:

Provides information about an error that occurred due to insufficient access to a specified resource.

ResourceNotFoundException:

Provides information about an error that occurred because a specified resource wasn't found.

ThrottlingException:

Provides information about an error that occurred because too many requests were sent during a certain amount of time.

ConflictException:

Provides information about an error that occurred due to a versioning conflict for a specified resource.

DeleteAllowList

$result = $client->deleteAllowList([/* ... */]);
$promise = $client->deleteAllowListAsync([/* ... */]);

Deletes an allow list.

Parameter Syntax

$result = $client->deleteAllowList([
    'id' => '<string>', // REQUIRED
    'ignoreJobChecks' => '<string>',
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

Provides information about an error that occurred because a specified resource wasn't found.

ThrottlingException:

Provides information about an error that occurred because too many requests were sent during a certain amount of time.

ValidationException:

Provides information about an error that occurred due to a syntax error in a request.

InternalServerException:

Provides information about an error that occurred due to an unknown internal server error, exception, or failure.

AccessDeniedException:

Provides information about an error that occurred due to insufficient access to a specified resource.

DeleteCustomDataIdentifier

$result = $client->deleteCustomDataIdentifier([/* ... */]);
$promise = $client->deleteCustomDataIdentifierAsync([/* ... */]);

Soft deletes a custom data identifier.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

Provides information about an error that occurred due to a syntax error in a request.

InternalServerException:

Provides information about an error that occurred due to an unknown internal server error, exception, or failure.

ServiceQuotaExceededException:

Provides information about an error that occurred due to one or more service quotas for an account.

AccessDeniedException:

Provides information about an error that occurred due to insufficient access to a specified resource.

ResourceNotFoundException:

Provides information about an error that occurred because a specified resource wasn't found.

ThrottlingException:

Provides information about an error that occurred because too many requests were sent during a certain amount of time.

ConflictException:

Provides information about an error that occurred due to a versioning conflict for a specified resource.

DeleteFindingsFilter

$result = $client->deleteFindingsFilter([/* ... */]);
$promise = $client->deleteFindingsFilterAsync([/* ... */]);

Deletes a findings filter.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

Provides information about an error that occurred due to a syntax error in a request.

InternalServerException:

Provides information about an error that occurred due to an unknown internal server error, exception, or failure.

ServiceQuotaExceededException:

Provides information about an error that occurred due to one or more service quotas for an account.

AccessDeniedException:

Provides information about an error that occurred due to insufficient access to a specified resource.

ResourceNotFoundException:

Provides information about an error that occurred because a specified resource wasn't found.

ThrottlingException:

Provides information about an error that occurred because too many requests were sent during a certain amount of time.

ConflictException:

Provides information about an error that occurred due to a versioning conflict for a specified resource.

DeleteInvitations

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

Deletes Amazon Macie membership invitations that were received from specific accounts.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'unprocessedAccounts' => [
        [
            'accountId' => '<string>',
            'errorCode' => 'ClientError|InternalError',
            'errorMessage' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ValidationException:

Provides information about an error that occurred due to a syntax error in a request.

InternalServerException:

Provides information about an error that occurred due to an unknown internal server error, exception, or failure.

ServiceQuotaExceededException:

Provides information about an error that occurred due to one or more service quotas for an account.

AccessDeniedException:

Provides information about an error that occurred due to insufficient access to a specified resource.

ResourceNotFoundException:

Provides information about an error that occurred because a specified resource wasn't found.

ThrottlingException:

Provides information about an error that occurred because too many requests were sent during a certain amount of time.

ConflictException:

Provides information about an error that occurred due to a versioning conflict for a specified resource.

DeleteMember

$result = $client->deleteMember([/* ... */]);
$promise = $client->deleteMemberAsync([/* ... */]);

Deletes the association between an Amazon Macie administrator account and an account.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

Provides information about an error that occurred due to a syntax error in a request.

InternalServerException:

Provides information about an error that occurred due to an unknown internal server error, exception, or failure.

ServiceQuotaExceededException:

Provides information about an error that occurred due to one or more service quotas for an account.

AccessDeniedException:

Provides information about an error that occurred due to insufficient access to a specified resource.

ResourceNotFoundException:

Provides information about an error that occurred because a specified resource wasn't found.

ThrottlingException:

Provides information about an error that occurred because too many requests were sent during a certain amount of time.

ConflictException:

Provides information about an error that occurred due to a versioning conflict for a specified resource.

DescribeBuckets

$result = $client->describeBuckets([/* ... */]);
$promise = $client->describeBucketsAsync([/* ... */]);

Retrieves (queries) statistical data and other information about one or more S3 buckets that Amazon Macie monitors and analyzes for an account.

Parameter Syntax

$result = $client->describeBuckets([
    'criteria' => [
        '<__string>' => [
            'eq' => ['<string>', ...],
            'gt' => <integer>,
            'gte' => <integer>,
            'lt' => <integer>,
            'lte' => <integer>,
            'neq' => ['<string>', ...],
            'prefix' => '<string>',
        ],
        // ...
    ],
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'sortCriteria' => [
        'attributeName' => '<string>',
        'orderBy' => 'ASC|DESC',
    ],
]);

Parameter Details

Result Syntax

[
    'buckets' => [
        [
            'accountId' => '<string>',
            'allowsUnencryptedObjectUploads' => 'TRUE|FALSE|UNKNOWN',
            'bucketArn' => '<string>',
            'bucketCreatedAt' => <DateTime>,
            'bucketName' => '<string>',
            'classifiableObjectCount' => <integer>,
            'classifiableSizeInBytes' => <integer>,
            'errorCode' => 'ACCESS_DENIED',
            'errorMessage' => '<string>',
            'jobDetails' => [
                'isDefinedInJob' => 'TRUE|FALSE|UNKNOWN',
                'isMonitoredByJob' => 'TRUE|FALSE|UNKNOWN',
                'lastJobId' => '<string>',
                'lastJobRunTime' => <DateTime>,
            ],
            'lastAutomatedDiscoveryTime' => <DateTime>,
            'lastUpdated' => <DateTime>,
            'objectCount' => <integer>,
            'objectCountByEncryptionType' => [
                'customerManaged' => <integer>,
                'kmsManaged' => <integer>,
                's3Managed' => <integer>,
                'unencrypted' => <integer>,
                'unknown' => <integer>,
            ],
            'publicAccess' => [
                'effectivePermission' => 'PUBLIC|NOT_PUBLIC|UNKNOWN',
                '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,
                        ],
                    ],
                ],
            ],
            'region' => '<string>',
            'replicationDetails' => [
                'replicated' => true || false,
                'replicatedExternally' => true || false,
                'replicationAccounts' => ['<string>', ...],
            ],
            'sensitivityScore' => <integer>,
            'serverSideEncryption' => [
                'kmsMasterKeyId' => '<string>',
                'type' => 'NONE|AES256|aws:kms|aws:kms:dsse',
            ],
            'sharedAccess' => 'EXTERNAL|INTERNAL|NOT_SHARED|UNKNOWN',
            'sizeInBytes' => <integer>,
            'sizeInBytesCompressed' => <integer>,
            'tags' => [
                [
                    'key' => '<string>',
                    'value' => '<string>',
                ],
                // ...
            ],
            'unclassifiableObjectCount' => [
                'fileType' => <integer>,
                'storageClass' => <integer>,
                'total' => <integer>,
            ],
            'unclassifiableObjectSizeInBytes' => [
                'fileType' => <integer>,
                'storageClass' => <integer>,
                'total' => <integer>,
            ],
            'versioning' => true || false,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ValidationException:

Provides information about an error that occurred due to a syntax error in a request.

InternalServerException:

Provides information about an error that occurred due to an unknown internal server error, exception, or failure.

ServiceQuotaExceededException:

Provides information about an error that occurred due to one or more service quotas for an account.

AccessDeniedException:

Provides information about an error that occurred due to insufficient access to a specified resource.

ResourceNotFoundException:

Provides information about an error that occurred because a specified resource wasn't found.

ThrottlingException:

Provides information about an error that occurred because too many requests were sent during a certain amount of time.

ConflictException:

Provides information about an error that occurred due to a versioning conflict for a specified resource.

DescribeClassificationJob

$result = $client->describeClassificationJob([/* ... */]);
$promise = $client->describeClassificationJobAsync([/* ... */]);

Retrieves the status and settings for a classification job.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'allowListIds' => ['<string>', ...],
    'clientToken' => '<string>',
    'createdAt' => <DateTime>,
    'customDataIdentifierIds' => ['<string>', ...],
    'description' => '<string>',
    'initialRun' => true || false,
    'jobArn' => '<string>',
    'jobId' => '<string>',
    'jobStatus' => 'RUNNING|PAUSED|CANCELLED|COMPLETE|IDLE|USER_PAUSED',
    'jobType' => 'ONE_TIME|SCHEDULED',
    'lastRunErrorStatus' => [
        'code' => 'NONE|ERROR',
    ],
    'lastRunTime' => <DateTime>,
    'managedDataIdentifierIds' => ['<string>', ...],
    'managedDataIdentifierSelector' => 'ALL|EXCLUDE|INCLUDE|NONE|RECOMMENDED',
    'name' => '<string>',
    's3JobDefinition' => [
        'bucketCriteria' => [
            'excludes' => [
                'and' => [
                    [
                        'simpleCriterion' => [
                            'comparator' => 'EQ|GT|GTE|LT|LTE|NE|CONTAINS|STARTS_WITH',
                            'key' => 'ACCOUNT_ID|S3_BUCKET_NAME|S3_BUCKET_EFFECTIVE_PERMISSION|S3_BUCKET_SHARED_ACCESS',
                            'values' => ['<string>', ...],
                        ],
                        'tagCriterion' => [
                            'comparator' => 'EQ|GT|GTE|LT|LTE|NE|CONTAINS|STARTS_WITH',
                            'tagValues' => [
                                [
                                    'key' => '<string>',
                                    'value' => '<string>',
                                ],
                                // ...
                            ],
                        ],
                    ],
                    // ...
                ],
            ],
            'includes' => [
                'and' => [
                    [
                        'simpleCriterion' => [
                            'comparator' => 'EQ|GT|GTE|LT|LTE|NE|CONTAINS|STARTS_WITH',
                            'key' => 'ACCOUNT_ID|S3_BUCKET_NAME|S3_BUCKET_EFFECTIVE_PERMISSION|S3_BUCKET_SHARED_ACCESS',
                            'values' => ['<string>', ...],
                        ],
                        'tagCriterion' => [
                            'comparator' => 'EQ|GT|GTE|LT|LTE|NE|CONTAINS|STARTS_WITH',
                            'tagValues' => [
                                [
                                    'key' => '<string>',
                                    'value' => '<string>',
                                ],
                                // ...
                            ],
                        ],
                    ],
                    // ...
                ],
            ],
        ],
        'bucketDefinitions' => [
            [
                'accountId' => '<string>',
                'buckets' => ['<string>', ...],
            ],
            // ...
        ],
        'scoping' => [
            'excludes' => [
                'and' => [
                    [
                        'simpleScopeTerm' => [
                            'comparator' => 'EQ|GT|GTE|LT|LTE|NE|CONTAINS|STARTS_WITH',
                            'key' => 'OBJECT_EXTENSION|OBJECT_LAST_MODIFIED_DATE|OBJECT_SIZE|OBJECT_KEY',
                            'values' => ['<string>', ...],
                        ],
                        'tagScopeTerm' => [
                            'comparator' => 'EQ|GT|GTE|LT|LTE|NE|CONTAINS|STARTS_WITH',
                            'key' => '<string>',
                            'tagValues' => [
                                [
                                    'key' => '<string>',
                                    'value' => '<string>',
                                ],
                                // ...
                            ],
                            'target' => 'S3_OBJECT',
                        ],
                    ],
                    // ...
                ],
            ],
            'includes' => [
                'and' => [
                    [
                        'simpleScopeTerm' => [
                            'comparator' => 'EQ|GT|GTE|LT|LTE|NE|CONTAINS|STARTS_WITH',
                            'key' => 'OBJECT_EXTENSION|OBJECT_LAST_MODIFIED_DATE|OBJECT_SIZE|OBJECT_KEY',
                            'values' => ['<string>', ...],
                        ],
                        'tagScopeTerm' => [
                            'comparator' => 'EQ|GT|GTE|LT|LTE|NE|CONTAINS|STARTS_WITH',
                            'key' => '<string>',
                            'tagValues' => [
                                [
                                    'key' => '<string>',
                                    'value' => '<string>',
                                ],
                                // ...
                            ],
                            'target' => 'S3_OBJECT',
                        ],
                    ],
                    // ...
                ],
            ],
        ],
    ],
    'samplingPercentage' => <integer>,
    'scheduleFrequency' => [
        'dailySchedule' => [
        ],
        'monthlySchedule' => [
            'dayOfMonth' => <integer>,
        ],
        'weeklySchedule' => [
            'dayOfWeek' => 'SUNDAY|MONDAY|TUESDAY|WEDNESDAY|THURSDAY|FRIDAY|SATURDAY',
        ],
    ],
    'statistics' => [
        'approximateNumberOfObjectsToProcess' => <float>,
        'numberOfRuns' => <float>,
    ],
    'tags' => ['<string>', ...],
    'userPausedDetails' => [
        'jobExpiresAt' => <DateTime>,
        'jobImminentExpirationHealthEventArn' => '<string>',
        'jobPausedAt' => <DateTime>,
    ],
]

Result Details

Errors

ValidationException:

Provides information about an error that occurred due to a syntax error in a request.

InternalServerException:

Provides information about an error that occurred due to an unknown internal server error, exception, or failure.

ServiceQuotaExceededException:

Provides information about an error that occurred due to one or more service quotas for an account.

AccessDeniedException:

Provides information about an error that occurred due to insufficient access to a specified resource.

ResourceNotFoundException:

Provides information about an error that occurred because a specified resource wasn't found.

ThrottlingException:

Provides information about an error that occurred because too many requests were sent during a certain amount of time.

ConflictException:

Provides information about an error that occurred due to a versioning conflict for a specified resource.

DescribeOrganizationConfiguration

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

Retrieves the Amazon Macie configuration settings for an organization in Organizations.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'autoEnable' => true || false,
    'maxAccountLimitReached' => true || false,
]

Result Details

Errors

ValidationException:

Provides information about an error that occurred due to a syntax error in a request.

InternalServerException:

Provides information about an error that occurred due to an unknown internal server error, exception, or failure.

ServiceQuotaExceededException:

Provides information about an error that occurred due to one or more service quotas for an account.

AccessDeniedException:

Provides information about an error that occurred due to insufficient access to a specified resource.

ResourceNotFoundException:

Provides information about an error that occurred because a specified resource wasn't found.

ThrottlingException:

Provides information about an error that occurred because too many requests were sent during a certain amount of time.

ConflictException:

Provides information about an error that occurred due to a versioning conflict for a specified resource.

DisableMacie

$result = $client->disableMacie([/* ... */]);
$promise = $client->disableMacieAsync([/* ... */]);

Disables Amazon Macie and deletes all settings and resources for a Macie account.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

Provides information about an error that occurred due to a syntax error in a request.

InternalServerException:

Provides information about an error that occurred due to an unknown internal server error, exception, or failure.

ServiceQuotaExceededException:

Provides information about an error that occurred due to one or more service quotas for an account.

AccessDeniedException:

Provides information about an error that occurred due to insufficient access to a specified resource.

ResourceNotFoundException:

Provides information about an error that occurred because a specified resource wasn't found.

ThrottlingException:

Provides information about an error that occurred because too many requests were sent during a certain amount of time.

ConflictException:

Provides information about an error that occurred due to a versioning conflict for a specified resource.

DisableOrganizationAdminAccount

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

Disables an account as the delegated Amazon Macie administrator account for an organization in Organizations.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

Provides information about an error that occurred due to a syntax error in a request.

InternalServerException:

Provides information about an error that occurred due to an unknown internal server error, exception, or failure.

ServiceQuotaExceededException:

Provides information about an error that occurred due to one or more service quotas for an account.

AccessDeniedException:

Provides information about an error that occurred due to insufficient access to a specified resource.

ResourceNotFoundException:

Provides information about an error that occurred because a specified resource wasn't found.

ThrottlingException:

Provides information about an error that occurred because too many requests were sent during a certain amount of time.

ConflictException:

Provides information about an error that occurred due to a versioning conflict for a specified resource.

DisassociateFromAdministratorAccount

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

Disassociates a member account from its Amazon Macie administrator account.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

Provides information about an error that occurred due to a syntax error in a request.

InternalServerException:

Provides information about an error that occurred due to an unknown internal server error, exception, or failure.

ServiceQuotaExceededException:

Provides information about an error that occurred due to one or more service quotas for an account.

AccessDeniedException:

Provides information about an error that occurred due to insufficient access to a specified resource.

ResourceNotFoundException:

Provides information about an error that occurred because a specified resource wasn't found.

ThrottlingException:

Provides information about an error that occurred because too many requests were sent during a certain amount of time.

ConflictException:

Provides information about an error that occurred due to a versioning conflict for a specified resource.

DisassociateFromMasterAccount

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

(Deprecated) Disassociates a member account from its Amazon Macie administrator account. This operation has been replaced by the DisassociateFromAdministratorAccount operation.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

Provides information about an error that occurred due to a syntax error in a request.

InternalServerException:

Provides information about an error that occurred due to an unknown internal server error, exception, or failure.

ServiceQuotaExceededException:

Provides information about an error that occurred due to one or more service quotas for an account.

AccessDeniedException:

Provides information about an error that occurred due to insufficient access to a specified resource.

ResourceNotFoundException:

Provides information about an error that occurred because a specified resource wasn't found.

ThrottlingException:

Provides information about an error that occurred because too many requests were sent during a certain amount of time.

ConflictException:

Provides information about an error that occurred due to a versioning conflict for a specified resource.

DisassociateMember

$result = $client->disassociateMember([/* ... */]);
$promise = $client->disassociateMemberAsync([/* ... */]);

Disassociates an Amazon Macie administrator account from a member account.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

Provides information about an error that occurred due to a syntax error in a request.

InternalServerException:

Provides information about an error that occurred due to an unknown internal server error, exception, or failure.

ServiceQuotaExceededException:

Provides information about an error that occurred due to one or more service quotas for an account.

AccessDeniedException:

Provides information about an error that occurred due to insufficient access to a specified resource.

ResourceNotFoundException:

Provides information about an error that occurred because a specified resource wasn't found.

ThrottlingException:

Provides information about an error that occurred because too many requests were sent during a certain amount of time.

ConflictException:

Provides information about an error that occurred due to a versioning conflict for a specified resource.

EnableMacie

$result = $client->enableMacie([/* ... */]);
$promise = $client->enableMacieAsync([/* ... */]);

Enables Amazon Macie and specifies the configuration settings for a Macie account.

Parameter Syntax

$result = $client->enableMacie([
    'clientToken' => '<string>',
    'findingPublishingFrequency' => 'FIFTEEN_MINUTES|ONE_HOUR|SIX_HOURS',
    'status' => 'PAUSED|ENABLED',
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

Provides information about an error that occurred due to a syntax error in a request.

InternalServerException:

Provides information about an error that occurred due to an unknown internal server error, exception, or failure.

ServiceQuotaExceededException:

Provides information about an error that occurred due to one or more service quotas for an account.

AccessDeniedException:

Provides information about an error that occurred due to insufficient access to a specified resource.

ResourceNotFoundException:

Provides information about an error that occurred because a specified resource wasn't found.

ThrottlingException:

Provides information about an error that occurred because too many requests were sent during a certain amount of time.

ConflictException:

Provides information about an error that occurred due to a versioning conflict for a specified resource.

EnableOrganizationAdminAccount

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

Designates an account as the delegated Amazon Macie administrator account for an organization in Organizations.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

Provides information about an error that occurred due to a syntax error in a request.

InternalServerException:

Provides information about an error that occurred due to an unknown internal server error, exception, or failure.

ServiceQuotaExceededException:

Provides information about an error that occurred due to one or more service quotas for an account.

AccessDeniedException:

Provides information about an error that occurred due to insufficient access to a specified resource.

ResourceNotFoundException:

Provides information about an error that occurred because a specified resource wasn't found.

ThrottlingException:

Provides information about an error that occurred because too many requests were sent during a certain amount of time.

ConflictException:

Provides information about an error that occurred due to a versioning conflict for a specified resource.

GetAdministratorAccount

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

Retrieves information about the Amazon Macie administrator account for an account.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'administrator' => [
        'accountId' => '<string>',
        'invitationId' => '<string>',
        'invitedAt' => <DateTime>,
        'relationshipStatus' => 'Enabled|Paused|Invited|Created|Removed|Resigned|EmailVerificationInProgress|EmailVerificationFailed|RegionDisabled|AccountSuspended',
    ],
]

Result Details

Errors

ValidationException:

Provides information about an error that occurred due to a syntax error in a request.

InternalServerException:

Provides information about an error that occurred due to an unknown internal server error, exception, or failure.

ServiceQuotaExceededException:

Provides information about an error that occurred due to one or more service quotas for an account.

AccessDeniedException:

Provides information about an error that occurred due to insufficient access to a specified resource.

ResourceNotFoundException:

Provides information about an error that occurred because a specified resource wasn't found.

ThrottlingException:

Provides information about an error that occurred because too many requests were sent during a certain amount of time.

ConflictException:

Provides information about an error that occurred due to a versioning conflict for a specified resource.

GetAllowList

$result = $client->getAllowList([/* ... */]);
$promise = $client->getAllowListAsync([/* ... */]);

Retrieves the settings and status of an allow list.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'arn' => '<string>',
    'createdAt' => <DateTime>,
    'criteria' => [
        'regex' => '<string>',
        's3WordsList' => [
            'bucketName' => '<string>',
            'objectKey' => '<string>',
        ],
    ],
    'description' => '<string>',
    'id' => '<string>',
    'name' => '<string>',
    'status' => [
        'code' => 'OK|S3_OBJECT_NOT_FOUND|S3_USER_ACCESS_DENIED|S3_OBJECT_ACCESS_DENIED|S3_THROTTLED|S3_OBJECT_OVERSIZE|S3_OBJECT_EMPTY|UNKNOWN_ERROR',
        'description' => '<string>',
    ],
    'tags' => ['<string>', ...],
    'updatedAt' => <DateTime>,
]

Result Details

Errors

ResourceNotFoundException:

Provides information about an error that occurred because a specified resource wasn't found.

ThrottlingException:

Provides information about an error that occurred because too many requests were sent during a certain amount of time.

ValidationException:

Provides information about an error that occurred due to a syntax error in a request.

InternalServerException:

Provides information about an error that occurred due to an unknown internal server error, exception, or failure.

AccessDeniedException:

Provides information about an error that occurred due to insufficient access to a specified resource.

GetAutomatedDiscoveryConfiguration

$result = $client->getAutomatedDiscoveryConfiguration([/* ... */]);
$promise = $client->getAutomatedDiscoveryConfigurationAsync([/* ... */]);

Retrieves the configuration settings and status of automated sensitive data discovery for an account.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'classificationScopeId' => '<string>',
    'disabledAt' => <DateTime>,
    'firstEnabledAt' => <DateTime>,
    'lastUpdatedAt' => <DateTime>,
    'sensitivityInspectionTemplateId' => '<string>',
    'status' => 'ENABLED|DISABLED',
]

Result Details

Errors

ThrottlingException:

Provides information about an error that occurred because too many requests were sent during a certain amount of time.

ValidationException:

Provides information about an error that occurred due to a syntax error in a request.

InternalServerException:

Provides information about an error that occurred due to an unknown internal server error, exception, or failure.

AccessDeniedException:

Provides information about an error that occurred due to insufficient access to a specified resource.

GetBucketStatistics

$result = $client->getBucketStatistics([/* ... */]);
$promise = $client->getBucketStatisticsAsync([/* ... */]);

Retrieves (queries) aggregated statistical data about all the S3 buckets that Amazon Macie monitors and analyzes for an account.

Parameter Syntax

$result = $client->getBucketStatistics([
    'accountId' => '<string>',
]);

Parameter Details

Result Syntax

[
    'bucketCount' => <integer>,
    'bucketCountByEffectivePermission' => [
        'publiclyAccessible' => <integer>,
        'publiclyReadable' => <integer>,
        'publiclyWritable' => <integer>,
        'unknown' => <integer>,
    ],
    'bucketCountByEncryptionType' => [
        'kmsManaged' => <integer>,
        's3Managed' => <integer>,
        'unencrypted' => <integer>,
        'unknown' => <integer>,
    ],
    'bucketCountByObjectEncryptionRequirement' => [
        'allowsUnencryptedObjectUploads' => <integer>,
        'deniesUnencryptedObjectUploads' => <integer>,
        'unknown' => <integer>,
    ],
    'bucketCountBySharedAccessType' => [
        'external' => <integer>,
        'internal' => <integer>,
        'notShared' => <integer>,
        'unknown' => <integer>,
    ],
    'bucketStatisticsBySensitivity' => [
        'classificationError' => [
            'classifiableSizeInBytes' => <integer>,
            'publiclyAccessibleCount' => <integer>,
            'totalCount' => <integer>,
            'totalSizeInBytes' => <integer>,
        ],
        'notClassified' => [
            'classifiableSizeInBytes' => <integer>,
            'publiclyAccessibleCount' => <integer>,
            'totalCount' => <integer>,
            'totalSizeInBytes' => <integer>,
        ],
        'notSensitive' => [
            'classifiableSizeInBytes' => <integer>,
            'publiclyAccessibleCount' => <integer>,
            'totalCount' => <integer>,
            'totalSizeInBytes' => <integer>,
        ],
        'sensitive' => [
            'classifiableSizeInBytes' => <integer>,
            'publiclyAccessibleCount' => <integer>,
            'totalCount' => <integer>,
            'totalSizeInBytes' => <integer>,
        ],
    ],
    'classifiableObjectCount' => <integer>,
    'classifiableSizeInBytes' => <integer>,
    'lastUpdated' => <DateTime>,
    'objectCount' => <integer>,
    'sizeInBytes' => <integer>,
    'sizeInBytesCompressed' => <integer>,
    'unclassifiableObjectCount' => [
        'fileType' => <integer>,
        'storageClass' => <integer>,
        'total' => <integer>,
    ],
    'unclassifiableObjectSizeInBytes' => [
        'fileType' => <integer>,
        'storageClass' => <integer>,
        'total' => <integer>,
    ],
]

Result Details

Errors

ValidationException:

Provides information about an error that occurred due to a syntax error in a request.

InternalServerException:

Provides information about an error that occurred due to an unknown internal server error, exception, or failure.

ServiceQuotaExceededException:

Provides information about an error that occurred due to one or more service quotas for an account.

AccessDeniedException:

Provides information about an error that occurred due to insufficient access to a specified resource.

ResourceNotFoundException:

Provides information about an error that occurred because a specified resource wasn't found.

ThrottlingException:

Provides information about an error that occurred because too many requests were sent during a certain amount of time.

ConflictException:

Provides information about an error that occurred due to a versioning conflict for a specified resource.

GetClassificationExportConfiguration

$result = $client->getClassificationExportConfiguration([/* ... */]);
$promise = $client->getClassificationExportConfigurationAsync([/* ... */]);

Retrieves the configuration settings for storing data classification results.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'configuration' => [
        's3Destination' => [
            'bucketName' => '<string>',
            'keyPrefix' => '<string>',
            'kmsKeyArn' => '<string>',
        ],
    ],
]

Result Details

Errors

ValidationException:

Provides information about an error that occurred due to a syntax error in a request.

InternalServerException:

Provides information about an error that occurred due to an unknown internal server error, exception, or failure.

ServiceQuotaExceededException:

Provides information about an error that occurred due to one or more service quotas for an account.

AccessDeniedException:

Provides information about an error that occurred due to insufficient access to a specified resource.

ResourceNotFoundException:

Provides information about an error that occurred because a specified resource wasn't found.

ThrottlingException:

Provides information about an error that occurred because too many requests were sent during a certain amount of time.

ConflictException:

Provides information about an error that occurred due to a versioning conflict for a specified resource.

GetClassificationScope

$result = $client->getClassificationScope([/* ... */]);
$promise = $client->getClassificationScopeAsync([/* ... */]);

Retrieves the classification scope settings for an account.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'id' => '<string>',
    'name' => '<string>',
    's3' => [
        'excludes' => [
            'bucketNames' => ['<string>', ...],
        ],
    ],
]

Result Details

Errors

ResourceNotFoundException:

Provides information about an error that occurred because a specified resource wasn't found.

ThrottlingException:

Provides information about an error that occurred because too many requests were sent during a certain amount of time.

ValidationException:

Provides information about an error that occurred due to a syntax error in a request.

InternalServerException:

Provides information about an error that occurred due to an unknown internal server error, exception, or failure.

AccessDeniedException:

Provides information about an error that occurred due to insufficient access to a specified resource.

GetCustomDataIdentifier

$result = $client->getCustomDataIdentifier([/* ... */]);
$promise = $client->getCustomDataIdentifierAsync([/* ... */]);

Retrieves the criteria and other settings for a custom data identifier.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'arn' => '<string>',
    'createdAt' => <DateTime>,
    'deleted' => true || false,
    'description' => '<string>',
    'id' => '<string>',
    'ignoreWords' => ['<string>', ...],
    'keywords' => ['<string>', ...],
    'maximumMatchDistance' => <integer>,
    'name' => '<string>',
    'regex' => '<string>',
    'severityLevels' => [
        [
            'occurrencesThreshold' => <integer>,
            'severity' => 'LOW|MEDIUM|HIGH',
        ],
        // ...
    ],
    'tags' => ['<string>', ...],
]

Result Details

Errors

ValidationException:

Provides information about an error that occurred due to a syntax error in a request.

InternalServerException:

Provides information about an error that occurred due to an unknown internal server error, exception, or failure.

ServiceQuotaExceededException:

Provides information about an error that occurred due to one or more service quotas for an account.

AccessDeniedException:

Provides information about an error that occurred due to insufficient access to a specified resource.

ResourceNotFoundException:

Provides information about an error that occurred because a specified resource wasn't found.

ThrottlingException:

Provides information about an error that occurred because too many requests were sent during a certain amount of time.

ConflictException:

Provides information about an error that occurred due to a versioning conflict for a specified resource.

GetFindingStatistics

$result = $client->getFindingStatistics([/* ... */]);
$promise = $client->getFindingStatisticsAsync([/* ... */]);

Retrieves (queries) aggregated statistical data about findings.

Parameter Syntax

$result = $client->getFindingStatistics([
    'findingCriteria' => [
        'criterion' => [
            '<__string>' => [
                'eq' => ['<string>', ...],
                'eqExactMatch' => ['<string>', ...],
                'gt' => <integer>,
                'gte' => <integer>,
                'lt' => <integer>,
                'lte' => <integer>,
                'neq' => ['<string>', ...],
            ],
            // ...
        ],
    ],
    'groupBy' => 'resourcesAffected.s3Bucket.name|type|classificationDetails.jobId|severity.description', // REQUIRED
    'size' => <integer>,
    'sortCriteria' => [
        'attributeName' => 'groupKey|count',
        'orderBy' => 'ASC|DESC',
    ],
]);

Parameter Details

Result Syntax

[
    'countsByGroup' => [
        [
            'count' => <integer>,
            'groupKey' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ValidationException:

Provides information about an error that occurred due to a syntax error in a request.

InternalServerException:

Provides information about an error that occurred due to an unknown internal server error, exception, or failure.

ServiceQuotaExceededException:

Provides information about an error that occurred due to one or more service quotas for an account.

AccessDeniedException:

Provides information about an error that occurred due to insufficient access to a specified resource.

ResourceNotFoundException:

Provides information about an error that occurred because a specified resource wasn't found.

ThrottlingException:

Provides information about an error that occurred because too many requests were sent during a certain amount of time.

ConflictException:

Provides information about an error that occurred due to a versioning conflict for a specified resource.

GetFindings

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

Retrieves the details of one or more findings.

Parameter Syntax

$result = $client->getFindings([
    'findingIds' => ['<string>', ...], // REQUIRED
    'sortCriteria' => [
        'attributeName' => '<string>',
        'orderBy' => 'ASC|DESC',
    ],
]);

Parameter Details

Result Syntax

[
    'findings' => [
        [
            'accountId' => '<string>',
            'archived' => true || false,
            'category' => 'CLASSIFICATION|POLICY',
            'classificationDetails' => [
                'detailedResultsLocation' => '<string>',
                'jobArn' => '<string>',
                'jobId' => '<string>',
                'originType' => 'SENSITIVE_DATA_DISCOVERY_JOB|AUTOMATED_SENSITIVE_DATA_DISCOVERY',
                'result' => [
                    'additionalOccurrences' => true || false,
                    'customDataIdentifiers' => [
                        'detections' => [
                            [
                                'arn' => '<string>',
                                'count' => <integer>,
                                'name' => '<string>',
                                'occurrences' => [
                                    'cells' => [
                                        [
                                            'cellReference' => '<string>',
                                            'column' => <integer>,
                                            'columnName' => '<string>',
                                            'row' => <integer>,
                                        ],
                                        // ...
                                    ],
                                    'lineRanges' => [
                                        [
                                            'end' => <integer>,
                                            'start' => <integer>,
                                            'startColumn' => <integer>,
                                        ],
                                        // ...
                                    ],
                                    'offsetRanges' => [
                                        [
                                            'end' => <integer>,
                                            'start' => <integer>,
                                            'startColumn' => <integer>,
                                        ],
                                        // ...
                                    ],
                                    'pages' => [
                                        [
                                            'lineRange' => [
                                                'end' => <integer>,
                                                'start' => <integer>,
                                                'startColumn' => <integer>,
                                            ],
                                            'offsetRange' => [
                                                'end' => <integer>,
                                                'start' => <integer>,
                                                'startColumn' => <integer>,
                                            ],
                                            'pageNumber' => <integer>,
                                        ],
                                        // ...
                                    ],
                                    'records' => [
                                        [
                                            'jsonPath' => '<string>',
                                            'recordIndex' => <integer>,
                                        ],
                                        // ...
                                    ],
                                ],
                            ],
                            // ...
                        ],
                        'totalCount' => <integer>,
                    ],
                    'mimeType' => '<string>',
                    'sensitiveData' => [
                        [
                            'category' => 'FINANCIAL_INFORMATION|PERSONAL_INFORMATION|CREDENTIALS|CUSTOM_IDENTIFIER',
                            'detections' => [
                                [
                                    'count' => <integer>,
                                    'occurrences' => [
                                        'cells' => [
                                            [
                                                'cellReference' => '<string>',
                                                'column' => <integer>,
                                                'columnName' => '<string>',
                                                'row' => <integer>,
                                            ],
                                            // ...
                                        ],
                                        'lineRanges' => [
                                            [
                                                'end' => <integer>,
                                                'start' => <integer>,
                                                'startColumn' => <integer>,
                                            ],
                                            // ...
                                        ],
                                        'offsetRanges' => [
                                            [
                                                'end' => <integer>,
                                                'start' => <integer>,
                                                'startColumn' => <integer>,
                                            ],
                                            // ...
                                        ],
                                        'pages' => [
                                            [
                                                'lineRange' => [
                                                    'end' => <integer>,
                                                    'start' => <integer>,
                                                    'startColumn' => <integer>,
                                                ],
                                                'offsetRange' => [
                                                    'end' => <integer>,
                                                    'start' => <integer>,
                                                    'startColumn' => <integer>,
                                                ],
                                                'pageNumber' => <integer>,
                                            ],
                                            // ...
                                        ],
                                        'records' => [
                                            [
                                                'jsonPath' => '<string>',
                                                'recordIndex' => <integer>,
                                            ],
                                            // ...
                                        ],
                                    ],
                                    'type' => '<string>',
                                ],
                                // ...
                            ],
                            'totalCount' => <integer>,
                        ],
                        // ...
                    ],
                    'sizeClassified' => <integer>,
                    'status' => [
                        'code' => '<string>',
                        'reason' => '<string>',
                    ],
                ],
            ],
            'count' => <integer>,
            'createdAt' => <DateTime>,
            'description' => '<string>',
            'id' => '<string>',
            'partition' => '<string>',
            'policyDetails' => [
                'action' => [
                    'actionType' => 'AWS_API_CALL',
                    'apiCallDetails' => [
                        'api' => '<string>',
                        'apiServiceName' => '<string>',
                        'firstSeen' => <DateTime>,
                        'lastSeen' => <DateTime>,
                    ],
                ],
                'actor' => [
                    'domainDetails' => [
                        'domainName' => '<string>',
                    ],
                    'ipAddressDetails' => [
                        'ipAddressV4' => '<string>',
                        'ipCity' => [
                            'name' => '<string>',
                        ],
                        'ipCountry' => [
                            'code' => '<string>',
                            'name' => '<string>',
                        ],
                        'ipGeoLocation' => [
                            'lat' => <float>,
                            'lon' => <float>,
                        ],
                        'ipOwner' => [
                            'asn' => '<string>',
                            'asnOrg' => '<string>',
                            'isp' => '<string>',
                            'org' => '<string>',
                        ],
                    ],
                    'userIdentity' => [
                        'assumedRole' => [
                            'accessKeyId' => '<string>',
                            'accountId' => '<string>',
                            'arn' => '<string>',
                            'principalId' => '<string>',
                            'sessionContext' => [
                                'attributes' => [
                                    'creationDate' => <DateTime>,
                                    'mfaAuthenticated' => true || false,
                                ],
                                'sessionIssuer' => [
                                    'accountId' => '<string>',
                                    'arn' => '<string>',
                                    'principalId' => '<string>',
                                    'type' => '<string>',
                                    'userName' => '<string>',
                                ],
                            ],
                        ],
                        'awsAccount' => [
                            'accountId' => '<string>',
                            'principalId' => '<string>',
                        ],
                        'awsService' => [
                            'invokedBy' => '<string>',
                        ],
                        'federatedUser' => [
                            'accessKeyId' => '<string>',
                            'accountId' => '<string>',
                            'arn' => '<string>',
                            'principalId' => '<string>',
                            'sessionContext' => [
                                'attributes' => [
                                    'creationDate' => <DateTime>,
                                    'mfaAuthenticated' => true || false,
                                ],
                                'sessionIssuer' => [
                                    'accountId' => '<string>',
                                    'arn' => '<string>',
                                    'principalId' => '<string>',
                                    'type' => '<string>',
                                    'userName' => '<string>',
                                ],
                            ],
                        ],
                        'iamUser' => [
                            'accountId' => '<string>',
                            'arn' => '<string>',
                            'principalId' => '<string>',
                            'userName' => '<string>',
                        ],
                        'root' => [
                            'accountId' => '<string>',
                            'arn' => '<string>',
                            'principalId' => '<string>',
                        ],
                        'type' => 'AssumedRole|IAMUser|FederatedUser|Root|AWSAccount|AWSService',
                    ],
                ],
            ],
            'region' => '<string>',
            'resourcesAffected' => [
                's3Bucket' => [
                    'allowsUnencryptedObjectUploads' => 'TRUE|FALSE|UNKNOWN',
                    'arn' => '<string>',
                    'createdAt' => <DateTime>,
                    'defaultServerSideEncryption' => [
                        'encryptionType' => 'NONE|AES256|aws:kms|UNKNOWN|aws:kms:dsse',
                        'kmsMasterKeyId' => '<string>',
                    ],
                    'name' => '<string>',
                    'owner' => [
                        'displayName' => '<string>',
                        'id' => '<string>',
                    ],
                    'publicAccess' => [
                        'effectivePermission' => 'PUBLIC|NOT_PUBLIC|UNKNOWN',
                        '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>',
                        ],
                        // ...
                    ],
                ],
                's3Object' => [
                    'bucketArn' => '<string>',
                    'eTag' => '<string>',
                    'extension' => '<string>',
                    'key' => '<string>',
                    'lastModified' => <DateTime>,
                    'path' => '<string>',
                    'publicAccess' => true || false,
                    'serverSideEncryption' => [
                        'encryptionType' => 'NONE|AES256|aws:kms|UNKNOWN|aws:kms:dsse',
                        'kmsMasterKeyId' => '<string>',
                    ],
                    'size' => <integer>,
                    'storageClass' => 'STANDARD|REDUCED_REDUNDANCY|STANDARD_IA|INTELLIGENT_TIERING|DEEP_ARCHIVE|ONEZONE_IA|GLACIER|GLACIER_IR|OUTPOSTS',
                    'tags' => [
                        [
                            'key' => '<string>',
                            'value' => '<string>',
                        ],
                        // ...
                    ],
                    'versionId' => '<string>',
                ],
            ],
            'sample' => true || false,
            'schemaVersion' => '<string>',
            'severity' => [
                'description' => 'Low|Medium|High',
                'score' => <integer>,
            ],
            'title' => '<string>',
            'type' => 'SensitiveData:S3Object/Multiple|SensitiveData:S3Object/Financial|SensitiveData:S3Object/Personal|SensitiveData:S3Object/Credentials|SensitiveData:S3Object/CustomIdentifier|Policy:IAMUser/S3BucketPublic|Policy:IAMUser/S3BucketSharedExternally|Policy:IAMUser/S3BucketReplicatedExternally|Policy:IAMUser/S3BucketEncryptionDisabled|Policy:IAMUser/S3BlockPublicAccessDisabled|Policy:IAMUser/S3BucketSharedWithCloudFront',
            'updatedAt' => <DateTime>,
        ],
        // ...
    ],
]

Result Details

Errors

ValidationException:

Provides information about an error that occurred due to a syntax error in a request.

InternalServerException:

Provides information about an error that occurred due to an unknown internal server error, exception, or failure.

ServiceQuotaExceededException:

Provides information about an error that occurred due to one or more service quotas for an account.

AccessDeniedException:

Provides information about an error that occurred due to insufficient access to a specified resource.

ResourceNotFoundException:

Provides information about an error that occurred because a specified resource wasn't found.

ThrottlingException:

Provides information about an error that occurred because too many requests were sent during a certain amount of time.

ConflictException:

Provides information about an error that occurred due to a versioning conflict for a specified resource.

GetFindingsFilter

$result = $client->getFindingsFilter([/* ... */]);
$promise = $client->getFindingsFilterAsync([/* ... */]);

Retrieves the criteria and other settings for a findings filter.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'action' => 'ARCHIVE|NOOP',
    'arn' => '<string>',
    'description' => '<string>',
    'findingCriteria' => [
        'criterion' => [
            '<__string>' => [
                'eq' => ['<string>', ...],
                'eqExactMatch' => ['<string>', ...],
                'gt' => <integer>,
                'gte' => <integer>,
                'lt' => <integer>,
                'lte' => <integer>,
                'neq' => ['<string>', ...],
            ],
            // ...
        ],
    ],
    'id' => '<string>',
    'name' => '<string>',
    'position' => <integer>,
    'tags' => ['<string>', ...],
]

Result Details

Errors

ValidationException:

Provides information about an error that occurred due to a syntax error in a request.

InternalServerException:

Provides information about an error that occurred due to an unknown internal server error, exception, or failure.

ServiceQuotaExceededException:

Provides information about an error that occurred due to one or more service quotas for an account.

AccessDeniedException:

Provides information about an error that occurred due to insufficient access to a specified resource.

ResourceNotFoundException:

Provides information about an error that occurred because a specified resource wasn't found.

ThrottlingException:

Provides information about an error that occurred because too many requests were sent during a certain amount of time.

ConflictException:

Provides information about an error that occurred due to a versioning conflict for a specified resource.

GetFindingsPublicationConfiguration

$result = $client->getFindingsPublicationConfiguration([/* ... */]);
$promise = $client->getFindingsPublicationConfigurationAsync([/* ... */]);

Retrieves the configuration settings for publishing findings to Security Hub.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'securityHubConfiguration' => [
        'publishClassificationFindings' => true || false,
        'publishPolicyFindings' => true || false,
    ],
]

Result Details

Errors

ValidationException:

Provides information about an error that occurred due to a syntax error in a request.

InternalServerException:

Provides information about an error that occurred due to an unknown internal server error, exception, or failure.

ServiceQuotaExceededException:

Provides information about an error that occurred due to one or more service quotas for an account.

AccessDeniedException:

Provides information about an error that occurred due to insufficient access to a specified resource.

ResourceNotFoundException:

Provides information about an error that occurred because a specified resource wasn't found.

ThrottlingException:

Provides information about an error that occurred because too many requests were sent during a certain amount of time.

ConflictException:

Provides information about an error that occurred due to a versioning conflict for a specified resource.

GetInvitationsCount

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

Retrieves the count of Amazon Macie membership invitations that were received by an account.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'invitationsCount' => <integer>,
]

Result Details

Errors

ValidationException:

Provides information about an error that occurred due to a syntax error in a request.

InternalServerException:

Provides information about an error that occurred due to an unknown internal server error, exception, or failure.

ServiceQuotaExceededException:

Provides information about an error that occurred due to one or more service quotas for an account.

AccessDeniedException:

Provides information about an error that occurred due to insufficient access to a specified resource.

ResourceNotFoundException:

Provides information about an error that occurred because a specified resource wasn't found.

ThrottlingException:

Provides information about an error that occurred because too many requests were sent during a certain amount of time.

ConflictException:

Provides information about an error that occurred due to a versioning conflict for a specified resource.

GetMacieSession

$result = $client->getMacieSession([/* ... */]);
$promise = $client->getMacieSessionAsync([/* ... */]);

Retrieves the status and configuration settings for an Amazon Macie account.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'createdAt' => <DateTime>,
    'findingPublishingFrequency' => 'FIFTEEN_MINUTES|ONE_HOUR|SIX_HOURS',
    'serviceRole' => '<string>',
    'status' => 'PAUSED|ENABLED',
    'updatedAt' => <DateTime>,
]

Result Details

Errors

ValidationException:

Provides information about an error that occurred due to a syntax error in a request.

InternalServerException:

Provides information about an error that occurred due to an unknown internal server error, exception, or failure.

ServiceQuotaExceededException:

Provides information about an error that occurred due to one or more service quotas for an account.

AccessDeniedException:

Provides information about an error that occurred due to insufficient access to a specified resource.

ResourceNotFoundException:

Provides information about an error that occurred because a specified resource wasn't found.

ThrottlingException:

Provides information about an error that occurred because too many requests were sent during a certain amount of time.

ConflictException:

Provides information about an error that occurred due to a versioning conflict for a specified resource.

GetMasterAccount

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

(Deprecated) Retrieves information about the Amazon Macie administrator account for an account. This operation has been replaced by the GetAdministratorAccount operation.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'master' => [
        'accountId' => '<string>',
        'invitationId' => '<string>',
        'invitedAt' => <DateTime>,
        'relationshipStatus' => 'Enabled|Paused|Invited|Created|Removed|Resigned|EmailVerificationInProgress|EmailVerificationFailed|RegionDisabled|AccountSuspended',
    ],
]

Result Details

Errors

ValidationException:

Provides information about an error that occurred due to a syntax error in a request.

InternalServerException:

Provides information about an error that occurred due to an unknown internal server error, exception, or failure.

ServiceQuotaExceededException:

Provides information about an error that occurred due to one or more service quotas for an account.

AccessDeniedException:

Provides information about an error that occurred due to insufficient access to a specified resource.

ResourceNotFoundException:

Provides information about an error that occurred because a specified resource wasn't found.

ThrottlingException:

Provides information about an error that occurred because too many requests were sent during a certain amount of time.

ConflictException:

Provides information about an error that occurred due to a versioning conflict for a specified resource.

GetMember

$result = $client->getMember([/* ... */]);
$promise = $client->getMemberAsync([/* ... */]);

Retrieves information about an account that's associated with an Amazon Macie administrator account.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'accountId' => '<string>',
    'administratorAccountId' => '<string>',
    'arn' => '<string>',
    'email' => '<string>',
    'invitedAt' => <DateTime>,
    'masterAccountId' => '<string>',
    'relationshipStatus' => 'Enabled|Paused|Invited|Created|Removed|Resigned|EmailVerificationInProgress|EmailVerificationFailed|RegionDisabled|AccountSuspended',
    'tags' => ['<string>', ...],
    'updatedAt' => <DateTime>,
]

Result Details

Errors

ValidationException:

Provides information about an error that occurred due to a syntax error in a request.

InternalServerException:

Provides information about an error that occurred due to an unknown internal server error, exception, or failure.

ServiceQuotaExceededException:

Provides information about an error that occurred due to one or more service quotas for an account.

AccessDeniedException:

Provides information about an error that occurred due to insufficient access to a specified resource.

ResourceNotFoundException:

Provides information about an error that occurred because a specified resource wasn't found.

ThrottlingException:

Provides information about an error that occurred because too many requests were sent during a certain amount of time.

ConflictException:

Provides information about an error that occurred due to a versioning conflict for a specified resource.

GetResourceProfile

$result = $client->getResourceProfile([/* ... */]);
$promise = $client->getResourceProfileAsync([/* ... */]);

Retrieves (queries) sensitive data discovery statistics and the sensitivity score for an S3 bucket.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'profileUpdatedAt' => <DateTime>,
    'sensitivityScore' => <integer>,
    'sensitivityScoreOverridden' => true || false,
    'statistics' => [
        'totalBytesClassified' => <integer>,
        'totalDetections' => <integer>,
        'totalDetectionsSuppressed' => <integer>,
        'totalItemsClassified' => <integer>,
        'totalItemsSensitive' => <integer>,
        'totalItemsSkipped' => <integer>,
        'totalItemsSkippedInvalidEncryption' => <integer>,
        'totalItemsSkippedInvalidKms' => <integer>,
        'totalItemsSkippedPermissionDenied' => <integer>,
    ],
]

Result Details

Errors

ValidationException:

Provides information about an error that occurred due to a syntax error in a request.

InternalServerException:

Provides information about an error that occurred due to an unknown internal server error, exception, or failure.

ServiceQuotaExceededException:

Provides information about an error that occurred due to one or more service quotas for an account.

AccessDeniedException:

Provides information about an error that occurred due to insufficient access to a specified resource.

ResourceNotFoundException:

Provides information about an error that occurred because a specified resource wasn't found.

ThrottlingException:

Provides information about an error that occurred because too many requests were sent during a certain amount of time.

GetRevealConfiguration

$result = $client->getRevealConfiguration([/* ... */]);
$promise = $client->getRevealConfigurationAsync([/* ... */]);

Retrieves the status and configuration settings for retrieving occurrences of sensitive data reported by findings.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'configuration' => [
        'kmsKeyId' => '<string>',
        'status' => 'ENABLED|DISABLED',
    ],
    'retrievalConfiguration' => [
        'externalId' => '<string>',
        'retrievalMode' => 'CALLER_CREDENTIALS|ASSUME_ROLE',
        'roleName' => '<string>',
    ],
]

Result Details

Errors

ThrottlingException:

Provides information about an error that occurred because too many requests were sent during a certain amount of time.

ValidationException:

Provides information about an error that occurred due to a syntax error in a request.

InternalServerException:

Provides information about an error that occurred due to an unknown internal server error, exception, or failure.

AccessDeniedException:

Provides information about an error that occurred due to insufficient access to a specified resource.

GetSensitiveDataOccurrences

$result = $client->getSensitiveDataOccurrences([/* ... */]);
$promise = $client->getSensitiveDataOccurrencesAsync([/* ... */]);

Retrieves occurrences of sensitive data reported by a finding.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'error' => '<string>',
    'sensitiveDataOccurrences' => [
        '<__string>' => [
            [
                'value' => '<string>',
            ],
            // ...
        ],
        // ...
    ],
    'status' => 'SUCCESS|PROCESSING|ERROR',
]

Result Details

Errors

UnprocessableEntityException:

Provides information about an error that occurred due to an unprocessable entity.

InternalServerException:

Provides information about an error that occurred due to an unknown internal server error, exception, or failure.

ServiceQuotaExceededException:

Provides information about an error that occurred due to one or more service quotas for an account.

AccessDeniedException:

Provides information about an error that occurred due to insufficient access to a specified resource.

ResourceNotFoundException:

Provides information about an error that occurred because a specified resource wasn't found.

ThrottlingException:

Provides information about an error that occurred because too many requests were sent during a certain amount of time.

GetSensitiveDataOccurrencesAvailability

$result = $client->getSensitiveDataOccurrencesAvailability([/* ... */]);
$promise = $client->getSensitiveDataOccurrencesAvailabilityAsync([/* ... */]);

Checks whether occurrences of sensitive data can be retrieved for a finding.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'code' => 'AVAILABLE|UNAVAILABLE',
    'reasons' => ['<string>', ...],
]

Result Details

Errors

ResourceNotFoundException:

Provides information about an error that occurred because a specified resource wasn't found.

ThrottlingException:

Provides information about an error that occurred because too many requests were sent during a certain amount of time.

InternalServerException:

Provides information about an error that occurred due to an unknown internal server error, exception, or failure.

AccessDeniedException:

Provides information about an error that occurred due to insufficient access to a specified resource.

GetSensitivityInspectionTemplate

$result = $client->getSensitivityInspectionTemplate([/* ... */]);
$promise = $client->getSensitivityInspectionTemplateAsync([/* ... */]);

Retrieves the settings for the sensitivity inspection template for an account.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'description' => '<string>',
    'excludes' => [
        'managedDataIdentifierIds' => ['<string>', ...],
    ],
    'includes' => [
        'allowListIds' => ['<string>', ...],
        'customDataIdentifierIds' => ['<string>', ...],
        'managedDataIdentifierIds' => ['<string>', ...],
    ],
    'name' => '<string>',
    'sensitivityInspectionTemplateId' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

Provides information about an error that occurred because a specified resource wasn't found.

ThrottlingException:

Provides information about an error that occurred because too many requests were sent during a certain amount of time.

ValidationException:

Provides information about an error that occurred due to a syntax error in a request.

InternalServerException:

Provides information about an error that occurred due to an unknown internal server error, exception, or failure.

AccessDeniedException:

Provides information about an error that occurred due to insufficient access to a specified resource.

GetUsageStatistics

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

Retrieves (queries) quotas and aggregated usage data for one or more accounts.

Parameter Syntax

$result = $client->getUsageStatistics([
    'filterBy' => [
        [
            'comparator' => 'GT|GTE|LT|LTE|EQ|NE|CONTAINS',
            'key' => 'accountId|serviceLimit|freeTrialStartDate|total',
            'values' => ['<string>', ...],
        ],
        // ...
    ],
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'sortBy' => [
        'key' => 'accountId|total|serviceLimitValue|freeTrialStartDate',
        'orderBy' => 'ASC|DESC',
    ],
    'timeRange' => 'MONTH_TO_DATE|PAST_30_DAYS',
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'records' => [
        [
            'accountId' => '<string>',
            'automatedDiscoveryFreeTrialStartDate' => <DateTime>,
            'freeTrialStartDate' => <DateTime>,
            'usage' => [
                [
                    'currency' => 'USD',
                    'estimatedCost' => '<string>',
                    'serviceLimit' => [
                        'isServiceLimited' => true || false,
                        'unit' => 'TERABYTES',
                        'value' => <integer>,
                    ],
                    'type' => 'DATA_INVENTORY_EVALUATION|SENSITIVE_DATA_DISCOVERY|AUTOMATED_SENSITIVE_DATA_DISCOVERY|AUTOMATED_OBJECT_MONITORING',
                ],
                // ...
            ],
        ],
        // ...
    ],
    'timeRange' => 'MONTH_TO_DATE|PAST_30_DAYS',
]

Result Details

Errors

ValidationException:

Provides information about an error that occurred due to a syntax error in a request.

InternalServerException:

Provides information about an error that occurred due to an unknown internal server error, exception, or failure.

ServiceQuotaExceededException:

Provides information about an error that occurred due to one or more service quotas for an account.

AccessDeniedException:

Provides information about an error that occurred due to insufficient access to a specified resource.

ResourceNotFoundException:

Provides information about an error that occurred because a specified resource wasn't found.

ThrottlingException:

Provides information about an error that occurred because too many requests were sent during a certain amount of time.

ConflictException:

Provides information about an error that occurred due to a versioning conflict for a specified resource.

GetUsageTotals

$result = $client->getUsageTotals([/* ... */]);
$promise = $client->getUsageTotalsAsync([/* ... */]);

Retrieves (queries) aggregated usage data for an account.

Parameter Syntax

$result = $client->getUsageTotals([
    'timeRange' => '<string>',
]);

Parameter Details

Result Syntax

[
    'timeRange' => 'MONTH_TO_DATE|PAST_30_DAYS',
    'usageTotals' => [
        [
            'currency' => 'USD',
            'estimatedCost' => '<string>',
            'type' => 'DATA_INVENTORY_EVALUATION|SENSITIVE_DATA_DISCOVERY|AUTOMATED_SENSITIVE_DATA_DISCOVERY|AUTOMATED_OBJECT_MONITORING',
        ],
        // ...
    ],
]

Result Details

Errors

ValidationException:

Provides information about an error that occurred due to a syntax error in a request.

InternalServerException:

Provides information about an error that occurred due to an unknown internal server error, exception, or failure.

ServiceQuotaExceededException:

Provides information about an error that occurred due to one or more service quotas for an account.

AccessDeniedException:

Provides information about an error that occurred due to insufficient access to a specified resource.

ResourceNotFoundException:

Provides information about an error that occurred because a specified resource wasn't found.

ThrottlingException:

Provides information about an error that occurred because too many requests were sent during a certain amount of time.

ConflictException:

Provides information about an error that occurred due to a versioning conflict for a specified resource.

ListAllowLists

$result = $client->listAllowLists([/* ... */]);
$promise = $client->listAllowListsAsync([/* ... */]);

Retrieves a subset of information about all the allow lists for an account.

Parameter Syntax

$result = $client->listAllowLists([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'allowLists' => [
        [
            'arn' => '<string>',
            'createdAt' => <DateTime>,
            'description' => '<string>',
            'id' => '<string>',
            'name' => '<string>',
            'updatedAt' => <DateTime>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ThrottlingException:

Provides information about an error that occurred because too many requests were sent during a certain amount of time.

ValidationException:

Provides information about an error that occurred due to a syntax error in a request.

InternalServerException:

Provides information about an error that occurred due to an unknown internal server error, exception, or failure.

AccessDeniedException:

Provides information about an error that occurred due to insufficient access to a specified resource.

ListClassificationJobs

$result = $client->listClassificationJobs([/* ... */]);
$promise = $client->listClassificationJobsAsync([/* ... */]);

Retrieves a subset of information about one or more classification jobs.

Parameter Syntax

$result = $client->listClassificationJobs([
    'filterCriteria' => [
        'excludes' => [
            [
                'comparator' => 'EQ|GT|GTE|LT|LTE|NE|CONTAINS|STARTS_WITH',
                'key' => 'jobType|jobStatus|createdAt|name',
                'values' => ['<string>', ...],
            ],
            // ...
        ],
        'includes' => [
            [
                'comparator' => 'EQ|GT|GTE|LT|LTE|NE|CONTAINS|STARTS_WITH',
                'key' => 'jobType|jobStatus|createdAt|name',
                'values' => ['<string>', ...],
            ],
            // ...
        ],
    ],
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'sortCriteria' => [
        'attributeName' => 'createdAt|jobStatus|name|jobType',
        'orderBy' => 'ASC|DESC',
    ],
]);

Parameter Details

Result Syntax

[
    'items' => [
        [
            'bucketCriteria' => [
                'excludes' => [
                    'and' => [
                        [
                            'simpleCriterion' => [
                                'comparator' => 'EQ|GT|GTE|LT|LTE|NE|CONTAINS|STARTS_WITH',
                                'key' => 'ACCOUNT_ID|S3_BUCKET_NAME|S3_BUCKET_EFFECTIVE_PERMISSION|S3_BUCKET_SHARED_ACCESS',
                                'values' => ['<string>', ...],
                            ],
                            'tagCriterion' => [
                                'comparator' => 'EQ|GT|GTE|LT|LTE|NE|CONTAINS|STARTS_WITH',
                                'tagValues' => [
                                    [
                                        'key' => '<string>',
                                        'value' => '<string>',
                                    ],
                                    // ...
                                ],
                            ],
                        ],
                        // ...
                    ],
                ],
                'includes' => [
                    'and' => [
                        [
                            'simpleCriterion' => [
                                'comparator' => 'EQ|GT|GTE|LT|LTE|NE|CONTAINS|STARTS_WITH',
                                'key' => 'ACCOUNT_ID|S3_BUCKET_NAME|S3_BUCKET_EFFECTIVE_PERMISSION|S3_BUCKET_SHARED_ACCESS',
                                'values' => ['<string>', ...],
                            ],
                            'tagCriterion' => [
                                'comparator' => 'EQ|GT|GTE|LT|LTE|NE|CONTAINS|STARTS_WITH',
                                'tagValues' => [
                                    [
                                        'key' => '<string>',
                                        'value' => '<string>',
                                    ],
                                    // ...
                                ],
                            ],
                        ],
                        // ...
                    ],
                ],
            ],
            'bucketDefinitions' => [
                [
                    'accountId' => '<string>',
                    'buckets' => ['<string>', ...],
                ],
                // ...
            ],
            'createdAt' => <DateTime>,
            'jobId' => '<string>',
            'jobStatus' => 'RUNNING|PAUSED|CANCELLED|COMPLETE|IDLE|USER_PAUSED',
            'jobType' => 'ONE_TIME|SCHEDULED',
            'lastRunErrorStatus' => [
                'code' => 'NONE|ERROR',
            ],
            'name' => '<string>',
            'userPausedDetails' => [
                'jobExpiresAt' => <DateTime>,
                'jobImminentExpirationHealthEventArn' => '<string>',
                'jobPausedAt' => <DateTime>,
            ],
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ValidationException:

Provides information about an error that occurred due to a syntax error in a request.

InternalServerException:

Provides information about an error that occurred due to an unknown internal server error, exception, or failure.

ServiceQuotaExceededException:

Provides information about an error that occurred due to one or more service quotas for an account.

AccessDeniedException:

Provides information about an error that occurred due to insufficient access to a specified resource.

ResourceNotFoundException:

Provides information about an error that occurred because a specified resource wasn't found.

ThrottlingException:

Provides information about an error that occurred because too many requests were sent during a certain amount of time.

ConflictException:

Provides information about an error that occurred due to a versioning conflict for a specified resource.

ListClassificationScopes

$result = $client->listClassificationScopes([/* ... */]);
$promise = $client->listClassificationScopesAsync([/* ... */]);

Retrieves a subset of information about the classification scope for an account.

Parameter Syntax

$result = $client->listClassificationScopes([
    'name' => '<string>',
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'classificationScopes' => [
        [
            'id' => '<string>',
            'name' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ThrottlingException:

Provides information about an error that occurred because too many requests were sent during a certain amount of time.

ValidationException:

Provides information about an error that occurred due to a syntax error in a request.

InternalServerException:

Provides information about an error that occurred due to an unknown internal server error, exception, or failure.

AccessDeniedException:

Provides information about an error that occurred due to insufficient access to a specified resource.

ListCustomDataIdentifiers

$result = $client->listCustomDataIdentifiers([/* ... */]);
$promise = $client->listCustomDataIdentifiersAsync([/* ... */]);

Retrieves a subset of information about all the custom data identifiers for an account.

Parameter Syntax

$result = $client->listCustomDataIdentifiers([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'items' => [
        [
            'arn' => '<string>',
            'createdAt' => <DateTime>,
            'description' => '<string>',
            'id' => '<string>',
            'name' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ValidationException:

Provides information about an error that occurred due to a syntax error in a request.

InternalServerException:

Provides information about an error that occurred due to an unknown internal server error, exception, or failure.

ServiceQuotaExceededException:

Provides information about an error that occurred due to one or more service quotas for an account.

AccessDeniedException:

Provides information about an error that occurred due to insufficient access to a specified resource.

ResourceNotFoundException:

Provides information about an error that occurred because a specified resource wasn't found.

ThrottlingException:

Provides information about an error that occurred because too many requests were sent during a certain amount of time.

ConflictException:

Provides information about an error that occurred due to a versioning conflict for a specified resource.

ListFindings

$result = $client->listFindings([/* ... */]);
$promise = $client->listFindingsAsync([/* ... */]);

Retrieves a subset of information about one or more findings.

Parameter Syntax

$result = $client->listFindings([
    'findingCriteria' => [
        'criterion' => [
            '<__string>' => [
                'eq' => ['<string>', ...],
                'eqExactMatch' => ['<string>', ...],
                'gt' => <integer>,
                'gte' => <integer>,
                'lt' => <integer>,
                'lte' => <integer>,
                'neq' => ['<string>', ...],
            ],
            // ...
        ],
    ],
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'sortCriteria' => [
        'attributeName' => '<string>',
        'orderBy' => 'ASC|DESC',
    ],
]);

Parameter Details

Result Syntax

[
    'findingIds' => ['<string>', ...],
    'nextToken' => '<string>',
]

Result Details

Errors

ValidationException:

Provides information about an error that occurred due to a syntax error in a request.

InternalServerException:

Provides information about an error that occurred due to an unknown internal server error, exception, or failure.

ServiceQuotaExceededException:

Provides information about an error that occurred due to one or more service quotas for an account.

AccessDeniedException:

Provides information about an error that occurred due to insufficient access to a specified resource.

ResourceNotFoundException:

Provides information about an error that occurred because a specified resource wasn't found.

ThrottlingException:

Provides information about an error that occurred because too many requests were sent during a certain amount of time.

ConflictException:

Provides information about an error that occurred due to a versioning conflict for a specified resource.

ListFindingsFilters

$result = $client->listFindingsFilters([/* ... */]);
$promise = $client->listFindingsFiltersAsync([/* ... */]);

Retrieves a subset of information about all the findings filters for an account.

Parameter Syntax

$result = $client->listFindingsFilters([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'findingsFilterListItems' => [
        [
            'action' => 'ARCHIVE|NOOP',
            'arn' => '<string>',
            'id' => '<string>',
            'name' => '<string>',
            'tags' => ['<string>', ...],
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ValidationException:

Provides information about an error that occurred due to a syntax error in a request.

InternalServerException:

Provides information about an error that occurred due to an unknown internal server error, exception, or failure.

ServiceQuotaExceededException:

Provides information about an error that occurred due to one or more service quotas for an account.

AccessDeniedException:

Provides information about an error that occurred due to insufficient access to a specified resource.

ResourceNotFoundException:

Provides information about an error that occurred because a specified resource wasn't found.

ThrottlingException:

Provides information about an error that occurred because too many requests were sent during a certain amount of time.

ConflictException:

Provides information about an error that occurred due to a versioning conflict for a specified resource.

ListInvitations

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

Retrieves information about the Amazon Macie membership invitations that were received by an account.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'invitations' => [
        [
            'accountId' => '<string>',
            'invitationId' => '<string>',
            'invitedAt' => <DateTime>,
            'relationshipStatus' => 'Enabled|Paused|Invited|Created|Removed|Resigned|EmailVerificationInProgress|EmailVerificationFailed|RegionDisabled|AccountSuspended',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ValidationException:

Provides information about an error that occurred due to a syntax error in a request.

InternalServerException:

Provides information about an error that occurred due to an unknown internal server error, exception, or failure.

ServiceQuotaExceededException:

Provides information about an error that occurred due to one or more service quotas for an account.

AccessDeniedException:

Provides information about an error that occurred due to insufficient access to a specified resource.

ResourceNotFoundException:

Provides information about an error that occurred because a specified resource wasn't found.

ThrottlingException:

Provides information about an error that occurred because too many requests were sent during a certain amount of time.

ConflictException:

Provides information about an error that occurred due to a versioning conflict for a specified resource.

ListManagedDataIdentifiers

$result = $client->listManagedDataIdentifiers([/* ... */]);
$promise = $client->listManagedDataIdentifiersAsync([/* ... */]);

Retrieves information about all the managed data identifiers that Amazon Macie currently provides.

Parameter Syntax

$result = $client->listManagedDataIdentifiers([
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'items' => [
        [
            'category' => 'FINANCIAL_INFORMATION|PERSONAL_INFORMATION|CREDENTIALS|CUSTOM_IDENTIFIER',
            'id' => '<string>',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

There are no errors described for this operation.

ListMembers

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

Retrieves information about the accounts that are associated with an Amazon Macie administrator account.

Parameter Syntax

$result = $client->listMembers([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'onlyAssociated' => '<string>',
]);

Parameter Details

Result Syntax

[
    'members' => [
        [
            'accountId' => '<string>',
            'administratorAccountId' => '<string>',
            'arn' => '<string>',
            'email' => '<string>',
            'invitedAt' => <DateTime>,
            'masterAccountId' => '<string>',
            'relationshipStatus' => 'Enabled|Paused|Invited|Created|Removed|Resigned|EmailVerificationInProgress|EmailVerificationFailed|RegionDisabled|AccountSuspended',
            'tags' => ['<string>', ...],
            'updatedAt' => <DateTime>,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ValidationException:

Provides information about an error that occurred due to a syntax error in a request.

InternalServerException:

Provides information about an error that occurred due to an unknown internal server error, exception, or failure.

ServiceQuotaExceededException:

Provides information about an error that occurred due to one or more service quotas for an account.

AccessDeniedException:

Provides information about an error that occurred due to insufficient access to a specified resource.

ResourceNotFoundException:

Provides information about an error that occurred because a specified resource wasn't found.

ThrottlingException:

Provides information about an error that occurred because too many requests were sent during a certain amount of time.

ConflictException:

Provides information about an error that occurred due to a versioning conflict for a specified resource.

ListOrganizationAdminAccounts

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

Retrieves information about the delegated Amazon Macie administrator account for an organization in Organizations.

Parameter Syntax

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

Parameter Details

Result Syntax

[
    'adminAccounts' => [
        [
            'accountId' => '<string>',
            'status' => 'ENABLED|DISABLING_IN_PROGRESS',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ValidationException:

Provides information about an error that occurred due to a syntax error in a request.

InternalServerException:

Provides information about an error that occurred due to an unknown internal server error, exception, or failure.

ServiceQuotaExceededException:

Provides information about an error that occurred due to one or more service quotas for an account.

AccessDeniedException:

Provides information about an error that occurred due to insufficient access to a specified resource.

ResourceNotFoundException:

Provides information about an error that occurred because a specified resource wasn't found.

ThrottlingException:

Provides information about an error that occurred because too many requests were sent during a certain amount of time.

ConflictException:

Provides information about an error that occurred due to a versioning conflict for a specified resource.

ListResourceProfileArtifacts

$result = $client->listResourceProfileArtifacts([/* ... */]);
$promise = $client->listResourceProfileArtifactsAsync([/* ... */]);

Retrieves information about objects that were selected from an S3 bucket for automated sensitive data discovery.

Parameter Syntax

$result = $client->listResourceProfileArtifacts([
    'nextToken' => '<string>',
    'resourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'artifacts' => [
        [
            'arn' => '<string>',
            'classificationResultStatus' => '<string>',
            'sensitive' => true || false,
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

Provides information about an error that occurred because a specified resource wasn't found.

ThrottlingException:

Provides information about an error that occurred because too many requests were sent during a certain amount of time.

ValidationException:

Provides information about an error that occurred due to a syntax error in a request.

InternalServerException:

Provides information about an error that occurred due to an unknown internal server error, exception, or failure.

AccessDeniedException:

Provides information about an error that occurred due to insufficient access to a specified resource.

ListResourceProfileDetections

$result = $client->listResourceProfileDetections([/* ... */]);
$promise = $client->listResourceProfileDetectionsAsync([/* ... */]);

Retrieves information about the types and amount of sensitive data that Amazon Macie found in an S3 bucket.

Parameter Syntax

$result = $client->listResourceProfileDetections([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'resourceArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'detections' => [
        [
            'arn' => '<string>',
            'count' => <integer>,
            'id' => '<string>',
            'name' => '<string>',
            'suppressed' => true || false,
            'type' => 'CUSTOM|MANAGED',
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ValidationException:

Provides information about an error that occurred due to a syntax error in a request.

InternalServerException:

Provides information about an error that occurred due to an unknown internal server error, exception, or failure.

ServiceQuotaExceededException:

Provides information about an error that occurred due to one or more service quotas for an account.

AccessDeniedException:

Provides information about an error that occurred due to insufficient access to a specified resource.

ResourceNotFoundException:

Provides information about an error that occurred because a specified resource wasn't found.

ThrottlingException:

Provides information about an error that occurred because too many requests were sent during a certain amount of time.

ListSensitivityInspectionTemplates

$result = $client->listSensitivityInspectionTemplates([/* ... */]);
$promise = $client->listSensitivityInspectionTemplatesAsync([/* ... */]);

Retrieves a subset of information about the sensitivity inspection template for an account.

Parameter Syntax

$result = $client->listSensitivityInspectionTemplates([
    'maxResults' => <integer>,
    'nextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'nextToken' => '<string>',
    'sensitivityInspectionTemplates' => [
        [
            'id' => '<string>',
            'name' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ThrottlingException:

Provides information about an error that occurred because too many requests were sent during a certain amount of time.

ValidationException:

Provides information about an error that occurred due to a syntax error in a request.

InternalServerException:

Provides information about an error that occurred due to an unknown internal server error, exception, or failure.

ServiceQuotaExceededException:

Provides information about an error that occurred due to one or more service quotas for an account.

AccessDeniedException:

Provides information about an error that occurred due to insufficient access to a specified resource.

ListTagsForResource

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

Retrieves the tags (keys and values) that are associated with an Amazon Macie resource.

Parameter Syntax

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

Parameter Details

Result Syntax

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

Result Details

Errors

There are no errors described for this operation.

PutClassificationExportConfiguration

$result = $client->putClassificationExportConfiguration([/* ... */]);
$promise = $client->putClassificationExportConfigurationAsync([/* ... */]);

Creates or updates the configuration settings for storing data classification results.

Parameter Syntax

$result = $client->putClassificationExportConfiguration([
    'configuration' => [ // REQUIRED
        's3Destination' => [
            'bucketName' => '<string>', // REQUIRED
            'keyPrefix' => '<string>',
            'kmsKeyArn' => '<string>', // REQUIRED
        ],
    ],
]);

Parameter Details

Result Syntax

[
    'configuration' => [
        's3Destination' => [
            'bucketName' => '<string>',
            'keyPrefix' => '<string>',
            'kmsKeyArn' => '<string>',
        ],
    ],
]

Result Details

Errors

ValidationException:

Provides information about an error that occurred due to a syntax error in a request.

InternalServerException:

Provides information about an error that occurred due to an unknown internal server error, exception, or failure.

ServiceQuotaExceededException:

Provides information about an error that occurred due to one or more service quotas for an account.

AccessDeniedException:

Provides information about an error that occurred due to insufficient access to a specified resource.

ResourceNotFoundException:

Provides information about an error that occurred because a specified resource wasn't found.

ThrottlingException:

Provides information about an error that occurred because too many requests were sent during a certain amount of time.

ConflictException:

Provides information about an error that occurred due to a versioning conflict for a specified resource.

PutFindingsPublicationConfiguration

$result = $client->putFindingsPublicationConfiguration([/* ... */]);
$promise = $client->putFindingsPublicationConfigurationAsync([/* ... */]);

Updates the configuration settings for publishing findings to Security Hub.

Parameter Syntax

$result = $client->putFindingsPublicationConfiguration([
    'clientToken' => '<string>',
    'securityHubConfiguration' => [
        'publishClassificationFindings' => true || false, // REQUIRED
        'publishPolicyFindings' => true || false, // REQUIRED
    ],
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

Provides information about an error that occurred due to a syntax error in a request.

InternalServerException:

Provides information about an error that occurred due to an unknown internal server error, exception, or failure.

ServiceQuotaExceededException:

Provides information about an error that occurred due to one or more service quotas for an account.

AccessDeniedException:

Provides information about an error that occurred due to insufficient access to a specified resource.

ResourceNotFoundException:

Provides information about an error that occurred because a specified resource wasn't found.

ThrottlingException:

Provides information about an error that occurred because too many requests were sent during a certain amount of time.

ConflictException:

Provides information about an error that occurred due to a versioning conflict for a specified resource.

SearchResources

$result = $client->searchResources([/* ... */]);
$promise = $client->searchResourcesAsync([/* ... */]);

Retrieves (queries) statistical data and other information about Amazon Web Services resources that Amazon Macie monitors and analyzes.

Parameter Syntax

$result = $client->searchResources([
    'bucketCriteria' => [
        'excludes' => [
            'and' => [
                [
                    'simpleCriterion' => [
                        'comparator' => 'EQ|NE',
                        'key' => 'ACCOUNT_ID|S3_BUCKET_NAME|S3_BUCKET_EFFECTIVE_PERMISSION|S3_BUCKET_SHARED_ACCESS',
                        'values' => ['<string>', ...],
                    ],
                    'tagCriterion' => [
                        'comparator' => 'EQ|NE',
                        'tagValues' => [
                            [
                                'key' => '<string>',
                                'value' => '<string>',
                            ],
                            // ...
                        ],
                    ],
                ],
                // ...
            ],
        ],
        'includes' => [
            'and' => [
                [
                    'simpleCriterion' => [
                        'comparator' => 'EQ|NE',
                        'key' => 'ACCOUNT_ID|S3_BUCKET_NAME|S3_BUCKET_EFFECTIVE_PERMISSION|S3_BUCKET_SHARED_ACCESS',
                        'values' => ['<string>', ...],
                    ],
                    'tagCriterion' => [
                        'comparator' => 'EQ|NE',
                        'tagValues' => [
                            [
                                'key' => '<string>',
                                'value' => '<string>',
                            ],
                            // ...
                        ],
                    ],
                ],
                // ...
            ],
        ],
    ],
    'maxResults' => <integer>,
    'nextToken' => '<string>',
    'sortCriteria' => [
        'attributeName' => 'ACCOUNT_ID|RESOURCE_NAME|S3_CLASSIFIABLE_OBJECT_COUNT|S3_CLASSIFIABLE_SIZE_IN_BYTES',
        'orderBy' => 'ASC|DESC',
    ],
]);

Parameter Details

Result Syntax

[
    'matchingResources' => [
        [
            'matchingBucket' => [
                'accountId' => '<string>',
                'bucketName' => '<string>',
                'classifiableObjectCount' => <integer>,
                'classifiableSizeInBytes' => <integer>,
                'errorCode' => 'ACCESS_DENIED',
                'errorMessage' => '<string>',
                'jobDetails' => [
                    'isDefinedInJob' => 'TRUE|FALSE|UNKNOWN',
                    'isMonitoredByJob' => 'TRUE|FALSE|UNKNOWN',
                    'lastJobId' => '<string>',
                    'lastJobRunTime' => <DateTime>,
                ],
                'lastAutomatedDiscoveryTime' => <DateTime>,
                'objectCount' => <integer>,
                'objectCountByEncryptionType' => [
                    'customerManaged' => <integer>,
                    'kmsManaged' => <integer>,
                    's3Managed' => <integer>,
                    'unencrypted' => <integer>,
                    'unknown' => <integer>,
                ],
                'sensitivityScore' => <integer>,
                'sizeInBytes' => <integer>,
                'sizeInBytesCompressed' => <integer>,
                'unclassifiableObjectCount' => [
                    'fileType' => <integer>,
                    'storageClass' => <integer>,
                    'total' => <integer>,
                ],
                'unclassifiableObjectSizeInBytes' => [
                    'fileType' => <integer>,
                    'storageClass' => <integer>,
                    'total' => <integer>,
                ],
            ],
        ],
        // ...
    ],
    'nextToken' => '<string>',
]

Result Details

Errors

ValidationException:

Provides information about an error that occurred due to a syntax error in a request.

InternalServerException:

Provides information about an error that occurred due to an unknown internal server error, exception, or failure.

ServiceQuotaExceededException:

Provides information about an error that occurred due to one or more service quotas for an account.

AccessDeniedException:

Provides information about an error that occurred due to insufficient access to a specified resource.

ResourceNotFoundException:

Provides information about an error that occurred because a specified resource wasn't found.

ThrottlingException:

Provides information about an error that occurred because too many requests were sent during a certain amount of time.

ConflictException:

Provides information about an error that occurred due to a versioning conflict for a specified resource.

TagResource

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

Adds or updates one or more tags (keys and values) that are associated with an Amazon Macie resource.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

There are no errors described for this operation.

TestCustomDataIdentifier

$result = $client->testCustomDataIdentifier([/* ... */]);
$promise = $client->testCustomDataIdentifierAsync([/* ... */]);

Tests a custom data identifier.

Parameter Syntax

$result = $client->testCustomDataIdentifier([
    'ignoreWords' => ['<string>', ...],
    'keywords' => ['<string>', ...],
    'maximumMatchDistance' => <integer>,
    'regex' => '<string>', // REQUIRED
    'sampleText' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'matchCount' => <integer>,
]

Result Details

Errors

ValidationException:

Provides information about an error that occurred due to a syntax error in a request.

InternalServerException:

Provides information about an error that occurred due to an unknown internal server error, exception, or failure.

ServiceQuotaExceededException:

Provides information about an error that occurred due to one or more service quotas for an account.

AccessDeniedException:

Provides information about an error that occurred due to insufficient access to a specified resource.

ResourceNotFoundException:

Provides information about an error that occurred because a specified resource wasn't found.

ThrottlingException:

Provides information about an error that occurred because too many requests were sent during a certain amount of time.

ConflictException:

Provides information about an error that occurred due to a versioning conflict for a specified resource.

UntagResource

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

Removes one or more tags (keys and values) from an Amazon Macie resource.

Parameter Syntax

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

Parameter Details

Result Syntax

[]

Result Details

Errors

There are no errors described for this operation.

UpdateAllowList

$result = $client->updateAllowList([/* ... */]);
$promise = $client->updateAllowListAsync([/* ... */]);

Updates the settings for an allow list.

Parameter Syntax

$result = $client->updateAllowList([
    'criteria' => [ // REQUIRED
        'regex' => '<string>',
        's3WordsList' => [
            'bucketName' => '<string>', // REQUIRED
            'objectKey' => '<string>', // REQUIRED
        ],
    ],
    'description' => '<string>',
    'id' => '<string>', // REQUIRED
    'name' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'arn' => '<string>',
    'id' => '<string>',
]

Result Details

Errors

ResourceNotFoundException:

Provides information about an error that occurred because a specified resource wasn't found.

ThrottlingException:

Provides information about an error that occurred because too many requests were sent during a certain amount of time.

ValidationException:

Provides information about an error that occurred due to a syntax error in a request.

InternalServerException:

Provides information about an error that occurred due to an unknown internal server error, exception, or failure.

AccessDeniedException:

Provides information about an error that occurred due to insufficient access to a specified resource.

UpdateAutomatedDiscoveryConfiguration

$result = $client->updateAutomatedDiscoveryConfiguration([/* ... */]);
$promise = $client->updateAutomatedDiscoveryConfigurationAsync([/* ... */]);

Enables or disables automated sensitive data discovery for an account.

Parameter Syntax

$result = $client->updateAutomatedDiscoveryConfiguration([
    'status' => 'ENABLED|DISABLED', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ThrottlingException:

Provides information about an error that occurred because too many requests were sent during a certain amount of time.

ValidationException:

Provides information about an error that occurred due to a syntax error in a request.

InternalServerException:

Provides information about an error that occurred due to an unknown internal server error, exception, or failure.

AccessDeniedException:

Provides information about an error that occurred due to insufficient access to a specified resource.

UpdateClassificationJob

$result = $client->updateClassificationJob([/* ... */]);
$promise = $client->updateClassificationJobAsync([/* ... */]);

Changes the status of a classification job.

Parameter Syntax

$result = $client->updateClassificationJob([
    'jobId' => '<string>', // REQUIRED
    'jobStatus' => 'RUNNING|PAUSED|CANCELLED|COMPLETE|IDLE|USER_PAUSED', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

Provides information about an error that occurred due to a syntax error in a request.

InternalServerException:

Provides information about an error that occurred due to an unknown internal server error, exception, or failure.

ServiceQuotaExceededException:

Provides information about an error that occurred due to one or more service quotas for an account.

AccessDeniedException:

Provides information about an error that occurred due to insufficient access to a specified resource.

ResourceNotFoundException:

Provides information about an error that occurred because a specified resource wasn't found.

ThrottlingException:

Provides information about an error that occurred because too many requests were sent during a certain amount of time.

ConflictException:

Provides information about an error that occurred due to a versioning conflict for a specified resource.

UpdateClassificationScope

$result = $client->updateClassificationScope([/* ... */]);
$promise = $client->updateClassificationScopeAsync([/* ... */]);

Updates the classification scope settings for an account.

Parameter Syntax

$result = $client->updateClassificationScope([
    'id' => '<string>', // REQUIRED
    's3' => [
        'excludes' => [ // REQUIRED
            'bucketNames' => ['<string>', ...], // REQUIRED
            'operation' => 'ADD|REPLACE|REMOVE', // REQUIRED
        ],
    ],
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ResourceNotFoundException:

Provides information about an error that occurred because a specified resource wasn't found.

ThrottlingException:

Provides information about an error that occurred because too many requests were sent during a certain amount of time.

ValidationException:

Provides information about an error that occurred due to a syntax error in a request.

InternalServerException:

Provides information about an error that occurred due to an unknown internal server error, exception, or failure.

AccessDeniedException:

Provides information about an error that occurred due to insufficient access to a specified resource.

UpdateFindingsFilter

$result = $client->updateFindingsFilter([/* ... */]);
$promise = $client->updateFindingsFilterAsync([/* ... */]);

Updates the criteria and other settings for a findings filter.

Parameter Syntax

$result = $client->updateFindingsFilter([
    'action' => 'ARCHIVE|NOOP',
    'clientToken' => '<string>',
    'description' => '<string>',
    'findingCriteria' => [
        'criterion' => [
            '<__string>' => [
                'eq' => ['<string>', ...],
                'eqExactMatch' => ['<string>', ...],
                'gt' => <integer>,
                'gte' => <integer>,
                'lt' => <integer>,
                'lte' => <integer>,
                'neq' => ['<string>', ...],
            ],
            // ...
        ],
    ],
    'id' => '<string>', // REQUIRED
    'name' => '<string>',
    'position' => <integer>,
]);

Parameter Details

Result Syntax

[
    'arn' => '<string>',
    'id' => '<string>',
]

Result Details

Errors

ValidationException:

Provides information about an error that occurred due to a syntax error in a request.

InternalServerException:

Provides information about an error that occurred due to an unknown internal server error, exception, or failure.

ServiceQuotaExceededException:

Provides information about an error that occurred due to one or more service quotas for an account.

AccessDeniedException:

Provides information about an error that occurred due to insufficient access to a specified resource.

ResourceNotFoundException:

Provides information about an error that occurred because a specified resource wasn't found.

ThrottlingException:

Provides information about an error that occurred because too many requests were sent during a certain amount of time.

ConflictException:

Provides information about an error that occurred due to a versioning conflict for a specified resource.