Macie2

This page documents function available when using the Macie2 module, created with @service Macie2.

Index

Documentation

Main.Macie2.accept_invitationMethod
accept_invitation(invitation_id)
accept_invitation(invitation_id, params::Dict{String,<:Any})

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

Arguments

  • invitation_id: The unique identifier for the invitation to accept.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "administratorAccountId": The Amazon Web Services account ID for the account that sent the invitation.
  • "masterAccount": (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.
source
Main.Macie2.batch_get_custom_data_identifiersMethod
batch_get_custom_data_identifiers()
batch_get_custom_data_identifiers(params::Dict{String,<:Any})

Retrieves information about one or more custom data identifiers.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "ids": An array of custom data identifier IDs, one for each custom data identifier to retrieve information about.
source
Main.Macie2.create_allow_listMethod
create_allow_list(client_token, criteria, name)
create_allow_list(client_token, criteria, name, params::Dict{String,<:Any})

Creates and defines the settings for an allow list.

Arguments

  • client_token: A unique, case-sensitive token that you provide to ensure the idempotency of the request.
  • criteria: The criteria that specify the text or text pattern to ignore. The criteria can be the location and name of an S3 object that lists specific text to ignore (s3WordsList), or a regular expression (regex) that defines a text pattern to ignore.
  • name: A custom name for the allow list. The name can contain as many as 128 characters.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "description": A custom description of the allow list. The description can contain as many as 512 characters.
  • "tags": A map of key-value pairs that specifies the tags to associate with the allow list. An allow list 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.
source
Main.Macie2.create_classification_jobMethod
create_classification_job(client_token, job_type, name, s3_job_definition)
create_classification_job(client_token, job_type, name, s3_job_definition, params::Dict{String,<:Any})

Creates and defines the settings for a classification job.

Arguments

  • client_token: A unique, case-sensitive token that you provide to ensure the idempotency of the request.
  • job_type: 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.
  • name: A custom name for the job. The name can contain as many as 500 characters.
  • s3_job_definition: The S3 buckets that contain the objects to analyze, and the scope of that analysis.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "allowListIds": An array of unique identifiers, one for each allow list for the job to use when it analyzes data.
  • "customDataIdentifierIds": 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.
  • "description": A custom description of the job. The description can contain as many as 200 characters.
  • "initialRun": 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.
  • "managedDataIdentifierIds": 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.
  • "managedDataIdentifierSelector": 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.
  • "samplingPercentage": 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.
  • "scheduleFrequency": 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.
  • "tags": 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.
source
Main.Macie2.create_custom_data_identifierMethod
create_custom_data_identifier(name, regex)
create_custom_data_identifier(name, regex, params::Dict{String,<:Any})

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

Arguments

  • name: 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 this name, depending on the actions that they're allowed to perform in Amazon Macie.
  • regex: The regular expression (regex) that defines the pattern to match. The expression can contain as many as 512 characters.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "clientToken": A unique, case-sensitive token that you provide to ensure the idempotency of the request.
  • "description": 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 this description, depending on the actions that they're allowed to perform in Amazon Macie.
  • "ignoreWords": An array that lists specific character sequences (ignore words) to exclude from the results. If the text matched by the regular expression contains 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.
  • "keywords": An array that lists specific character sequences (keywords), one of which must precede and 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.
  • "maximumMatchDistance": The maximum number of characters that can exist between the end of at least one complete character sequence specified by the keywords array and the end of the text that matches the regex pattern. If a complete keyword precedes all the text that matches the pattern and the keyword is within the specified distance, Amazon Macie includes the result. The distance can be 1-300 characters. The default value is 50.
  • "severityLevels": The severity to assign to findings that the custom data identifier produces, based on the number of occurrences of text that matches the custom data identifier's detection criteria. You can specify as many as three SeverityLevel objects in this array, one for each severity: LOW, MEDIUM, or HIGH. If you specify more than one, the occurrences thresholds must be in ascending order by severity, moving from LOW to HIGH. For example, 1 for LOW, 50 for MEDIUM, and 100 for HIGH. If an S3 object contains fewer occurrences than the lowest specified threshold, Amazon Macie doesn't create a finding. If you don't specify any values for this array, Macie creates findings for S3 objects that contain at least one occurrence of text that matches the detection criteria, and Macie assigns the MEDIUM severity to those findings.
  • "tags": 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.
source
Main.Macie2.create_findings_filterMethod
create_findings_filter(action, finding_criteria, name)
create_findings_filter(action, finding_criteria, name, params::Dict{String,<:Any})

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

Arguments

  • action: The action to perform on findings that match the filter criteria (findingCriteria). Valid values are: ARCHIVE, suppress (automatically archive) the findings; and, NOOP, don't perform any action on the findings.
  • finding_criteria: The criteria to use to filter findings.
  • name: 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 this name, depending on the actions that they're allowed to perform in Amazon Macie.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "clientToken": A unique, case-sensitive token that you provide to ensure the idempotency of the request.
  • "description": 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 this description, depending on the actions that they're allowed to perform in Amazon Macie.
  • "position": 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.
  • "tags": 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.
source
Main.Macie2.create_invitationsMethod
create_invitations(account_ids)
create_invitations(account_ids, params::Dict{String,<:Any})

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

Arguments

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

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "disableEmailNotification": Specifies whether to send the invitation as an email message. If this value is false, Amazon Macie sends the invitation (as an email message) to the email address that you specified for the recipient's account when you associated the account with your account. The default value is false.
  • "message": Custom text to include in the email message that contains the invitation. The text can contain as many as 80 alphanumeric characters.
source
Main.Macie2.create_memberMethod
create_member(account)
create_member(account, params::Dict{String,<:Any})

Associates an account with an Amazon Macie administrator account.

Arguments

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

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "tags": 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.
source
Main.Macie2.create_sample_findingsMethod
create_sample_findings()
create_sample_findings(params::Dict{String,<:Any})

Creates sample findings.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "findingTypes": An array of finding types, one for each type of sample finding to create. To create a sample of every type of finding that Amazon Macie supports, don't include this array in your request.
source
Main.Macie2.decline_invitationsMethod
decline_invitations(account_ids)
decline_invitations(account_ids, params::Dict{String,<:Any})

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

Arguments

  • account_ids: An array that lists Amazon Web Services account IDs, one for each account that sent an invitation to decline.
source
Main.Macie2.delete_allow_listMethod
delete_allow_list(id)
delete_allow_list(id, params::Dict{String,<:Any})

Deletes an allow list.

Arguments

  • id: The unique identifier for the Amazon Macie resource that the request applies to.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "ignoreJobChecks": Specifies whether to force deletion of the allow list, even if active classification jobs are configured to use the list. When you try to delete an allow list, Amazon Macie checks for classification jobs that use the list and have a status other than COMPLETE or CANCELLED. By default, Macie rejects your request if any jobs meet these criteria. To skip these checks and delete the list, set this value to true. To delete the list only if no active jobs are configured to use it, set this value to false.
source
Main.Macie2.delete_custom_data_identifierMethod
delete_custom_data_identifier(id)
delete_custom_data_identifier(id, params::Dict{String,<:Any})

Soft deletes a custom data identifier.

Arguments

  • id: The unique identifier for the Amazon Macie resource that the request applies to.
source
Main.Macie2.delete_findings_filterMethod
delete_findings_filter(id)
delete_findings_filter(id, params::Dict{String,<:Any})

Deletes a findings filter.

Arguments

  • id: The unique identifier for the Amazon Macie resource that the request applies to.
source
Main.Macie2.delete_invitationsMethod
delete_invitations(account_ids)
delete_invitations(account_ids, params::Dict{String,<:Any})

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

Arguments

  • account_ids: An array that lists Amazon Web Services account IDs, one for each account that sent an invitation to delete.
source
Main.Macie2.delete_memberMethod
delete_member(id)
delete_member(id, params::Dict{String,<:Any})

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

Arguments

  • id: The unique identifier for the Amazon Macie resource that the request applies to.
source
Main.Macie2.describe_bucketsMethod
describe_buckets()
describe_buckets(params::Dict{String,<:Any})

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

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "criteria": The criteria to use to filter the query results.
  • "maxResults": The maximum number of items to include in each page of the response. The default value is 50.
  • "nextToken": The nextToken string that specifies which page of results to return in a paginated response.
  • "sortCriteria": The criteria to use to sort the query results.
source
Main.Macie2.describe_classification_jobMethod
describe_classification_job(job_id)
describe_classification_job(job_id, params::Dict{String,<:Any})

Retrieves the status and settings for a classification job.

Arguments

  • job_id: The unique identifier for the classification job.
source
Main.Macie2.disable_macieMethod
disable_macie()
disable_macie(params::Dict{String,<:Any})

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

source
Main.Macie2.disable_organization_admin_accountMethod
disable_organization_admin_account(admin_account_id)
disable_organization_admin_account(admin_account_id, params::Dict{String,<:Any})

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

Arguments

  • admin_account_id: The Amazon Web Services account ID of the delegated Amazon Macie administrator account.
source
Main.Macie2.disassociate_from_master_accountMethod
disassociate_from_master_account()
disassociate_from_master_account(params::Dict{String,<:Any})

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

source
Main.Macie2.disassociate_memberMethod
disassociate_member(id)
disassociate_member(id, params::Dict{String,<:Any})

Disassociates an Amazon Macie administrator account from a member account.

Arguments

  • id: The unique identifier for the Amazon Macie resource that the request applies to.
source
Main.Macie2.enable_macieMethod
enable_macie()
enable_macie(params::Dict{String,<:Any})

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

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "clientToken": A unique, case-sensitive token that you provide to ensure the idempotency of the request.
  • "findingPublishingFrequency": Specifies how often to publish updates to policy findings for the account. This includes publishing updates to Security Hub and Amazon EventBridge (formerly Amazon CloudWatch Events).
  • "status": Specifies the new status for the account. To enable Amazon Macie and start all Macie activities for the account, set this value to ENABLED.
source
Main.Macie2.enable_organization_admin_accountMethod
enable_organization_admin_account(admin_account_id)
enable_organization_admin_account(admin_account_id, params::Dict{String,<:Any})

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

Arguments

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

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "clientToken": A unique, case-sensitive token that you provide to ensure the idempotency of the request.
source
Main.Macie2.get_administrator_accountMethod
get_administrator_account()
get_administrator_account(params::Dict{String,<:Any})

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

source
Main.Macie2.get_allow_listMethod
get_allow_list(id)
get_allow_list(id, params::Dict{String,<:Any})

Retrieves the settings and status of an allow list.

Arguments

  • id: The unique identifier for the Amazon Macie resource that the request applies to.
source
Main.Macie2.get_bucket_statisticsMethod
get_bucket_statistics()
get_bucket_statistics(params::Dict{String,<:Any})

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

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "accountId": The unique identifier for the Amazon Web Services account.
source
Main.Macie2.get_classification_scopeMethod
get_classification_scope(id)
get_classification_scope(id, params::Dict{String,<:Any})

Retrieves the classification scope settings for an account.

Arguments

  • id: The unique identifier for the Amazon Macie resource that the request applies to.
source
Main.Macie2.get_custom_data_identifierMethod
get_custom_data_identifier(id)
get_custom_data_identifier(id, params::Dict{String,<:Any})

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

Arguments

  • id: The unique identifier for the Amazon Macie resource that the request applies to.
source
Main.Macie2.get_finding_statisticsMethod
get_finding_statistics(group_by)
get_finding_statistics(group_by, params::Dict{String,<:Any})

Retrieves (queries) aggregated statistical data about findings.

Arguments

  • group_by: 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.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "findingCriteria": The criteria to use to filter the query results.
  • "size": The maximum number of items to include in each page of the response.
  • "sortCriteria": The criteria to use to sort the query results.
source
Main.Macie2.get_findingsMethod
get_findings(finding_ids)
get_findings(finding_ids, params::Dict{String,<:Any})

Retrieves the details of one or more findings.

Arguments

  • finding_ids: An array of strings that lists the unique identifiers for the findings to retrieve. You can specify as many as 50 unique identifiers in this array.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "sortCriteria": The criteria for sorting the results of the request.
source
Main.Macie2.get_findings_filterMethod
get_findings_filter(id)
get_findings_filter(id, params::Dict{String,<:Any})

Retrieves the criteria and other settings for a findings filter.

Arguments

  • id: The unique identifier for the Amazon Macie resource that the request applies to.
source
Main.Macie2.get_invitations_countMethod
get_invitations_count()
get_invitations_count(params::Dict{String,<:Any})

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

source
Main.Macie2.get_macie_sessionMethod
get_macie_session()
get_macie_session(params::Dict{String,<:Any})

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

source
Main.Macie2.get_master_accountMethod
get_master_account()
get_master_account(params::Dict{String,<:Any})

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

source
Main.Macie2.get_memberMethod
get_member(id)
get_member(id, params::Dict{String,<:Any})

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

Arguments

  • id: The unique identifier for the Amazon Macie resource that the request applies to.
source
Main.Macie2.get_resource_profileMethod
get_resource_profile(resource_arn)
get_resource_profile(resource_arn, params::Dict{String,<:Any})

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

Arguments

  • resource_arn: The Amazon Resource Name (ARN) of the S3 bucket that the request applies to.
source
Main.Macie2.get_reveal_configurationMethod
get_reveal_configuration()
get_reveal_configuration(params::Dict{String,<:Any})

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

source
Main.Macie2.get_sensitive_data_occurrencesMethod
get_sensitive_data_occurrences(finding_id)
get_sensitive_data_occurrences(finding_id, params::Dict{String,<:Any})

Retrieves occurrences of sensitive data reported by a finding.

Arguments

  • finding_id: The unique identifier for the finding.
source
Main.Macie2.get_sensitive_data_occurrences_availabilityMethod
get_sensitive_data_occurrences_availability(finding_id)
get_sensitive_data_occurrences_availability(finding_id, params::Dict{String,<:Any})

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

Arguments

  • finding_id: The unique identifier for the finding.
source
Main.Macie2.get_sensitivity_inspection_templateMethod
get_sensitivity_inspection_template(id)
get_sensitivity_inspection_template(id, params::Dict{String,<:Any})

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

Arguments

  • id: The unique identifier for the Amazon Macie resource that the request applies to.
source
Main.Macie2.get_usage_statisticsMethod
get_usage_statistics()
get_usage_statistics(params::Dict{String,<:Any})

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

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "filterBy": 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.
  • "maxResults": The maximum number of items to include in each page of the response.
  • "nextToken": The nextToken string that specifies which page of results to return in a paginated response.
  • "sortBy": The criteria to use to sort the query results.
  • "timeRange": The inclusive time period to query usage data for. Valid values are: MONTHTODATE, for the current calendar month to date; and, PAST30DAYS, for the preceding 30 days. If you don't specify a value, Amazon Macie provides usage data for the preceding 30 days.
source
Main.Macie2.get_usage_totalsMethod
get_usage_totals()
get_usage_totals(params::Dict{String,<:Any})

Retrieves (queries) aggregated usage data for an account.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "timeRange": The inclusive time period to retrieve the data for. Valid values are: MONTHTODATE, for the current calendar month to date; and, PAST30DAYS, 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.
source
Main.Macie2.list_allow_listsMethod
list_allow_lists()
list_allow_lists(params::Dict{String,<:Any})

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

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of items to include in each page of a paginated response.
  • "nextToken": The nextToken string that specifies which page of results to return in a paginated response.
source
Main.Macie2.list_classification_jobsMethod
list_classification_jobs()
list_classification_jobs(params::Dict{String,<:Any})

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

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "filterCriteria": The criteria to use to filter the results.
  • "maxResults": The maximum number of items to include in each page of the response.
  • "nextToken": The nextToken string that specifies which page of results to return in a paginated response.
  • "sortCriteria": The criteria to use to sort the results.
source
Main.Macie2.list_classification_scopesMethod
list_classification_scopes()
list_classification_scopes(params::Dict{String,<:Any})

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

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "name": The name of the classification scope to retrieve the unique identifier for.
  • "nextToken": The nextToken string that specifies which page of results to return in a paginated response.
source
Main.Macie2.list_custom_data_identifiersMethod
list_custom_data_identifiers()
list_custom_data_identifiers(params::Dict{String,<:Any})

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

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of items to include in each page of the response.
  • "nextToken": The nextToken string that specifies which page of results to return in a paginated response.
source
Main.Macie2.list_findingsMethod
list_findings()
list_findings(params::Dict{String,<:Any})

Retrieves a subset of information about one or more findings.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "findingCriteria": The criteria to use to filter the results.
  • "maxResults": The maximum number of items to include in each page of the response.
  • "nextToken": The nextToken string that specifies which page of results to return in a paginated response.
  • "sortCriteria": The criteria to use to sort the results.
source
Main.Macie2.list_findings_filtersMethod
list_findings_filters()
list_findings_filters(params::Dict{String,<:Any})

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

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of items to include in each page of a paginated response.
  • "nextToken": The nextToken string that specifies which page of results to return in a paginated response.
source
Main.Macie2.list_invitationsMethod
list_invitations()
list_invitations(params::Dict{String,<:Any})

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

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of items to include in each page of a paginated response.
  • "nextToken": The nextToken string that specifies which page of results to return in a paginated response.
source
Main.Macie2.list_managed_data_identifiersMethod
list_managed_data_identifiers()
list_managed_data_identifiers(params::Dict{String,<:Any})

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

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "nextToken": The nextToken string that specifies which page of results to return in a paginated response.
source
Main.Macie2.list_membersMethod
list_members()
list_members(params::Dict{String,<:Any})

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

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of items to include in each page of a paginated response.
  • "nextToken": The nextToken string that specifies which page of results to return in a paginated response.
  • "onlyAssociated": 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.
source
Main.Macie2.list_organization_admin_accountsMethod
list_organization_admin_accounts()
list_organization_admin_accounts(params::Dict{String,<:Any})

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

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of items to include in each page of a paginated response.
  • "nextToken": The nextToken string that specifies which page of results to return in a paginated response.
source
Main.Macie2.list_resource_profile_artifactsMethod
list_resource_profile_artifacts(resource_arn)
list_resource_profile_artifacts(resource_arn, params::Dict{String,<:Any})

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

Arguments

  • resource_arn: The Amazon Resource Name (ARN) of the S3 bucket that the request applies to.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "nextToken": The nextToken string that specifies which page of results to return in a paginated response.
source
Main.Macie2.list_resource_profile_detectionsMethod
list_resource_profile_detections(resource_arn)
list_resource_profile_detections(resource_arn, params::Dict{String,<:Any})

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

Arguments

  • resource_arn: The Amazon Resource Name (ARN) of the S3 bucket that the request applies to.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of items to include in each page of a paginated response.
  • "nextToken": The nextToken string that specifies which page of results to return in a paginated response.
source
Main.Macie2.list_sensitivity_inspection_templatesMethod
list_sensitivity_inspection_templates()
list_sensitivity_inspection_templates(params::Dict{String,<:Any})

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

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "maxResults": The maximum number of items to include in each page of a paginated response.
  • "nextToken": The nextToken string that specifies which page of results to return in a paginated response.
source
Main.Macie2.list_tags_for_resourceMethod
list_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})

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

