Amazon Macie 2 2020-01-01
- Client: Aws\Macie2\Macie2Client
- Service ID: macie2
- Version: 2020-01-01
This page describes the parameters and results for the operations of the Amazon Macie 2 (2020-01-01), and shows how to use the Aws\Macie2\Macie2Client object to call the described operations. This documentation is specific to the 2020-01-01 API version of the service.
Operation Summary
Each of the following operations can be created from a client using
$client->getCommand('CommandName'), where "CommandName" is the
name of one of the following operations. Note: a command is a value that
encapsulates an operation and the parameters used to create an HTTP request.
You can also create and send a command immediately using the magic methods
available on a client object: $client->commandName(/* parameters */).
You can send the command asynchronously (returning a promise) by appending the
word "Async" to the operation name: $client->commandNameAsync(/* parameters */).
- AcceptInvitation ( array $params = [] )
Accepts an Amazon Macie membership invitation that was received from a specific account.
- BatchGetCustomDataIdentifiers ( array $params = [] )
Retrieves information about one or more custom data identifiers.
- CreateClassificationJob ( array $params = [] )
Creates and defines the settings for a classification job.
- CreateCustomDataIdentifier ( array $params = [] )
Creates and defines the criteria and other settings for a custom data identifier.
- CreateFindingsFilter ( array $params = [] )
Creates and defines the criteria and other settings for a findings filter.
- CreateInvitations ( array $params = [] )
Sends an Amazon Macie membership invitation to one or more accounts.
- CreateMember ( array $params = [] )
Associates an account with an Amazon Macie master account.
- CreateSampleFindings ( array $params = [] )
Creates sample findings.
- DeclineInvitations ( array $params = [] )
Declines Amazon Macie membership invitations that were received from specific accounts.
- DeleteCustomDataIdentifier ( array $params = [] )
Soft deletes a custom data identifier.
- DeleteFindingsFilter ( array $params = [] )
Deletes a findings filter.
- DeleteInvitations ( array $params = [] )
Deletes Amazon Macie membership invitations that were received from specific accounts.
- DeleteMember ( array $params = [] )
Deletes the association between an Amazon Macie master account and an account.
- DescribeBuckets ( array $params = [] )
Retrieves (queries) statistical data and other information about one or more S3 buckets that Amazon Macie monitors and analyzes.
- DescribeClassificationJob ( array $params = [] )
Retrieves the status and settings for a classification job.
- DescribeOrganizationConfiguration ( array $params = [] )
Retrieves the Amazon Macie configuration settings for an AWS organization.
- DisableMacie ( array $params = [] )
Disables an Amazon Macie account and deletes Macie resources for the account.
- DisableOrganizationAdminAccount ( array $params = [] )
Disables an account as the delegated Amazon Macie administrator account for an AWS organization.
- DisassociateFromMasterAccount ( array $params = [] )
Disassociates a member account from its Amazon Macie master account.
- DisassociateMember ( array $params = [] )
Disassociates an Amazon Macie master account from a member account.
- EnableMacie ( array $params = [] )
Enables Amazon Macie and specifies the configuration settings for a Macie account.
- EnableOrganizationAdminAccount ( array $params = [] )
Designates an account as the delegated Amazon Macie administrator account for an AWS organization.
- GetBucketStatistics ( array $params = [] )
Retrieves (queries) aggregated statistical data for all the S3 buckets that Amazon Macie monitors and analyzes.
- GetClassificationExportConfiguration ( array $params = [] )
Retrieves the configuration settings for storing data classification results.
- GetCustomDataIdentifier ( array $params = [] )
Retrieves the criteria and other settings for a custom data identifier.
- GetFindingStatistics ( array $params = [] )
Retrieves (queries) aggregated statistical data about findings.
- GetFindings ( array $params = [] )
Retrieves the details of one or more findings.
- GetFindingsFilter ( array $params = [] )
Retrieves the criteria and other settings for a findings filter.
- GetInvitationsCount ( array $params = [] )
Retrieves the count of Amazon Macie membership invitations that were received by an account.
- GetMacieSession ( array $params = [] )
Retrieves the current status and configuration settings for an Amazon Macie account.
- GetMasterAccount ( array $params = [] )
Retrieves information about the Amazon Macie master account for an account.
- GetMember ( array $params = [] )
Retrieves information about a member account that's associated with an Amazon Macie master account.
- GetUsageStatistics ( array $params = [] )
Retrieves (queries) quotas and aggregated usage data for one or more accounts.
- GetUsageTotals ( array $params = [] )
Retrieves (queries) aggregated usage data for an account.
- ListClassificationJobs ( array $params = [] )
Retrieves a subset of information about one or more classification jobs.
- ListCustomDataIdentifiers ( array $params = [] )
Retrieves a subset of information about all the custom data identifiers for an account.
- ListFindings ( array $params = [] )
Retrieves a subset of information about one or more findings.
- ListFindingsFilters ( array $params = [] )
Retrieves a subset of information about all the findings filters for an account.
- ListInvitations ( array $params = [] )
Retrieves information about all the Amazon Macie membership invitations that were received by an account.
- ListMembers ( array $params = [] )
Retrieves information about the accounts that are associated with an Amazon Macie master account.
- ListOrganizationAdminAccounts ( array $params = [] )
Retrieves information about the delegated Amazon Macie administrator account for an AWS organization.
- ListTagsForResource ( array $params = [] )
Retrieves the tags (keys and values) that are associated with a classification job, custom data identifier, findings filter, or member account.
- PutClassificationExportConfiguration ( array $params = [] )
Creates or updates the configuration settings for storing data classification results.
- TagResource ( array $params = [] )
Adds or updates one or more tags (keys and values) that are associated with a classification job, custom data identifier, findings filter, or member account.
- TestCustomDataIdentifier ( array $params = [] )
Tests a custom data identifier.
- UntagResource ( array $params = [] )
Removes one or more tags (keys and values) from a classification job, custom data identifier, findings filter, or member account.
- UpdateClassificationJob ( array $params = [] )
Changes the status of a classification job.
- UpdateFindingsFilter ( array $params = [] )
Updates the criteria and other settings for a findings filter.
- UpdateMacieSession ( array $params = [] )
Suspends or re-enables an Amazon Macie account, or updates the configuration settings for a Macie account.
- UpdateMemberSession ( array $params = [] )
Enables an Amazon Macie master account to suspend or re-enable a member account.
- UpdateOrganizationConfiguration ( array $params = [] )
Updates the Amazon Macie configuration settings for an AWS organization.
Paginators
Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:
Operations
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([
'invitationId' => '<string>', // REQUIRED
'masterAccount' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[]
Result Details
Errors
-
Provides information about an error that occurred due to a syntax error in a request.
-
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.
-
Provides information about an error that occurred due to insufficient access to a specified resource.
-
Provides information about an error that occurred because a specified resource wasn't found.
-
Provides information about an error that occurred because too many requests were sent during a certain amount of time.
-
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
Members
- customDataIdentifiers
-
- Type: Array of BatchGetCustomDataIdentifierSummary structures
- notFoundIdentifierIds
-
- Type: Array of strings
Errors
-
Provides information about an error that occurred due to a syntax error in a request.
-
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.
-
Provides information about an error that occurred due to insufficient access to a specified resource.
-
Provides information about an error that occurred because a specified resource wasn't found.
-
Provides information about an error that occurred because too many requests were sent during a certain amount of time.
-
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([
'clientToken' => '<string>', // REQUIRED
'customDataIdentifierIds' => ['<string>', ...],
'description' => '<string>',
'initialRun' => true || false,
'jobType' => 'ONE_TIME|SCHEDULED', // REQUIRED
'name' => '<string>', // REQUIRED
's3JobDefinition' => [ // REQUIRED
'bucketDefinitions' => [
[
'accountId' => '<string>',
'buckets' => ['<string>', ...],
],
// ...
],
'scoping' => [
'excludes' => [
'and' => [
[
'simpleScopeTerm' => [
'comparator' => 'EQ|GT|GTE|LT|LTE|NE|CONTAINS',
'key' => 'BUCKET_CREATION_DATE|OBJECT_EXTENSION|OBJECT_LAST_MODIFIED_DATE|OBJECT_SIZE|TAG',
'values' => ['<string>', ...],
],
'tagScopeTerm' => [
'comparator' => 'EQ|GT|GTE|LT|LTE|NE|CONTAINS',
'key' => '<string>',
'tagValues' => [
[
'key' => '<string>',
'value' => '<string>',
],
// ...
],
'target' => 'S3_OBJECT',
],
],
// ...
],
],
'includes' => [
'and' => [
[
'simpleScopeTerm' => [
'comparator' => 'EQ|GT|GTE|LT|LTE|NE|CONTAINS',
'key' => 'BUCKET_CREATION_DATE|OBJECT_EXTENSION|OBJECT_LAST_MODIFIED_DATE|OBJECT_SIZE|TAG',
'values' => ['<string>', ...],
],
'tagScopeTerm' => [
'comparator' => 'EQ|GT|GTE|LT|LTE|NE|CONTAINS',
'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
Members
- clientToken
-
- Required: Yes
- Type: string
- customDataIdentifierIds
-
- Type: Array of strings
- description
-
- Type: string
- initialRun
-
- Type: boolean
- jobType
-
- Required: Yes
- Type: string
The schedule for running a classification job. Valid values are:
- name
-
- Required: Yes
- Type: string
- s3JobDefinition
-
- Required: Yes
- Type: S3JobDefinition structure
Specifies which S3 buckets contain the objects that a classification job analyzes, and the scope of that analysis.
- samplingPercentage
-
- Type: int
- scheduleFrequency
-
- Type: JobScheduleFrequency structure
Specifies the recurrence pattern for running a classification job.
- tags
-
- Type: Associative array of custom strings keys (__string) to strings
A string-to-string map of key-value pairs that specifies the tags (keys and values) for a classification job, custom data identifier, findings filter, or member account.
Result Syntax
[
'jobArn' => '<string>',
'jobId' => '<string>',
]
Result Details
Errors
-
Provides information about an error that occurred due to a syntax error in a request.
-
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.
-
Provides information about an error that occurred due to insufficient access to a specified resource.
-
Provides information about an error that occurred because a specified resource wasn't found.
-
Provides information about an error that occurred because too many requests were sent during a certain amount of time.
-
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>',
'regex' => '<string>',
'tags' => ['<string>', ...],
]);
Parameter Details
Members
- clientToken
-
- Type: string
- description
-
- Type: string
- ignoreWords
-
- Type: Array of strings
- keywords
-
- Type: Array of strings
- maximumMatchDistance
-
- Type: int
- name
-
- Type: string
- regex
-
- Type: string
- tags
-
- Type: Associative array of custom strings keys (__string) to strings
A string-to-string map of key-value pairs that specifies the tags (keys and values) for a classification job, custom data identifier, findings filter, or member account.
Result Syntax
[
'customDataIdentifierId' => '<string>',
]
Result Details
Errors
-
Provides information about an error that occurred due to a syntax error in a request.
-
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.
-
Provides information about an error that occurred due to insufficient access to a specified resource.
-
Provides information about an error that occurred because a specified resource wasn't found.
-
Provides information about an error that occurred because too many requests were sent during a certain amount of time.
-
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
Members
- action
-
- Required: Yes
- Type: string
The action to perform on findings that meet the filter criteria. To suppress (automatically archive) findings that meet the criteria, set this value to ARCHIVE. Valid values are:
- clientToken
-
- Type: string
- description
-
- Type: string
- findingCriteria
-
- Required: Yes
- Type: FindingCriteria structure
Specifies, as a map, one or more property-based conditions that filter the results of a query for findings.
- name
-
- Required: Yes
- Type: string
- position
-
- Type: int
- tags
-
- Type: Associative array of custom strings keys (__string) to strings
A string-to-string map of key-value pairs that specifies the tags (keys and values) for a classification job, custom data identifier, findings filter, or member account.
Result Syntax
[
'arn' => '<string>',
'id' => '<string>',
]
Result Details
Errors
-
Provides information about an error that occurred due to a syntax error in a request.
-
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.
-
Provides information about an error that occurred due to insufficient access to a specified resource.
-
Provides information about an error that occurred because a specified resource wasn't found.
-
Provides information about an error that occurred because too many requests were sent during a certain amount of time.
-
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
Members
Result Syntax
[
'unprocessedAccounts' => [
[
'accountId' => '<string>',
'errorCode' => 'ClientError|InternalError',
'errorMessage' => '<string>',
],
// ...
],
]
Result Details
Members
- unprocessedAccounts
-
- Type: Array of UnprocessedAccount structures
Errors
-
Provides information about an error that occurred due to a syntax error in a request.
-
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.
-
Provides information about an error that occurred due to insufficient access to a specified resource.
-
Provides information about an error that occurred because a specified resource wasn't found.
-
Provides information about an error that occurred because too many requests were sent during a certain amount of time.
-
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 master account.
Parameter Syntax
$result = $client->createMember([
'account' => [ // REQUIRED
'accountId' => '<string>', // REQUIRED
'email' => '<string>', // REQUIRED
],
'tags' => ['<string>', ...],
]);
Parameter Details
Members
- account
-
- Required: Yes
- Type: AccountDetail structure
Specifies details for an account to associate with an Amazon Macie master account.
- tags
-
- Type: Associative array of custom strings keys (__string) to strings
A string-to-string map of key-value pairs that specifies the tags (keys and values) for a classification job, custom data identifier, findings filter, or member account.
Result Syntax
[
'arn' => '<string>',
]
Result Details
Errors
-
Provides information about an error that occurred due to a syntax error in a request.
-
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.
-
Provides information about an error that occurred due to insufficient access to a specified resource.
-
Provides information about an error that occurred because a specified resource wasn't found.
-
Provides information about an error that occurred because too many requests were sent during a certain amount of time.
-
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
-
Provides information about an error that occurred due to a syntax error in a request.
-
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.
-
Provides information about an error that occurred due to insufficient access to a specified resource.
-
Provides information about an error that occurred because a specified resource wasn't found.
-
Provides information about an error that occurred because too many requests were sent during a certain amount of time.
-
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
Members
- unprocessedAccounts
-
- Type: Array of UnprocessedAccount structures
Errors
-
Provides information about an error that occurred due to a syntax error in a request.
-
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.
-
Provides information about an error that occurred due to insufficient access to a specified resource.
-
Provides information about an error that occurred because a specified resource wasn't found.
-
Provides information about an error that occurred because too many requests were sent during a certain amount of time.
-
Provides information about an error that occurred due to a versioning conflict for 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
-
Provides information about an error that occurred due to a syntax error in a request.
-
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.
-
Provides information about an error that occurred due to insufficient access to a specified resource.
-
Provides information about an error that occurred because a specified resource wasn't found.
-
Provides information about an error that occurred because too many requests were sent during a certain amount of time.
-
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
-
Provides information about an error that occurred due to a syntax error in a request.
-
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.
-
Provides information about an error that occurred due to insufficient access to a specified resource.
-
Provides information about an error that occurred because a specified resource wasn't found.
-
Provides information about an error that occurred because too many requests were sent during a certain amount of time.
-
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
Members
- unprocessedAccounts
-
- Type: Array of UnprocessedAccount structures
Errors
-
Provides information about an error that occurred due to a syntax error in a request.
-
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.
-
Provides information about an error that occurred due to insufficient access to a specified resource.
-
Provides information about an error that occurred because a specified resource wasn't found.
-
Provides information about an error that occurred because too many requests were sent during a certain amount of time.
-
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 master account and an account.
Parameter Syntax
$result = $client->deleteMember([
'id' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[]
Result Details
Errors
-
Provides information about an error that occurred due to a syntax error in a request.
-
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.
-
Provides information about an error that occurred due to insufficient access to a specified resource.
-
Provides information about an error that occurred because a specified resource wasn't found.
-
Provides information about an error that occurred because too many requests were sent during a certain amount of time.
-
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.
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
Members
- criteria
-
- Type: Associative array of custom strings keys (__string) to BucketCriteriaAdditionalProperties structures
Specifies, as a map, one or more property-based conditions that filter the results of a query for information about S3 buckets.
- maxResults
-
- Type: int
- nextToken
-
- Type: string
- sortCriteria
-
- Type: BucketSortCriteria structure
Specifies criteria for sorting the results of a query for information about S3 buckets.
Result Syntax
[
'buckets' => [
[
'accountId' => '<string>',
'bucketArn' => '<string>',
'bucketCreatedAt' => <DateTime>,
'bucketName' => '<string>',
'classifiableObjectCount' => <integer>,
'classifiableSizeInBytes' => <integer>,
'jobDetails' => [
'isDefinedInJob' => 'TRUE|FALSE|UNKNOWN',
'isMonitoredByJob' => 'TRUE|FALSE|UNKNOWN',
'lastJobId' => '<string>',
'lastJobRunTime' => <DateTime>,
],
'lastUpdated' => <DateTime>,
'objectCount' => <integer>,
'objectCountByEncryptionType' => [
'customerManaged' => <integer>,
'kmsManaged' => <integer>,
's3Managed' => <integer>,
'unencrypted' => <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>', ...],
],
'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
Members
- buckets
-
- Type: Array of BucketMetadata structures
- nextToken
-
- Type: string
Errors
-
Provides information about an error that occurred due to a syntax error in a request.
-
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.
-
Provides information about an error that occurred due to insufficient access to a specified resource.
-
Provides information about an error that occurred because a specified resource wasn't found.
-
Provides information about an error that occurred because too many requests were sent during a certain amount of time.
-
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
[
'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>,
'name' => '<string>',
's3JobDefinition' => [
'bucketDefinitions' => [
[
'accountId' => '<string>',
'buckets' => ['<string>', ...],
],
// ...
],
'scoping' => [
'excludes' => [
'and' => [
[
'simpleScopeTerm' => [
'comparator' => 'EQ|GT|GTE|LT|LTE|NE|CONTAINS',
'key' => 'BUCKET_CREATION_DATE|OBJECT_EXTENSION|OBJECT_LAST_MODIFIED_DATE|OBJECT_SIZE|TAG',
'values' => ['<string>', ...],
],
'tagScopeTerm' => [
'comparator' => 'EQ|GT|GTE|LT|LTE|NE|CONTAINS',
'key' => '<string>',
'tagValues' => [
[
'key' => '<string>',
'value' => '<string>',
],
// ...
],
'target' => 'S3_OBJECT',
],
],
// ...
],
],
'includes' => [
'and' => [
[
'simpleScopeTerm' => [
'comparator' => 'EQ|GT|GTE|LT|LTE|NE|CONTAINS',
'key' => 'BUCKET_CREATION_DATE|OBJECT_EXTENSION|OBJECT_LAST_MODIFIED_DATE|OBJECT_SIZE|TAG',
'values' => ['<string>', ...],
],
'tagScopeTerm' => [
'comparator' => 'EQ|GT|GTE|LT|LTE|NE|CONTAINS',
'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
Members
- clientToken
-
- Type: string
- createdAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- customDataIdentifierIds
-
- Type: Array of strings
- description
-
- Type: string
- initialRun
-
- Type: boolean
- jobArn
-
- Type: string
- jobId
-
- Type: string
- jobStatus
-
- Type: string
The status of a classification job. Possible values are:
- jobType
-
- Type: string
The schedule for running a classification job. Valid values are:
- lastRunErrorStatus
-
- Type: LastRunErrorStatus structure
Specifies whether any account- or bucket-level access errors occurred when a classification job ran. For example, the job is configured to analyze data for a member account that was suspended, or the job is configured to analyze an S3 bucket that Amazon Macie isn't allowed to access.
- lastRunTime
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- name
-
- Type: string
- s3JobDefinition
-
- Type: S3JobDefinition structure
Specifies which S3 buckets contain the objects that a classification job analyzes, and the scope of that analysis.
- samplingPercentage
-
- Type: int
- scheduleFrequency
-
- Type: JobScheduleFrequency structure
Specifies the recurrence pattern for running a classification job.
- statistics
-
- Type: Statistics structure
Provides processing statistics for a classification job.
- tags
-
- Type: Associative array of custom strings keys (__string) to strings
A string-to-string map of key-value pairs that specifies the tags (keys and values) for a classification job, custom data identifier, findings filter, or member account.
- userPausedDetails
-
- Type: UserPausedDetails structure
Provides information about when a classification job was paused. For a one-time job, this object also specifies when the job will expire and be cancelled if it isn't resumed. For a recurring job, this object also specifies when the paused job run will expire and be cancelled if it isn't resumed. This object is present only if a job's current status (jobStatus) is USER_PAUSED. The information in this object applies only to a job that was paused while it had a status of RUNNING.
Errors
-
Provides information about an error that occurred due to a syntax error in a request.
-
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.
-
Provides information about an error that occurred due to insufficient access to a specified resource.
-
Provides information about an error that occurred because a specified resource wasn't found.
-
Provides information about an error that occurred because too many requests were sent during a certain amount of time.
-
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 AWS organization.
Parameter Syntax
$result = $client->describeOrganizationConfiguration([ ]);
Parameter Details
Members
Result Syntax
[
'autoEnable' => true || false,
'maxAccountLimitReached' => true || false,
]
Result Details
Errors
-
Provides information about an error that occurred due to a syntax error in a request.
-
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.
-
Provides information about an error that occurred due to insufficient access to a specified resource.
-
Provides information about an error that occurred because a specified resource wasn't found.
-
Provides information about an error that occurred because too many requests were sent during a certain amount of time.
-
Provides information about an error that occurred due to a versioning conflict for a specified resource.
DisableMacie
$result = $client->disableMacie([/* ... */]); $promise = $client->disableMacieAsync([/* ... */]);
Disables an Amazon Macie account and deletes Macie resources for the account.
Parameter Syntax
$result = $client->disableMacie([ ]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
Provides information about an error that occurred due to a syntax error in a request.
-
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.
-
Provides information about an error that occurred due to insufficient access to a specified resource.
-
Provides information about an error that occurred because a specified resource wasn't found.
-
Provides information about an error that occurred because too many requests were sent during a certain amount of time.
-
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 AWS organization.
Parameter Syntax
$result = $client->disableOrganizationAdminAccount([
'adminAccountId' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[]
Result Details
Errors
-
Provides information about an error that occurred due to a syntax error in a request.
-
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.
-
Provides information about an error that occurred due to insufficient access to a specified resource.
-
Provides information about an error that occurred because a specified resource wasn't found.
-
Provides information about an error that occurred because too many requests were sent during a certain amount of time.
-
Provides information about an error that occurred due to a versioning conflict for a specified resource.
DisassociateFromMasterAccount
$result = $client->disassociateFromMasterAccount([/* ... */]); $promise = $client->disassociateFromMasterAccountAsync([/* ... */]);
Disassociates a member account from its Amazon Macie master account.
Parameter Syntax
$result = $client->disassociateFromMasterAccount([ ]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
Provides information about an error that occurred due to a syntax error in a request.
-
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.
-
Provides information about an error that occurred due to insufficient access to a specified resource.
-
Provides information about an error that occurred because a specified resource wasn't found.
-
Provides information about an error that occurred because too many requests were sent during a certain amount of time.
-
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 master account from a member account.
Parameter Syntax
$result = $client->disassociateMember([
'id' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[]
Result Details
Errors
-
Provides information about an error that occurred due to a syntax error in a request.
-
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.
-
Provides information about an error that occurred due to insufficient access to a specified resource.
-
Provides information about an error that occurred because a specified resource wasn't found.
-
Provides information about an error that occurred because too many requests were sent during a certain amount of time.
-
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
Members
- clientToken
-
- Type: string
- findingPublishingFrequency
-
- Type: string
The frequency with which Amazon Macie publishes updates to policy findings for an account. This includes publishing updates to AWS Security Hub and Amazon EventBridge (formerly called Amazon CloudWatch Events). Valid values are:
- status
-
- Type: string
The status of an Amazon Macie account. Valid values are:
Result Syntax
[]
Result Details
Errors
-
Provides information about an error that occurred due to a syntax error in a request.
-
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.
-
Provides information about an error that occurred due to insufficient access to a specified resource.
-
Provides information about an error that occurred because a specified resource wasn't found.
-
Provides information about an error that occurred because too many requests were sent during a certain amount of time.
-
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 AWS organization.
Parameter Syntax
$result = $client->enableOrganizationAdminAccount([
'adminAccountId' => '<string>', // REQUIRED
'clientToken' => '<string>',
]);
Parameter Details
Result Syntax
[]
Result Details
Errors
-
Provides information about an error that occurred due to a syntax error in a request.
-
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.
-
Provides information about an error that occurred due to insufficient access to a specified resource.
-
Provides information about an error that occurred because a specified resource wasn't found.
-
Provides information about an error that occurred because too many requests were sent during a certain amount of time.
-
Provides information about an error that occurred due to a versioning conflict for a specified resource.
GetBucketStatistics
$result = $client->getBucketStatistics([/* ... */]); $promise = $client->getBucketStatisticsAsync([/* ... */]);
Retrieves (queries) aggregated statistical data for all the S3 buckets that Amazon Macie monitors and analyzes.
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>,
],
'bucketCountBySharedAccessType' => [
'external' => <integer>,
'internal' => <integer>,
'notShared' => <integer>,
'unknown' => <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
Members
- bucketCount
-
- Type: long (int|float)
- bucketCountByEffectivePermission
-
- Type: BucketCountByEffectivePermission structure
Provides information about the number of S3 buckets that are publicly accessible based on a combination of permissions settings for each bucket.
- bucketCountByEncryptionType
-
- Type: BucketCountByEncryptionType structure
Provides information about the number of S3 buckets that use certain types of server-side encryption or don't encrypt objects by default.
- bucketCountBySharedAccessType
-
- Type: BucketCountBySharedAccessType structure
Provides information about the number of S3 buckets that are shared with other AWS accounts.
- classifiableObjectCount
-
- Type: long (int|float)
- classifiableSizeInBytes
-
- Type: long (int|float)
- lastUpdated
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- objectCount
-
- Type: long (int|float)
- sizeInBytes
-
- Type: long (int|float)
- sizeInBytesCompressed
-
- Type: long (int|float)
- unclassifiableObjectCount
-
- Type: ObjectLevelStatistics structure
Provides information about the total storage size (in bytes) or number of objects that Amazon Macie can't analyze in one or more S3 buckets. In a BucketMetadata object, this data is for a specific bucket. In a GetBucketStatisticsResponse object, this data is aggregated for all the buckets in the query results.
- unclassifiableObjectSizeInBytes
-
- Type: ObjectLevelStatistics structure
Provides information about the total storage size (in bytes) or number of objects that Amazon Macie can't analyze in one or more S3 buckets. In a BucketMetadata object, this data is for a specific bucket. In a GetBucketStatisticsResponse object, this data is aggregated for all the buckets in the query results.
Errors
-
Provides information about an error that occurred due to a syntax error in a request.
-
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.
-
Provides information about an error that occurred due to insufficient access to a specified resource.
-
Provides information about an error that occurred because a specified resource wasn't found.
-
Provides information about an error that occurred because too many requests were sent during a certain amount of time.
-
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
Members
Result Syntax
[
'configuration' => [
's3Destination' => [
'bucketName' => '<string>',
'keyPrefix' => '<string>',
'kmsKeyArn' => '<string>',
],
],
]
Result Details
Members
- configuration
-
- Type: ClassificationExportConfiguration structure
Specifies where to store data classification results, and the encryption settings to use when storing results in that location. Currently, you can store classification results only in an S3 bucket.
Errors
-
Provides information about an error that occurred due to a syntax error in a request.
-
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.
-
Provides information about an error that occurred due to insufficient access to a specified resource.
-
Provides information about an error that occurred because a specified resource wasn't found.
-
Provides information about an error that occurred because too many requests were sent during a certain amount of time.
-
Provides information about an error that occurred due to a versioning conflict for 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>',
'tags' => ['<string>', ...],
]
Result Details
Members
- arn
-
- Type: string
- createdAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- deleted
-
- Type: boolean
- description
-
- Type: string
- id
-
- Type: string
- ignoreWords
-
- Type: Array of strings
- keywords
-
- Type: Array of strings
- maximumMatchDistance
-
- Type: int
- name
-
- Type: string
- regex
-
- Type: string
- tags
-
- Type: Associative array of custom strings keys (__string) to strings
A string-to-string map of key-value pairs that specifies the tags (keys and values) for a classification job, custom data identifier, findings filter, or member account.
Errors
-
Provides information about an error that occurred due to a syntax error in a request.
-
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.
-
Provides information about an error that occurred due to insufficient access to a specified resource.
-
Provides information about an error that occurred because a specified resource wasn't found.
-
Provides information about an error that occurred because too many requests were sent during a certain amount of time.
-
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
Members
- findingCriteria
-
- Type: FindingCriteria structure
Specifies, as a map, one or more property-based conditions that filter the results of a query for findings.
- groupBy
-
- Required: Yes
- Type: string
- size
-
- Type: int
- sortCriteria
-
- Type: FindingStatisticsSortCriteria structure
Specifies criteria for sorting the results of a query that retrieves aggregated statistical data about findings.
Result Syntax
[
'countsByGroup' => [
[
'count' => <integer>,
'groupKey' => '<string>',
],
// ...
],
]
Result Details
Members
- countsByGroup
-
- Type: Array of GroupCount structures
Errors
-
Provides information about an error that occurred due to a syntax error in a request.
-
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.
-
Provides information about an error that occurred due to insufficient access to a specified resource.
-
Provides information about an error that occurred because a specified resource wasn't found.
-
Provides information about an error that occurred because too many requests were sent during a certain amount of time.
-
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
Members
- findingIds
-
- Required: Yes
- Type: Array of strings
- sortCriteria
-
- Type: SortCriteria structure
Specifies criteria for sorting the results of a request for findings.
Result Syntax
[
'findings' => [
[
'accountId' => '<string>',
'archived' => true || false,
'category' => 'CLASSIFICATION|POLICY',
'classificationDetails' => [
'detailedResultsLocation' => '<string>',
'jobArn' => '<string>',
'jobId' => '<string>',
'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' => [
'arn' => '<string>',
'createdAt' => <DateTime>,
'defaultServerSideEncryption' => [
'encryptionType' => 'NONE|AES256|aws:kms|UNKNOWN',
'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',
'kmsMasterKeyId' => '<string>',
],
'size' => <integer>,
'storageClass' => 'STANDARD|REDUCED_REDUNDANCY|STANDARD_IA|INTELLIGENT_TIERING|DEEP_ARCHIVE|ONEZONE_IA|GLACIER',
'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',
'updatedAt' => <DateTime>,
],
// ...
],
]
Result Details
Members
- findings
-
- Type: Array of Finding structures
Errors
-
Provides information about an error that occurred due to a syntax error in a request.
-
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.
-
Provides information about an error that occurred due to insufficient access to a specified resource.
-
Provides information about an error that occurred because a specified resource wasn't found.
-
Provides information about an error that occurred because too many requests were sent during a certain amount of time.
-
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
Members
- action
-
- Type: string
The action to perform on findings that meet the filter criteria. To suppress (automatically archive) findings that meet the criteria, set this value to ARCHIVE. Valid values are:
- arn
-
- Type: string
- description
-
- Type: string
- findingCriteria
-
- Type: FindingCriteria structure
Specifies, as a map, one or more property-based conditions that filter the results of a query for findings.
- id
-
- Type: string
- name
-
- Type: string
- position
-
- Type: int
- tags
-
- Type: Associative array of custom strings keys (__string) to strings
A string-to-string map of key-value pairs that specifies the tags (keys and values) for a classification job, custom data identifier, findings filter, or member account.
Errors
-
Provides information about an error that occurred due to a syntax error in a request.
-
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.
-
Provides information about an error that occurred due to insufficient access to a specified resource.
-
Provides information about an error that occurred because a specified resource wasn't found.
-
Provides information about an error that occurred because too many requests were sent during a certain amount of time.
-
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
Members
Result Syntax
[
'invitationsCount' => <integer>,
]
Result Details
Errors
-
Provides information about an error that occurred due to a syntax error in a request.
-
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.
-
Provides information about an error that occurred due to insufficient access to a specified resource.
-
Provides information about an error that occurred because a specified resource wasn't found.
-
Provides information about an error that occurred because too many requests were sent during a certain amount of time.
-
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 current status and configuration settings for an Amazon Macie account.
Parameter Syntax
$result = $client->getMacieSession([ ]);
Parameter Details
Members
Result Syntax
[
'createdAt' => <DateTime>,
'findingPublishingFrequency' => 'FIFTEEN_MINUTES|ONE_HOUR|SIX_HOURS',
'serviceRole' => '<string>',
'status' => 'PAUSED|ENABLED',
'updatedAt' => <DateTime>,
]
Result Details
Members
- createdAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- findingPublishingFrequency
-
- Type: string
The frequency with which Amazon Macie publishes updates to policy findings for an account. This includes publishing updates to AWS Security Hub and Amazon EventBridge (formerly called Amazon CloudWatch Events). Valid values are:
- serviceRole
-
- Type: string
- status
-
- Type: string
The status of an Amazon Macie account. Valid values are:
- updatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Errors
-
Provides information about an error that occurred due to a syntax error in a request.
-
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.
-
Provides information about an error that occurred due to insufficient access to a specified resource.
-
Provides information about an error that occurred because a specified resource wasn't found.
-
Provides information about an error that occurred because too many requests were sent during a certain amount of time.
-
Provides information about an error that occurred due to a versioning conflict for a specified resource.
GetMasterAccount
$result = $client->getMasterAccount([/* ... */]); $promise = $client->getMasterAccountAsync([/* ... */]);
Retrieves information about the Amazon Macie master account for an account.
Parameter Syntax
$result = $client->getMasterAccount([ ]);
Parameter Details
Members
Result Syntax
[
'master' => [
'accountId' => '<string>',
'invitationId' => '<string>',
'invitedAt' => <DateTime>,
'relationshipStatus' => 'Enabled|Paused|Invited|Created|Removed|Resigned|EmailVerificationInProgress|EmailVerificationFailed|RegionDisabled|AccountSuspended',
],
]
Result Details
Members
- master
-
- Type: Invitation structure
Provides information about an Amazon Macie membership invitation that was received by an account.
Errors
-
Provides information about an error that occurred due to a syntax error in a request.
-
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.
-
Provides information about an error that occurred due to insufficient access to a specified resource.
-
Provides information about an error that occurred because a specified resource wasn't found.
-
Provides information about an error that occurred because too many requests were sent during a certain amount of time.
-
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 a member account that's associated with an Amazon Macie master account.
Parameter Syntax
$result = $client->getMember([
'id' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'accountId' => '<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
Members
- accountId
-
- Type: string
- arn
-
- Type: string
-
- Type: string
- invitedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- masterAccountId
-
- Type: string
- relationshipStatus
-
- Type: string
The current status of the relationship between an account and an associated Amazon Macie master account (inviter account). Possible values are:
- tags
-
- Type: Associative array of custom strings keys (__string) to strings
A string-to-string map of key-value pairs that specifies the tags (keys and values) for a classification job, custom data identifier, findings filter, or member account.
- updatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
Errors
-
Provides information about an error that occurred due to a syntax error in a request.
-
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.
-
Provides information about an error that occurred due to insufficient access to a specified resource.
-
Provides information about an error that occurred because a specified resource wasn't found.
-
Provides information about an error that occurred because too many requests were sent during a certain amount of time.
-
Provides information about an error that occurred due to a versioning conflict for 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',
],
]);
Parameter Details
Members
- filterBy
-
- Type: Array of UsageStatisticsFilter structures
- maxResults
-
- Type: int
- nextToken
-
- Type: string
- sortBy
-
- Type: UsageStatisticsSortBy structure
Specifies criteria for sorting the results of a query for account quotas and usage data.
Result Syntax
[
'nextToken' => '<string>',
'records' => [
[
'accountId' => '<string>',
'freeTrialStartDate' => <DateTime>,
'usage' => [
[
'currency' => 'USD',
'estimatedCost' => '<string>',
'serviceLimit' => [
'isServiceLimited' => true || false,
'unit' => 'TERABYTES',
'value' => <integer>,
],
'type' => 'DATA_INVENTORY_EVALUATION|SENSITIVE_DATA_DISCOVERY',
],
// ...
],
],
// ...
],
]
Result Details
Members
- nextToken
-
- Type: string
- records
-
- Type: Array of UsageRecord structures
Errors
-
Provides information about an error that occurred due to a syntax error in a request.
-
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.
-
Provides information about an error that occurred due to insufficient access to a specified resource.
-
Provides information about an error that occurred because a specified resource wasn't found.
-
Provides information about an error that occurred because too many requests were sent during a certain amount of time.
-
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([ ]);
Parameter Details
Members
Result Syntax
[
'usageTotals' => [
[
'currency' => 'USD',
'estimatedCost' => '<string>',
'type' => 'DATA_INVENTORY_EVALUATION|SENSITIVE_DATA_DISCOVERY',
],
// ...
],
]
Result Details
Members
- usageTotals
-
- Type: Array of UsageTotal structures
Errors
-
Provides information about an error that occurred due to a syntax error in a request.
-
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.
-
Provides information about an error that occurred due to insufficient access to a specified resource.
-
Provides information about an error that occurred because a specified resource wasn't found.
-
Provides information about an error that occurred because too many requests were sent during a certain amount of time.
-
Provides information about an error that occurred due to a versioning conflict for 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',
'key' => 'jobType|jobStatus|createdAt|name',
'values' => ['<string>', ...],
],
// ...
],
'includes' => [
[
'comparator' => 'EQ|GT|GTE|LT|LTE|NE|CONTAINS',
'key' => 'jobType|jobStatus|createdAt|name',
'values' => ['<string>', ...],
],
// ...
],
],
'maxResults' => <integer>,
'nextToken' => '<string>',
'sortCriteria' => [
'attributeName' => 'createdAt|jobStatus|name|jobType',
'orderBy' => 'ASC|DESC',
],
]);
Parameter Details
Members
- filterCriteria
-
- Type: ListJobsFilterCriteria structure
Specifies criteria for filtering the results of a request for information about classification jobs.
- maxResults
-
- Type: int
- nextToken
-
- Type: string
- sortCriteria
-
- Type: ListJobsSortCriteria structure
Specifies criteria for sorting the results of a request for information about classification jobs.
Result Syntax
[
'items' => [
[
'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
Members
- items
-
- Type: Array of JobSummary structures
- nextToken
-
- Type: string
Errors
-
Provides information about an error that occurred due to a syntax error in a request.
-
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.
-
Provides information about an error that occurred due to insufficient access to a specified resource.
-
Provides information about an error that occurred because a specified resource wasn't found.
-
Provides information about an error that occurred because too many requests were sent during a certain amount of time.
-
Provides information about an error that occurred due to a versioning conflict for 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
Members
- items
-
- Type: Array of CustomDataIdentifierSummary structures
- nextToken
-
- Type: string
Errors
-
Provides information about an error that occurred due to a syntax error in a request.
-
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.
-
Provides information about an error that occurred due to insufficient access to a specified resource.
-
Provides information about an error that occurred because a specified resource wasn't found.
-
Provides information about an error that occurred because too many requests were sent during a certain amount of time.
-
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
Members
- findingCriteria
-
- Type: FindingCriteria structure
Specifies, as a map, one or more property-based conditions that filter the results of a query for findings.
- maxResults
-
- Type: int
- nextToken
-
- Type: string
- sortCriteria
-
- Type: SortCriteria structure
Specifies criteria for sorting the results of a request for findings.
Result Syntax
[
'findingIds' => ['<string>', ...],
'nextToken' => '<string>',
]
Result Details
Errors
-
Provides information about an error that occurred due to a syntax error in a request.
-
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.
-
Provides information about an error that occurred due to insufficient access to a specified resource.
-
Provides information about an error that occurred because a specified resource wasn't found.
-
Provides information about an error that occurred because too many requests were sent during a certain amount of time.
-
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
Members
- findingsFilterListItems
-
- Type: Array of FindingsFilterListItem structures
- nextToken
-
- Type: string
Errors
-
Provides information about an error that occurred due to a syntax error in a request.
-
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.
-
Provides information about an error that occurred due to insufficient access to a specified resource.
-
Provides information about an error that occurred because a specified resource wasn't found.
-
Provides information about an error that occurred because too many requests were sent during a certain amount of time.
-
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 all 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
Members
- invitations
-
- Type: Array of Invitation structures
- nextToken
-
- Type: string
Errors
-
Provides information about an error that occurred due to a syntax error in a request.
-
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.
-
Provides information about an error that occurred due to insufficient access to a specified resource.
-
Provides information about an error that occurred because a specified resource wasn't found.
-
Provides information about an error that occurred because too many requests were sent during a certain amount of time.
-
Provides information about an error that occurred due to a versioning conflict for a specified resource.
ListMembers
$result = $client->listMembers([/* ... */]); $promise = $client->listMembersAsync([/* ... */]);
Retrieves information about the accounts that are associated with an Amazon Macie master account.
Parameter Syntax
$result = $client->listMembers([
'maxResults' => <integer>,
'nextToken' => '<string>',
'onlyAssociated' => '<string>',
]);
Parameter Details
Result Syntax
[
'members' => [
[
'accountId' => '<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
Members
- members
-
- Type: Array of Member structures
- nextToken
-
- Type: string
Errors
-
Provides information about an error that occurred due to a syntax error in a request.
-
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.
-
Provides information about an error that occurred due to insufficient access to a specified resource.
-
Provides information about an error that occurred because a specified resource wasn't found.
-
Provides information about an error that occurred because too many requests were sent during a certain amount of time.
-
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 AWS organization.
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
Members
- adminAccounts
-
- Type: Array of AdminAccount structures
- nextToken
-
- Type: string
Errors
-
Provides information about an error that occurred due to a syntax error in a request.
-
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.
-
Provides information about an error that occurred due to insufficient access to a specified resource.
-
Provides information about an error that occurred because a specified resource wasn't found.
-
Provides information about an error that occurred because too many requests were sent during a certain amount of time.
-
Provides information about an error that occurred due to a versioning conflict for a specified resource.
ListTagsForResource
$result = $client->listTagsForResource([/* ... */]); $promise = $client->listTagsForResourceAsync([/* ... */]);
Retrieves the tags (keys and values) that are associated with a classification job, custom data identifier, findings filter, or member account.
Parameter Syntax
$result = $client->listTagsForResource([
'resourceArn' => '<string>', // REQUIRED
]);
Parameter Details
Result Syntax
[
'tags' => ['<string>', ...],
]
Result Details
Members
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
Members
- configuration
-
- Required: Yes
- Type: ClassificationExportConfiguration structure
Specifies where to store data classification results, and the encryption settings to use when storing results in that location. Currently, you can store classification results only in an S3 bucket.
Result Syntax
[
'configuration' => [
's3Destination' => [
'bucketName' => '<string>',
'keyPrefix' => '<string>',
'kmsKeyArn' => '<string>',
],
],
]
Result Details
Members
- configuration
-
- Type: ClassificationExportConfiguration structure
Specifies where to store data classification results, and the encryption settings to use when storing results in that location. Currently, you can store classification results only in an S3 bucket.
Errors
-
Provides information about an error that occurred due to a syntax error in a request.
-
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.
-
Provides information about an error that occurred due to insufficient access to a specified resource.
-
Provides information about an error that occurred because a specified resource wasn't found.
-
Provides information about an error that occurred because too many requests were sent during a certain amount of time.
-
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 a classification job, custom data identifier, findings filter, or member account.
Parameter Syntax
$result = $client->tagResource([
'resourceArn' => '<string>', // REQUIRED
'tags' => ['<string>', ...], // REQUIRED
]);
Parameter Details
Members
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
Members
Result Syntax
[
'matchCount' => <integer>,
]
Result Details
Errors
-
Provides information about an error that occurred due to a syntax error in a request.
-
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.
-
Provides information about an error that occurred due to insufficient access to a specified resource.
-
Provides information about an error that occurred because a specified resource wasn't found.
-
Provides information about an error that occurred because too many requests were sent during a certain amount of time.
-
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 a classification job, custom data identifier, findings filter, or member account.
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.
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
Members
Result Syntax
[]
Result Details
Errors
-
Provides information about an error that occurred due to a syntax error in a request.
-
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.
-
Provides information about an error that occurred due to insufficient access to a specified resource.
-
Provides information about an error that occurred because a specified resource wasn't found.
-
Provides information about an error that occurred because too many requests were sent during a certain amount of time.
-
Provides information about an error that occurred due to a versioning conflict for 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',
'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
Members
- action
-
- Type: string
The action to perform on findings that meet the filter criteria. To suppress (automatically archive) findings that meet the criteria, set this value to ARCHIVE. Valid values are:
- description
-
- Type: string
- findingCriteria
-
- Type: FindingCriteria structure
Specifies, as a map, one or more property-based conditions that filter the results of a query for findings.
- id
-
- Required: Yes
- Type: string
- name
-
- Type: string
- position
-
- Type: int
Result Syntax
[
'arn' => '<string>',
'id' => '<string>',
]
Result Details
Errors
-
Provides information about an error that occurred due to a syntax error in a request.
-
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.
-
Provides information about an error that occurred due to insufficient access to a specified resource.
-
Provides information about an error that occurred because a specified resource wasn't found.
-
Provides information about an error that occurred because too many requests were sent during a certain amount of time.
-
Provides information about an error that occurred due to a versioning conflict for a specified resource.
UpdateMacieSession
$result = $client->updateMacieSession([/* ... */]); $promise = $client->updateMacieSessionAsync([/* ... */]);
Suspends or re-enables an Amazon Macie account, or updates the configuration settings for a Macie account.
Parameter Syntax
$result = $client->updateMacieSession([
'findingPublishingFrequency' => 'FIFTEEN_MINUTES|ONE_HOUR|SIX_HOURS',
'status' => 'PAUSED|ENABLED',
]);
Parameter Details
Members
- findingPublishingFrequency
-
- Type: string
The frequency with which Amazon Macie publishes updates to policy findings for an account. This includes publishing updates to AWS Security Hub and Amazon EventBridge (formerly called Amazon CloudWatch Events). Valid values are:
- status
-
- Type: string
The status of an Amazon Macie account. Valid values are:
Result Syntax
[]
Result Details
Errors
-
Provides information about an error that occurred due to a syntax error in a request.
-
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.
-
Provides information about an error that occurred due to insufficient access to a specified resource.
-
Provides information about an error that occurred because a specified resource wasn't found.
-
Provides information about an error that occurred because too many requests were sent during a certain amount of time.
-
Provides information about an error that occurred due to a versioning conflict for a specified resource.
UpdateMemberSession
$result = $client->updateMemberSession([/* ... */]); $promise = $client->updateMemberSessionAsync([/* ... */]);
Enables an Amazon Macie master account to suspend or re-enable a member account.
Parameter Syntax
$result = $client->updateMemberSession([
'id' => '<string>', // REQUIRED
'status' => 'PAUSED|ENABLED', // REQUIRED
]);
Parameter Details
Members
Result Syntax
[]
Result Details
Errors
-
Provides information about an error that occurred due to a syntax error in a request.
-
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.
-
Provides information about an error that occurred due to insufficient access to a specified resource.
-
Provides information about an error that occurred because a specified resource wasn't found.
-
Provides information about an error that occurred because too many requests were sent during a certain amount of time.
-
Provides information about an error that occurred due to a versioning conflict for a specified resource.
UpdateOrganizationConfiguration
$result = $client->updateOrganizationConfiguration([/* ... */]); $promise = $client->updateOrganizationConfigurationAsync([/* ... */]);
Updates the Amazon Macie configuration settings for an AWS organization.
Parameter Syntax
$result = $client->updateOrganizationConfiguration([
'autoEnable' => true || false, // REQUIRED
]);
Parameter Details
Result Syntax
[]
Result Details
Errors
-
Provides information about an error that occurred due to a syntax error in a request.
-
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.
-
Provides information about an error that occurred due to insufficient access to a specified resource.
-
Provides information about an error that occurred because a specified resource wasn't found.
-
Provides information about an error that occurred because too many requests were sent during a certain amount of time.
-
Provides information about an error that occurred due to a versioning conflict for a specified resource.
Shapes
AccessControlList
Description
Provides information about the permissions settings of the bucket-level access control list (ACL) for an S3 bucket.
Members
AccessDeniedException
Description
Provides information about an error that occurred due to insufficient access to a specified resource.
Members
AccountDetail
Description
Specifies details for an account to associate with an Amazon Macie master account.
Members
AccountLevelPermissions
Description
Provides information about account-level permissions settings that apply to an S3 bucket.
Members
- blockPublicAccess
-
- Type: BlockPublicAccess structure
Provides information about the block public access settings for an S3 bucket. These settings can apply to a bucket at the account level or bucket level. For detailed information about each setting, see Using Amazon S3 block public access in the Amazon Simple Storage Service Developer Guide.
AdminAccount
Description
Provides information about the delegated Amazon Macie administrator account for an AWS organization.
Members
ApiCallDetails
Description
Provides information about an API operation that an entity invoked for an affected resource.
Members
AssumedRole
Description
Provides information about an identity that performed an action on an affected resource by using temporary security credentials. The credentials were obtained using the AssumeRole operation of the AWS Security Token Service (AWS STS) API.
Members
- accessKeyId
-
- Type: string
- accountId
-
- Type: string
- arn
-
- Type: string
- principalId
-
- Type: string
- sessionContext
-
- Type: SessionContext structure
Provides information about a session that was created for an entity that performed an action by using temporary security credentials.
AwsAccount
Description
Provides information about an AWS account and entity that performed an action on an affected resource. The action was performed using the credentials for an AWS account other than your own account.
Members
AwsService
Description
Provides information about an AWS service that performed an action on an affected resource.
Members
BatchGetCustomDataIdentifierSummary
Description
Provides information about a custom data identifier.
Members
BlockPublicAccess
Description
Provides information about the block public access settings for an S3 bucket. These settings can apply to a bucket at the account level or bucket level. For detailed information about each setting, see Using Amazon S3 block public access in the Amazon Simple Storage Service Developer Guide.
Members
BucketCountByEffectivePermission
Description
Provides information about the number of S3 buckets that are publicly accessible based on a combination of permissions settings for each bucket.
Members
BucketCountByEncryptionType
Description
Provides information about the number of S3 buckets that use certain types of server-side encryption or don't encrypt objects by default.
Members
BucketCountBySharedAccessType
Description
Provides information about the number of S3 buckets that are shared with other AWS accounts.
Members
BucketCriteriaAdditionalProperties
Description
Specifies the operator to use in a property-based condition that filters the results of a query for information about S3 buckets.
Members
BucketLevelPermissions
Description
Provides information about the bucket-level permissions settings for an S3 bucket.
Members
- accessControlList
-
- Type: AccessControlList structure
Provides information about the permissions settings of the bucket-level access control list (ACL) for an S3 bucket.
- blockPublicAccess
-
- Type: BlockPublicAccess structure
Provides information about the block public access settings for an S3 bucket. These settings can apply to a bucket at the account level or bucket level. For detailed information about each setting, see Using Amazon S3 block public access in the Amazon Simple Storage Service Developer Guide.
- bucketPolicy
-
- Type: BucketPolicy structure
Provides information about the permissions settings of a bucket policy for an S3 bucket.
BucketMetadata
Description
Provides information about an S3 bucket that Amazon Macie monitors and analyzes.
Members
- accountId
-
- Type: string
- bucketArn
-
- Type: string
- bucketCreatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- bucketName
-
- Type: string
- classifiableObjectCount
-
- Type: long (int|float)
- classifiableSizeInBytes
-
- Type: long (int|float)
- jobDetails
-
- Type: JobDetails structure
Specifies whether any one-time or recurring classification jobs are configured to analyze data in an S3 bucket, and, if so, the details of the job that ran most recently.
- lastUpdated
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- objectCount
-
- Type: long (int|float)
- objectCountByEncryptionType
-
- Type: ObjectCountByEncryptionType structure
Provides information about the number of objects that are in an S3 bucket and use certain types of server-side encryption, use client-side encryption, or aren't encrypted.
- publicAccess
-
- Type: BucketPublicAccess structure
Provides information about the permissions settings that determine whether an S3 bucket is publicly accessible.
- region
-
- Type: string
- replicationDetails
-
- Type: ReplicationDetails structure
Provides information about settings that define whether one or more objects in an S3 bucket are replicated to S3 buckets for other AWS accounts and, if so, which accounts.
- sharedAccess
-
- Type: string
- sizeInBytes
-
- Type: long (int|float)
- sizeInBytesCompressed
-
- Type: long (int|float)
- tags
-
- Type: Array of KeyValuePair structures
- unclassifiableObjectCount
-
- Type: ObjectLevelStatistics structure
Provides information about the total storage size (in bytes) or number of objects that Amazon Macie can't analyze in one or more S3 buckets. In a BucketMetadata object, this data is for a specific bucket. In a GetBucketStatisticsResponse object, this data is aggregated for all the buckets in the query results.
- unclassifiableObjectSizeInBytes
-
- Type: ObjectLevelStatistics structure
Provides information about the total storage size (in bytes) or number of objects that Amazon Macie can't analyze in one or more S3 buckets. In a BucketMetadata object, this data is for a specific bucket. In a GetBucketStatisticsResponse object, this data is aggregated for all the buckets in the query results.
- versioning
-
- Type: boolean
BucketPermissionConfiguration
Description
Provides information about the account-level and bucket-level permissions settings for an S3 bucket.
Members
- accountLevelPermissions
-
- Type: AccountLevelPermissions structure
Provides information about account-level permissions settings that apply to an S3 bucket.
- bucketLevelPermissions
-
- Type: BucketLevelPermissions structure
Provides information about the bucket-level permissions settings for an S3 bucket.
BucketPolicy
Description
Provides information about the permissions settings of a bucket policy for an S3 bucket.
Members
BucketPublicAccess
Description
Provides information about the permissions settings that determine whether an S3 bucket is publicly accessible.
Members
- effectivePermission
-
- Type: string
- permissionConfiguration
-
- Type: BucketPermissionConfiguration structure
Provides information about the account-level and bucket-level permissions settings for an S3 bucket.
BucketSortCriteria
Description
Specifies criteria for sorting the results of a query for information about S3 buckets.
Members
Cell
Description
Specifies the location of an occurrence of sensitive data in a Microsoft Excel workbook, CSV file, or TSV file.
Members
ClassificationDetails
Description
Provides information about a sensitive data finding, including the classification job that produced the finding.
Members
- detailedResultsLocation
-
- Type: string
- jobArn
-
- Type: string
- jobId
-
- Type: string
- result
-
- Type: ClassificationResult structure
Provides the details of a sensitive data finding, including the types, number of occurrences, and locations of the sensitive data that was detected.
ClassificationExportConfiguration
Description
Specifies where to store data classification results, and the encryption settings to use when storing results in that location. Currently, you can store classification results only in an S3 bucket.
Members
- s3Destination
-
- Type: S3Destination structure
Specifies an S3 bucket to store data classification results in, and the encryption settings to use when storing results in that bucket.
ClassificationResult
Description
Provides the details of a sensitive data finding, including the types, number of occurrences, and locations of the sensitive data that was detected.
Members
- additionalOccurrences
-
- Type: boolean
- customDataIdentifiers
-
- Type: CustomDataIdentifiers structure
Provides information about custom data identifiers that produced a sensitive data finding, and the number of occurrences of the data that they detected for the finding.
- mimeType
-
- Type: string
- sensitiveData
-
- Type: Array of SensitiveDataItem structures
Provides information about the category and number of occurrences of sensitive data that produced a finding.
- sizeClassified
-
- Type: long (int|float)
- status
-
- Type: ClassificationResultStatus structure
Provides information about the status of a sensitive data finding.
ClassificationResultStatus
Description
Provides information about the status of a sensitive data finding.
Members
ConflictException
Description
Provides information about an error that occurred due to a versioning conflict for a specified resource.
Members
CriterionAdditionalProperties
Description
Specifies the operator to use in a property-based condition that filters the results of a query for findings. For detailed information and examples of each operator, see Fundamentals of filtering findings in the Amazon Macie User Guide.
Members
CustomDataIdentifierSummary
Description
Provides information about a custom data identifier.
Members
CustomDataIdentifiers
Description
Provides information about custom data identifiers that produced a sensitive data finding, and the number of occurrences of the data that they detected for the finding.
Members
- detections
-
- Type: Array of CustomDetection structures
Provides information about custom data identifiers that produced a sensitive data finding, and the number of occurrences of the data that each identifier detected.
- totalCount
-
- Type: long (int|float)
CustomDetection
Description
Provides information about a custom data identifier that produced a sensitive data finding, and the sensitive data that it detected for the finding.
Members
- arn
-
- Type: string
- count
-
- Type: long (int|float)
- name
-
- Type: string
- occurrences
-
- Type: Occurrences structure
Provides the location of 1-15 occurrences of sensitive data that was detected by managed data identifiers or a custom data identifier and produced a sensitive data finding.
DailySchedule
Description
Specifies that a classification job runs once a day, every day. This is an empty object.
Members
DefaultDetection
Description
Provides information about a type of sensitive data that was detected by managed data identifiers and produced a sensitive data finding.
Members
- count
-
- Type: long (int|float)
- occurrences
-
- Type: Occurrences structure
Provides the location of 1-15 occurrences of sensitive data that was detected by managed data identifiers or a custom data identifier and produced a sensitive data finding.
- type
-
- Type: string
DomainDetails
Description
Provides information about the domain name of the device that an entity used to perform an action on an affected resource.
Members
Empty
Description
The request succeeded and there isn't any content to include in the body of the response (No Content).
Members
FederatedUser
Description
Provides information about an identity that performed an action on an affected resource by using temporary security credentials. The credentials were obtained using the GetFederationToken operation of the AWS Security Token Service (AWS STS) API.
Members
- accessKeyId
-
- Type: string
- accountId
-
- Type: string
- arn
-
- Type: string
- principalId
-
- Type: string
- sessionContext
-
- Type: SessionContext structure
Provides information about a session that was created for an entity that performed an action by using temporary security credentials.
Finding
Description
Provides the details of a finding.
Members
- accountId
-
- Type: string
- archived
-
- Type: boolean
- category
-
- Type: string
The category of the finding. Valid values are:
- classificationDetails
-
- Type: ClassificationDetails structure
Provides information about a sensitive data finding, including the classification job that produced the finding.
- count
-
- Type: long (int|float)
- createdAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- description
-
- Type: string
- id
-
- Type: string
- partition
-
- Type: string
- policyDetails
-
- Type: PolicyDetails structure
Provides the details of a policy finding.
- region
-
- Type: string
- resourcesAffected
-
- Type: ResourcesAffected structure
Provides information about the resources that a finding applies to.
- sample
-
- Type: boolean
- schemaVersion
-
- Type: string
- severity
-
- Type: Severity structure
Provides the numerical and qualitative representations of a finding's severity.
- title
-
- Type: string
- type
-
- Type: string
The type of finding. For details about each type, see Types of Amazon Macie findings in the Amazon Macie User Guide. Valid values are:
- updatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
FindingAction
Description
Provides information about an action that occurred for a resource and produced a policy finding.
Members
- actionType
-
- Type: string
The type of action that occurred for the resource and produced the policy finding:
- apiCallDetails
-
- Type: ApiCallDetails structure
Provides information about an API operation that an entity invoked for an affected resource.
FindingActor
Description
Provides information about an entity that performed an action that produced a policy finding for a resource.
Members
- domainDetails
-
- Type: DomainDetails structure
Provides information about the domain name of the device that an entity used to perform an action on an affected resource.
- ipAddressDetails
-
- Type: IpAddressDetails structure
Provides information about the IP address of the device that an entity used to perform an action on an affected resource.
- userIdentity
-
- Type: UserIdentity structure
Provides information about the type and other characteristics of an entity that performed an action on an affected resource.
FindingCriteria
Description
Specifies, as a map, one or more property-based conditions that filter the results of a query for findings.
Members
- criterion
-
- Type: Associative array of custom strings keys (__string) to CriterionAdditionalProperties structures
Specifies a condition that defines a property, operator, and one or more values to filter the results of a query for findings. The number of values depends on the property and operator specified by the condition. For information about defining filter conditions, see Fundamentals of filtering findings in the Amazon Macie User Guide.
FindingStatisticsSortCriteria
Description
Specifies criteria for sorting the results of a query that retrieves aggregated statistical data about findings.
Members
FindingsFilterListItem
Description
Provides information about a findings filter.
Members
- action
-
- Type: string
The action to perform on findings that meet the filter criteria. To suppress (automatically archive) findings that meet the criteria, set this value to ARCHIVE. Valid values are:
- arn
-
- Type: string
- id
-
- Type: string
- name
-
- Type: string
- tags
-
- Type: Associative array of custom strings keys (__string) to strings
A string-to-string map of key-value pairs that specifies the tags (keys and values) for a classification job, custom data identifier, findings filter, or member account.
GroupCount
Description
Provides a group of results for a query that retrieved aggregated statistical data about findings.
Members
IamUser
Description
Provides information about an AWS Identity and Access Management (IAM) user who performed an action on an affected resource.
Members
InternalServerException
Description
Provides information about an error that occurred due to an unknown internal server error, exception, or failure.
Members
Invitation
Description
Provides information about an Amazon Macie membership invitation that was received by an account.
Members
- accountId
-
- Type: string
- invitationId
-
- Type: string
- invitedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- relationshipStatus
-
- Type: string
The current status of the relationship between an account and an associated Amazon Macie master account (inviter account). Possible values are:
IpAddressDetails
Description
Provides information about the IP address of the device that an entity used to perform an action on an affected resource.
Members
- ipAddressV4
-
- Type: string
- ipCity
-
- Type: IpCity structure
Provides information about the city that an IP address originated from.
- ipCountry
-
- Type: IpCountry structure
Provides information about the country that an IP address originated from.
- ipGeoLocation
-
- Type: IpGeoLocation structure
Provides geographic coordinates that indicate where a specified IP address originated from.
- ipOwner
-
- Type: IpOwner structure
Provides information about the registered owner of an IP address.
IpCity
Description
Provides information about the city that an IP address originated from.
Members
IpCountry
Description
Provides information about the country that an IP address originated from.
Members
IpGeoLocation
Description
Provides geographic coordinates that indicate where a specified IP address originated from.
Members
IpOwner
Description
Provides information about the registered owner of an IP address.
Members
JobDetails
Description
Specifies whether any one-time or recurring classification jobs are configured to analyze data in an S3 bucket, and, if so, the details of the job that ran most recently.
Members
JobScheduleFrequency
Description
Specifies the recurrence pattern for running a classification job.
Members
- dailySchedule
-
- Type: DailySchedule structure
Specifies that a classification job runs once a day, every day. This is an empty object.
- monthlySchedule
-
- Type: MonthlySchedule structure
Specifies a monthly recurrence pattern for running a classification job.
- weeklySchedule
-
- Type: WeeklySchedule structure
Specifies a weekly recurrence pattern for running a classification job.
JobScopeTerm
Description
Specifies a property- or tag-based condition that defines criteria for including or excluding objects from a classification job.
Members
- simpleScopeTerm
-
- Type: SimpleScopeTerm structure
Specifies a property-based condition that determines whether an object is included or excluded from a classification job.
- tagScopeTerm
-
- Type: TagScopeTerm structure
Specifies a tag-based condition that determines whether an object is included or excluded from a classification job.
JobScopingBlock
Description
Specifies one or more property- and tag-based conditions that define criteria for including or excluding objects from a classification job. If you specify more than one condition, Amazon Macie uses an AND operator to join the conditions.
Members
- and
-
- Type: Array of JobScopeTerm structures
JobSummary
Description
Provides information about a classification job, including the current status of the job.
Members
- bucketDefinitions
-
- Type: Array of S3BucketDefinitionForJob structures
- createdAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- jobId
-
- Type: string
- jobStatus
-
- Type: string
The status of a classification job. Possible values are:
- jobType
-
- Type: string
The schedule for running a classification job. Valid values are:
- lastRunErrorStatus
-
- Type: LastRunErrorStatus structure
Specifies whether any account- or bucket-level access errors occurred when a classification job ran. For example, the job is configured to analyze data for a member account that was suspended, or the job is configured to analyze an S3 bucket that Amazon Macie isn't allowed to access.
- name
-
- Type: string
- userPausedDetails
-
- Type: UserPausedDetails structure
Provides information about when a classification job was paused. For a one-time job, this object also specifies when the job will expire and be cancelled if it isn't resumed. For a recurring job, this object also specifies when the paused job run will expire and be cancelled if it isn't resumed. This object is present only if a job's current status (jobStatus) is USER_PAUSED. The information in this object applies only to a job that was paused while it had a status of RUNNING.
KeyValuePair
Description
Provides information about the tags that are associated with an S3 bucket or object. Each tag consists of a required tag key and an associated tag value.
Members
LastRunErrorStatus
Description
Specifies whether any account- or bucket-level access errors occurred when a classification job ran. For example, the job is configured to analyze data for a member account that was suspended, or the job is configured to analyze an S3 bucket that Amazon Macie isn't allowed to access.
Members
ListJobsFilterCriteria
Description
Specifies criteria for filtering the results of a request for information about classification jobs.
Members
- excludes
-
- Type: Array of ListJobsFilterTerm structures
- includes
-
- Type: Array of ListJobsFilterTerm structures
ListJobsFilterTerm
Description
Specifies a condition that filters the results of a request for information about classification jobs. Each condition consists of a property, an operator, and one or more values.
Members
ListJobsSortCriteria
Description
Specifies criteria for sorting the results of a request for information about classification jobs.
Members
Member
Description
Provides information about an account that's associated with an Amazon Macie master account.
Members
- accountId
-
- Type: string
- arn
-
- Type: string
-
- Type: string
- invitedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- masterAccountId
-
- Type: string
- relationshipStatus
-
- Type: string
The current status of the relationship between an account and an associated Amazon Macie master account (inviter account). Possible values are:
- tags
-
- Type: Associative array of custom strings keys (__string) to strings
A string-to-string map of key-value pairs that specifies the tags (keys and values) for a classification job, custom data identifier, findings filter, or member account.
- updatedAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
MonthlySchedule
Description
Specifies a monthly recurrence pattern for running a classification job.
Members
ObjectCountByEncryptionType
Description
Provides information about the number of objects that are in an S3 bucket and use certain types of server-side encryption, use client-side encryption, or aren't encrypted.
Members
ObjectLevelStatistics
Description
Provides information about the total storage size (in bytes) or number of objects that Amazon Macie can't analyze in one or more S3 buckets. In a BucketMetadata object, this data is for a specific bucket. In a GetBucketStatisticsResponse object, this data is aggregated for all the buckets in the query results.
Members
Occurrences
Description
Provides the location of 1-15 occurrences of sensitive data that was detected by managed data identifiers or a custom data identifier and produced a sensitive data finding.
Members
- cells
-
- Type: Array of Cell structures
Specifies the location of occurrences of sensitive data in a Microsoft Excel workbook, CSV file, or TSV file.
- lineRanges
-
- Type: Array of Range structures
Provides details about the location of occurrences of sensitive data in an Adobe Portable Document Format file, Microsoft Word document, or non-binary text file.
- offsetRanges
-
- Type: Array of Range structures
Provides details about the location of occurrences of sensitive data in an Adobe Portable Document Format file, Microsoft Word document, or non-binary text file.
- pages
-
- Type: Array of Page structures
Specifies the location of occurrences of sensitive data in an Adobe Portable Document Format file.
- records
-
- Type: Array of Record structures
Specifies the location of occurrences of sensitive data in an Apache Parquet file.
Page
Description
Specifies the location of an occurrence of sensitive data in an Adobe Portable Document Format file.
Members
- lineRange
-
- Type: Range structure
Provides details about the location of an occurrence of sensitive data in an Adobe Portable Document Format file, Microsoft Word document, or non-binary text file.
- offsetRange
-
- Type: Range structure
Provides details about the location of an occurrence of sensitive data in an Adobe Portable Document Format file, Microsoft Word document, or non-binary text file.
- pageNumber
-
- Type: long (int|float)
PolicyDetails
Description
Provides the details of a policy finding.
Members
- action
-
- Type: FindingAction structure
Provides information about an action that occurred for a resource and produced a policy finding.
- actor
-
- Type: FindingActor structure
Provides information about an entity that performed an action that produced a policy finding for a resource.
Range
Description
Provides details about the location of an occurrence of sensitive data in an Adobe Portable Document Format file, Microsoft Word document, or non-binary text file.
Members
Record
Description
Specifies the location of an occurrence of sensitive data in an Apache Avro object container or Apache Parquet file.
Members
ReplicationDetails
Description
Provides information about settings that define whether one or more objects in an S3 bucket are replicated to S3 buckets for other AWS accounts and, if so, which accounts.
Members
ResourceNotFoundException
Description
Provides information about an error that occurred because a specified resource wasn't found.
Members
ResourcesAffected
Description
Provides information about the resources that a finding applies to.
Members
S3Bucket
Description
Provides information about an S3 bucket that a finding applies to.
Members
- arn
-
- Type: string
- createdAt
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- defaultServerSideEncryption
-
- Type: ServerSideEncryption structure
Provides information about the server-side encryption settings for an S3 bucket or S3 object.
- name
-
- Type: string
- owner
-
- Type: S3BucketOwner structure
Provides information about the user who owns an S3 bucket.
- publicAccess
-
- Type: BucketPublicAccess structure
Provides information about the permissions settings that determine whether an S3 bucket is publicly accessible.
- tags
-
- Type: Array of KeyValuePair structures
Provides information about the tags that are associated with an S3 bucket or object. Each tag consists of a required tag key and an associated tag value.
S3BucketDefinitionForJob
Description
Specifies which AWS account owns the S3 buckets that a classification job analyzes, and the buckets to analyze for the account.
Members
S3BucketOwner
Description
Provides information about the user who owns an S3 bucket.
Members
S3Destination
Description
Specifies an S3 bucket to store data classification results in, and the encryption settings to use when storing results in that bucket.
Members
S3JobDefinition
Description
Specifies which S3 buckets contain the objects that a classification job analyzes, and the scope of that analysis.
Members
- bucketDefinitions
-
- Type: Array of S3BucketDefinitionForJob structures
- scoping
-
- Type: Scoping structure
Specifies one or more property- and tag-based conditions that refine the scope of a classification job. These conditions define criteria that determine which objects a job analyzes. Exclude conditions take precedence over include conditions.
S3Object
Description
Provides information about an S3 object that a finding applies to.
Members
- bucketArn
-
- Type: string
- eTag
-
- Type: string
- extension
-
- Type: string
- key
-
- Type: string
- lastModified
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- path
-
- Type: string
- publicAccess
-
- Type: boolean
- serverSideEncryption
-
- Type: ServerSideEncryption structure
Provides information about the server-side encryption settings for an S3 bucket or S3 object.
- size
-
- Type: long (int|float)
- storageClass
-
- Type: string
The storage class of the S3 object. Possible values are:
- tags
-
- Type: Array of KeyValuePair structures
Provides information about the tags that are associated with an S3 bucket or object. Each tag consists of a required tag key and an associated tag value.
- versionId
-
- Type: string
Scoping
Description
Specifies one or more property- and tag-based conditions that refine the scope of a classification job. These conditions define criteria that determine which objects a job analyzes. Exclude conditions take precedence over include conditions.
Members
- excludes
-
- Type: JobScopingBlock structure
Specifies one or more property- and tag-based conditions that define criteria for including or excluding objects from a classification job. If you specify more than one condition, Amazon Macie uses an AND operator to join the conditions.
- includes
-
- Type: JobScopingBlock structure
Specifies one or more property- and tag-based conditions that define criteria for including or excluding objects from a classification job. If you specify more than one condition, Amazon Macie uses an AND operator to join the conditions.
SensitiveDataItem
Description
Provides information about the category, types, and occurrences of sensitive data that produced a sensitive data finding.
Members
- category
-
- Type: string
The category of sensitive data that was detected and produced the finding. Possible values are:
- detections
-
- Type: Array of DefaultDetection structures
Provides information about sensitive data that was detected by managed data identifiers and produced a sensitive data finding, and the number of occurrences of each type of sensitive data that was detected.
- totalCount
-
- Type: long (int|float)
ServerSideEncryption
Description
Provides information about the server-side encryption settings for an S3 bucket or S3 object.
Members
ServiceLimit
Description
Specifies a current quota for an account.
Members
ServiceQuotaExceededException
Description
Provides information about an error that occurred due to one or more service quotas for an account.
Members
SessionContext
Description
Provides information about a session that was created for an entity that performed an action by using temporary security credentials.
Members
- attributes
-
- Type: SessionContextAttributes structure
Provides information about the context in which temporary security credentials were issued to an entity.
- sessionIssuer
-
- Type: SessionIssuer structure
Provides information about the source and type of temporary security credentials that were issued to an entity.
SessionContextAttributes
Description
Provides information about the context in which temporary security credentials were issued to an entity.
Members
SessionIssuer
Description
Provides information about the source and type of temporary security credentials that were issued to an entity.
Members
Severity
Description
Provides the numerical and qualitative representations of a finding's severity.
Members
SimpleScopeTerm
Description
Specifies a property-based condition that determines whether an object is included or excluded from a classification job.
Members
SortCriteria
Description
Specifies criteria for sorting the results of a request for findings.
Members
Statistics
Description
Provides processing statistics for a classification job.
Members
TagScopeTerm
Description
Specifies a tag-based condition that determines whether an object is included or excluded from a classification job.
Members
- comparator
-
- Type: string
The operator to use in a condition. Valid values are:
- key
-
- Type: string
- tagValues
-
- Type: Array of TagValuePair structures
- target
-
- Type: string
The type of object to apply a tag-based condition to. Valid values are:
TagValuePair
Description
Specifies a tag key or tag key and value pair to use in a tag-based condition for a classification job.
Members
ThrottlingException
Description
Provides information about an error that occurred because too many requests were sent during a certain amount of time.
Members
UnprocessedAccount
Description
Provides information about an account-related request that hasn't been processed.
Members
UsageByAccount
Description
Provides data for a specific usage metric and the corresponding quota for an account. The value for the metric is an aggregated value that reports usage during the past 30 days.
Members
- currency
-
- Type: string
The type of currency that data for a usage metric is reported in. Possible values are:
- estimatedCost
-
- Type: string
- serviceLimit
-
- Type: ServiceLimit structure
Specifies a current quota for an account.
- type
-
- Type: string
The name of a usage metric for an account. Possible values are:
UsageRecord
Description
Provides quota and aggregated usage data for an account.
Members
- accountId
-
- Type: string
- freeTrialStartDate
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
- usage
-
- Type: Array of UsageByAccount structures
UsageStatisticsFilter
Description
Specifies a condition for filtering the results of a query for account quotas and usage data.
Members
- comparator
-
- Type: string
The operator to use in a condition that filters the results of a query for account quotas and usage data. Valid values are:
- key
-
- Type: string
The field to use in a condition that filters the results of a query for account quotas and usage data. Valid values are:
- values
-
- Type: Array of strings
UsageStatisticsSortBy
Description
Specifies criteria for sorting the results of a query for account quotas and usage data.
Members
UsageTotal
Description
Provides aggregated data for a usage metric. The value for the metric reports usage data for an account during the past 30 days.
Members
UserIdentity
Description
Provides information about the type and other characteristics of an entity that performed an action on an affected resource.
Members
- assumedRole
-
- Type: AssumedRole structure
Provides information about an identity that performed an action on an affected resource by using temporary security credentials. The credentials were obtained using the AssumeRole operation of the AWS Security Token Service (AWS STS) API.
- awsAccount
-
- Type: AwsAccount structure
Provides information about an AWS account and entity that performed an action on an affected resource. The action was performed using the credentials for an AWS account other than your own account.
- awsService
-
- Type: AwsService structure
Provides information about an AWS service that performed an action on an affected resource.
- federatedUser
-
- Type: FederatedUser structure
Provides information about an identity that performed an action on an affected resource by using temporary security credentials. The credentials were obtained using the GetFederationToken operation of the AWS Security Token Service (AWS STS) API.
- iamUser
-
- Type: IamUser structure
Provides information about an AWS Identity and Access Management (IAM) user who performed an action on an affected resource.
- root
-
- Type: UserIdentityRoot structure
Provides information about an AWS account and entity that performed an action on an affected resource. The action was performed using the credentials for your AWS account.
- type
-
- Type: string
The type of entity that performed the action on the affected resource. Possible values are:
UserIdentityRoot
Description
Provides information about an AWS account and entity that performed an action on an affected resource. The action was performed using the credentials for your AWS account.
Members
UserPausedDetails
Description
Provides information about when a classification job was paused. For a one-time job, this object also specifies when the job will expire and be cancelled if it isn't resumed. For a recurring job, this object also specifies when the paused job run will expire and be cancelled if it isn't resumed. This object is present only if a job's current status (jobStatus) is USER_PAUSED. The information in this object applies only to a job that was paused while it had a status of RUNNING.
Members
ValidationException
Description
Provides information about an error that occurred due to a syntax error in a request.