libZSservicesZSamazonka-maciev2ZSamazonka-maciev2
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.MacieV2.Lens

Contents

Description

 
Synopsis

Operations

CreateMember

createMember_tags :: Lens' CreateMember (Maybe (HashMap Text Text)) Source #

A map of key-value pairs that specifies the tags to associate with the account in Amazon Macie.

An account can have a maximum of 50 tags. Each tag consists of a tag key and an associated tag value. The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.

createMember_account :: Lens' CreateMember AccountDetail Source #

The details of the account to associate with the administrator account.

createMemberResponse_arn :: Lens' CreateMemberResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the account that was associated with the administrator account.

EnableOrganizationAdminAccount

enableOrganizationAdminAccount_clientToken :: Lens' EnableOrganizationAdminAccount (Maybe Text) Source #

A unique, case-sensitive token that you provide to ensure the idempotency of the request.

enableOrganizationAdminAccount_adminAccountId :: Lens' EnableOrganizationAdminAccount Text Source #

The Amazon Web Services account ID for the account to designate as the delegated Amazon Macie administrator account for the organization.

DescribeClassificationJob

describeClassificationJob_jobId :: Lens' DescribeClassificationJob Text Source #

The unique identifier for the classification job.

describeClassificationJobResponse_lastRunErrorStatus :: Lens' DescribeClassificationJobResponse (Maybe LastRunErrorStatus) Source #

Specifies whether any account- or bucket-level access errors occurred when the job ran. For a recurring job, this value indicates the error status of the job's most recent run.

describeClassificationJobResponse_jobType :: Lens' DescribeClassificationJobResponse (Maybe JobType) Source #

The schedule for running the job. Possible values are:

  • ONE_TIME - The job runs only once.
  • SCHEDULED - The job runs on a daily, weekly, or monthly basis. The scheduleFrequency property indicates the recurrence pattern for the job.

describeClassificationJobResponse_initialRun :: Lens' DescribeClassificationJobResponse (Maybe Bool) Source #

For a recurring job, specifies whether you configured the job to analyze all existing, eligible objects immediately after the job was created (true). If you configured the job to analyze only those objects that were created or changed after the job was created and before the job's first scheduled run, this value is false. This value is also false for a one-time job.

describeClassificationJobResponse_clientToken :: Lens' DescribeClassificationJobResponse (Maybe Text) Source #

The token that was provided to ensure the idempotency of the request to create the job.

describeClassificationJobResponse_s3JobDefinition :: Lens' DescribeClassificationJobResponse (Maybe S3JobDefinition) Source #

The S3 buckets that contain the objects to analyze, and the scope of that analysis.

describeClassificationJobResponse_createdAt :: Lens' DescribeClassificationJobResponse (Maybe UTCTime) Source #

The date and time, in UTC and extended ISO 8601 format, when the job was created.

describeClassificationJobResponse_userPausedDetails :: Lens' DescribeClassificationJobResponse (Maybe UserPausedDetails) Source #

If the current status of the job is USER_PAUSED, specifies when the job was paused and when the job or job run will expire and be cancelled if it isn't resumed. This value is present only if the value for jobStatus is USER_PAUSED.

describeClassificationJobResponse_samplingPercentage :: Lens' DescribeClassificationJobResponse (Maybe Int) Source #

The sampling depth, as a percentage, that determines the percentage of eligible objects that the job analyzes.

describeClassificationJobResponse_managedDataIdentifierSelector :: Lens' DescribeClassificationJobResponse (Maybe ManagedDataIdentifierSelector) Source #

The selection type that determines which managed data identifiers the job uses to analyze data. Possible values are:

  • ALL - Use all the managed data identifiers that Amazon Macie provides.
  • EXCLUDE - Use all the managed data identifiers that Macie provides except the managed data identifiers specified by the managedDataIdentifierIds property.
  • INCLUDE - Use only the managed data identifiers specified by the managedDataIdentifierIds property.
  • NONE - Don't use any managed data identifiers.

If this value is null, the job uses all managed data identifiers. If this value is null, ALL, or EXCLUDE for a recurring job, the job also uses new managed data identifiers as they are released.

describeClassificationJobResponse_lastRunTime :: Lens' DescribeClassificationJobResponse (Maybe UTCTime) Source #

The date and time, in UTC and extended ISO 8601 format, when the job started. If the job is a recurring job, this value indicates when the most recent run started.

describeClassificationJobResponse_customDataIdentifierIds :: Lens' DescribeClassificationJobResponse (Maybe [Text]) Source #

An array of unique identifiers, one for each custom data identifier that the job uses to analyze data. This value is null if the job uses only managed data identifiers to analyze data.

describeClassificationJobResponse_statistics :: Lens' DescribeClassificationJobResponse (Maybe Statistics) Source #

The number of times that the job has run and processing statistics for the job's current run.

describeClassificationJobResponse_managedDataIdentifierIds :: Lens' DescribeClassificationJobResponse (Maybe [Text]) Source #

An array of unique identifiers, one for each managed data identifier that the job is explicitly configured to include (use) or exclude (not use) when it analyzes data. Inclusion or exclusion depends on the managed data identifier selection type specified for the job (managedDataIdentifierSelector). This value is null if the job's managed data identifier selection type is ALL or the job uses only custom data identifiers (customDataIdentifierIds) to analyze data.

describeClassificationJobResponse_jobStatus :: Lens' DescribeClassificationJobResponse (Maybe JobStatus) Source #

The current status of the job. Possible values are:

  • CANCELLED - You cancelled the job or, if it's a one-time job, you paused the job and didn't resume it within 30 days.
  • COMPLETE - For a one-time job, Amazon Macie finished processing the data specified for the job. This value doesn't apply to recurring jobs.
  • IDLE - For a recurring job, the previous scheduled run is complete and the next scheduled run is pending. This value doesn't apply to one-time jobs.
  • PAUSED - Macie started running the job but additional processing would exceed the monthly sensitive data discovery quota for your account or one or more member accounts that the job analyzes data for.
  • RUNNING - For a one-time job, the job is in progress. For a recurring job, a scheduled run is in progress.
  • USER_PAUSED - You paused the job. If you paused the job while it had a status of RUNNING and you don't resume it within 30 days of pausing it, the job or job run will expire and be cancelled, depending on the job's type. To check the expiration date, refer to the UserPausedDetails.jobExpiresAt property.

describeClassificationJobResponse_tags :: Lens' DescribeClassificationJobResponse (Maybe (HashMap Text Text)) Source #

A map of key-value pairs that specifies which tags (keys and values) are associated with the classification job.

describeClassificationJobResponse_scheduleFrequency :: Lens' DescribeClassificationJobResponse (Maybe JobScheduleFrequency) Source #

The recurrence pattern for running the job. This value is null if the job is configured to run only once.

ListFindings

listFindings_findingCriteria :: Lens' ListFindings (Maybe FindingCriteria) Source #

The criteria to use to filter the results.

listFindings_sortCriteria :: Lens' ListFindings (Maybe SortCriteria) Source #

The criteria to use to sort the results.

listFindings_nextToken :: Lens' ListFindings (Maybe Text) Source #

The nextToken string that specifies which page of results to return in a paginated response.

listFindings_maxResults :: Lens' ListFindings (Maybe Int) Source #

The maximum number of items to include in each page of the response.

listFindingsResponse_findingIds :: Lens' ListFindingsResponse (Maybe [Text]) Source #

An array of strings, where each string is the unique identifier for a finding that meets the filter criteria specified in the request.

listFindingsResponse_nextToken :: Lens' ListFindingsResponse (Maybe Text) Source #

The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

GetAdministratorAccount

getAdministratorAccountResponse_administrator :: Lens' GetAdministratorAccountResponse (Maybe Invitation) Source #

The Amazon Web Services account ID for the administrator account. If the accounts are associated by a Macie membership invitation, this object also provides details about the invitation that was sent to establish the relationship between the accounts.

ListOrganizationAdminAccounts

listOrganizationAdminAccounts_nextToken :: Lens' ListOrganizationAdminAccounts (Maybe Text) Source #

The nextToken string that specifies which page of results to return in a paginated response.

listOrganizationAdminAccounts_maxResults :: Lens' ListOrganizationAdminAccounts (Maybe Natural) Source #

The maximum number of items to include in each page of a paginated response.

listOrganizationAdminAccountsResponse_adminAccounts :: Lens' ListOrganizationAdminAccountsResponse (Maybe [AdminAccount]) Source #

An array of objects, one for each delegated Amazon Macie administrator account for the organization. Only one of these accounts can have a status of ENABLED.

listOrganizationAdminAccountsResponse_nextToken :: Lens' ListOrganizationAdminAccountsResponse (Maybe Text) Source #

The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

SearchResources

searchResources_bucketCriteria :: Lens' SearchResources (Maybe SearchResourcesBucketCriteria) Source #

The filter conditions that determine which S3 buckets to include or exclude from the query results.

searchResources_nextToken :: Lens' SearchResources (Maybe Text) Source #

The nextToken string that specifies which page of results to return in a paginated response.

searchResources_maxResults :: Lens' SearchResources (Maybe Int) Source #

The maximum number of items to include in each page of the response. The default value is 50.

searchResourcesResponse_nextToken :: Lens' SearchResourcesResponse (Maybe Text) Source #

The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

searchResourcesResponse_matchingResources :: Lens' SearchResourcesResponse (Maybe [MatchingResource]) Source #

An array of objects, one for each resource that meets the filter criteria specified in the request.

DisableMacie

UpdateFindingsFilter

updateFindingsFilter_clientToken :: Lens' UpdateFindingsFilter (Maybe Text) Source #

A unique, case-sensitive token that you provide to ensure the idempotency of the request.

updateFindingsFilter_action :: Lens' UpdateFindingsFilter (Maybe FindingsFilterAction) Source #

The action to perform on findings that meet the filter criteria (findingCriteria). Valid values are: ARCHIVE, suppress (automatically archive) the findings; and, NOOP, don't perform any action on the findings.

updateFindingsFilter_name :: Lens' UpdateFindingsFilter (Maybe Text) Source #

A custom name for the filter. The name must contain at least 3 characters and can contain as many as 64 characters.

We strongly recommend that you avoid including any sensitive data in the name of a filter. Other users might be able to see the filter's name, depending on the actions that they're allowed to perform in Amazon Macie.

updateFindingsFilter_description :: Lens' UpdateFindingsFilter (Maybe Text) Source #

A custom description of the filter. The description can contain as many as 512 characters.

We strongly recommend that you avoid including any sensitive data in the description of a filter. Other users might be able to see the filter's description, depending on the actions that they're allowed to perform in Amazon Macie.

updateFindingsFilter_position :: Lens' UpdateFindingsFilter (Maybe Int) Source #

The position of the filter in the list of saved filters on the Amazon Macie console. This value also determines the order in which the filter is applied to findings, relative to other filters that are also applied to the findings.

updateFindingsFilter_id :: Lens' UpdateFindingsFilter Text Source #

The unique identifier for the Amazon Macie resource or account that the request applies to.

updateFindingsFilterResponse_arn :: Lens' UpdateFindingsFilterResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the filter that was updated.

updateFindingsFilterResponse_id :: Lens' UpdateFindingsFilterResponse (Maybe Text) Source #

The unique identifier for the filter that was updated.

DeleteFindingsFilter

deleteFindingsFilter_id :: Lens' DeleteFindingsFilter Text Source #

The unique identifier for the Amazon Macie resource or account that the request applies to.

ListFindingsFilters

listFindingsFilters_nextToken :: Lens' ListFindingsFilters (Maybe Text) Source #

The nextToken string that specifies which page of results to return in a paginated response.

listFindingsFilters_maxResults :: Lens' ListFindingsFilters (Maybe Natural) Source #

The maximum number of items to include in each page of a paginated response.

listFindingsFiltersResponse_findingsFilterListItems :: Lens' ListFindingsFiltersResponse (Maybe [FindingsFilterListItem]) Source #

An array of objects, one for each filter that's associated with the account.

listFindingsFiltersResponse_nextToken :: Lens' ListFindingsFiltersResponse (Maybe Text) Source #

The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

EnableMacie

enableMacie_status :: Lens' EnableMacie (Maybe MacieStatus) Source #

Specifies the new status for the account. To enable Amazon Macie and start all Macie activities for the account, set this value to ENABLED.

enableMacie_clientToken :: Lens' EnableMacie (Maybe Text) Source #

A unique, case-sensitive token that you provide to ensure the idempotency of the request.

enableMacie_findingPublishingFrequency :: Lens' EnableMacie (Maybe FindingPublishingFrequency) Source #

Specifies how often to publish updates to policy findings for the account. This includes publishing updates to Security Hub and Amazon EventBridge (formerly called Amazon CloudWatch Events).

GetUsageTotals

getUsageTotals_timeRange :: Lens' GetUsageTotals (Maybe Text) Source #

The inclusive time period to retrieve the data for. Valid values are: MONTH_TO_DATE, for the current calendar month to date; and, PAST_30_DAYS, for the preceding 30 days. If you don't specify a value for this parameter, Amazon Macie provides aggregated usage data for the preceding 30 days.

getUsageTotalsResponse_timeRange :: Lens' GetUsageTotalsResponse (Maybe TimeRange) Source #

The inclusive time period that the usage data applies to. Possible values are: MONTH_TO_DATE, for the current calendar month to date; and, PAST_30_DAYS, for the preceding 30 days.

getUsageTotalsResponse_usageTotals :: Lens' GetUsageTotalsResponse (Maybe [UsageTotal]) Source #

An array of objects that contains the results of the query. Each object contains the data for a specific usage metric.

CreateFindingsFilter

createFindingsFilter_clientToken :: Lens' CreateFindingsFilter (Maybe Text) Source #

A unique, case-sensitive token that you provide to ensure the idempotency of the request.

createFindingsFilter_description :: Lens' CreateFindingsFilter (Maybe Text) Source #

A custom description of the filter. The description can contain as many as 512 characters.

We strongly recommend that you avoid including any sensitive data in the description of a filter. Other users of your account might be able to see the filter's description, depending on the actions that they're allowed to perform in Amazon Macie.

createFindingsFilter_tags :: Lens' CreateFindingsFilter (Maybe (HashMap Text Text)) Source #

A map of key-value pairs that specifies the tags to associate with the filter.

A findings filter can have a maximum of 50 tags. Each tag consists of a tag key and an associated tag value. The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.

createFindingsFilter_position :: Lens' CreateFindingsFilter (Maybe Int) Source #

The position of the filter in the list of saved filters on the Amazon Macie console. This value also determines the order in which the filter is applied to findings, relative to other filters that are also applied to the findings.

createFindingsFilter_action :: Lens' CreateFindingsFilter FindingsFilterAction Source #

The action to perform on findings that meet the filter criteria (findingCriteria). Valid values are: ARCHIVE, suppress (automatically archive) the findings; and, NOOP, don't perform any action on the findings.

createFindingsFilter_name :: Lens' CreateFindingsFilter Text Source #

A custom name for the filter. The name must contain at least 3 characters and can contain as many as 64 characters.

We strongly recommend that you avoid including any sensitive data in the name of a filter. Other users of your account might be able to see the filter's name, depending on the actions that they're allowed to perform in Amazon Macie.

createFindingsFilterResponse_arn :: Lens' CreateFindingsFilterResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the filter that was created.

createFindingsFilterResponse_id :: Lens' CreateFindingsFilterResponse (Maybe Text) Source #

The unique identifier for the filter that was created.

ListTagsForResource

listTagsForResource_resourceArn :: Lens' ListTagsForResource Text Source #

The Amazon Resource Name (ARN) of the classification job, custom data identifier, findings filter, or member account.

listTagsForResourceResponse_tags :: Lens' ListTagsForResourceResponse (Maybe (HashMap Text Text)) Source #

A map of key-value pairs that identifies the tags (keys and values) that are associated with the resource.

ListInvitations

listInvitations_nextToken :: Lens' ListInvitations (Maybe Text) Source #

The nextToken string that specifies which page of results to return in a paginated response.

listInvitations_maxResults :: Lens' ListInvitations (Maybe Natural) Source #

The maximum number of items to include in each page of a paginated response.

listInvitationsResponse_invitations :: Lens' ListInvitationsResponse (Maybe [Invitation]) Source #

An array of objects, one for each invitation that was received by the account.

listInvitationsResponse_nextToken :: Lens' ListInvitationsResponse (Maybe Text) Source #

The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

DescribeBuckets

describeBuckets_sortCriteria :: Lens' DescribeBuckets (Maybe BucketSortCriteria) Source #

The criteria to use to sort the query results.

describeBuckets_nextToken :: Lens' DescribeBuckets (Maybe Text) Source #

The nextToken string that specifies which page of results to return in a paginated response.

describeBuckets_maxResults :: Lens' DescribeBuckets (Maybe Int) Source #

The maximum number of items to include in each page of the response. The default value is 50.

describeBucketsResponse_buckets :: Lens' DescribeBucketsResponse (Maybe [BucketMetadata]) Source #