Arguments

  • resource_arn: The Amazon Resource Name (ARN) of the resource.
source
Main.Macie2.put_classification_export_configurationMethod
put_classification_export_configuration(configuration)
put_classification_export_configuration(configuration, params::Dict{String,<:Any})

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

Arguments

  • configuration: The location to store data classification results in, and the encryption settings to use when storing results in that location.
source
Main.Macie2.put_findings_publication_configurationMethod
put_findings_publication_configuration()
put_findings_publication_configuration(params::Dict{String,<:Any})

Updates the configuration settings for publishing findings to Security Hub.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "clientToken": A unique, case-sensitive token that you provide to ensure the idempotency of the request.
  • "securityHubConfiguration": The configuration settings that determine which findings to publish to Security Hub.
source
Main.Macie2.search_resourcesMethod
search_resources()
search_resources(params::Dict{String,<:Any})

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

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "bucketCriteria": The filter conditions that determine which S3 buckets to include or exclude from the query results.
  • "maxResults": The maximum number of items to include in each page of the response. The default value is 50.
  • "nextToken": The nextToken string that specifies which page of results to return in a paginated response.
  • "sortCriteria": The criteria to use to sort the results.
source
Main.Macie2.tag_resourceMethod
tag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})

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

Arguments

  • resource_arn: The Amazon Resource Name (ARN) of the resource.
  • tags: 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.
