NAME

Paws::Macie2 - Perl Interface to AWS Amazon Macie 2

SYNOPSIS

  use Paws;

  my $obj = Paws->service('Macie2');
  my $res = $obj->Method(
    Arg1 => $val1,
    Arg2 => [ 'V1', 'V2' ],
    # if Arg3 is an object, the HashRef will be used as arguments to the constructor
    # of the arguments type
    Arg3 => { Att1 => 'Val1' },
    # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
    # the constructor of the arguments type
    Arg4 => [ { Att1 => 'Val1'  }, { Att1 => 'Val2' } ],
  );

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.

For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/macie2-2020-01-01

METHODS

AcceptInvitation

InvitationId => Str
[AdministratorAccountId => Str]
[MasterAccount => Str]

Each argument is described in detail in: Paws::Macie2::AcceptInvitation

Returns: a Paws::Macie2::AcceptInvitationResponse instance

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

BatchGetCustomDataIdentifiers

[Ids => ArrayRef[Str|Undef]]

Each argument is described in detail in: Paws::Macie2::BatchGetCustomDataIdentifiers

Returns: a Paws::Macie2::BatchGetCustomDataIdentifiersResponse instance

Retrieves information about one or more custom data identifiers.

CreateClassificationJob

ClientToken => Str
JobType => Str
Name => Str
S3JobDefinition => Paws::Macie2::S3JobDefinition
[CustomDataIdentifierIds => ArrayRef[Str|Undef]]
[Description => Str]
[InitialRun => Bool]
[SamplingPercentage => Int]
[ScheduleFrequency => Paws::Macie2::JobScheduleFrequency]
[Tags => Paws::Macie2::TagMap]

Each argument is described in detail in: Paws::Macie2::CreateClassificationJob

Returns: a Paws::Macie2::CreateClassificationJobResponse instance

Creates and defines the settings for a classification job.

CreateCustomDataIdentifier

[ClientToken => Str]
[Description => Str]
[IgnoreWords => ArrayRef[Str|Undef]]
[Keywords => ArrayRef[Str|Undef]]
[MaximumMatchDistance => Int]
[Name => Str]
[Regex => Str]
[Tags => Paws::Macie2::TagMap]

Each argument is described in detail in: Paws::Macie2::CreateCustomDataIdentifier

Returns: a Paws::Macie2::CreateCustomDataIdentifierResponse instance

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

CreateFindingsFilter

Action => Str
FindingCriteria => Paws::Macie2::FindingCriteria
Name => Str
[ClientToken => Str]
[Description => Str]
[Position => Int]
[Tags => Paws::Macie2::TagMap]

Each argument is described in detail in: Paws::Macie2::CreateFindingsFilter

Returns: a Paws::Macie2::CreateFindingsFilterResponse instance

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

CreateInvitations

AccountIds => ArrayRef[Str|Undef]
[DisableEmailNotification => Bool]
[Message => Str]

Each argument is described in detail in: Paws::Macie2::CreateInvitations

Returns: a Paws::Macie2::CreateInvitationsResponse instance

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

CreateMember

Account => Paws::Macie2::AccountDetail
[Tags => Paws::Macie2::TagMap]

Each argument is described in detail in: Paws::Macie2::CreateMember

Returns: a Paws::Macie2::CreateMemberResponse instance

Associates an account with an Amazon Macie administrator account.

CreateSampleFindings

[FindingTypes => ArrayRef[Str|Undef]]

Each argument is described in detail in: Paws::Macie2::CreateSampleFindings

Returns: a Paws::Macie2::CreateSampleFindingsResponse instance

Creates sample findings.

DeclineInvitations

AccountIds => ArrayRef[Str|Undef]

Each argument is described in detail in: Paws::Macie2::DeclineInvitations

Returns: a Paws::Macie2::DeclineInvitationsResponse instance

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

DeleteCustomDataIdentifier

Id => Str

Each argument is described in detail in: Paws::Macie2::DeleteCustomDataIdentifier

Returns: a Paws::Macie2::DeleteCustomDataIdentifierResponse instance

Soft deletes a custom data identifier.

DeleteFindingsFilter

Id => Str