An array of objects, one for each bucket that meets the filter criteria specified in the request.

describeBucketsResponse_nextToken :: Lens' DescribeBucketsResponse (Maybe Text) Source #

The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

ListClassificationJobs

listClassificationJobs_nextToken :: Lens' ListClassificationJobs (Maybe Text) Source #

The nextToken string that specifies which page of results to return in a paginated response.

listClassificationJobs_maxResults :: Lens' ListClassificationJobs (Maybe Int) Source #

The maximum number of items to include in each page of the response.

listClassificationJobsResponse_items :: Lens' ListClassificationJobsResponse (Maybe [JobSummary]) Source #

An array of objects, one for each job that meets the filter criteria specified in the request.

listClassificationJobsResponse_nextToken :: Lens' ListClassificationJobsResponse (Maybe Text) Source #

The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

GetFindingsFilter

getFindingsFilter_id :: Lens' GetFindingsFilter Text Source #

The unique identifier for the Amazon Macie resource or account that the request applies to.

getFindingsFilterResponse_arn :: Lens' GetFindingsFilterResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the filter.

getFindingsFilterResponse_action :: Lens' GetFindingsFilterResponse (Maybe FindingsFilterAction) Source #

The action that's performed on findings that meet the filter criteria (findingCriteria). Possible values are: ARCHIVE, suppress (automatically archive) the findings; and, NOOP, don't perform any action on the findings.

getFindingsFilterResponse_tags :: Lens' GetFindingsFilterResponse (Maybe (HashMap Text Text)) Source #

A map of key-value pairs that identifies the tags (keys and values) that are associated with the filter.

getFindingsFilterResponse_position :: Lens' GetFindingsFilterResponse (Maybe Int) Source #

The position of the filter in the list of saved filters on the Amazon Macie console. This value also determines the order in which the filter is applied to findings, relative to other filters that are also applied to the findings.

UpdateClassificationJob

updateClassificationJob_jobId :: Lens' UpdateClassificationJob Text Source #

The unique identifier for the classification job.

updateClassificationJob_jobStatus :: Lens' UpdateClassificationJob JobStatus Source #

The new status for the job. Valid values are:

  • CANCELLED - Stops the job permanently and cancels it. This value is valid only if the job's current status is IDLE, PAUSED, RUNNING, or USER_PAUSED.

    If you specify this value and the job's current status is RUNNING, Amazon Macie immediately begins to stop all processing tasks for the job. You can't resume or restart a job after you cancel it.

  • RUNNING - Resumes the job. This value is valid only if the job's current status is USER_PAUSED.

    If you paused the job while it was actively running and you specify this value less than 30 days after you paused the job, Macie immediately resumes processing from the point where you paused the job. Otherwise, Macie resumes the job according to the schedule and other settings for the job.

  • USER_PAUSED - Pauses the job temporarily. This value is valid only if the job's current status is IDLE, PAUSED, or RUNNING. If you specify this value and the job's current status is RUNNING, Macie immediately begins to pause all processing tasks for the job.

    If you pause a one-time job and you don't resume it within 30 days, the job expires and Macie cancels the job. If you pause a recurring job when its status is RUNNING and you don't resume it within 30 days, the job run expires and Macie cancels the run. To check the expiration date, refer to the UserPausedDetails.jobExpiresAt property.

DeleteInvitations

deleteInvitations_accountIds :: Lens' DeleteInvitations [Text] Source #

An array that lists Amazon Web Services account IDs, one for each account that sent an invitation to delete.

deleteInvitationsResponse_unprocessedAccounts :: Lens' DeleteInvitationsResponse (Maybe [UnprocessedAccount]) Source #

An array of objects, one for each account whose invitation hasn't been deleted. Each object identifies the account and explains why the request hasn't been processed for that account.

GetMasterAccount

getMasterAccountResponse_master :: Lens' GetMasterAccountResponse (Maybe Invitation) Source #

(Deprecated) The Amazon Web Services account ID for the administrator account. If the accounts are associated by a Macie membership invitation, this object also provides details about the invitation that was sent to establish the relationship between the accounts.

PutClassificationExportConfiguration

putClassificationExportConfiguration_configuration :: Lens' PutClassificationExportConfiguration ClassificationExportConfiguration Source #

The location to store data classification results in, and the encryption settings to use when storing results in that location.

putClassificationExportConfigurationResponse_configuration :: Lens' PutClassificationExportConfigurationResponse (Maybe ClassificationExportConfiguration) Source #

The location where the data classification results are stored, and the encryption settings that are used when storing results in that location.

GetCustomDataIdentifier

getCustomDataIdentifier_id :: Lens' GetCustomDataIdentifier Text Source #

The unique identifier for the Amazon Macie resource or account that the request applies to.

getCustomDataIdentifierResponse_arn :: Lens' GetCustomDataIdentifierResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the custom data identifier.

getCustomDataIdentifierResponse_createdAt :: Lens' GetCustomDataIdentifierResponse (Maybe UTCTime) Source #

The date and time, in UTC and extended ISO 8601 format, when the custom data identifier was created.

getCustomDataIdentifierResponse_regex :: Lens' GetCustomDataIdentifierResponse (Maybe Text) Source #

The regular expression (regex) that defines the pattern to match.

getCustomDataIdentifierResponse_keywords :: Lens' GetCustomDataIdentifierResponse (Maybe [Text]) Source #

An array that lists specific character sequences (keywords), one of which must be within proximity (maximumMatchDistance) of the regular expression to match. Keywords aren't case sensitive.

getCustomDataIdentifierResponse_ignoreWords :: Lens' GetCustomDataIdentifierResponse (Maybe [Text]) Source #

An array that lists specific character sequences (ignore words) to exclude from the results. If the text matched by the regular expression is the same as any string in this array, Amazon Macie ignores it. Ignore words are case sensitive.

getCustomDataIdentifierResponse_id :: Lens' GetCustomDataIdentifierResponse (Maybe Text) Source #

The unique identifier for the custom data identifier.

getCustomDataIdentifierResponse_deleted :: Lens' GetCustomDataIdentifierResponse (Maybe Bool) Source #

Specifies whether the custom data identifier was deleted. If you delete a custom data identifier, Amazon Macie doesn't delete it permanently. Instead, it soft deletes the identifier.

getCustomDataIdentifierResponse_maximumMatchDistance :: Lens' GetCustomDataIdentifierResponse (Maybe Int) Source #

The maximum number of characters that can exist between text that matches the regex pattern and the character sequences specified by the keywords array. Amazon Macie includes or excludes a result based on the proximity of a keyword to text that matches the regex pattern.

getCustomDataIdentifierResponse_description :: Lens' GetCustomDataIdentifierResponse (Maybe Text) Source #

The custom description of the custom data identifier.

getCustomDataIdentifierResponse_tags :: Lens' GetCustomDataIdentifierResponse (Maybe (HashMap Text Text)) Source #

A map of key-value pairs that identifies the tags (keys and values) that are associated with the custom data identifier.

GetUsageStatistics

getUsageStatistics_timeRange :: Lens' GetUsageStatistics (Maybe TimeRange) Source #

The inclusive time period to query usage data for. Valid values are: MONTH_TO_DATE, for the current calendar month to date; and, PAST_30_DAYS, for the preceding 30 days. If you don't specify a value, Amazon Macie provides usage data for the preceding 30 days.

getUsageStatistics_nextToken :: Lens' GetUsageStatistics (Maybe Text) Source #

The nextToken string that specifies which page of results to return in a paginated response.

getUsageStatistics_filterBy :: Lens' GetUsageStatistics (Maybe [UsageStatisticsFilter]) Source #

An array of objects, one for each condition to use to filter the query results. If you specify more than one condition, Amazon Macie uses an AND operator to join the conditions.

getUsageStatistics_maxResults :: Lens' GetUsageStatistics (Maybe Int) Source #

The maximum number of items to include in each page of the response.

getUsageStatistics_sortBy :: Lens' GetUsageStatistics (Maybe UsageStatisticsSortBy) Source #

The criteria to use to sort the query results.

getUsageStatisticsResponse_timeRange :: Lens' GetUsageStatisticsResponse (Maybe TimeRange) Source #

The inclusive time period that the usage data applies to. Possible values are: MONTH_TO_DATE, for the current calendar month to date; and, PAST_30_DAYS, for the preceding 30 days.

getUsageStatisticsResponse_records :: Lens' GetUsageStatisticsResponse (Maybe [UsageRecord]) Source #

An array of objects that contains the results of the query. Each object contains the data for an account that meets the filter criteria specified in the request.

getUsageStatisticsResponse_nextToken :: Lens' GetUsageStatisticsResponse (Maybe Text) Source #

The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

DeclineInvitations

declineInvitations_accountIds :: Lens' DeclineInvitations [Text] Source #

An array that lists Amazon Web Services account IDs, one for each account that sent an invitation to decline.

declineInvitationsResponse_unprocessedAccounts :: Lens' DeclineInvitationsResponse (Maybe [UnprocessedAccount]) Source #

An array of objects, one for each account whose invitation hasn't been declined. Each object identifies the account and explains why the request hasn't been processed for that account.

TestCustomDataIdentifier

testCustomDataIdentifier_keywords :: Lens' TestCustomDataIdentifier (Maybe [Text]) Source #

An array that lists specific character sequences (keywords), one of which must be within proximity (maximumMatchDistance) of the regular expression to match. The array can contain as many as 50 keywords. Each keyword can contain 3-90 UTF-8 characters. Keywords aren't case sensitive.

testCustomDataIdentifier_ignoreWords :: Lens' TestCustomDataIdentifier (Maybe [Text]) Source #

An array that lists specific character sequences (ignore words) to exclude from the results. If the text matched by the regular expression is the same as any string in this array, Amazon Macie ignores it. The array can contain as many as 10 ignore words. Each ignore word can contain 4-90 UTF-8 characters. Ignore words are case sensitive.

testCustomDataIdentifier_maximumMatchDistance :: Lens' TestCustomDataIdentifier (Maybe Int) Source #

The maximum number of characters that can exist between text that matches the regex pattern and the character sequences specified by the keywords array. Amazon Macie includes or excludes a result based on the proximity of a keyword to text that matches the regex pattern. The distance can be 1-300 characters. The default value is 50.

testCustomDataIdentifier_regex :: Lens' TestCustomDataIdentifier Text Source #

The regular expression (regex) that defines the pattern to match. The expression can contain as many as 512 characters.

testCustomDataIdentifier_sampleText :: Lens' TestCustomDataIdentifier Text Source #

The sample text to inspect by using the custom data identifier. The text can contain as many as 1,000 characters.

testCustomDataIdentifierResponse_matchCount :: Lens' TestCustomDataIdentifierResponse (Maybe Int) Source #

The number of instances of sample text that matched the detection criteria specified in the custom data identifier.

CreateInvitations

createInvitations_disableEmailNotification :: Lens' CreateInvitations (Maybe Bool) Source #

Specifies whether to send an email notification to the root user of each account that the invitation will be sent to. This notification is in addition to an alert that the root user receives in Personal Health Dashboard. To send an email notification to the root user of each account, set this value to true.

createInvitations_message :: Lens' CreateInvitations (Maybe Text) Source #

A custom message to include in the invitation. Amazon Macie adds this message to the standard content that it sends for an invitation.

createInvitations_accountIds :: Lens' CreateInvitations [Text] Source #

An array that lists Amazon Web Services account IDs, one for each account to send the invitation to.

createInvitationsResponse_unprocessedAccounts :: Lens' CreateInvitationsResponse (Maybe [UnprocessedAccount]) Source #

An array of objects, one for each account whose invitation hasn't been processed. Each object identifies the account and explains why the invitation hasn't been processed for the account.

DescribeOrganizationConfiguration

describeOrganizationConfigurationResponse_maxAccountLimitReached :: Lens' DescribeOrganizationConfigurationResponse (Maybe Bool) Source #

Specifies whether the maximum number of Amazon Macie member accounts are part of the Amazon Web Services organization.

describeOrganizationConfigurationResponse_autoEnable :: Lens' DescribeOrganizationConfigurationResponse (Maybe Bool) Source #

Specifies whether Amazon Macie is enabled automatically for accounts that are added to the Amazon Web Services organization.

BatchGetCustomDataIdentifiers

batchGetCustomDataIdentifiers_ids :: Lens' BatchGetCustomDataIdentifiers (Maybe [Text]) Source #

An array of custom data identifier IDs, one for each custom data identifier to retrieve information about.

batchGetCustomDataIdentifiersResponse_notFoundIdentifierIds :: Lens' BatchGetCustomDataIdentifiersResponse (Maybe [Text]) Source #

An array of custom data identifier IDs, one for each custom data identifier that was specified in the request but doesn't correlate to an existing custom data identifier.

batchGetCustomDataIdentifiersResponse_customDataIdentifiers :: Lens' BatchGetCustomDataIdentifiersResponse (Maybe [BatchGetCustomDataIdentifierSummary]) Source #

An array of objects, one for each custom data identifier that meets the criteria specified in the request.

DeleteMember

deleteMember_id :: Lens' DeleteMember Text Source #

The unique identifier for the Amazon Macie resource or account that the request applies to.

DisassociateFromMasterAccount

AcceptInvitation

acceptInvitation_administratorAccountId :: Lens' AcceptInvitation (Maybe Text) Source #

The Amazon Web Services account ID for the account that sent the invitation.

acceptInvitation_masterAccount :: Lens' AcceptInvitation (Maybe Text) Source #

(Deprecated) The Amazon Web Services account ID for the account that sent the invitation. This property has been replaced by the administratorAccountId property and is retained only for backward compatibility.

acceptInvitation_invitationId :: Lens' AcceptInvitation Text Source #

The unique identifier for the invitation to accept.

ListMembers

listMembers_nextToken :: Lens' ListMembers (Maybe Text) Source #

The nextToken string that specifies which page of results to return in a paginated response.

listMembers_onlyAssociated :: Lens' ListMembers (Maybe Text) Source #

Specifies which accounts to include in the response, based on the status of an account's relationship with the administrator account. By default, the response includes only current member accounts. To include all accounts, set this value to false.

listMembers_maxResults :: Lens' ListMembers (Maybe Natural) Source #

The maximum number of items to include in each page of a paginated response.

listMembersResponse_members :: Lens' ListMembersResponse (Maybe [Member]) Source #

An array of objects, one for each account that's associated with the administrator account and meets the criteria specified by the onlyAssociated request parameter.

listMembersResponse_nextToken :: Lens' ListMembersResponse (Maybe Text) Source #

The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

UpdateMacieSession

updateMacieSession_status :: Lens' UpdateMacieSession (Maybe MacieStatus) Source #

Specifies a new status for the account. Valid values are: ENABLED, resume all Amazon Macie activities for the account; and, PAUSED, suspend all Macie activities for the account.

updateMacieSession_findingPublishingFrequency :: Lens' UpdateMacieSession (Maybe FindingPublishingFrequency) Source #

Specifies how often to publish updates to policy findings for the account. This includes publishing updates to Security Hub and Amazon EventBridge (formerly called Amazon CloudWatch Events).

GetClassificationExportConfiguration

getClassificationExportConfigurationResponse_configuration :: Lens' GetClassificationExportConfigurationResponse (Maybe ClassificationExportConfiguration) Source #

The location where data classification results are stored, and the encryption settings that are used when storing results in that location.

GetFindingsPublicationConfiguration

CreateCustomDataIdentifier

createCustomDataIdentifier_clientToken :: Lens' CreateCustomDataIdentifier (Maybe Text) Source #

A unique, case-sensitive token that you provide to ensure the idempotency of the request.

createCustomDataIdentifier_regex :: Lens' CreateCustomDataIdentifier (Maybe Text) Source #

The regular expression (regex) that defines the pattern to match. The expression can contain as many as 512 characters.

createCustomDataIdentifier_name :: Lens' CreateCustomDataIdentifier (Maybe Text) Source #

A custom name for the custom data identifier. The name can contain as many as 128 characters.

We strongly recommend that you avoid including any sensitive data in the name of a custom data identifier. Other users of your account might be able to see the identifier's name, depending on the actions that they're allowed to perform in Amazon Macie.

createCustomDataIdentifier_keywords :: Lens' CreateCustomDataIdentifier (Maybe [Text]) Source #

An array that lists specific character sequences (keywords), one of which must be within proximity (maximumMatchDistance) of the regular expression to match. The array can contain as many as 50 keywords. Each keyword can contain 3-90 UTF-8 characters. Keywords aren't case sensitive.

createCustomDataIdentifier_ignoreWords :: Lens' CreateCustomDataIdentifier (Maybe [Text]) Source #

An array that lists specific character sequences (ignore words) to exclude from the results. If the text matched by the regular expression is the same as any string in this array, Amazon Macie ignores it. The array can contain as many as 10 ignore words. Each ignore word can contain 4-90 UTF-8 characters. Ignore words are case sensitive.

createCustomDataIdentifier_maximumMatchDistance :: Lens' CreateCustomDataIdentifier (Maybe Int) Source #