source
Main.Macie2.test_custom_data_identifierMethod
test_custom_data_identifier(regex, sample_text)
test_custom_data_identifier(regex, sample_text, params::Dict{String,<:Any})

Tests a custom data identifier.

Arguments

  • regex: The regular expression (regex) that defines the pattern to match. The expression can contain as many as 512 characters.
  • sample_text: The sample text to inspect by using the custom data identifier. The text can contain as many as 1,000 characters.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "ignoreWords": An array that lists specific character sequences (ignore words) to exclude from the results. If the text matched by the regular expression contains 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.
  • "keywords": An array that lists specific character sequences (keywords), one of which must precede and 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.
  • "maximumMatchDistance": The maximum number of characters that can exist between the end of at least one complete character sequence specified by the keywords array and the end of the text that matches the regex pattern. If a complete keyword precedes all the text that matches the pattern and the keyword is within the specified distance, Amazon Macie includes the result. The distance can be 1-300 characters. The default value is 50.
source
Main.Macie2.untag_resourceMethod
untag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})

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

Arguments

  • resource_arn: The Amazon Resource Name (ARN) of the resource.
  • tag_keys: One or more tags (keys) to remove from the resource. In an HTTP request to remove multiple tags, append the tagKeys parameter and argument for each tag to remove, separated by an ampersand (&amp;).
