macie2 function

Amazon Macie 2

Amazon Macie 2

Amazon Macie

macie2(config = list(), credentials = list(), endpoint = NULL, region = NULL)

Arguments

  • config: Optional configuration of credentials, endpoint, and/or region.

    • credentials :

      • creds :

        • access_key_id : AWS access key ID
        • secret_access_key : AWS secret access key
        • session_token : AWS temporary session token
      • profile : The name of a profile to use. If not given, then the default profile is used.

      • anonymous : Set anonymous credentials.

    • endpoint : The complete URL to use for the constructed client.

    • region : The AWS Region used in instantiating the client.

    • close_connection : Immediately close all HTTP connections.

    • timeout : The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.

    • s3_force_path_style : Set this to true to force the request to use path-style addressing, i.e. http://s3.amazonaws.com/BUCKET/KEY.

    • sts_regional_endpoint : Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html

  • credentials: Optional credentials shorthand for the config parameter

    • creds :

      • access_key_id : AWS access key ID
      • secret_access_key : AWS secret access key
      • session_token : AWS temporary session token
    • profile : The name of a profile to use. If not given, then the default profile is used.

    • anonymous : Set anonymous credentials.

  • endpoint: Optional shorthand for complete URL to use for the constructed client.

  • region: Optional shorthand for AWS Region used in instantiating the client.

Returns

A client for the service. You can call the service's operations using syntax like svc$operation(...), where svc is the name you've assigned to the client. The available operations are listed in the Operations section.

Service syntax

svc <- macie2(
  config = list(
    credentials = list(
 creds = list(
   access_key_id = "string",
   secret_access_key = "string",
   session_token = "string"
 ),
 profile = "string",
 anonymous = "logical"
    ),
    endpoint = "string",
    region = "string",
    close_connection = "logical",
    timeout = "numeric",
    s3_force_path_style = "logical",
    sts_regional_endpoint = "string"
  ),
  credentials = list(
    creds = list(
 access_key_id = "string",
 secret_access_key = "string",
 session_token = "string"
    ),
    profile = "string",
    anonymous = "logical"
  ),
  endpoint = "string",
  region = "string"
)

Operations