The maximum number of characters that can exist between text that matches the regex pattern and the character sequences specified by the keywords array. Amazon Macie includes or excludes a result based on the proximity of a keyword to text that matches the regex pattern. The distance can be 1-300 characters. The default value is 50.

createCustomDataIdentifier_description :: Lens' CreateCustomDataIdentifier (Maybe Text) Source #

A custom description of the custom data identifier. The description can contain as many as 512 characters.

We strongly recommend that you avoid including any sensitive data in the description of a custom data identifier. Other users of your account might be able to see the identifier's description, depending on the actions that they're allowed to perform in Amazon Macie.

createCustomDataIdentifier_tags :: Lens' CreateCustomDataIdentifier (Maybe (HashMap Text Text)) Source #

A map of key-value pairs that specifies the tags to associate with the custom data identifier.

A custom data identifier can have a maximum of 50 tags. Each tag consists of a tag key and an associated tag value. The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.

createCustomDataIdentifierResponse_customDataIdentifierId :: Lens' CreateCustomDataIdentifierResponse (Maybe Text) Source #

The unique identifier for the custom data identifier that was created.

CreateSampleFindings

createSampleFindings_findingTypes :: Lens' CreateSampleFindings (Maybe [FindingType]) Source #

An array that lists one or more types of findings to include in the set of sample findings. Currently, the only supported value is Policy:IAMUser/S3BucketEncryptionDisabled.

ListManagedDataIdentifiers

listManagedDataIdentifiers_nextToken :: Lens' ListManagedDataIdentifiers (Maybe Text) Source #

The nextToken string that specifies which page of results to return in a paginated response.

listManagedDataIdentifiersResponse_nextToken :: Lens' ListManagedDataIdentifiersResponse (Maybe Text) Source #

The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

UpdateMemberSession

updateMemberSession_id :: Lens' UpdateMemberSession Text Source #

The unique identifier for the Amazon Macie resource or account that the request applies to.

updateMemberSession_status :: Lens' UpdateMemberSession MacieStatus Source #

Specifies the new status for the account. Valid values are: ENABLED, resume all Amazon Macie activities for the account; and, PAUSED, suspend all Macie activities for the account.

GetInvitationsCount

getInvitationsCountResponse_invitationsCount :: Lens' GetInvitationsCountResponse (Maybe Integer) Source #

The total number of invitations that were received by the account, not including the currently accepted invitation.

UpdateOrganizationConfiguration

updateOrganizationConfiguration_autoEnable :: Lens' UpdateOrganizationConfiguration Bool Source #

Specifies whether to enable Amazon Macie automatically for each account, when the account is added to the Amazon Web Services organization.

DisassociateMember

disassociateMember_id :: Lens' DisassociateMember Text Source #

The unique identifier for the Amazon Macie resource or account that the request applies to.

CreateClassificationJob

createClassificationJob_initialRun :: Lens' CreateClassificationJob (Maybe Bool) Source #

For a recurring job, specifies whether to analyze all existing, eligible objects immediately after the job is created (true). To analyze only those objects that are created or changed after you create the job and before the job's first scheduled run, set this value to false.

If you configure the job to run only once, don't specify a value for this property.

createClassificationJob_samplingPercentage :: Lens' CreateClassificationJob (Maybe Int) Source #

The sampling depth, as a percentage, for the job to apply when processing objects. This value determines the percentage of eligible objects that the job analyzes. If this value is less than 100, Amazon Macie selects the objects to analyze at random, up to the specified percentage, and analyzes all the data in those objects.

createClassificationJob_managedDataIdentifierSelector :: Lens' CreateClassificationJob (Maybe ManagedDataIdentifierSelector) Source #

The selection type to apply when determining which managed data identifiers the job uses to analyze data. Valid values are:

  • ALL - Use all the managed data identifiers that Amazon Macie provides. If you specify this value, don't specify any values for the managedDataIdentifierIds property.
  • EXCLUDE - Use all the managed data identifiers that Macie provides except the managed data identifiers specified by the managedDataIdentifierIds property.
  • INCLUDE - Use only the managed data identifiers specified by the managedDataIdentifierIds property.
  • NONE - Don't use any managed data identifiers. If you specify this value, specify at least one custom data identifier for the job (customDataIdentifierIds) and don't specify any values for the managedDataIdentifierIds property.

If you don't specify a value for this property, the job uses all managed data identifiers. If you don't specify a value for this property or you specify ALL or EXCLUDE for a recurring job, the job also uses new managed data identifiers as they are released.

createClassificationJob_customDataIdentifierIds :: Lens' CreateClassificationJob (Maybe [Text]) Source #

An array of unique identifiers, one for each custom data identifier for the job to use when it analyzes data. To use only managed data identifiers, don't specify a value for this property and specify a value other than NONE for the managedDataIdentifierSelector property.

createClassificationJob_managedDataIdentifierIds :: Lens' CreateClassificationJob (Maybe [Text]) Source #

An array of unique identifiers, one for each managed data identifier for the job to include (use) or exclude (not use) when it analyzes data. Inclusion or exclusion depends on the managed data identifier selection type that you specify for the job (managedDataIdentifierSelector).

To retrieve a list of valid values for this property, use the ListManagedDataIdentifiers operation.

createClassificationJob_description :: Lens' CreateClassificationJob (Maybe Text) Source #

A custom description of the job. The description can contain as many as 200 characters.

createClassificationJob_tags :: Lens' CreateClassificationJob (Maybe (HashMap Text Text)) Source #

A map of key-value pairs that specifies the tags to associate with the job.

A job can have a maximum of 50 tags. Each tag consists of a tag key and an associated tag value. The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.

createClassificationJob_scheduleFrequency :: Lens' CreateClassificationJob (Maybe JobScheduleFrequency) Source #

The recurrence pattern for running the job. To run the job only once, don't specify a value for this property and set the value for the jobType property to ONE_TIME.

createClassificationJob_s3JobDefinition :: Lens' CreateClassificationJob S3JobDefinition Source #

The S3 buckets that contain the objects to analyze, and the scope of that analysis.

createClassificationJob_jobType :: Lens' CreateClassificationJob JobType Source #

The schedule for running the job. Valid values are:

  • ONE_TIME - Run the job only once. If you specify this value, don't specify a value for the scheduleFrequency property.
  • SCHEDULED - Run the job on a daily, weekly, or monthly basis. If you specify this value, use the scheduleFrequency property to define the recurrence pattern for the job.

createClassificationJob_clientToken :: Lens' CreateClassificationJob Text Source #

A unique, case-sensitive token that you provide to ensure the idempotency of the request.

createClassificationJob_name :: Lens' CreateClassificationJob Text Source #

A custom name for the job. The name can contain as many as 500 characters.

GetBucketStatistics

getBucketStatistics_accountId :: Lens' GetBucketStatistics (Maybe Text) Source #

The unique identifier for the Amazon Web Services account.

getBucketStatisticsResponse_sizeInBytesCompressed :: Lens' GetBucketStatisticsResponse (Maybe Integer) Source #

The total storage size, in bytes, of the objects that are compressed (.gz, .gzip, .zip) files in the buckets.

If versioning is enabled for any of the buckets, Amazon Macie calculates this value based on the size of the latest version of each applicable object in those buckets. This value doesn't reflect the storage size of all versions of the applicable objects in the buckets.

getBucketStatisticsResponse_lastUpdated :: Lens' GetBucketStatisticsResponse (Maybe UTCTime) Source #

The date and time, in UTC and extended ISO 8601 format, when Amazon Macie most recently retrieved both bucket and object metadata from Amazon S3 for the buckets.

getBucketStatisticsResponse_sizeInBytes :: Lens' GetBucketStatisticsResponse (Maybe Integer) Source #

The total storage size, in bytes, of the buckets.

If versioning is enabled for any of the buckets, Amazon Macie calculates this value based on the size of the latest version of each object in those buckets. This value doesn't reflect the storage size of all versions of the objects in the buckets.

getBucketStatisticsResponse_bucketCountBySharedAccessType :: Lens' GetBucketStatisticsResponse (Maybe BucketCountBySharedAccessType) Source #

The total number of buckets that are or aren't shared with another Amazon Web Services account.

getBucketStatisticsResponse_classifiableObjectCount :: Lens' GetBucketStatisticsResponse (Maybe Integer) Source #

The total number of objects that Amazon Macie can analyze in the buckets. These objects use a supported storage class and have a file name extension for a supported file or storage format.

getBucketStatisticsResponse_unclassifiableObjectSizeInBytes :: Lens' GetBucketStatisticsResponse (Maybe ObjectLevelStatistics) Source #

The total storage size, in bytes, of the objects that Amazon Macie can't analyze in the buckets. These objects don't use a supported storage class or don't have a file name extension for a supported file or storage format.

getBucketStatisticsResponse_unclassifiableObjectCount :: Lens' GetBucketStatisticsResponse (Maybe ObjectLevelStatistics) Source #

The total number of objects that Amazon Macie can't analyze in the buckets. These objects don't use a supported storage class or don't have a file name extension for a supported file or storage format.

getBucketStatisticsResponse_bucketCountByEffectivePermission :: Lens' GetBucketStatisticsResponse (Maybe BucketCountByEffectivePermission) Source #

The total number of buckets that are publicly accessible based on a combination of permissions settings for each bucket.

getBucketStatisticsResponse_bucketCountByObjectEncryptionRequirement :: Lens' GetBucketStatisticsResponse (Maybe BucketCountPolicyAllowsUnencryptedObjectUploads) Source #

The total number of buckets whose bucket policies do or don't require server-side encryption of objects when objects are uploaded to the buckets.

getBucketStatisticsResponse_classifiableSizeInBytes :: Lens' GetBucketStatisticsResponse (Maybe Integer) Source #

The total storage size, in bytes, of all the objects that Amazon Macie can analyze in the buckets. These objects use a supported storage class and have a file name extension for a supported file or storage format.

If versioning is enabled for any of the buckets, Macie calculates this value based on the size of the latest version of each applicable object in those buckets. This value doesn't reflect the storage size of all versions of all applicable objects in the buckets.

getBucketStatisticsResponse_bucketCountByEncryptionType :: Lens' GetBucketStatisticsResponse (Maybe BucketCountByEncryptionType) Source #

The total number of buckets that use certain types of server-side encryption to encrypt new objects by default. This object also reports the total number of buckets that don't encrypt new objects by default.

TagResource

tagResource_resourceArn :: Lens' TagResource Text Source #

The Amazon Resource Name (ARN) of the classification job, custom data identifier, findings filter, or member account.

tagResource_tags :: Lens' TagResource (HashMap Text Text) Source #

A map of key-value pairs that specifies the tags to associate with the resource.

A resource can have a maximum of 50 tags. Each tag consists of a tag key and an associated tag value. The maximum length of a tag key is 128 characters. The maximum length of a tag value is 256 characters.

GetFindings

getFindings_sortCriteria :: Lens' GetFindings (Maybe SortCriteria) Source #

The criteria for sorting the results of the request.

getFindings_findingIds :: Lens' GetFindings [Text] Source #

An array of strings that lists the unique identifiers for the findings to retrieve.

getFindingsResponse_findings :: Lens' GetFindingsResponse (Maybe [Finding]) Source #

An array of objects, one for each finding that meets the criteria specified in the request.

PutFindingsPublicationConfiguration

putFindingsPublicationConfiguration_clientToken :: Lens' PutFindingsPublicationConfiguration (Maybe Text) Source #

A unique, case-sensitive token that you provide to ensure the idempotency of the request.

putFindingsPublicationConfiguration_securityHubConfiguration :: Lens' PutFindingsPublicationConfiguration (Maybe SecurityHubConfiguration) Source #

The configuration settings that determine which findings to publish to Security Hub.

UntagResource

untagResource_tagKeys :: Lens' UntagResource [Text] Source #

The key of the tag to remove from the resource. To remove multiple tags, append the tagKeys parameter and argument for each additional tag to remove, separated by an ampersand (&).

untagResource_resourceArn :: Lens' UntagResource Text Source #

The Amazon Resource Name (ARN) of the classification job, custom data identifier, findings filter, or member account.

GetMacieSession

getMacieSessionResponse_status :: Lens' GetMacieSessionResponse (Maybe MacieStatus) Source #

The current status of the Macie account. Possible values are: PAUSED, the account is enabled but all Macie activities are suspended (paused) for the account; and, ENABLED, the account is enabled and all Macie activities are enabled for the account.

getMacieSessionResponse_createdAt :: Lens' GetMacieSessionResponse (Maybe UTCTime) Source #

The date and time, in UTC and extended ISO 8601 format, when the Amazon Macie account was created.

getMacieSessionResponse_findingPublishingFrequency :: Lens' GetMacieSessionResponse (Maybe FindingPublishingFrequency) Source #

The frequency with which Macie publishes updates to policy findings for the account. This includes publishing updates to Security Hub and Amazon EventBridge (formerly called Amazon CloudWatch Events).

getMacieSessionResponse_updatedAt :: Lens' GetMacieSessionResponse (Maybe UTCTime) Source #

The date and time, in UTC and extended ISO 8601 format, of the most recent change to the status of the Macie account.

getMacieSessionResponse_serviceRole :: Lens' GetMacieSessionResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the service-linked role that allows Macie to monitor and analyze data in Amazon Web Services resources for the account.

GetFindingStatistics

getFindingStatistics_size :: Lens' GetFindingStatistics (Maybe Int) Source #

The maximum number of items to include in each page of the response.

getFindingStatistics_findingCriteria :: Lens' GetFindingStatistics (Maybe FindingCriteria) Source #

The criteria to use to filter the query results.

getFindingStatistics_groupBy :: Lens' GetFindingStatistics GroupBy Source #

The finding property to use to group the query results. Valid values are:

  • classificationDetails.jobId - The unique identifier for the classification job that produced the finding.
  • resourcesAffected.s3Bucket.name - The name of the S3 bucket that the finding applies to.
  • severity.description - The severity level of the finding, such as High or Medium.
  • type - The type of finding, such as Policy:IAMUser/S3BucketPublic and SensitiveData:S3Object/Personal.

getFindingStatisticsResponse_countsByGroup :: Lens' GetFindingStatisticsResponse (Maybe [GroupCount]) Source #

An array of objects, one for each group of findings that meet the filter criteria specified in the request.

GetMember

getMember_id :: Lens' GetMember Text Source #

The unique identifier for the Amazon Macie resource or account that the request applies to.

getMemberResponse_email :: Lens' GetMemberResponse (Maybe Text) Source #

The email address for the account.

getMemberResponse_administratorAccountId :: Lens' GetMemberResponse (Maybe Text) Source #

The Amazon Web Services account ID for the administrator account.

getMemberResponse_arn :: Lens' GetMemberResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) of the account.

getMemberResponse_relationshipStatus :: Lens' GetMemberResponse (Maybe RelationshipStatus) Source #

The current status of the relationship between the account and the administrator account.

getMemberResponse_masterAccountId :: Lens' GetMemberResponse (Maybe Text) Source #

(Deprecated) The Amazon Web Services account ID for the administrator account. This property has been replaced by the administratorAccountId property and is retained only for backward compatibility.

getMemberResponse_invitedAt :: Lens' GetMemberResponse (Maybe UTCTime) Source #

The date and time, in UTC and extended ISO 8601 format, when an Amazon Macie membership invitation was last sent to the account. This value is null if a Macie invitation hasn't been sent to the account.

getMemberResponse_accountId :: Lens' GetMemberResponse (Maybe Text) Source #

The Amazon Web Services account ID for the account.

getMemberResponse_updatedAt :: Lens' GetMemberResponse (Maybe UTCTime) Source #

The date and time, in UTC and extended ISO 8601 format, of the most recent change to the status of the relationship between the account and the administrator account.

getMemberResponse_tags :: Lens' GetMemberResponse (Maybe (HashMap Text Text)) Source #

A map of key-value pairs that identifies the tags (keys and values) that are associated with the member account in Amazon Macie.

getMemberResponse_httpStatus :: Lens' GetMemberResponse Int Source #

The response's http status code.

DisassociateFromAdministratorAccount

DeleteCustomDataIdentifier

deleteCustomDataIdentifier_id :: Lens' DeleteCustomDataIdentifier Text Source #

The unique identifier for the Amazon Macie resource or account that the request applies to.

DisableOrganizationAdminAccount

disableOrganizationAdminAccount_adminAccountId :: Lens' DisableOrganizationAdminAccount Text Source #

The Amazon Web Services account ID of the delegated Amazon Macie administrator account.

ListCustomDataIdentifiers

listCustomDataIdentifiers_nextToken :: Lens' ListCustomDataIdentifiers (Maybe Text) Source #

The nextToken string that specifies which page of results to return in a paginated response.

listCustomDataIdentifiers_maxResults :: Lens' ListCustomDataIdentifiers (Maybe Int) Source #

The maximum number of items to include in each page of the response.

listCustomDataIdentifiersResponse_nextToken :: Lens' ListCustomDataIdentifiersResponse (Maybe Text) Source #