source
Main.Macie2.update_allow_listMethod
update_allow_list(criteria, id, name)
update_allow_list(criteria, id, name, params::Dict{String,<:Any})

Updates the settings for an allow list.

Arguments

  • criteria: The criteria that specify the text or text pattern to ignore. The criteria can be the location and name of an S3 object that lists specific text to ignore (s3WordsList), or a regular expression that defines a text pattern to ignore (regex). You can change a list's underlying criteria, such as the name of the S3 object or the regular expression to use. However, you can't change the type from s3WordsList to regex or the other way around.
  • id: The unique identifier for the Amazon Macie resource that the request applies to.
  • name: A custom name for the allow list. The name can contain as many as 128 characters.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "description": A custom description of the allow list. The description can contain as many as 512 characters.
source
Main.Macie2.update_automated_discovery_configurationMethod
update_automated_discovery_configuration(status)
update_automated_discovery_configuration(status, params::Dict{String,<:Any})

Enables or disables automated sensitive data discovery for an account.

Arguments

  • status: The new status of automated sensitive data discovery for the account. Valid values are: ENABLED, start or resume automated sensitive data discovery activities for the account; and, DISABLED, stop performing automated sensitive data discovery activities for the account. When you enable automated sensitive data discovery for the first time, Amazon Macie uses default configuration settings to determine which data sources to analyze and which managed data identifiers to use. To change these settings, use the UpdateClassificationScope and UpdateSensitivityInspectionTemplate operations, respectively. If you change the settings and subsequently disable the configuration, Amazon Macie retains your changes.