Each argument is described in detail in: Paws::Macie2::DeleteFindingsFilter

Returns: a Paws::Macie2::DeleteFindingsFilterResponse instance

Deletes a findings filter.

DeleteInvitations

AccountIds => ArrayRef[Str|Undef]

Each argument is described in detail in: Paws::Macie2::DeleteInvitations

Returns: a Paws::Macie2::DeleteInvitationsResponse instance

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

DeleteMember

Id => Str

Each argument is described in detail in: Paws::Macie2::DeleteMember

Returns: a Paws::Macie2::DeleteMemberResponse instance

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

DescribeBuckets

[Criteria => Paws::Macie2::BucketCriteria]
[MaxResults => Int]
[NextToken => Str]
[SortCriteria => Paws::Macie2::BucketSortCriteria]

Each argument is described in detail in: Paws::Macie2::DescribeBuckets

Returns: a Paws::Macie2::DescribeBucketsResponse instance

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

DescribeClassificationJob

JobId => Str

Each argument is described in detail in: Paws::Macie2::DescribeClassificationJob

Returns: a Paws::Macie2::DescribeClassificationJobResponse instance

Retrieves the status and settings for a classification job.

DescribeOrganizationConfiguration

Each argument is described in detail in: Paws::Macie2::DescribeOrganizationConfiguration

Returns: a Paws::Macie2::DescribeOrganizationConfigurationResponse instance

Retrieves the Amazon Macie configuration settings for an Amazon Web Services organization.

DisableMacie

Each argument is described in detail in: Paws::Macie2::DisableMacie

Returns: a Paws::Macie2::DisableMacieResponse instance

Disables an Amazon Macie account and deletes Macie resources for the account.

DisableOrganizationAdminAccount

AdminAccountId => Str

Each argument is described in detail in: Paws::Macie2::DisableOrganizationAdminAccount

Returns: a Paws::Macie2::DisableOrganizationAdminAccountResponse instance

Disables an account as the delegated Amazon Macie administrator account for an Amazon Web Services organization.

DisassociateFromAdministratorAccount

Each argument is described in detail in: Paws::Macie2::DisassociateFromAdministratorAccount

Returns: a Paws::Macie2::DisassociateFromAdministratorAccountResponse instance

Disassociates a member account from its Amazon Macie administrator account.

DisassociateFromMasterAccount

Each argument is described in detail in: Paws::Macie2::DisassociateFromMasterAccount

Returns: a Paws::Macie2::DisassociateFromMasterAccountResponse instance

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

DisassociateFromAdministratorAccount operation.

DisassociateMember

Id => Str

Each argument is described in detail in: Paws::Macie2::DisassociateMember

Returns: a Paws::Macie2::DisassociateMemberResponse instance

Disassociates an Amazon Macie administrator account from a member account.

EnableMacie

[ClientToken => Str]
[FindingPublishingFrequency => Str]
[Status => Str]

Each argument is described in detail in: Paws::Macie2::EnableMacie

Returns: a Paws::Macie2::EnableMacieResponse instance

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

EnableOrganizationAdminAccount

AdminAccountId => Str
[ClientToken => Str]

Each argument is described in detail in: Paws::Macie2::EnableOrganizationAdminAccount

Returns: a Paws::Macie2::EnableOrganizationAdminAccountResponse instance

Designates an account as the delegated Amazon Macie administrator account for an Amazon Web Services organization.

GetAdministratorAccount

Each argument is described in detail in: Paws::Macie2::GetAdministratorAccount

Returns: a Paws::Macie2::GetAdministratorAccountResponse instance

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

GetBucketStatistics

[AccountId => Str]

Each argument is described in detail in: Paws::Macie2::GetBucketStatistics

Returns: a Paws::Macie2::GetBucketStatisticsResponse instance

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

GetClassificationExportConfiguration

Each argument is described in detail in: Paws::Macie2::GetClassificationExportConfiguration

Returns: a Paws::Macie2::GetClassificationExportConfigurationResponse instance

Retrieves the configuration settings for storing data classification results.

GetCustomDataIdentifier

Id => Str

Each argument is described in detail in: Paws::Macie2::GetCustomDataIdentifier