The string to use in a subsequent request to get the next page of results in a paginated response. This value is null if there are no additional pages.

Types

AccessControlList

accessControlList_allowsPublicWriteAccess :: Lens' AccessControlList (Maybe Bool) Source #

Specifies whether the ACL grants the general public with write access permissions for the bucket.

accessControlList_allowsPublicReadAccess :: Lens' AccessControlList (Maybe Bool) Source #

Specifies whether the ACL grants the general public with read access permissions for the bucket.

AccountDetail

accountDetail_email :: Lens' AccountDetail Text Source #

The email address for the account.

accountDetail_accountId :: Lens' AccountDetail Text Source #

The Amazon Web Services account ID for the account.

AccountLevelPermissions

accountLevelPermissions_blockPublicAccess :: Lens' AccountLevelPermissions (Maybe BlockPublicAccess) Source #

The block public access settings for the Amazon Web Services account that owns the bucket.

AdminAccount

adminAccount_status :: Lens' AdminAccount (Maybe AdminStatus) Source #

The current status of the account as the delegated administrator of Amazon Macie for the organization.

adminAccount_accountId :: Lens' AdminAccount (Maybe Text) Source #

The Amazon Web Services account ID for the account.

ApiCallDetails

apiCallDetails_firstSeen :: Lens' ApiCallDetails (Maybe UTCTime) Source #

The first date and time, in UTC and extended ISO 8601 format, when any operation was invoked and produced the finding.

apiCallDetails_apiServiceName :: Lens' ApiCallDetails (Maybe Text) Source #

The URL of the Amazon Web Service that provides the operation, for example: s3.amazonaws.com.

apiCallDetails_lastSeen :: Lens' ApiCallDetails (Maybe UTCTime) Source #

The most recent date and time, in UTC and extended ISO 8601 format, when the specified operation (api) was invoked and produced the finding.

apiCallDetails_api :: Lens' ApiCallDetails (Maybe Text) Source #

The name of the operation that was invoked most recently and produced the finding.

AssumedRole

assumedRole_principalId :: Lens' AssumedRole (Maybe Text) Source #

The unique identifier for the entity that was used to get the credentials.

assumedRole_arn :: Lens' AssumedRole (Maybe Text) Source #

The Amazon Resource Name (ARN) of the entity that was used to get the credentials.

assumedRole_sessionContext :: Lens' AssumedRole (Maybe SessionContext) Source #

The details of the session that was created for the credentials, including the entity that issued the session.

assumedRole_accountId :: Lens' AssumedRole (Maybe Text) Source #

The unique identifier for the Amazon Web Services account that owns the entity that was used to get the credentials.

assumedRole_accessKeyId :: Lens' AssumedRole (Maybe Text) Source #

The Amazon Web Services access key ID that identifies the credentials.

AwsAccount

awsAccount_principalId :: Lens' AwsAccount (Maybe Text) Source #

The unique identifier for the entity that performed the action.

awsAccount_accountId :: Lens' AwsAccount (Maybe Text) Source #

The unique identifier for the Amazon Web Services account.

AwsService

awsService_invokedBy :: Lens' AwsService (Maybe Text) Source #

The name of the Amazon Web Service that performed the action.

BatchGetCustomDataIdentifierSummary

batchGetCustomDataIdentifierSummary_arn :: Lens' BatchGetCustomDataIdentifierSummary (Maybe Text) Source #

The Amazon Resource Name (ARN) of the custom data identifier.

batchGetCustomDataIdentifierSummary_createdAt :: Lens' BatchGetCustomDataIdentifierSummary (Maybe UTCTime) Source #

The date and time, in UTC and extended ISO 8601 format, when the custom data identifier was created.

batchGetCustomDataIdentifierSummary_id :: Lens' BatchGetCustomDataIdentifierSummary (Maybe Text) Source #

The unique identifier for the custom data identifier.

batchGetCustomDataIdentifierSummary_deleted :: Lens' BatchGetCustomDataIdentifierSummary (Maybe Bool) Source #

Specifies whether the custom data identifier was deleted. If you delete a custom data identifier, Amazon Macie doesn't delete it permanently. Instead, it soft deletes the identifier.

BlockPublicAccess

blockPublicAccess_ignorePublicAcls :: Lens' BlockPublicAccess (Maybe Bool) Source #

Specifies whether Amazon S3 ignores public ACLs for the bucket and objects in the bucket.

blockPublicAccess_blockPublicAcls :: Lens' BlockPublicAccess (Maybe Bool) Source #

Specifies whether Amazon S3 blocks public access control lists (ACLs) for the bucket and objects in the bucket.

blockPublicAccess_restrictPublicBuckets :: Lens' BlockPublicAccess (Maybe Bool) Source #

Specifies whether Amazon S3 restricts public bucket policies for the bucket.

blockPublicAccess_blockPublicPolicy :: Lens' BlockPublicAccess (Maybe Bool) Source #

Specifies whether Amazon S3 blocks public bucket policies for the bucket.

BucketCountByEffectivePermission

bucketCountByEffectivePermission_publiclyAccessible :: Lens' BucketCountByEffectivePermission (Maybe Integer) Source #

The total number of buckets that allow the general public to have read or write access to the bucket.

bucketCountByEffectivePermission_unknown :: Lens' BucketCountByEffectivePermission (Maybe Integer) Source #

The total number of buckets that Amazon Macie wasn't able to evaluate permissions settings for. Macie can't determine whether these buckets are publicly accessible.

bucketCountByEffectivePermission_publiclyReadable :: Lens' BucketCountByEffectivePermission (Maybe Integer) Source #

The total number of buckets that allow the general public to have read access to the bucket.

bucketCountByEffectivePermission_publiclyWritable :: Lens' BucketCountByEffectivePermission (Maybe Integer) Source #

The total number of buckets that allow the general public to have write access to the bucket.

BucketCountByEncryptionType

bucketCountByEncryptionType_unknown :: Lens' BucketCountByEncryptionType (Maybe Integer) Source #

The total number of buckets that Amazon Macie doesn't have current encryption metadata for. Macie can't provide current data about the default encryption settings for these buckets.

bucketCountByEncryptionType_s3Managed :: Lens' BucketCountByEncryptionType (Maybe Integer) Source #

The total number of buckets that use an Amazon S3 managed key to encrypt new objects by default. These buckets use Amazon S3 managed encryption (SSE-S3) by default.

bucketCountByEncryptionType_unencrypted :: Lens' BucketCountByEncryptionType (Maybe Integer) Source #

The total number of buckets that don't encrypt new objects by default. Default encryption is disabled for these buckets.

bucketCountByEncryptionType_kmsManaged :: Lens' BucketCountByEncryptionType (Maybe Integer) Source #

The total number of buckets that use an KMS key to encrypt new objects by default, either an Amazon Web Services managed key or a customer managed key. These buckets use KMS encryption (SSE-KMS) by default.

BucketCountBySharedAccessType

bucketCountBySharedAccessType_notShared :: Lens' BucketCountBySharedAccessType (Maybe Integer) Source #

The total number of buckets that aren't shared with other Amazon Web Services accounts.

bucketCountBySharedAccessType_internal :: Lens' BucketCountBySharedAccessType (Maybe Integer) Source #

The total number of buckets that are shared with an Amazon Web Services account that's part of the same Amazon Macie organization.

bucketCountBySharedAccessType_external :: Lens' BucketCountBySharedAccessType (Maybe Integer) Source #

The total number of buckets that are shared with an Amazon Web Services account that isn't part of the same Amazon Macie organization.

bucketCountBySharedAccessType_unknown :: Lens' BucketCountBySharedAccessType (Maybe Integer) Source #

The total number of buckets that Amazon Macie wasn't able to evaluate shared access settings for. Macie can't determine whether these buckets are shared with other Amazon Web Services accounts.

BucketCountPolicyAllowsUnencryptedObjectUploads

bucketCountPolicyAllowsUnencryptedObjectUploads_deniesUnencryptedObjectUploads :: Lens' BucketCountPolicyAllowsUnencryptedObjectUploads (Maybe Integer) Source #

The total number of buckets whose bucket policies require server-side encryption of new objects. PutObject requests for these buckets must include the x-amz-server-side-encryption header and the value for that header must be AES256 or aws:kms.

bucketCountPolicyAllowsUnencryptedObjectUploads_unknown :: Lens' BucketCountPolicyAllowsUnencryptedObjectUploads (Maybe Integer) Source #

The total number of buckets that Amazon Macie wasn't able to evaluate server-side encryption requirements for. Macie can't determine whether the bucket policies for these buckets require server-side encryption of new objects.

bucketCountPolicyAllowsUnencryptedObjectUploads_allowsUnencryptedObjectUploads :: Lens' BucketCountPolicyAllowsUnencryptedObjectUploads (Maybe Integer) Source #

The total number of buckets that don't have a bucket policy or have a bucket policy that doesn't require server-side encryption of new objects. If a bucket policy exists, the policy doesn't require PutObject requests to include the x-amz-server-side-encryption header and it doesn't require the value for that header to be AES256 or aws:kms.

BucketCriteriaAdditionalProperties

bucketCriteriaAdditionalProperties_eq :: Lens' BucketCriteriaAdditionalProperties (Maybe [Text]) Source #

The value for the property matches (equals) the specified value. If you specify multiple values, Amazon Macie uses OR logic to join the values.

bucketCriteriaAdditionalProperties_lte :: Lens' BucketCriteriaAdditionalProperties (Maybe Integer) Source #

The value for the property is less than or equal to the specified value.

bucketCriteriaAdditionalProperties_prefix :: Lens' BucketCriteriaAdditionalProperties (Maybe Text) Source #

The name of the bucket begins with the specified value.

bucketCriteriaAdditionalProperties_gt :: Lens' BucketCriteriaAdditionalProperties (Maybe Integer) Source #

The value for the property is greater than the specified value.

bucketCriteriaAdditionalProperties_neq :: Lens' BucketCriteriaAdditionalProperties (Maybe [Text]) Source #

The value for the property doesn't match (doesn't equal) the specified value. If you specify multiple values, Amazon Macie uses OR logic to join the values.

bucketCriteriaAdditionalProperties_lt :: Lens' BucketCriteriaAdditionalProperties (Maybe Integer) Source #

The value for the property is less than the specified value.

bucketCriteriaAdditionalProperties_gte :: Lens' BucketCriteriaAdditionalProperties (Maybe Integer) Source #

The value for the property is greater than or equal to the specified value.

BucketLevelPermissions

bucketLevelPermissions_accessControlList :: Lens' BucketLevelPermissions (Maybe AccessControlList) Source #

The permissions settings of the access control list (ACL) for the bucket. This value is null if an ACL hasn't been defined for the bucket.

bucketLevelPermissions_bucketPolicy :: Lens' BucketLevelPermissions (Maybe BucketPolicy) Source #

The permissions settings of the bucket policy for the bucket. This value is null if a bucket policy hasn't been defined for the bucket.

BucketMetadata

bucketMetadata_sizeInBytesCompressed :: Lens' BucketMetadata (Maybe Integer) Source #

The total storage size, in bytes, of the objects that are compressed (.gz, .gzip, .zip) files in the bucket.

If versioning is enabled for the bucket, Amazon Macie calculates this value based on the size of the latest version of each applicable object in the bucket. This value doesn't reflect the storage size of all versions of each applicable object in the bucket.

bucketMetadata_lastUpdated :: Lens' BucketMetadata (Maybe UTCTime) Source #

The date and time, in UTC and extended ISO 8601 format, when Amazon Macie most recently retrieved both bucket and object metadata from Amazon S3 for the bucket.

bucketMetadata_objectCountByEncryptionType :: Lens' BucketMetadata (Maybe ObjectCountByEncryptionType) Source #

The total number of objects that are in the bucket, grouped by server-side encryption type. This includes a grouping that reports the total number of objects that aren't encrypted or use client-side encryption.

bucketMetadata_sharedAccess :: Lens' BucketMetadata (Maybe SharedAccess) Source #

Specifies whether the bucket is shared with another Amazon Web Services account. Possible values are:

  • EXTERNAL - The bucket is shared with an Amazon Web Services account that isn't part of the same Amazon Macie organization.
  • INTERNAL - The bucket is shared with an Amazon Web Services account that's part of the same Amazon Macie organization.
  • NOT_SHARED - The bucket isn't shared with other Amazon Web Services accounts.
  • UNKNOWN - Amazon Macie wasn't able to evaluate the shared access settings for the bucket.

bucketMetadata_sizeInBytes :: Lens' BucketMetadata (Maybe Integer) Source #

The total storage size, in bytes, of the bucket.

If versioning is enabled for the bucket, Amazon Macie calculates this value based on the size of the latest version of each object in the bucket. This value doesn't reflect the storage size of all versions of each object in the bucket.

bucketMetadata_classifiableObjectCount :: Lens' BucketMetadata (Maybe Integer) Source #

The total number of objects that Amazon Macie can analyze in the bucket. These objects use a supported storage class and have a file name extension for a supported file or storage format.

bucketMetadata_accountId :: Lens' BucketMetadata (Maybe Text) Source #

The unique identifier for the Amazon Web Services account that owns the bucket.

bucketMetadata_unclassifiableObjectSizeInBytes :: Lens' BucketMetadata (Maybe ObjectLevelStatistics) Source #

The total storage size, in bytes, of the objects that Amazon Macie can't analyze in the bucket. These objects don't use a supported storage class or don't have a file name extension for a supported file or storage format.

bucketMetadata_unclassifiableObjectCount :: Lens' BucketMetadata (Maybe ObjectLevelStatistics) Source #

The total number of objects that Amazon Macie can't analyze in the bucket. These objects don't use a supported storage class or don't have a file name extension for a supported file or storage format.

bucketMetadata_versioning :: Lens' BucketMetadata (Maybe Bool) Source #

Specifies whether versioning is enabled for the bucket.

bucketMetadata_allowsUnencryptedObjectUploads :: Lens' BucketMetadata (Maybe AllowsUnencryptedObjectUploads) Source #

Specifies whether the bucket policy for the bucket requires server-side encryption of objects when objects are uploaded to the bucket. Possible values are:

  • FALSE - The bucket policy requires server-side encryption of new objects. PutObject requests must include the x-amz-server-side-encryption header and the value for that header must be AES256 or aws:kms.
  • TRUE - The bucket doesn't have a bucket policy or it has a bucket policy that doesn't require server-side encryption of new objects. If a bucket policy exists, it doesn't require PutObject requests to include the x-amz-server-side-encryption header and it doesn't require the value for that header to be AES256 or aws:kms.
  • UNKNOWN - Amazon Macie can't determine whether the bucket policy requires server-side encryption of new objects.

bucketMetadata_publicAccess :: Lens' BucketMetadata (Maybe BucketPublicAccess) Source #

Specifies whether the bucket is publicly accessible due to the combination of permissions settings that apply to the bucket, and provides information about those settings.

bucketMetadata_errorCode :: Lens' BucketMetadata (Maybe BucketMetadataErrorCode) Source #

Specifies the error code for an error that prevented Amazon Macie from retrieving and processing information about the bucket and the bucket's objects. If this value is ACCESS_DENIED, Macie doesn't have permission to retrieve the information. For example, the bucket has a restrictive bucket policy and Amazon S3 denied the request. If this value is null, Macie was able to retrieve and process the information.

bucketMetadata_jobDetails :: Lens' BucketMetadata (Maybe JobDetails) Source #

Specifies whether any one-time or recurring classification jobs are configured to analyze data in the bucket, and, if so, the details of the job that ran most recently.

bucketMetadata_region :: Lens' BucketMetadata (Maybe Text) Source #

The Amazon Web Services Region that hosts the bucket.

bucketMetadata_bucketCreatedAt :: Lens' BucketMetadata (Maybe UTCTime) Source #

The date and time, in UTC and extended ISO 8601 format, when the bucket was created.

bucketMetadata_errorMessage :: Lens' BucketMetadata (Maybe Text) Source #

A brief description of the error (errorCode) that prevented Amazon Macie from retrieving and processing information about the bucket and the bucket's objects. This value is null if Macie was able to retrieve and process the information.

bucketMetadata_bucketArn :: Lens' BucketMetadata (Maybe Text) Source #

The Amazon Resource Name (ARN) of the bucket.

bucketMetadata_objectCount :: Lens' BucketMetadata (Maybe Integer) Source #

The total number of objects in the bucket.

bucketMetadata_replicationDetails :: Lens' BucketMetadata (Maybe ReplicationDetails) Source #

Specifies whether the bucket is configured to replicate one or more objects to buckets for other Amazon Web Services accounts and, if so, which accounts.

bucketMetadata_serverSideEncryption :: Lens' BucketMetadata (Maybe BucketServerSideEncryption) Source #

Specifies whether the bucket encrypts new objects by default and, if so, the type of server-side encryption that's used.

bucketMetadata_tags :: Lens' BucketMetadata (Maybe [KeyValuePair]) Source #

An array that specifies the tags (keys and values) that are associated with the bucket.

bucketMetadata_classifiableSizeInBytes :: Lens' BucketMetadata (Maybe Integer) Source #