source
Main.Macie2.update_classification_jobMethod
update_classification_job(job_id, job_status)
update_classification_job(job_id, job_status, params::Dict{String,<:Any})

Changes the status of a classification job.

Arguments

  • job_id: The unique identifier for the classification job.
  • job_status: 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 USERPAUSED. 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 USERPAUSED. 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.
source
Main.Macie2.update_classification_scopeMethod
update_classification_scope(id)
update_classification_scope(id, params::Dict{String,<:Any})

Updates the classification scope settings for an account.

Arguments

  • id: The unique identifier for the Amazon Macie resource that the request applies to.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "s3": The S3 buckets to add or remove from the exclusion list defined by the classification scope.
source
Main.Macie2.update_findings_filterMethod
update_findings_filter(id)
update_findings_filter(id, params::Dict{String,<:Any})

Updates the criteria and other settings for a findings filter.

Arguments

  • id: The unique identifier for the Amazon Macie resource that the request applies to.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "action": The action to perform on findings that match the filter criteria (findingCriteria). Valid values are: ARCHIVE, suppress (automatically archive) the findings; and, NOOP, don't perform any action on the findings.
  • "clientToken": A unique, case-sensitive token that you provide to ensure the idempotency of the request.
  • "description": 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 this description, depending on the actions that they're allowed to perform in Amazon Macie.
  • "findingCriteria": The criteria to use to filter findings.
  • "name": 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 this name, depending on the actions that they're allowed to perform in Amazon Macie.
  • "position": 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.
