Learn R Programming

paws (version 0.2.0)

macie2: Amazon Macie 2

Description

Amazon Macie is a fully managed data security and data privacy service that uses machine learning and pattern matching to discover and protect your sensitive data in AWS. Macie automates the discovery of sensitive data, such as PII and intellectual property, to provide you with insight into the data that your organization stores in AWS. Macie also provides an inventory of your Amazon S3 buckets, which it continually monitors for you. If Macie detects sensitive data or potential data access issues, it generates detailed findings for you to review and act upon as necessary.

Usage

macie2(config = list())

Value

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.

Arguments

config

Optional configuration of credentials, endpoint, and/or region.

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

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"
  )
)

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
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_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
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_bucket_statisticsRetrieves (queries) aggregated statistical data about S3 buckets that Amazon Macie monitors and analyzes
get_classification_export_configurationRetrieves the configuration settings for storing data classification results
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 current 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_reveal_configurationRetrieves the status and configuration settings for retrieving (revealing) occurrences of sensitive data reported by findings
get_sensitive_data_occurrencesRetrieves (reveals) occurrences of sensitive data reported by a finding
get_sensitive_data_occurrences_availabilityChecks whether occurrences of sensitive data can be retrieved (revealed) for a finding
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_classification_jobsRetrieves a subset of information about one or more classification jobs
list_custom_data_identifiersRetrieves a subset of information about all 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 the 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_tags_for_resourceRetrieves the tags (keys and values) that are associated with a classification job, custom data identifier, findings filter, or member account
put_classification_export_configurationCreates 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
tag_resourceAdds or updates one or more tags (keys and values) that are associated with a classification job, custom data identifier, findings filter, or member account
test_custom_data_identifierTests a custom data identifier
untag_resourceRemoves one or more tags (keys and values) from a classification job, custom data identifier, findings filter, or member account
update_classification_jobChanges the status of a classification job
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_reveal_configurationUpdates the status and configuration settings for retrieving (revealing) occurrences of sensitive data reported by findings

Examples

Run this code
if (FALSE) {
svc <- macie2()
svc$accept_invitation(
  Foo = 123
)
}

Run the code above in your browser using DataLab