The total storage size, in bytes, of the objects that Amazon Macie can analyze in the bucket. These objects use a supported storage class and have a file name extension for a supported file or storage format.

If versioning is enabled for the bucket, Macie calculates this value based on the size of the latest version of each applicable object in the bucket. This value doesn't reflect the storage size of all versions of each applicable object in the bucket.

BucketPermissionConfiguration

BucketPolicy

bucketPolicy_allowsPublicWriteAccess :: Lens' BucketPolicy (Maybe Bool) Source #

Specifies whether the bucket policy allows the general public to have write access to the bucket.

bucketPolicy_allowsPublicReadAccess :: Lens' BucketPolicy (Maybe Bool) Source #

Specifies whether the bucket policy allows the general public to have read access to the bucket.

BucketPublicAccess

bucketPublicAccess_permissionConfiguration :: Lens' BucketPublicAccess (Maybe BucketPermissionConfiguration) Source #

The account-level and bucket-level permissions settings for the bucket.

bucketPublicAccess_effectivePermission :: Lens' BucketPublicAccess (Maybe EffectivePermission) Source #

Specifies whether the bucket is publicly accessible due to the combination of permissions settings that apply to the bucket. Possible values are:

  • NOT_PUBLIC - The bucket isn't publicly accessible.
  • PUBLIC - The bucket is publicly accessible.
  • UNKNOWN - Amazon Macie can't determine whether the bucket is publicly accessible.

BucketServerSideEncryption

bucketServerSideEncryption_kmsMasterKeyId :: Lens' BucketServerSideEncryption (Maybe Text) Source #

The Amazon Resource Name (ARN) or unique identifier (key ID) for the KMS key that's used by default to encrypt objects that are added to the bucket. This value is null if the bucket uses an Amazon S3 managed key to encrypt new objects or the bucket doesn't encrypt new objects by default.

bucketServerSideEncryption_type :: Lens' BucketServerSideEncryption (Maybe Type) Source #

The type of server-side encryption that's used by default when storing new objects in the bucket. Possible values are:

  • AES256 - New objects are encrypted with an Amazon S3 managed key. They use SSE-S3 encryption.
  • aws:kms - New objects are encrypted with an KMS key (kmsMasterKeyId), either an Amazon Web Services managed key or a customer managed key. They use SSE-KMS encryption.
  • NONE - New objects aren't encrypted by default. Default encryption is disabled for the bucket.

BucketSortCriteria

bucketSortCriteria_orderBy :: Lens' BucketSortCriteria (Maybe OrderBy) Source #

The sort order to apply to the results, based on the value specified by the attributeName property. Valid values are: ASC, sort the results in ascending order; and, DESC, sort the results in descending order.

bucketSortCriteria_attributeName :: Lens' BucketSortCriteria (Maybe Text) Source #

The name of the bucket property to sort the results by. This value can be one of the following properties that Amazon Macie defines as bucket metadata: accountId, bucketName, classifiableObjectCount, classifiableSizeInBytes, objectCount, or sizeInBytes.

Cell

cell_row :: Lens' Cell (Maybe Integer) Source #

The row number of the row that contains the sensitive data.

cell_cellReference :: Lens' Cell (Maybe Text) Source #

The location of the cell, as an absolute cell reference, that contains the sensitive data, for example Sheet2!C5 for cell C5 on Sheet2 in a Microsoft Excel workbook. This value is null for CSV and TSV files.

cell_column :: Lens' Cell (Maybe Integer) Source #

The column number of the column that contains the sensitive data. For a Microsoft Excel workbook, this value correlates to the alphabetical character(s) for a column identifier, for example: 1 for column A, 2 for column B, and so on.

cell_columnName :: Lens' Cell (Maybe Text) Source #

The name of the column that contains the sensitive data, if available.

ClassificationDetails

classificationDetails_detailedResultsLocation :: Lens' ClassificationDetails (Maybe Text) Source #

The path to the folder or file (in Amazon S3) that contains the corresponding sensitive data discovery result for the finding. If a finding applies to a large archive or compressed file, this value is the path to a folder. Otherwise, this value is the path to a file.

classificationDetails_jobId :: Lens' ClassificationDetails (Maybe Text) Source #

The unique identifier for the classification job that produced the finding.

classificationDetails_jobArn :: Lens' ClassificationDetails (Maybe Text) Source #

The Amazon Resource Name (ARN) of the classification job that produced the finding.

ClassificationExportConfiguration

classificationExportConfiguration_s3Destination :: Lens' ClassificationExportConfiguration (Maybe S3Destination) Source #

The S3 bucket to store data classification results in, and the encryption settings to use when storing results in that bucket.

ClassificationResult

classificationResult_sensitiveData :: Lens' ClassificationResult (Maybe [SensitiveDataItem]) Source #

The category, types, and number of occurrences of the sensitive data that produced the finding.

classificationResult_mimeType :: Lens' ClassificationResult (Maybe Text) Source #

The type of content, as a MIME type, that the finding applies to. For example, application/gzip, for a GNU Gzip compressed archive file, or application/pdf, for an Adobe Portable Document Format file.

classificationResult_sizeClassified :: Lens' ClassificationResult (Maybe Integer) Source #

The total size, in bytes, of the data that the finding applies to.

classificationResult_additionalOccurrences :: Lens' ClassificationResult (Maybe Bool) Source #

Specifies whether Amazon Macie detected additional occurrences of sensitive data in the S3 object. A finding includes location data for a maximum of 15 occurrences of sensitive data.

This value can help you determine whether to investigate additional occurrences of sensitive data in an object. You can do this by referring to the corresponding sensitive data discovery result for the finding (ClassificationDetails.detailedResultsLocation).

classificationResult_customDataIdentifiers :: Lens' ClassificationResult (Maybe CustomDataIdentifiers) Source #

The custom data identifiers that detected the sensitive data and the number of occurrences of the data that they detected.

ClassificationResultStatus

classificationResultStatus_reason :: Lens' ClassificationResultStatus (Maybe Text) Source #

A brief description of the status of the finding. Amazon Macie uses this value to notify you of any errors, warnings, or considerations that might impact your analysis of the finding.

classificationResultStatus_code :: Lens' ClassificationResultStatus (Maybe Text) Source #

The status of the finding. Possible values are:

  • COMPLETE - Amazon Macie successfully completed its analysis of the S3 object that the finding applies to.
  • PARTIAL - Macie analyzed only a subset of the data in the S3 object that the finding applies to. For example, the object is an archive file that contains files in an unsupported format.
  • SKIPPED - Macie wasn't able to analyze the S3 object that the finding applies to. For example, the object is a file in an unsupported format.

CriteriaBlockForJob

criteriaBlockForJob_and :: Lens' CriteriaBlockForJob (Maybe [CriteriaForJob]) Source #

An array of conditions, one for each condition that determines which buckets to include or exclude from the job. If you specify more than one condition, Amazon Macie uses AND logic to join the conditions.

CriteriaForJob

criteriaForJob_tagCriterion :: Lens' CriteriaForJob (Maybe TagCriterionForJob) Source #

A tag-based condition that defines an operator and tag keys, tag values, or tag key and value pairs for including or excluding buckets from the job.

criteriaForJob_simpleCriterion :: Lens' CriteriaForJob (Maybe SimpleCriterionForJob) Source #

A property-based condition that defines a property, operator, and one or more values for including or excluding buckets from the job.

CriterionAdditionalProperties

criterionAdditionalProperties_eq :: Lens' CriterionAdditionalProperties (Maybe [Text]) Source #

The value for the property matches (equals) the specified value. If you specify multiple values, Macie uses OR logic to join the values.

criterionAdditionalProperties_lte :: Lens' CriterionAdditionalProperties (Maybe Integer) Source #

The value for the property is less than or equal to the specified value.

criterionAdditionalProperties_gt :: Lens' CriterionAdditionalProperties (Maybe Integer) Source #

The value for the property is greater than the specified value.

criterionAdditionalProperties_eqExactMatch :: Lens' CriterionAdditionalProperties (Maybe [Text]) Source #

The value for the property exclusively matches (equals an exact match for) all the specified values. If you specify multiple values, Amazon Macie uses AND logic to join the values.

You can use this operator with the following properties: customDataIdentifiers.detections.arn, customDataIdentifiers.detections.name, resourcesAffected.s3Bucket.tags.key, resourcesAffected.s3Bucket.tags.value, resourcesAffected.s3Object.tags.key, resourcesAffected.s3Object.tags.value, sensitiveData.category, and sensitiveData.detections.type.

criterionAdditionalProperties_neq :: Lens' CriterionAdditionalProperties (Maybe [Text]) Source #

The value for the property doesn't match (doesn't equal) the specified value. If you specify multiple values, Macie uses OR logic to join the values.

criterionAdditionalProperties_lt :: Lens' CriterionAdditionalProperties (Maybe Integer) Source #

The value for the property is less than the specified value.

criterionAdditionalProperties_gte :: Lens' CriterionAdditionalProperties (Maybe Integer) Source #

The value for the property is greater than or equal to the specified value.

CustomDataIdentifierSummary

customDataIdentifierSummary_arn :: Lens' CustomDataIdentifierSummary (Maybe Text) Source #

The Amazon Resource Name (ARN) of the custom data identifier.

customDataIdentifierSummary_createdAt :: Lens' CustomDataIdentifierSummary (Maybe UTCTime) Source #

The date and time, in UTC and extended ISO 8601 format, when the custom data identifier was created.

customDataIdentifierSummary_name :: Lens' CustomDataIdentifierSummary (Maybe Text) Source #

The custom name of the custom data identifier.

customDataIdentifierSummary_id :: Lens' CustomDataIdentifierSummary (Maybe Text) Source #

The unique identifier for the custom data identifier.

customDataIdentifierSummary_description :: Lens' CustomDataIdentifierSummary (Maybe Text) Source #

The custom description of the custom data identifier.

CustomDataIdentifiers

customDataIdentifiers_detections :: Lens' CustomDataIdentifiers (Maybe [CustomDetection]) Source #

The custom data identifiers that detected the data, and the number of occurrences of the data that each identifier detected.

customDataIdentifiers_totalCount :: Lens' CustomDataIdentifiers (Maybe Integer) Source #

The total number of occurrences of the data that was detected by the custom data identifiers and produced the finding.

CustomDetection

customDetection_occurrences :: Lens' CustomDetection (Maybe Occurrences) Source #

The location of 1-15 occurrences of the sensitive data that the custom data identifier detected. A finding includes location data for a maximum of 15 occurrences of sensitive data.

customDetection_arn :: Lens' CustomDetection (Maybe Text) Source #

The Amazon Resource Name (ARN) of the custom data identifier.

customDetection_count :: Lens' CustomDetection (Maybe Integer) Source #

The total number of occurrences of the sensitive data that the custom data identifier detected.

customDetection_name :: Lens' CustomDetection (Maybe Text) Source #

The name of the custom data identifier.

DailySchedule

DefaultDetection

defaultDetection_occurrences :: Lens' DefaultDetection (Maybe Occurrences) Source #

The location of 1-15 occurrences of the sensitive data that was detected. A finding includes location data for a maximum of 15 occurrences of sensitive data.

defaultDetection_count :: Lens' DefaultDetection (Maybe Integer) Source #

The total number of occurrences of the type of sensitive data that was detected.

defaultDetection_type :: Lens' DefaultDetection (Maybe Text) Source #

The type of sensitive data that was detected. For example, AWS_CREDENTIALS, PHONE_NUMBER, or ADDRESS.

DomainDetails

FederatedUser

federatedUser_principalId :: Lens' FederatedUser (Maybe Text) Source #

The unique identifier for the entity that was used to get the credentials.

federatedUser_arn :: Lens' FederatedUser (Maybe Text) Source #

The Amazon Resource Name (ARN) of the entity that was used to get the credentials.

federatedUser_sessionContext :: Lens' FederatedUser (Maybe SessionContext) Source #

The details of the session that was created for the credentials, including the entity that issued the session.

federatedUser_accountId :: Lens' FederatedUser (Maybe Text) Source #

The unique identifier for the Amazon Web Services account that owns the entity that was used to get the credentials.

federatedUser_accessKeyId :: Lens' FederatedUser (Maybe Text) Source #

The Amazon Web Services access key ID that identifies the credentials.

Finding

finding_classificationDetails :: Lens' Finding (Maybe ClassificationDetails) Source #

The details of a sensitive data finding. This value is null for a policy finding.

finding_policyDetails :: Lens' Finding (Maybe PolicyDetails) Source #

The details of a policy finding. This value is null for a sensitive data finding.

finding_createdAt :: Lens' Finding (Maybe UTCTime) Source #

The date and time, in UTC and extended ISO 8601 format, when the finding was created.

finding_category :: Lens' Finding (Maybe FindingCategory) Source #

The category of the finding. Possible values are: CLASSIFICATION, for a sensitive data finding; and, POLICY, for a policy finding.

finding_severity :: Lens' Finding (Maybe Severity) Source #

The severity level and score for the finding.

finding_count :: Lens' Finding (Maybe Integer) Source #

The total number of occurrences of the finding. For sensitive data findings, this value is always 1. All sensitive data findings are considered new (unique) because they derive from individual classification jobs.

finding_schemaVersion :: Lens' Finding (Maybe Text) Source #

The version of the schema that was used to define the data structures in the finding.

finding_resourcesAffected :: Lens' Finding (Maybe ResourcesAffected) Source #

The resources that the finding applies to.

finding_accountId :: Lens' Finding (Maybe Text) Source #

The unique identifier for the Amazon Web Services account that the finding applies to. This is typically the account that owns the affected resource.

finding_partition :: Lens' Finding (Maybe Text) Source #

The Amazon Web Services partition that Amazon Macie created the finding in.

finding_id :: Lens' Finding (Maybe Text) Source #

The unique identifier for the finding. This is a random string that Amazon Macie generates and assigns to a finding when it creates the finding.

finding_region :: Lens' Finding (Maybe Text) Source #

The Amazon Web Services Region that Amazon Macie created the finding in.

finding_updatedAt :: Lens' Finding (Maybe UTCTime) Source #

The date and time, in UTC and extended ISO 8601 format, when the finding was last updated. For sensitive data findings, this value is the same as the value for the createdAt property. All sensitive data findings are considered new (unique) because they derive from individual classification jobs.

finding_title :: Lens' Finding (Maybe Text) Source #

The brief description of the finding.

finding_type :: Lens' Finding (Maybe FindingType) Source #

The type of the finding.

finding_archived :: Lens' Finding (Maybe Bool) Source #

Specifies whether the finding is archived (suppressed).

finding_description :: Lens' Finding (Maybe Text) Source #

The description of the finding.

finding_sample :: Lens' Finding (Maybe Bool) Source #

Specifies whether the finding is a sample finding. A sample finding is a finding that uses example data to demonstrate what a finding might contain.

FindingAction

findingAction_apiCallDetails :: Lens' FindingAction (Maybe ApiCallDetails) Source #

The invocation details of the API operation that an entity invoked for the affected resource, if the value for the actionType property is AWS_API_CALL.

findingAction_actionType :: Lens' FindingAction (Maybe FindingActionType) Source #

The type of action that occurred for the affected resource. This value is typically AWS_API_CALL, which indicates that an entity invoked an API operation for the resource.

FindingActor

findingActor_userIdentity :: Lens' FindingActor (Maybe UserIdentity) Source #

The type and other characteristics of the entity that performed the action on the affected resource.

findingActor_ipAddressDetails :: Lens' FindingActor (Maybe IpAddressDetails) Source #

The IP address of the device that the entity used to perform the action on the affected resource. This object also provides information such as the owner and geographic location for the IP address.

findingActor_domainDetails :: Lens' FindingActor (Maybe DomainDetails) Source #

The domain name of the device that the entity used to perform the action on the affected resource.

FindingCriteria

findingCriteria_criterion :: Lens' FindingCriteria (Maybe (HashMap Text CriterionAdditionalProperties)) Source #

A condition that specifies the property, operator, and one or more values to use to filter the results.

FindingStatisticsSortCriteria

findingStatisticsSortCriteria_orderBy :: Lens' FindingStatisticsSortCriteria (Maybe OrderBy) Source #

The sort order to apply to the results, based on the value for the property specified by the attributeName property. Valid values are: ASC, sort the results in ascending order; and, DESC, sort the results in descending order.

findingStatisticsSortCriteria_attributeName :: Lens' FindingStatisticsSortCriteria (Maybe FindingStatisticsSortAttributeName) Source #

The grouping to sort the results by. Valid values are: count, sort the results by the number of findings in each group of results; and, groupKey, sort the results by the name of each group of results.

FindingsFilterListItem

findingsFilterListItem_arn :: Lens' FindingsFilterListItem (Maybe Text) Source #

The Amazon Resource Name (ARN) of the filter.

findingsFilterListItem_action :: Lens' FindingsFilterListItem (Maybe FindingsFilterAction) Source #

The action that's performed on findings that meet the filter criteria. Possible values are: ARCHIVE, suppress (automatically archive) the findings; and, NOOP, don't perform any action on the findings.