source
Main.Macie2.update_macie_sessionMethod
update_macie_session()
update_macie_session(params::Dict{String,<:Any})

Suspends or re-enables Amazon Macie, or updates the configuration settings for a Macie account.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "findingPublishingFrequency": Specifies how often to publish updates to policy findings for the account. This includes publishing updates to Security Hub and Amazon EventBridge (formerly Amazon CloudWatch Events).
  • "status": 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.
source
Main.Macie2.update_member_sessionMethod
update_member_session(id, status)
update_member_session(id, status, params::Dict{String,<:Any})

Enables an Amazon Macie administrator to suspend or re-enable Macie for a member account.

Arguments

  • id: The unique identifier for the Amazon Macie resource that the request applies to.
  • status: 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.
source
Main.Macie2.update_organization_configurationMethod
update_organization_configuration(auto_enable)
update_organization_configuration(auto_enable, params::Dict{String,<:Any})

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

Arguments

  • auto_enable: Specifies whether to enable Amazon Macie automatically for an account when the account is added to the organization in Organizations.
source
Main.Macie2.update_resource_profileMethod
update_resource_profile(resource_arn)
update_resource_profile(resource_arn, params::Dict{String,<:Any})

Updates the sensitivity score for an S3 bucket.

Arguments

  • resource_arn: The Amazon Resource Name (ARN) of the S3 bucket that the request applies to.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "sensitivityScoreOverride": The new sensitivity score for the bucket. Valid values are: 100, assign the maximum score and apply the Sensitive label to the bucket; and, null (empty), assign a score that Amazon Macie calculates automatically after you submit the request.