Returns: a Paws::Macie2::GetCustomDataIdentifierResponse instance

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

GetFindings

FindingIds => ArrayRef[Str|Undef]
[SortCriteria => Paws::Macie2::SortCriteria]

Each argument is described in detail in: Paws::Macie2::GetFindings

Returns: a Paws::Macie2::GetFindingsResponse instance

Retrieves the details of one or more findings.

GetFindingsFilter

Id => Str

Each argument is described in detail in: Paws::Macie2::GetFindingsFilter

Returns: a Paws::Macie2::GetFindingsFilterResponse instance

Retrieves the criteria and other settings for a findings filter.

GetFindingsPublicationConfiguration

Each argument is described in detail in: Paws::Macie2::GetFindingsPublicationConfiguration

Returns: a Paws::Macie2::GetFindingsPublicationConfigurationResponse instance

Retrieves the configuration settings for publishing findings to Security Hub.

GetFindingStatistics

GroupBy => Str
[FindingCriteria => Paws::Macie2::FindingCriteria]
[Size => Int]
[SortCriteria => Paws::Macie2::FindingStatisticsSortCriteria]

Each argument is described in detail in: Paws::Macie2::GetFindingStatistics

Returns: a Paws::Macie2::GetFindingStatisticsResponse instance

Retrieves (queries) aggregated statistical data about findings.

GetInvitationsCount

Each argument is described in detail in: Paws::Macie2::GetInvitationsCount

Returns: a Paws::Macie2::GetInvitationsCountResponse instance

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

GetMacieSession

Each argument is described in detail in: Paws::Macie2::GetMacieSession

Returns: a Paws::Macie2::GetMacieSessionResponse instance

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

GetMasterAccount

Each argument is described in detail in: Paws::Macie2::GetMasterAccount

Returns: a Paws::Macie2::GetMasterAccountResponse instance

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

GetAdministratorAccount operation.

GetMember

Id => Str

Each argument is described in detail in: Paws::Macie2::GetMember

Returns: a Paws::Macie2::GetMemberResponse instance

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

GetUsageStatistics

[FilterBy => ArrayRef[Paws::Macie2::UsageStatisticsFilter]]
[MaxResults => Int]
[NextToken => Str]
[SortBy => Paws::Macie2::UsageStatisticsSortBy]
[TimeRange => Str]

Each argument is described in detail in: Paws::Macie2::GetUsageStatistics

Returns: a Paws::Macie2::GetUsageStatisticsResponse instance

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

GetUsageTotals

[TimeRange => Str]

Each argument is described in detail in: Paws::Macie2::GetUsageTotals

Returns: a Paws::Macie2::GetUsageTotalsResponse instance

Retrieves (queries) aggregated usage data for an account.

ListClassificationJobs

[FilterCriteria => Paws::Macie2::ListJobsFilterCriteria]
[MaxResults => Int]
[NextToken => Str]
[SortCriteria => Paws::Macie2::ListJobsSortCriteria]

Each argument is described in detail in: Paws::Macie2::ListClassificationJobs

Returns: a Paws::Macie2::ListClassificationJobsResponse instance

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

ListCustomDataIdentifiers