findingsFilterListItem_id :: Lens' FindingsFilterListItem (Maybe Text) Source #

The unique identifier for the filter.

findingsFilterListItem_tags :: Lens' FindingsFilterListItem (Maybe (HashMap Text Text)) Source #

A map of key-value pairs that identifies the tags (keys and values) that are associated with the filter.

GroupCount

groupCount_groupKey :: Lens' GroupCount (Maybe Text) Source #

The name of the property that defines the group in the query results, as specified by the groupBy property in the query request.

groupCount_count :: Lens' GroupCount (Maybe Integer) Source #

The total number of findings in the group of query results.

IamUser

iamUser_principalId :: Lens' IamUser (Maybe Text) Source #

The unique identifier for the IAM user who performed the action.

iamUser_arn :: Lens' IamUser (Maybe Text) Source #

The Amazon Resource Name (ARN) of the principal that performed the action. The last section of the ARN contains the name of the user who performed the action.

iamUser_userName :: Lens' IamUser (Maybe Text) Source #

The user name of the IAM user who performed the action.

iamUser_accountId :: Lens' IamUser (Maybe Text) Source #

The unique identifier for the Amazon Web Services account that's associated with the IAM user who performed the action.

Invitation

invitation_relationshipStatus :: Lens' Invitation (Maybe RelationshipStatus) Source #

The status of the relationship between the account that sent the invitation (inviter account) and the account that received the invitation (invitee account).

invitation_invitedAt :: Lens' Invitation (Maybe UTCTime) Source #

The date and time, in UTC and extended ISO 8601 format, when the invitation was sent.

invitation_invitationId :: Lens' Invitation (Maybe Text) Source #

The unique identifier for the invitation. Amazon Macie uses this identifier to validate the inviter account with the invitee account.

invitation_accountId :: Lens' Invitation (Maybe Text) Source #

The Amazon Web Services account ID for the account that sent the invitation.

IpAddressDetails

ipAddressDetails_ipCity :: Lens' IpAddressDetails (Maybe IpCity) Source #

The city that the IP address originated from.

ipAddressDetails_ipGeoLocation :: Lens' IpAddressDetails (Maybe IpGeoLocation) Source #

The geographic coordinates of the location that the IP address originated from.

ipAddressDetails_ipAddressV4 :: Lens' IpAddressDetails (Maybe Text) Source #

The Internet Protocol version 4 (IPv4) address of the device.

ipAddressDetails_ipOwner :: Lens' IpAddressDetails (Maybe IpOwner) Source #

The registered owner of the IP address.

ipAddressDetails_ipCountry :: Lens' IpAddressDetails (Maybe IpCountry) Source #

The country that the IP address originated from.

IpCity

ipCity_name :: Lens' IpCity (Maybe Text) Source #

The name of the city.

IpCountry

ipCountry_name :: Lens' IpCountry (Maybe Text) Source #

The name of the country that the IP address originated from.

ipCountry_code :: Lens' IpCountry (Maybe Text) Source #

The two-character code, in ISO 3166-1 alpha-2 format, for the country that the IP address originated from. For example, US for the United States.

IpGeoLocation

ipGeoLocation_lat :: Lens' IpGeoLocation (Maybe Double) Source #

The latitude coordinate of the location, rounded to four decimal places.

ipGeoLocation_lon :: Lens' IpGeoLocation (Maybe Double) Source #

The longitude coordinate of the location, rounded to four decimal places.

IpOwner

ipOwner_org :: Lens' IpOwner (Maybe Text) Source #

The name of the organization that owned the IP address.

ipOwner_asnOrg :: Lens' IpOwner (Maybe Text) Source #

The organization identifier that's associated with the autonomous system number (ASN) for the autonomous system that included the IP address.

ipOwner_asn :: Lens' IpOwner (Maybe Text) Source #

The autonomous system number (ASN) for the autonomous system that included the IP address.

ipOwner_isp :: Lens' IpOwner (Maybe Text) Source #

The name of the internet service provider (ISP) that owned the IP address.

JobDetails

jobDetails_isMonitoredByJob :: Lens' JobDetails (Maybe IsMonitoredByJob) Source #

Specifies whether any recurring jobs are configured to analyze data in the bucket. Possible values are:

  • TRUE - The bucket is explicitly included in the bucket definition (S3BucketDefinitionForJob) for one or more recurring jobs or the bucket matches the bucket criteria (S3BucketCriteriaForJob) for one or more recurring jobs. At least one of those jobs has a status other than CANCELLED.
  • FALSE - The bucket isn't explicitly included in the bucket definition (S3BucketDefinitionForJob) for any recurring jobs, the bucket doesn't match the bucket criteria (S3BucketCriteriaForJob) for any recurring jobs, or all the recurring jobs that are configured to analyze data in the bucket have a status of CANCELLED.
  • UNKNOWN - An exception occurred when Amazon Macie attempted to retrieve job data for the bucket.

jobDetails_isDefinedInJob :: Lens' JobDetails (Maybe IsDefinedInJob) Source #

Specifies whether any one-time or recurring jobs are configured to analyze data in the bucket. Possible values are:

  • TRUE - The bucket is explicitly included in the bucket definition (S3BucketDefinitionForJob) for one or more jobs and at least one of those jobs has a status other than CANCELLED. Or the bucket matched the bucket criteria (S3BucketCriteriaForJob) for at least one job that previously ran.
  • FALSE - The bucket isn't explicitly included in the bucket definition (S3BucketDefinitionForJob) for any jobs, all the jobs that explicitly include the bucket in their bucket definitions have a status of CANCELLED, or the bucket didn't match the bucket criteria (S3BucketCriteriaForJob) for any jobs that previously ran.
  • UNKNOWN - An exception occurred when Amazon Macie attempted to retrieve job data for the bucket.

jobDetails_lastJobId :: Lens' JobDetails (Maybe Text) Source #

The unique identifier for the job that ran most recently and is configured to analyze data in the bucket, either the latest run of a recurring job or the only run of a one-time job.

This value is typically null if the value for the isDefinedInJob property is FALSE or UNKNOWN.

jobDetails_lastJobRunTime :: Lens' JobDetails (Maybe UTCTime) Source #

The date and time, in UTC and extended ISO 8601 format, when the job (lastJobId) started. If the job is a recurring job, this value indicates when the most recent run started.

This value is typically null if the value for the isDefinedInJob property is FALSE or UNKNOWN.

JobScheduleFrequency

jobScheduleFrequency_dailySchedule :: Lens' JobScheduleFrequency (Maybe DailySchedule) Source #

Specifies a daily recurrence pattern for running the job.

jobScheduleFrequency_monthlySchedule :: Lens' JobScheduleFrequency (Maybe MonthlySchedule) Source #

Specifies a monthly recurrence pattern for running the job.

jobScheduleFrequency_weeklySchedule :: Lens' JobScheduleFrequency (Maybe WeeklySchedule) Source #

Specifies a weekly recurrence pattern for running the job.

JobScopeTerm

jobScopeTerm_simpleScopeTerm :: Lens' JobScopeTerm (Maybe SimpleScopeTerm) Source #

A property-based condition that defines a property, operator, and one or more values for including or excluding objects from the job.

jobScopeTerm_tagScopeTerm :: Lens' JobScopeTerm (Maybe TagScopeTerm) Source #

A tag-based condition that defines the operator and tag keys or tag key and value pairs for including or excluding objects from the job.

JobScopingBlock

jobScopingBlock_and :: Lens' JobScopingBlock (Maybe [JobScopeTerm]) Source #

An array of conditions, one for each property- or tag-based condition that determines which objects to include or exclude from the job. If you specify more than one condition, Amazon Macie uses AND logic to join the conditions.

JobSummary

jobSummary_lastRunErrorStatus :: Lens' JobSummary (Maybe LastRunErrorStatus) Source #

Specifies whether any account- or bucket-level access errors occurred when the job ran. For a recurring job, this value indicates the error status of the job's most recent run.

jobSummary_jobType :: Lens' JobSummary (Maybe JobType) Source #

The schedule for running the job. Possible values are:

  • ONE_TIME - The job runs only once.
  • SCHEDULED - The job runs on a daily, weekly, or monthly basis.

jobSummary_jobId :: Lens' JobSummary (Maybe Text) Source #

The unique identifier for the job.

jobSummary_createdAt :: Lens' JobSummary (Maybe UTCTime) Source #

The date and time, in UTC and extended ISO 8601 format, when the job was created.

jobSummary_userPausedDetails :: Lens' JobSummary (Maybe UserPausedDetails) Source #

If the current status of the job is USER_PAUSED, specifies when the job was paused and when the job or job run will expire and be cancelled if it isn't resumed. This value is present only if the value for jobStatus is USER_PAUSED.

jobSummary_bucketCriteria :: Lens' JobSummary (Maybe S3BucketCriteriaForJob) Source #

The property- and tag-based conditions that determine which S3 buckets are included or excluded from the job's analysis. Each time the job runs, the job uses these criteria to determine which buckets to analyze. A job's definition can contain a bucketCriteria object or a bucketDefinitions array, not both.

jobSummary_name :: Lens' JobSummary (Maybe Text) Source #

The custom name of the job.

jobSummary_bucketDefinitions :: Lens' JobSummary (Maybe [S3BucketDefinitionForJob]) Source #

An array of objects, one for each Amazon Web Services account that owns specific S3 buckets for the job to analyze. Each object specifies the account ID for an account and one or more buckets to analyze for that account. A job's definition can contain a bucketDefinitions array or a bucketCriteria object, not both.

jobSummary_jobStatus :: Lens' JobSummary (Maybe JobStatus) Source #

The current status of the job. Possible values are:

  • CANCELLED - You cancelled the job or, if it's a one-time job, you paused the job and didn't resume it within 30 days.
  • COMPLETE - For a one-time job, Amazon Macie finished processing the data specified for the job. This value doesn't apply to recurring jobs.
  • IDLE - For a recurring job, the previous scheduled run is complete and the next scheduled run is pending. This value doesn't apply to one-time jobs.
  • PAUSED - Macie started running the job but additional processing would exceed the monthly sensitive data discovery quota for your account or one or more member accounts that the job analyzes data for.
  • RUNNING - For a one-time job, the job is in progress. For a recurring job, a scheduled run is in progress.
  • USER_PAUSED - You paused the job. If you paused the job while it had a status of RUNNING and you don't resume it within 30 days of pausing it, the job or job run will expire and be cancelled, depending on the job's type. To check the expiration date, refer to the UserPausedDetails.jobExpiresAt property.

KeyValuePair

keyValuePair_value :: Lens' KeyValuePair (Maybe Text) Source #

One part of a key-value pair that comprises a tag. A tag value acts as a descriptor for a tag key. A tag value can be an empty string.

keyValuePair_key :: Lens' KeyValuePair (Maybe Text) Source #

One part of a key-value pair that comprises a tag. A tag key is a general label that acts as a category for more specific tag values.

LastRunErrorStatus

lastRunErrorStatus_code :: Lens' LastRunErrorStatus (Maybe LastRunErrorStatusCode) Source #

Specifies whether any account- or bucket-level access errors occurred when the job ran. For a recurring job, this value indicates the error status of the job's most recent run. Possible values are:

  • ERROR - One or more errors occurred. Amazon Macie didn't process all the data specified for the job.
  • NONE - No errors occurred. Macie processed all the data specified for the job.

ListJobsFilterCriteria

listJobsFilterCriteria_includes :: Lens' ListJobsFilterCriteria (Maybe [ListJobsFilterTerm]) Source #

An array of objects, one for each condition that determines which jobs to include in the results.

listJobsFilterCriteria_excludes :: Lens' ListJobsFilterCriteria (Maybe [ListJobsFilterTerm]) Source #

An array of objects, one for each condition that determines which jobs to exclude from the results.

ListJobsFilterTerm

listJobsFilterTerm_values :: Lens' ListJobsFilterTerm (Maybe [Text]) Source #

An array that lists one or more values to use to filter the results.

listJobsFilterTerm_key :: Lens' ListJobsFilterTerm (Maybe ListJobsFilterKey) Source #

The property to use to filter the results.

listJobsFilterTerm_comparator :: Lens' ListJobsFilterTerm (Maybe JobComparator) Source #

The operator to use to filter the results.

ListJobsSortCriteria

listJobsSortCriteria_orderBy :: Lens' ListJobsSortCriteria (Maybe OrderBy) Source #

The sort order to apply to the results, based on the value for the property specified by the attributeName property. Valid values are: ASC, sort the results in ascending order; and, DESC, sort the results in descending order.

ManagedDataIdentifierSummary

managedDataIdentifierSummary_category :: Lens' ManagedDataIdentifierSummary (Maybe SensitiveDataItemCategory) Source #

The category of sensitive data that the managed data identifier detects: CREDENTIALS, for credentials data such as private keys or Amazon Web Services secret keys; FINANCIAL_INFORMATION, for financial data such as credit card numbers; or, PERSONAL_INFORMATION, for personal health information, such as health insurance identification numbers, or personally identifiable information, such as passport numbers.

managedDataIdentifierSummary_id :: Lens' ManagedDataIdentifierSummary (Maybe Text) Source #

The unique identifier for the managed data identifier. This is a string that describes the type of sensitive data that the managed data identifier detects. For example: OPENSSH_PRIVATE_KEY for OpenSSH private keys, CREDIT_CARD_NUMBER for credit card numbers, or USA_PASSPORT_NUMBER for US passport numbers.

MatchingBucket

matchingBucket_sizeInBytesCompressed :: Lens' MatchingBucket (Maybe Integer) Source #

The total storage size, in bytes, of the objects that are compressed (.gz, .gzip, .zip) files in the bucket.

If versioning is enabled for the bucket, Amazon Macie calculates this value based on the size of the latest version of each applicable object in the bucket. This value doesn't reflect the storage size of all versions of each applicable object in the bucket.

matchingBucket_objectCountByEncryptionType :: Lens' MatchingBucket (Maybe ObjectCountByEncryptionType) Source #

The total number of objects that are in the bucket, grouped by server-side encryption type. This includes a grouping that reports the total number of objects that aren't encrypted or use client-side encryption.

matchingBucket_sizeInBytes :: Lens' MatchingBucket (Maybe Integer) Source #

The total storage size, in bytes, of the bucket.

If versioning is enabled for the bucket, Amazon Macie calculates this value based on the size of the latest version of each object in the bucket. This value doesn't reflect the storage size of all versions of each object in the bucket.

matchingBucket_classifiableObjectCount :: Lens' MatchingBucket (Maybe Integer) Source #

The total number of objects that Amazon Macie can analyze in the bucket. These objects use a supported storage class and have a file name extension for a supported file or storage format.

matchingBucket_accountId :: Lens' MatchingBucket (Maybe Text) Source #

The unique identifier for the Amazon Web Services account that owns the bucket.

matchingBucket_unclassifiableObjectSizeInBytes :: Lens' MatchingBucket (Maybe ObjectLevelStatistics) Source #

The total storage size, in bytes, of the objects that Amazon Macie can't analyze in the bucket. These objects don't use a supported storage class or don't have a file name extension for a supported file or storage format.

matchingBucket_unclassifiableObjectCount :: Lens' MatchingBucket (Maybe ObjectLevelStatistics) Source #

The total number of objects that Amazon Macie can't analyze in the bucket. These objects don't use a supported storage class or don't have a file name extension for a supported file or storage format.

matchingBucket_errorCode :: Lens' MatchingBucket (Maybe BucketMetadataErrorCode) Source #

Specifies the error code for an error that prevented Amazon Macie from retrieving and processing information about the bucket and the bucket's objects. If this value is ACCESS_DENIED, Macie doesn't have permission to retrieve the information. For example, the bucket has a restrictive bucket policy and Amazon S3 denied the request. If this value is null, Macie was able to retrieve and process the information.

matchingBucket_jobDetails :: Lens' MatchingBucket (Maybe JobDetails) Source #

Specifies whether any one-time or recurring classification jobs are configured to analyze objects in the bucket, and, if so, the details of the job that ran most recently.

matchingBucket_errorMessage :: Lens' MatchingBucket (Maybe Text) Source #

A brief description of the error (errorCode) that prevented Amazon Macie from retrieving and processing information about the bucket and the bucket's objects. This value is null if Macie was able to retrieve and process the information.

matchingBucket_objectCount :: Lens' MatchingBucket (Maybe Integer) Source #

The total number of objects in the bucket.

matchingBucket_classifiableSizeInBytes :: Lens' MatchingBucket (Maybe Integer) Source #

The total storage size, in bytes, of the objects that Amazon Macie can analyze in the bucket. These objects use a supported storage class and have a file name extension for a supported file or storage format.

If versioning is enabled for the bucket, Macie calculates this value based on the size of the latest version of each applicable object in the bucket. This value doesn't reflect the storage size of all versions of each applicable object in the bucket.

MatchingResource

matchingResource_matchingBucket :: Lens' MatchingResource (Maybe MatchingBucket) Source #