source
Main.Macie2.update_resource_profile_detectionsMethod
update_resource_profile_detections(resource_arn)
update_resource_profile_detections(resource_arn, params::Dict{String,<:Any})

Updates the sensitivity scoring settings for an S3 bucket.

Arguments

  • resource_arn: The Amazon Resource Name (ARN) of the S3 bucket that the request applies to.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "suppressDataIdentifiers": An array of objects, one for each custom data identifier or managed data identifier that detected the type of sensitive data to start excluding or including in the bucket's score. To start including all sensitive data types in the score, don't specify any values for this array.
source
Main.Macie2.update_reveal_configurationMethod
update_reveal_configuration(configuration)
update_reveal_configuration(configuration, params::Dict{String,<:Any})

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

Arguments

  • configuration: The new configuration settings and the status of the configuration for the account.
source
Main.Macie2.update_sensitivity_inspection_templateMethod
update_sensitivity_inspection_template(id)
update_sensitivity_inspection_template(id, params::Dict{String,<:Any})

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

Arguments

  • id: The unique identifier for the Amazon Macie resource that the request applies to.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "description": A custom description of the template.
  • "excludes": The managed data identifiers to explicitly exclude (not use) when analyzing data. To exclude an allow list or custom data identifier that's currently included by the template, update the values for the SensitivityInspectionTemplateIncludes.allowListIds and SensitivityInspectionTemplateIncludes.customDataIdentifierIds properties, respectively.
  • "includes": The allow lists, custom data identifiers, and managed data identifiers to include (use) when analyzing data.
source