accept_invitationAccepts an Amazon Macie membership invitation that was received from a specific account
batch_get_custom_data_identifiersRetrieves information about one or more custom data identifiers
batch_update_automated_discovery_accountsChanges the status of automated sensitive data discovery for one or more accounts
create_allow_listCreates and defines the settings for an allow list
create_classification_jobCreates and defines the settings for a classification job
create_custom_data_identifierCreates and defines the criteria and other settings for a custom data identifier
create_findings_filterCreates and defines the criteria and other settings for a findings filter
create_invitationsSends an Amazon Macie membership invitation to one or more accounts
create_memberAssociates an account with an Amazon Macie administrator account
create_sample_findingsCreates sample findings
decline_invitationsDeclines Amazon Macie membership invitations that were received from specific accounts
delete_allow_listDeletes an allow list
delete_custom_data_identifierSoft deletes a custom data identifier
delete_findings_filterDeletes a findings filter
delete_invitationsDeletes Amazon Macie membership invitations that were received from specific accounts
delete_memberDeletes the association between an Amazon Macie administrator account and an account
describe_bucketsRetrieves (queries) statistical data and other information about one or more S3 buckets that Amazon Macie monitors and analyzes for an account
describe_classification_jobRetrieves the status and settings for a classification job
describe_organization_configurationRetrieves the Amazon Macie configuration settings for an organization in Organizations
disable_macieDisables Amazon Macie and deletes all settings and resources for a Macie account
disable_organization_admin_accountDisables an account as the delegated Amazon Macie administrator account for an organization in Organizations
disassociate_from_administrator_accountDisassociates a member account from its Amazon Macie administrator account
disassociate_from_master_account(Deprecated) Disassociates a member account from its Amazon Macie administrator account
disassociate_memberDisassociates an Amazon Macie administrator account from a member account
enable_macieEnables Amazon Macie and specifies the configuration settings for a Macie account
enable_organization_admin_accountDesignates an account as the delegated Amazon Macie administrator account for an organization in Organizations
get_administrator_accountRetrieves information about the Amazon Macie administrator account for an account
get_allow_listRetrieves the settings and status of an allow list
get_automated_discovery_configurationRetrieves the configuration settings and status of automated sensitive data discovery for an organization or standalone account
get_bucket_statisticsRetrieves (queries) aggregated statistical data about all the S3 buckets that Amazon Macie monitors and analyzes for an account
get_classification_export_configurationRetrieves the configuration settings for storing data classification results
get_classification_scopeRetrieves the classification scope settings for an account
get_custom_data_identifierRetrieves the criteria and other settings for a custom data identifier
get_findingsRetrieves the details of one or more findings
get_findings_filterRetrieves the criteria and other settings for a findings filter
get_findings_publication_configurationRetrieves the configuration settings for publishing findings to Security Hub
get_finding_statisticsRetrieves (queries) aggregated statistical data about findings
get_invitations_countRetrieves the count of Amazon Macie membership invitations that were received by an account
get_macie_sessionRetrieves the status and configuration settings for an Amazon Macie account
get_master_account(Deprecated) Retrieves information about the Amazon Macie administrator account for an account
get_memberRetrieves information about an account that's associated with an Amazon Macie administrator account
get_resource_profileRetrieves (queries) sensitive data discovery statistics and the sensitivity score for an S3 bucket
get_reveal_configurationRetrieves the status and configuration settings for retrieving occurrences of sensitive data reported by findings
get_sensitive_data_occurrencesRetrieves occurrences of sensitive data reported by a finding
get_sensitive_data_occurrences_availabilityChecks whether occurrences of sensitive data can be retrieved for a finding
get_sensitivity_inspection_templateRetrieves the settings for the sensitivity inspection template for an account
get_usage_statisticsRetrieves (queries) quotas and aggregated usage data for one or more accounts
get_usage_totalsRetrieves (queries) aggregated usage data for an account
list_allow_listsRetrieves a subset of information about all the allow lists for an account
list_automated_discovery_accountsRetrieves the status of automated sensitive data discovery for one or more accounts
list_classification_jobsRetrieves a subset of information about one or more classification jobs
list_classification_scopesRetrieves a subset of information about the classification scope for an account
list_custom_data_identifiersRetrieves a subset of information about the custom data identifiers for an account
list_findingsRetrieves a subset of information about one or more findings
list_findings_filtersRetrieves a subset of information about all the findings filters for an account
list_invitationsRetrieves information about Amazon Macie membership invitations that were received by an account
list_managed_data_identifiersRetrieves information about all the managed data identifiers that Amazon Macie currently provides
list_membersRetrieves information about the accounts that are associated with an Amazon Macie administrator account
list_organization_admin_accountsRetrieves information about the delegated Amazon Macie administrator account for an organization in Organizations
list_resource_profile_artifactsRetrieves information about objects that Amazon Macie selected from an S3 bucket for automated sensitive data discovery
list_resource_profile_detectionsRetrieves information about the types and amount of sensitive data that Amazon Macie found in an S3 bucket
list_sensitivity_inspection_templatesRetrieves a subset of information about the sensitivity inspection template for an account
list_tags_for_resourceRetrieves the tags (keys and values) that are associated with an Amazon Macie resource
put_classification_export_configurationAdds or updates the configuration settings for storing data classification results
put_findings_publication_configurationUpdates the configuration settings for publishing findings to Security Hub
search_resourcesRetrieves (queries) statistical data and other information about Amazon Web Services resources that Amazon Macie monitors and analyzes for an account
tag_resourceAdds or updates one or more tags (keys and values) that are associated with an Amazon Macie resource
test_custom_data_identifierTests criteria for a custom data identifier
untag_resourceRemoves one or more tags (keys and values) from an Amazon Macie resource
update_allow_listUpdates the settings for an allow list
update_automated_discovery_configurationChanges the configuration settings and status of automated sensitive data discovery for an organization or standalone account
update_classification_jobChanges the status of a classification job
update_classification_scopeUpdates the classification scope settings for an account
update_findings_filterUpdates the criteria and other settings for a findings filter
update_macie_sessionSuspends or re-enables Amazon Macie, or updates the configuration settings for a Macie account
update_member_sessionEnables an Amazon Macie administrator to suspend or re-enable Macie for a member account
update_organization_configurationUpdates the Amazon Macie configuration settings for an organization in Organizations
update_resource_profileUpdates the sensitivity score for an S3 bucket
update_resource_profile_detectionsUpdates the sensitivity scoring settings for an S3 bucket
update_reveal_configurationUpdates the status and configuration settings for retrieving occurrences of sensitive data reported by findings
update_sensitivity_inspection_templateUpdates the settings for the sensitivity inspection template for an account

Examples

## Not run: svc <- macie2() svc$accept_invitation( Foo = 123 ) ## End(Not run)
  • Maintainer: Dyfan Jones
  • License: Apache License (>= 2.0)
  • Last published: 2025-03-17