The details of an S3 bucket that Amazon Macie monitors and analyzes.

Member

member_email :: Lens' Member (Maybe Text) Source #

The email address for the account.

member_administratorAccountId :: Lens' Member (Maybe Text) Source #

The Amazon Web Services account ID for the administrator account.

member_arn :: Lens' Member (Maybe Text) Source #

The Amazon Resource Name (ARN) of the account.

member_relationshipStatus :: Lens' Member (Maybe RelationshipStatus) Source #

The current status of the relationship between the account and the administrator account.

member_masterAccountId :: Lens' Member (Maybe Text) Source #

(Deprecated) The Amazon Web Services account ID for the administrator account. This property has been replaced by the administratorAccountId property and is retained only for backward compatibility.

member_invitedAt :: Lens' Member (Maybe UTCTime) Source #

The date and time, in UTC and extended ISO 8601 format, when an Amazon Macie membership invitation was last sent to the account. This value is null if a Macie invitation hasn't been sent to the account.

member_accountId :: Lens' Member (Maybe Text) Source #

The Amazon Web Services account ID for the account.

member_updatedAt :: Lens' Member (Maybe UTCTime) Source #

The date and time, in UTC and extended ISO 8601 format, of the most recent change to the status of the relationship between the account and the administrator account.

member_tags :: Lens' Member (Maybe (HashMap Text Text)) Source #

A map of key-value pairs that identifies the tags (keys and values) that are associated with the account in Amazon Macie.

MonthlySchedule

monthlySchedule_dayOfMonth :: Lens' MonthlySchedule (Maybe Int) Source #

The numeric day of the month when Amazon Macie runs the job. This value can be an integer from 1 through 31.

If this value exceeds the number of days in a certain month, Macie doesn't run the job that month. Macie runs the job only during months that have the specified day. For example, if this value is 31 and a month has only 30 days, Macie doesn't run the job that month. To run the job every month, specify a value that's less than 29.

ObjectCountByEncryptionType

objectCountByEncryptionType_unknown :: Lens' ObjectCountByEncryptionType (Maybe Integer) Source #

The total number of objects that Amazon Macie doesn't have current encryption metadata for. Macie can't provide current data about the encryption settings for these objects.

objectCountByEncryptionType_s3Managed :: Lens' ObjectCountByEncryptionType (Maybe Integer) Source #

The total number of objects that are encrypted with an Amazon S3 managed key. The objects use Amazon S3 managed encryption (SSE-S3).

objectCountByEncryptionType_unencrypted :: Lens' ObjectCountByEncryptionType (Maybe Integer) Source #

The total number of objects that aren't encrypted or use client-side encryption.

objectCountByEncryptionType_kmsManaged :: Lens' ObjectCountByEncryptionType (Maybe Integer) Source #

The total number of objects that are encrypted with an KMS key, either an Amazon Web Services managed key or a customer managed key. The objects use KMS encryption (SSE-KMS).

objectCountByEncryptionType_customerManaged :: Lens' ObjectCountByEncryptionType (Maybe Integer) Source #

The total number of objects that are encrypted with a customer-provided key. The objects use customer-provided server-side encryption (SSE-C).

ObjectLevelStatistics

objectLevelStatistics_fileType :: Lens' ObjectLevelStatistics (Maybe Integer) Source #

The total storage size (in bytes) or number of objects that Amazon Macie can't analyze because the objects don't have a file name extension for a supported file or storage format.

objectLevelStatistics_storageClass :: Lens' ObjectLevelStatistics (Maybe Integer) Source #

The total storage size (in bytes) or number of objects that Amazon Macie can't analyze because the objects use an unsupported storage class.

objectLevelStatistics_total :: Lens' ObjectLevelStatistics (Maybe Integer) Source #

The total storage size (in bytes) or number of objects that Amazon Macie can't analyze because the objects use an unsupported storage class or don't have a file name extension for a supported file or storage format.

Occurrences

occurrences_lineRanges :: Lens' Occurrences (Maybe [Range]) Source #

An array of objects, one for each occurrence of sensitive data in a non-binary text file, such as an HTML, TXT, or XML file. Each Range object specifies a line or inclusive range of lines that contains the sensitive data, and the position of the data on the specified line or lines.

This value is often null for file types that are supported by Cell, Page, or Record objects. Exceptions are the location of sensitive data in: unstructured sections of an otherwise structured file, such as a comment in a file; a malformed file that Amazon Macie analyzes as plain text; and, a CSV or TSV file that has any column names that contain sensitive data.

occurrences_cells :: Lens' Occurrences (Maybe [Cell]) Source #

An array of objects, one for each occurrence of sensitive data in a Microsoft Excel workbook, CSV file, or TSV file. This value is null for all other types of files.

Each Cell object specifies a cell or field that contains the sensitive data.

occurrences_pages :: Lens' Occurrences (Maybe [Page]) Source #

An array of objects, one for each occurrence of sensitive data in an Adobe Portable Document Format file. This value is null for all other types of files.

Each Page object specifies a page that contains the sensitive data.

occurrences_records :: Lens' Occurrences (Maybe [Record]) Source #

An array of objects, one for each occurrence of sensitive data in an Apache Avro object container, Apache Parquet file, JSON file, or JSON Lines file. This value is null for all other types of files.

For an Avro object container or Parquet file, each Record object specifies a record index and the path to a field in a record that contains the sensitive data. For a JSON or JSON Lines file, each Record object specifies the path to a field or array that contains the sensitive data. For a JSON Lines file, it also specifies the index of the line that contains the data.

Page

page_offsetRange :: Lens' Page (Maybe Range) Source #

Reserved for future use.

page_lineRange :: Lens' Page (Maybe Range) Source #

Reserved for future use.

page_pageNumber :: Lens' Page (Maybe Integer) Source #

The page number of the page that contains the sensitive data.

PolicyDetails

policyDetails_actor :: Lens' PolicyDetails (Maybe FindingActor) Source #

The entity that performed the action that produced the finding.

policyDetails_action :: Lens' PolicyDetails (Maybe FindingAction) Source #

The action that produced the finding.

Range

range_start :: Lens' Range (Maybe Integer) Source #

The number of lines from the beginning of the file to the beginning of the sensitive data.

range_end :: Lens' Range (Maybe Integer) Source #

The number of lines from the beginning of the file to the end of the sensitive data.

range_startColumn :: Lens' Range (Maybe Integer) Source #

The number of characters, with spaces and starting from 1, from the beginning of the first line that contains the sensitive data (start) to the beginning of the sensitive data.

Record

record_jsonPath :: Lens' Record (Maybe Text) Source #

The path, as a JSONPath expression, to the sensitive data. For an Avro object container or Parquet file, this is the path to the field in the record (recordIndex) that contains the data. For a JSON or JSON Lines file, this is the path to the field or array that contains the data. If the data is a value in an array, the path also indicates which value contains the data.

If Amazon Macie detects sensitive data in the name of any element in the path, Macie omits this field. If the name of an element exceeds 20 characters, Macie truncates the name by removing characters from the beginning of the name. If the resulting full path exceeds 250 characters, Macie also truncates the path, starting with the first element in the path, until the path contains 250 or fewer characters.

record_recordIndex :: Lens' Record (Maybe Integer) Source #

For an Avro object container or Parquet file, the record index, starting from 0, for the record that contains the sensitive data. For a JSON Lines file, the line index, starting from 0, for the line that contains the sensitive data. This value is always 0 for JSON files.

ReplicationDetails

replicationDetails_replicated :: Lens' ReplicationDetails (Maybe Bool) Source #

Specifies whether the bucket is configured to replicate one or more objects to any destination.

replicationDetails_replicationAccounts :: Lens' ReplicationDetails (Maybe [Text]) Source #

An array of Amazon Web Services account IDs, one for each Amazon Web Services account that the bucket is configured to replicate one or more objects to.

replicationDetails_replicatedExternally :: Lens' ReplicationDetails (Maybe Bool) Source #

Specifies whether the bucket is configured to replicate one or more objects to an Amazon Web Services account that isn't part of the same Amazon Macie organization.

ResourcesAffected

resourcesAffected_s3Object :: Lens' ResourcesAffected (Maybe S3Object) Source #

The details of the S3 object that the finding applies to.

resourcesAffected_s3Bucket :: Lens' ResourcesAffected (Maybe S3Bucket) Source #

The details of the S3 bucket that the finding applies to.

S3Bucket

s3Bucket_arn :: Lens' S3Bucket (Maybe Text) Source #

The Amazon Resource Name (ARN) of the bucket.

s3Bucket_createdAt :: Lens' S3Bucket (Maybe UTCTime) Source #

The date and time, in UTC and extended ISO 8601 format, when the bucket was created.

s3Bucket_owner :: Lens' S3Bucket (Maybe S3BucketOwner) Source #

The display name and canonical user ID for the Amazon Web Services account that owns the bucket.

s3Bucket_name :: Lens' S3Bucket (Maybe Text) Source #

The name of the bucket.

s3Bucket_defaultServerSideEncryption :: Lens' S3Bucket (Maybe ServerSideEncryption) Source #

The type of server-side encryption that's used by default to encrypt objects in the bucket.

s3Bucket_allowsUnencryptedObjectUploads :: Lens' S3Bucket (Maybe AllowsUnencryptedObjectUploads) Source #

Specifies whether the bucket policy for the bucket requires server-side encryption of objects when objects are uploaded to the bucket. Possible values are:

  • FALSE - The bucket policy requires server-side encryption of new objects. PutObject requests must include the x-amz-server-side-encryption header and the value for that header must be AES256 or aws:kms.
  • TRUE - The bucket doesn't have a bucket policy or it has a bucket policy that doesn't require server-side encryption of new objects. If a bucket policy exists, it doesn't require PutObject requests to include the x-amz-server-side-encryption header and it doesn't require the value for that header to be AES256 or aws:kms.
  • UNKNOWN - Amazon Macie can't determine whether the bucket policy requires server-side encryption of objects.

s3Bucket_publicAccess :: Lens' S3Bucket (Maybe BucketPublicAccess) Source #

The permissions settings that determine whether the bucket is publicly accessible.

s3Bucket_tags :: Lens' S3Bucket (Maybe [KeyValuePair]) Source #

The tags that are associated with the bucket.

S3BucketCriteriaForJob

s3BucketCriteriaForJob_includes :: Lens' S3BucketCriteriaForJob (Maybe CriteriaBlockForJob) Source #

The property- and tag-based conditions that determine which buckets to include in the job.

s3BucketCriteriaForJob_excludes :: Lens' S3BucketCriteriaForJob (Maybe CriteriaBlockForJob) Source #

The property- and tag-based conditions that determine which buckets to exclude from the job.

S3BucketDefinitionForJob

s3BucketDefinitionForJob_accountId :: Lens' S3BucketDefinitionForJob Text Source #

The unique identifier for the Amazon Web Services account that owns the buckets.

s3BucketDefinitionForJob_buckets :: Lens' S3BucketDefinitionForJob [Text] Source #

An array that lists the names of the buckets.

S3BucketOwner

s3BucketOwner_displayName :: Lens' S3BucketOwner (Maybe Text) Source #

The display name of the account that owns the bucket.

s3BucketOwner_id :: Lens' S3BucketOwner (Maybe Text) Source #

The canonical user ID for the account that owns the bucket.

S3Destination

s3Destination_keyPrefix :: Lens' S3Destination (Maybe Text) Source #

The path prefix to use in the path to the location in the bucket. This prefix specifies where to store classification results in the bucket.

s3Destination_kmsKeyArn :: Lens' S3Destination Text Source #

The Amazon Resource Name (ARN) of the KMS key to use for encryption of the results. This must be the ARN of an existing, symmetric, customer managed KMS key that's in the same Amazon Web Services Region as the bucket.

S3JobDefinition

s3JobDefinition_scoping :: Lens' S3JobDefinition (Maybe Scoping) Source #

The property- and tag-based conditions that determine which S3 objects to include or exclude from the analysis. Each time the job runs, the job uses these criteria to determine which objects to analyze.

s3JobDefinition_bucketCriteria :: Lens' S3JobDefinition (Maybe S3BucketCriteriaForJob) Source #

The property- and tag-based conditions that determine which S3 buckets to include or exclude from the analysis. Each time the job runs, the job uses these criteria to determine which buckets contain objects to analyze. A job's definition can contain a bucketCriteria object or a bucketDefinitions array, not both.

s3JobDefinition_bucketDefinitions :: Lens' S3JobDefinition (Maybe [S3BucketDefinitionForJob]) Source #

An array of objects, one for each Amazon Web Services account that owns specific S3 buckets to analyze. Each object specifies the account ID for an account and one or more buckets to analyze for that account. A job's definition can contain a bucketDefinitions array or a bucketCriteria object, not both.

S3Object

s3Object_eTag :: Lens' S3Object (Maybe Text) Source #

The entity tag (ETag) that identifies the affected version of the object. If the object was overwritten or changed after Amazon Macie produced the finding, this value might be different from the current ETag for the object.

s3Object_versionId :: Lens' S3Object (Maybe Text) Source #

The identifier for the affected version of the object.

s3Object_path :: Lens' S3Object (Maybe Text) Source #

The path to the object, including the full key (name).

s3Object_size :: Lens' S3Object (Maybe Integer) Source #

The total storage size, in bytes, of the object.

s3Object_extension :: Lens' S3Object (Maybe Text) Source #

The file name extension of the object. If the object doesn't have a file name extension, this value is "".

s3Object_key :: Lens' S3Object (Maybe Text) Source #

The full key (name) that's assigned to the object.

s3Object_storageClass :: Lens' S3Object (Maybe StorageClass) Source #

The storage class of the object.

s3Object_publicAccess :: Lens' S3Object (Maybe Bool) Source #

Specifies whether the object is publicly accessible due to the combination of permissions settings that apply to the object.

s3Object_lastModified :: Lens' S3Object (Maybe UTCTime) Source #

The date and time, in UTC and extended ISO 8601 format, when the object was last modified.

s3Object_bucketArn :: Lens' S3Object (Maybe Text) Source #

The Amazon Resource Name (ARN) of the bucket that contains the object.

s3Object_serverSideEncryption :: Lens' S3Object (Maybe ServerSideEncryption) Source #

The type of server-side encryption that's used to encrypt the object.

s3Object_tags :: Lens' S3Object (Maybe [KeyValuePair]) Source #

The tags that are associated with the object.

Scoping

scoping_includes :: Lens' Scoping (Maybe JobScopingBlock) Source #

The property- and tag-based conditions that determine which objects to include in the analysis.

scoping_excludes :: Lens' Scoping (Maybe JobScopingBlock) Source #

The property- and tag-based conditions that determine which objects to exclude from the analysis.

SearchResourcesBucketCriteria

searchResourcesBucketCriteria_includes :: Lens' SearchResourcesBucketCriteria (Maybe SearchResourcesCriteriaBlock) Source #

The property- and tag-based conditions that determine which buckets to include in the results.

searchResourcesBucketCriteria_excludes :: Lens' SearchResourcesBucketCriteria (Maybe SearchResourcesCriteriaBlock) Source #

The property- and tag-based conditions that determine which buckets to exclude from the results.

SearchResourcesCriteria

searchResourcesCriteria_tagCriterion :: Lens' SearchResourcesCriteria (Maybe SearchResourcesTagCriterion) Source #

A tag-based condition that defines an operator and tag keys, tag values, or tag key and value pairs for including or excluding resources from the results.

searchResourcesCriteria_simpleCriterion :: Lens' SearchResourcesCriteria (Maybe SearchResourcesSimpleCriterion) Source #

A property-based condition that defines a property, operator, and one or more values for including or excluding resources from the results.

SearchResourcesCriteriaBlock

searchResourcesCriteriaBlock_and :: Lens' SearchResourcesCriteriaBlock (Maybe [SearchResourcesCriteria]) Source #

An array of objects, one for each property- or tag-based condition that includes or excludes resources from the query results. If you specify more than one condition, Amazon Macie uses AND logic to join the conditions.

SearchResourcesSimpleCriterion

searchResourcesSimpleCriterion_values :: Lens' SearchResourcesSimpleCriterion (Maybe [Text]) Source #

An array that lists one or more values to use in the condition. If you specify multiple values, Amazon Macie uses OR logic to join the values. Valid values for each supported property (key) are:

  • ACCOUNT_ID - A string that represents the unique identifier for the Amazon Web Services account that owns the resource.
  • S3_BUCKET_EFFECTIVE_PERMISSION - A string that represents an enumerated value that Macie defines for the BucketPublicAccess.effectivePermission property of an S3 bucket.
  • S3_BUCKET_NAME - A string that represents the name of an S3 bucket.
  • S3_BUCKET_SHARED_ACCESS - A string that represents an enumerated value that Macie defines for the BucketMetadata.sharedAccess property of an S3 bucket.

Values are case sensitive. Also, Macie doesn't support use of partial values or wildcard characters in values.

searchResourcesSimpleCriterion_comparator :: Lens' SearchResourcesSimpleCriterion (Maybe SearchResourcesComparator) Source #