[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::Macie2::ListCustomDataIdentifiers

Returns: a Paws::Macie2::ListCustomDataIdentifiersResponse instance

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

ListFindings

[FindingCriteria => Paws::Macie2::FindingCriteria]
[MaxResults => Int]
[NextToken => Str]
[SortCriteria => Paws::Macie2::SortCriteria]

Each argument is described in detail in: Paws::Macie2::ListFindings

Returns: a Paws::Macie2::ListFindingsResponse instance

Retrieves a subset of information about one or more findings.

ListFindingsFilters

[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::Macie2::ListFindingsFilters

Returns: a Paws::Macie2::ListFindingsFiltersResponse instance

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

ListInvitations

[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::Macie2::ListInvitations

Returns: a Paws::Macie2::ListInvitationsResponse instance

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

ListMembers

[MaxResults => Int]
[NextToken => Str]
[OnlyAssociated => Str]

Each argument is described in detail in: Paws::Macie2::ListMembers

Returns: a Paws::Macie2::ListMembersResponse instance

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

ListOrganizationAdminAccounts

[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::Macie2::ListOrganizationAdminAccounts

Returns: a Paws::Macie2::ListOrganizationAdminAccountsResponse instance

Retrieves information about the delegated Amazon Macie administrator account for an Amazon Web Services organization.

ListTagsForResource

ResourceArn => Str

Each argument is described in detail in: Paws::Macie2::ListTagsForResource

Returns: a Paws::Macie2::ListTagsForResourceResponse instance

Retrieves the tags (keys and values) that are associated with a classification job, custom data identifier, findings filter, or member account.

PutClassificationExportConfiguration

Configuration => Paws::Macie2::ClassificationExportConfiguration

Each argument is described in detail in: Paws::Macie2::PutClassificationExportConfiguration

Returns: a Paws::Macie2::PutClassificationExportConfigurationResponse instance

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

PutFindingsPublicationConfiguration

[ClientToken => Str]
[SecurityHubConfiguration => Paws::Macie2::SecurityHubConfiguration]

Each argument is described in detail in: Paws::Macie2::PutFindingsPublicationConfiguration

Returns: a Paws::Macie2::PutFindingsPublicationConfigurationResponse instance

Updates the configuration settings for publishing findings to Security Hub.

SearchResources

[BucketCriteria => Paws::Macie2::SearchResourcesBucketCriteria]
[MaxResults => Int]
[NextToken => Str]
[SortCriteria => Paws::Macie2::SearchResourcesSortCriteria]

Each argument is described in detail in: Paws::Macie2::SearchResources

Returns: a Paws::Macie2::SearchResourcesResponse instance

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

TagResource

ResourceArn => Str
Tags => Paws::Macie2::TagMap

Each argument is described in detail in: Paws::Macie2::TagResource

Returns: a Paws::Macie2::TagResourceResponse instance

Adds or updates one or more tags (keys and values) that are associated with a classification job, custom data identifier, findings filter, or member account.

TestCustomDataIdentifier

Regex => Str
SampleText => Str
[IgnoreWords => ArrayRef[Str|Undef]]
[Keywords => ArrayRef[Str|Undef]]
[MaximumMatchDistance => Int]

Each argument is described in detail in: Paws::Macie2::TestCustomDataIdentifier

Returns: a Paws::Macie2::TestCustomDataIdentifierResponse instance

Tests a custom data identifier.

UntagResource

ResourceArn => Str
TagKeys => ArrayRef[Str|Undef]

Each argument is described in detail in: Paws::Macie2::UntagResource

Returns: a Paws::Macie2::UntagResourceResponse instance

Removes one or more tags (keys and values) from a classification job, custom data identifier, findings filter, or member account.

UpdateClassificationJob

JobId => Str
JobStatus => Str

Each argument is described in detail in: Paws::Macie2::UpdateClassificationJob

Returns: a Paws::Macie2::UpdateClassificationJobResponse instance

Changes the status of a classification job.

UpdateFindingsFilter

Id => Str
[Action => Str]
[ClientToken => Str]
[Description => Str]
[FindingCriteria => Paws::Macie2::FindingCriteria]
[Name => Str]
[Position => Int]

Each argument is described in detail in: Paws::Macie2::UpdateFindingsFilter

Returns: a Paws::Macie2::UpdateFindingsFilterResponse instance

Updates the criteria and other settings for a findings filter.

UpdateMacieSession

[FindingPublishingFrequency => Str]
[Status => Str]

Each argument is described in detail in: Paws::Macie2::UpdateMacieSession

Returns: a Paws::Macie2::UpdateMacieSessionResponse instance

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

UpdateMemberSession

Id => Str
Status => Str

Each argument is described in detail in: Paws::Macie2::UpdateMemberSession

Returns: a Paws::Macie2::UpdateMemberSessionResponse instance

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

UpdateOrganizationConfiguration

AutoEnable => Bool

Each argument is described in detail in: Paws::Macie2::UpdateOrganizationConfiguration

Returns: a Paws::Macie2::UpdateOrganizationConfigurationResponse instance

Updates the Amazon Macie configuration settings for an Amazon Web Services organization.

PAGINATORS

Paginator methods are helpers that repetively call methods that return partial results