The operator to use in the condition. Valid values are EQ (equals) and NE (not equals).

SearchResourcesSortCriteria

searchResourcesSortCriteria_orderBy :: Lens' SearchResourcesSortCriteria (Maybe OrderBy) Source #

The sort order to apply to the results, based on the value for the property specified by the attributeName property. Valid values are: ASC, sort the results in ascending order; and, DESC, sort the results in descending order.

SearchResourcesTagCriterion

searchResourcesTagCriterion_tagValues :: Lens' SearchResourcesTagCriterion (Maybe [SearchResourcesTagCriterionPair]) Source #

The tag keys, tag values, or tag key and value pairs to use in the condition.

searchResourcesTagCriterion_comparator :: Lens' SearchResourcesTagCriterion (Maybe SearchResourcesComparator) Source #

The operator to use in the condition. Valid values are EQ (equals) and NE (not equals).

SearchResourcesTagCriterionPair

searchResourcesTagCriterionPair_key :: Lens' SearchResourcesTagCriterionPair (Maybe Text) Source #

The value for the tag key to use in the condition.

SecurityHubConfiguration

securityHubConfiguration_publishPolicyFindings :: Lens' SecurityHubConfiguration Bool Source #

Specifies whether to publish policy findings to Security Hub. If you set this value to true, Amazon Macie automatically publishes all new and updated policy findings that weren't suppressed by a findings filter. The default value is true.

securityHubConfiguration_publishClassificationFindings :: Lens' SecurityHubConfiguration Bool Source #

Specifies whether to publish sensitive data findings to Security Hub. If you set this value to true, Amazon Macie automatically publishes all sensitive data findings that weren't suppressed by a findings filter. The default value is false.

SensitiveDataItem

sensitiveDataItem_detections :: Lens' SensitiveDataItem (Maybe [DefaultDetection]) Source #

An array of objects, one for each type of sensitive data that was detected. Each object reports the number of occurrences of a specific type of sensitive data that was detected, and the location of up to 15 of those occurrences.

sensitiveDataItem_category :: Lens' SensitiveDataItem (Maybe SensitiveDataItemCategory) Source #

The category of sensitive data that was detected. For example: CREDENTIALS, for credentials data such as private keys or Amazon Web Services secret keys; FINANCIAL_INFORMATION, for financial data such as credit card numbers; or, PERSONAL_INFORMATION, for personal health information, such as health insurance identification numbers, or personally identifiable information, such as passport numbers.

sensitiveDataItem_totalCount :: Lens' SensitiveDataItem (Maybe Integer) Source #

The total number of occurrences of the sensitive data that was detected.

ServerSideEncryption

serverSideEncryption_encryptionType :: Lens' ServerSideEncryption (Maybe EncryptionType) Source #

The server-side encryption algorithm that's used when storing data in the bucket or object. If default encryption is disabled for the bucket or the object isn't encrypted using server-side encryption, this value is NONE.

serverSideEncryption_kmsMasterKeyId :: Lens' ServerSideEncryption (Maybe Text) Source #

The Amazon Resource Name (ARN) or unique identifier (key ID) for the KMS key that's used to encrypt data in the bucket or the object. This value is null if an KMS key isn't used to encrypt the data.

ServiceLimit

serviceLimit_isServiceLimited :: Lens' ServiceLimit (Maybe Bool) Source #

Specifies whether the account has met the quota that corresponds to the metric specified by the UsageByAccount.type field in the response.

serviceLimit_value :: Lens' ServiceLimit (Maybe Integer) Source #

The value for the metric specified by the UsageByAccount.type field in the response.

serviceLimit_unit :: Lens' ServiceLimit (Maybe Unit) Source #

The unit of measurement for the value specified by the value field.

SessionContext

sessionContext_attributes :: Lens' SessionContext (Maybe SessionContextAttributes) Source #

The date and time when the credentials were issued, and whether the credentials were authenticated with a multi-factor authentication (MFA) device.

sessionContext_sessionIssuer :: Lens' SessionContext (Maybe SessionIssuer) Source #

The source and type of credentials that were issued to the entity.

SessionContextAttributes

sessionContextAttributes_creationDate :: Lens' SessionContextAttributes (Maybe UTCTime) Source #

The date and time, in UTC and ISO 8601 format, when the credentials were issued.

sessionContextAttributes_mfaAuthenticated :: Lens' SessionContextAttributes (Maybe Bool) Source #

Specifies whether the credentials were authenticated with a multi-factor authentication (MFA) device.

SessionIssuer

sessionIssuer_principalId :: Lens' SessionIssuer (Maybe Text) Source #

The unique identifier for the entity that was used to get the credentials.

sessionIssuer_arn :: Lens' SessionIssuer (Maybe Text) Source #

The Amazon Resource Name (ARN) of the source account, IAM user, or role that was used to get the credentials.

sessionIssuer_userName :: Lens' SessionIssuer (Maybe Text) Source #

The name or alias of the user or role that issued the session. This value is null if the credentials were obtained from a root account that doesn't have an alias.

sessionIssuer_accountId :: Lens' SessionIssuer (Maybe Text) Source #

The unique identifier for the Amazon Web Services account that owns the entity that was used to get the credentials.

sessionIssuer_type :: Lens' SessionIssuer (Maybe Text) Source #

The source of the temporary security credentials, such as Root, IAMUser, or Role.

Severity

severity_score :: Lens' Severity (Maybe Integer) Source #

The numerical representation of the finding's severity, ranging from 1 (least severe) to 3 (most severe).

severity_description :: Lens' Severity (Maybe SeverityDescription) Source #

The qualitative representation of the finding's severity, ranging from Low (least severe) to High (most severe).

SimpleCriterionForJob

simpleCriterionForJob_values :: Lens' SimpleCriterionForJob (Maybe [Text]) Source #

An array that lists one or more values to use in the condition. If you specify multiple values, Amazon Macie uses OR logic to join the values. Valid values for each supported property (key) are:

  • ACCOUNT_ID - A string that represents the unique identifier for the Amazon Web Services account that owns the bucket.
  • S3_BUCKET_EFFECTIVE_PERMISSION - A string that represents an enumerated value that Macie defines for the BucketPublicAccess.effectivePermission property of a bucket.
  • S3_BUCKET_NAME - A string that represents the name of a bucket.
  • S3_BUCKET_SHARED_ACCESS - A string that represents an enumerated value that Macie defines for the BucketMetadata.sharedAccess property of a bucket.

Values are case sensitive. Also, Macie doesn't support use of partial values or wildcard characters in these values.

simpleCriterionForJob_comparator :: Lens' SimpleCriterionForJob (Maybe JobComparator) Source #

The operator to use in the condition. Valid values are EQ (equals) and NE (not equals).

SimpleScopeTerm

simpleScopeTerm_values :: Lens' SimpleScopeTerm (Maybe [Text]) Source #

An array that lists the values to use in the condition. If the value for the key property is OBJECT_EXTENSION or OBJECT_KEY, this array can specify multiple values and Amazon Macie uses OR logic to join the values. Otherwise, this array can specify only one value.

Valid values for each supported property (key) are:

  • OBJECT_EXTENSION - A string that represents the file name extension of an object. For example: docx or pdf
  • OBJECT_KEY - A string that represents the key prefix (folder name or path) of an object. For example: logs or awslogs/eventlogs. This value applies a condition to objects whose keys (names) begin with the specified value.
  • OBJECT_LAST_MODIFIED_DATE - The date and time (in UTC and extended ISO 8601 format) when an object was created or last changed, whichever is latest. For example: 2020-09-28T14:31:13Z
  • OBJECT_SIZE - An integer that represents the storage size (in bytes) of an object.

Macie doesn't support use of wildcard characters in these values. Also, string values are case sensitive.

simpleScopeTerm_key :: Lens' SimpleScopeTerm (Maybe ScopeFilterKey) Source #

The object property to use in the condition.

simpleScopeTerm_comparator :: Lens' SimpleScopeTerm (Maybe JobComparator) Source #

The operator to use in the condition. Valid values for each supported property (key) are:

  • OBJECT_EXTENSION - EQ (equals) or NE (not equals)
  • OBJECT_KEY - STARTS_WITH
  • OBJECT_LAST_MODIFIED_DATE - Any operator except CONTAINS
  • OBJECT_SIZE - Any operator except CONTAINS

SortCriteria

sortCriteria_orderBy :: Lens' SortCriteria (Maybe OrderBy) Source #

The sort order to apply to the results, based on the value for the property specified by the attributeName property. Valid values are: ASC, sort the results in ascending order; and, DESC, sort the results in descending order.

sortCriteria_attributeName :: Lens' SortCriteria (Maybe Text) Source #

The name of the property to sort the results by. This value can be the name of any property that Amazon Macie defines for a finding.

Statistics

statistics_approximateNumberOfObjectsToProcess :: Lens' Statistics (Maybe Double) Source #

The approximate number of objects that the job has yet to process during its current run.

statistics_numberOfRuns :: Lens' Statistics (Maybe Double) Source #

The number of times that the job has run.

TagCriterionForJob

tagCriterionForJob_tagValues :: Lens' TagCriterionForJob (Maybe [TagCriterionPairForJob]) Source #

The tag keys, tag values, or tag key and value pairs to use in the condition.

tagCriterionForJob_comparator :: Lens' TagCriterionForJob (Maybe JobComparator) Source #

The operator to use in the condition. Valid values are EQ (equals) and NE (not equals).

TagCriterionPairForJob

tagCriterionPairForJob_value :: Lens' TagCriterionPairForJob (Maybe Text) Source #

The tag value to use in the condition.

tagCriterionPairForJob_key :: Lens' TagCriterionPairForJob (Maybe Text) Source #

The value for the tag key to use in the condition.

TagScopeTerm

tagScopeTerm_tagValues :: Lens' TagScopeTerm (Maybe [TagValuePair]) Source #

The tag keys or tag key and value pairs to use in the condition. To specify only tag keys in a condition, specify the keys in this array and set the value for each associated tag value to an empty string.

tagScopeTerm_key :: Lens' TagScopeTerm (Maybe Text) Source #

The object property to use in the condition. The only valid value is TAG.

tagScopeTerm_comparator :: Lens' TagScopeTerm (Maybe JobComparator) Source #

The operator to use in the condition. Valid values are EQ (equals) or NE (not equals).

tagScopeTerm_target :: Lens' TagScopeTerm (Maybe TagTarget) Source #

The type of object to apply the condition to.

TagValuePair

tagValuePair_value :: Lens' TagValuePair (Maybe Text) Source #

The tag value, associated with the specified tag key (key), to use in the condition. To specify only a tag key for a condition, specify the tag key for the key property and set this value to an empty string.

tagValuePair_key :: Lens' TagValuePair (Maybe Text) Source #

The value for the tag key to use in the condition.

UnprocessedAccount

unprocessedAccount_accountId :: Lens' UnprocessedAccount (Maybe Text) Source #

The Amazon Web Services account ID for the account that the request applies to.

unprocessedAccount_errorCode :: Lens' UnprocessedAccount (Maybe ErrorCode) Source #

The source of the issue or delay in processing the request.

unprocessedAccount_errorMessage :: Lens' UnprocessedAccount (Maybe Text) Source #

The reason why the request hasn't been processed.

UsageByAccount

usageByAccount_serviceLimit :: Lens' UsageByAccount (Maybe ServiceLimit) Source #

The current value for the quota that corresponds to the metric specified by the type field.

usageByAccount_currency :: Lens' UsageByAccount (Maybe Currency) Source #

The type of currency that the value for the metric (estimatedCost) is reported in.

usageByAccount_type :: Lens' UsageByAccount (Maybe UsageType) Source #

The name of the metric. Possible values are: DATA_INVENTORY_EVALUATION, for monitoring S3 buckets; and, SENSITIVE_DATA_DISCOVERY, for analyzing S3 objects to detect sensitive data.

usageByAccount_estimatedCost :: Lens' UsageByAccount (Maybe Text) Source #

The estimated value for the metric.

UsageRecord

usageRecord_accountId :: Lens' UsageRecord (Maybe Text) Source #

The unique identifier for the Amazon Web Services account that the data applies to.

usageRecord_freeTrialStartDate :: Lens' UsageRecord (Maybe UTCTime) Source #

The date and time, in UTC and extended ISO 8601 format, when the free trial started for the account.

usageRecord_usage :: Lens' UsageRecord (Maybe [UsageByAccount]) Source #

An array of objects that contains usage data and quotas for the account. Each object contains the data for a specific usage metric and the corresponding quota.

UsageStatisticsFilter

usageStatisticsFilter_values :: Lens' UsageStatisticsFilter (Maybe [Text]) Source #

An array that lists values to use in the condition, based on the value for the field specified by the key property. If the value for the key property is accountId, this array can specify multiple values. Otherwise, this array can specify only one value.

Valid values for each supported field are:

  • accountId - The unique identifier for an Amazon Web Services account.
  • freeTrialStartDate - The date and time, in UTC and extended ISO 8601 format, when the free trial started for an account.
  • serviceLimit - A Boolean (true or false) value that indicates whether an account has reached its monthly quota.
  • total - A string that represents the current estimated cost for an account.

usageStatisticsFilter_comparator :: Lens' UsageStatisticsFilter (Maybe UsageStatisticsFilterComparator) Source #

The operator to use in the condition. If the value for the key property is accountId, this value must be CONTAINS. If the value for the key property is any other supported field, this value can be EQ, GT, GTE, LT, LTE, or NE.

UsageStatisticsSortBy

usageStatisticsSortBy_orderBy :: Lens' UsageStatisticsSortBy (Maybe OrderBy) Source #

The sort order to apply to the results, based on the value for the field specified by the key property. Valid values are: ASC, sort the results in ascending order; and, DESC, sort the results in descending order.

UsageTotal

usageTotal_currency :: Lens' UsageTotal (Maybe Currency) Source #

The type of currency that the value for the metric (estimatedCost) is reported in.

usageTotal_type :: Lens' UsageTotal (Maybe UsageType) Source #

The name of the metric. Possible values are: DATA_INVENTORY_EVALUATION, for monitoring S3 buckets; and, SENSITIVE_DATA_DISCOVERY, for analyzing S3 objects to detect sensitive data.

usageTotal_estimatedCost :: Lens' UsageTotal (Maybe Text) Source #

The estimated value for the metric.

UserIdentity

userIdentity_iamUser :: Lens' UserIdentity (Maybe IamUser) Source #

If the action was performed using the credentials for an Identity and Access Management (IAM) user, the name and other details about the user.

userIdentity_root :: Lens' UserIdentity (Maybe UserIdentityRoot) Source #

If the action was performed using the credentials for your Amazon Web Services account, the details of your account.

userIdentity_awsAccount :: Lens' UserIdentity (Maybe AwsAccount) Source #

If the action was performed using the credentials for another Amazon Web Services account, the details of that account.

userIdentity_assumedRole :: Lens' UserIdentity (Maybe AssumedRole) Source #

If the action was performed with temporary security credentials that were obtained using the AssumeRole operation of the Security Token Service (STS) API, the identifiers, session context, and other details about the identity.

userIdentity_federatedUser :: Lens' UserIdentity (Maybe FederatedUser) Source #

If the action was performed with temporary security credentials that were obtained using the GetFederationToken operation of the Security Token Service (STS) API, the identifiers, session context, and other details about the identity.

userIdentity_awsService :: Lens' UserIdentity (Maybe AwsService) Source #

If the action was performed by an Amazon Web Services account that belongs to an Amazon Web Service, the name of the service.

userIdentity_type :: Lens' UserIdentity (Maybe UserIdentityType) Source #

The type of entity that performed the action.

UserIdentityRoot

userIdentityRoot_principalId :: Lens' UserIdentityRoot (Maybe Text) Source #

The unique identifier for the entity that performed the action.

userIdentityRoot_arn :: Lens' UserIdentityRoot (Maybe Text) Source #

The Amazon Resource Name (ARN) of the principal that performed the action. The last section of the ARN contains the name of the user or role that performed the action.

userIdentityRoot_accountId :: Lens' UserIdentityRoot (Maybe Text) Source #

The unique identifier for the Amazon Web Services account.

UserPausedDetails

userPausedDetails_jobExpiresAt :: Lens' UserPausedDetails (Maybe UTCTime) Source #

The date and time, in UTC and extended ISO 8601 format, when the job or job run will expire and be cancelled if you don't resume it first.

userPausedDetails_jobImminentExpirationHealthEventArn :: Lens' UserPausedDetails (Maybe Text) Source #

The Amazon Resource Name (ARN) of the Health event that Amazon Macie sent to notify you of the job or job run's pending expiration and cancellation. This value is null if a job has been paused for less than 23 days.

userPausedDetails_jobPausedAt :: Lens' UserPausedDetails (Maybe UTCTime) Source #

The date and time, in UTC and extended ISO 8601 format, when you paused the job.

WeeklySchedule

weeklySchedule_dayOfWeek :: Lens' WeeklySchedule (Maybe DayOfWeek) Source #

The day of the week when Amazon Macie runs the job.