AWS.Macie2 reference

AcceptInvitation

Source: src/AWS/Macie2/AcceptInvitation.ts

Runtime binding for macie2:AcceptInvitation.

Accepts an Amazon Macie membership invitation that was received from a specific account. Account-level operation — invoked with the caller’s request as-is. Provide the implementation with Effect.provide(AWS.Macie2.AcceptInvitationHttp).

AcceptInvitation: Administrator & Invitations

// init — account-level binding, no resource argument
const acceptInvitation = yield* AWS.Macie2.AcceptInvitation();

// runtime
yield* acceptInvitation({ administratorAccountId, invitationId });

AllowList

Source: src/AWS/Macie2/AllowList.ts

An Amazon Macie allow list — text patterns or predefined words that Macie ignores when it inspects S3 objects for sensitive data. Requires Macie to be enabled for the account (see Macie2.Session). Name, description, and criteria are all updatable in place; destroy deletes the list even if classification jobs reference it.

AllowList: Creating an allow list

Regex allow list

const allowList = yield* Macie2.AllowList("InternalIds", {
  description: "Internal ticket ids are not sensitive",
  criteria: { regex: "TICKET-[0-9]{6}" },
});

Predefined words from S3

const allowList = yield* Macie2.AllowList("KnownTestData", {
  criteria: {
    s3WordsList: { bucketName: bucket.bucketName, objectKey: "words.txt" },
  },
});

BatchGetCustomDataIdentifiers

Source: src/AWS/Macie2/BatchGetCustomDataIdentifiers.ts

Runtime binding for macie2:BatchGetCustomDataIdentifiers.

Retrieves information about one or more custom data identifiers. Account-level operation — invoked with the caller’s request as-is. Provide the implementation with Effect.provide(AWS.Macie2.BatchGetCustomDataIdentifiersHttp).

BatchGetCustomDataIdentifiers: Custom Data Identifiers & Lists

// init — account-level binding, no resource argument
const batchGetCustomDataIdentifiers = yield* AWS.Macie2.BatchGetCustomDataIdentifiers();

// runtime
const { customDataIdentifiers } = yield* batchGetCustomDataIdentifiers({ ids });

BatchUpdateAutomatedDiscoveryAccounts

Source: src/AWS/Macie2/BatchUpdateAutomatedDiscoveryAccounts.ts

Runtime binding for macie2:BatchUpdateAutomatedDiscoveryAccounts.

Changes the status of automated sensitive data discovery for one or more accounts. Account-level operation — invoked with the caller’s request as-is. Provide the implementation with Effect.provide(AWS.Macie2.BatchUpdateAutomatedDiscoveryAccountsHttp).

BatchUpdateAutomatedDiscoveryAccounts: Automated Discovery

// init — account-level binding, no resource argument
const batchUpdateAutomatedDiscoveryAccounts = yield* AWS.Macie2.BatchUpdateAutomatedDiscoveryAccounts();

// runtime
yield* batchUpdateAutomatedDiscoveryAccounts({
  accounts: [{ accountId, status: "ENABLED" }],
});

ClassificationJob

Source: src/AWS/Macie2/ClassificationJob.ts

An Amazon Macie classification job — scans one or more S3 buckets for sensitive data. Requires Macie to be enabled for the account (see Macie2.Session). Jobs are immutable once created; changing the job type, name, or bucket set replaces the job. Destroy cancels the job.

ClassificationJob: Creating a classification job

One-time job over a bucket

const job = yield* Macie2.ClassificationJob("Scan", {
  jobType: "ONE_TIME",
  bucketDefinitions: [{ accountId, buckets: ["my-bucket"] }],
});

Sampled scan with a description

const job = yield* Macie2.ClassificationJob("Scan", {
  jobType: "ONE_TIME",
  bucketDefinitions: [{ accountId, buckets: ["my-bucket"] }],
  samplingPercentage: 20,
  description: "PII sweep",
});

CreateInvitations

Source: src/AWS/Macie2/CreateInvitations.ts

Runtime binding for macie2:CreateInvitations.

Sends an Amazon Macie membership invitation to one or more accounts. Account-level operation — invoked with the caller’s request as-is. Provide the implementation with Effect.provide(AWS.Macie2.CreateInvitationsHttp).

CreateInvitations: Administrator & Invitations

// init — account-level binding, no resource argument
const createInvitations = yield* AWS.Macie2.CreateInvitations();

// runtime
const { unprocessedAccounts } = yield* createInvitations({ accountIds });

CreateMember

Source: src/AWS/Macie2/CreateMember.ts

Runtime binding for macie2:CreateMember.

Associates an account with an Amazon Macie administrator account. Account-level operation — invoked with the caller’s request as-is. Provide the implementation with Effect.provide(AWS.Macie2.CreateMemberHttp).

CreateMember: Organization & Members

// init — account-level binding, no resource argument
const createMember = yield* AWS.Macie2.CreateMember();

// runtime
yield* createMember({ account: { accountId, email } });

CreateSampleFindings

Source: src/AWS/Macie2/CreateSampleFindings.ts

Runtime binding for macie2:CreateSampleFindings.

Creates sample findings. Account-level operation — invoked with the caller’s request as-is. Provide the implementation with Effect.provide(AWS.Macie2.CreateSampleFindingsHttp).

CreateSampleFindings: Working with Findings

// init — account-level binding, no resource argument
const createSampleFindings = yield* AWS.Macie2.CreateSampleFindings();

// runtime
yield* createSampleFindings({});

CustomDataIdentifier

Source: src/AWS/Macie2/CustomDataIdentifier.ts

An Amazon Macie custom data identifier — a regex-based detection criterion (with optional keywords, ignore words, and severity thresholds) that classification jobs and automated discovery use to detect organization- specific sensitive data. Requires Macie to be enabled for the account (see Macie2.Session). Definitions are immutable: any change other than tags replaces the identifier. Destroy soft-deletes it.

CustomDataIdentifier: Creating a custom data identifier

Employee-id detector

const identifier = yield* Macie2.CustomDataIdentifier("EmployeeId", {
  regex: "EMP-[0-9]{8}",
  description: "Internal employee id format",
});

Keyword-scoped detector with severity thresholds

const identifier = yield* Macie2.CustomDataIdentifier("AccountNumber", {
  regex: "[0-9]{12}",
  keywords: ["account number", "acct no"],
  maximumMatchDistance: 30,
  severityLevels: [
    { occurrencesThreshold: 1, severity: "LOW" },
    { occurrencesThreshold: 25, severity: "HIGH" },
  ],
});

DeclineInvitations

Source: src/AWS/Macie2/DeclineInvitations.ts

Runtime binding for macie2:DeclineInvitations.

Declines Amazon Macie membership invitations that were received from specific accounts. Account-level operation — invoked with the caller’s request as-is. Provide the implementation with Effect.provide(AWS.Macie2.DeclineInvitationsHttp).

DeclineInvitations: Administrator & Invitations

// init — account-level binding, no resource argument
const declineInvitations = yield* AWS.Macie2.DeclineInvitations();

// runtime
yield* declineInvitations({ accountIds });

DeleteInvitations

Source: src/AWS/Macie2/DeleteInvitations.ts

Runtime binding for macie2:DeleteInvitations.

Deletes Amazon Macie membership invitations that were received from specific accounts. Account-level operation — invoked with the caller’s request as-is. Provide the implementation with Effect.provide(AWS.Macie2.DeleteInvitationsHttp).

DeleteInvitations: Administrator & Invitations

// init — account-level binding, no resource argument
const deleteInvitations = yield* AWS.Macie2.DeleteInvitations();

// runtime
yield* deleteInvitations({ accountIds });

DeleteMember

Source: src/AWS/Macie2/DeleteMember.ts

Runtime binding for macie2:DeleteMember.

Deletes the association between an Amazon Macie administrator account and an account. Account-level operation — invoked with the caller’s request as-is. Provide the implementation with Effect.provide(AWS.Macie2.DeleteMemberHttp).

DeleteMember: Organization & Members

// init — account-level binding, no resource argument
const deleteMember = yield* AWS.Macie2.DeleteMember();

// runtime
yield* deleteMember({ id: accountId });

DescribeBuckets

Source: src/AWS/Macie2/DescribeBuckets.ts

Runtime binding for macie2:DescribeBuckets.

Retrieves (queries) statistical data and other information about one or more S3 buckets that Amazon Macie monitors and analyzes for an account. Account-level operation — invoked with the caller’s request as-is. Provide the implementation with Effect.provide(AWS.Macie2.DescribeBucketsHttp).

DescribeBuckets: S3 Bucket Inventory

// init — account-level binding, no resource argument
const describeBuckets = yield* AWS.Macie2.DescribeBuckets();

// runtime
const { buckets } = yield* describeBuckets({});

DescribeOrganizationConfiguration

Source: src/AWS/Macie2/DescribeOrganizationConfiguration.ts

Runtime binding for macie2:DescribeOrganizationConfiguration.

Retrieves the Amazon Macie configuration settings for an organization in Organizations. Account-level operation — invoked with the caller’s request as-is. Provide the implementation with Effect.provide(AWS.Macie2.DescribeOrganizationConfigurationHttp).

DescribeOrganizationConfiguration: Organization & Members

// init — account-level binding, no resource argument
const describeOrganizationConfiguration = yield* AWS.Macie2.DescribeOrganizationConfiguration();

// runtime
const { autoEnable } = yield* describeOrganizationConfiguration();

DisableOrganizationAdminAccount

Source: src/AWS/Macie2/DisableOrganizationAdminAccount.ts

Runtime binding for macie2:DisableOrganizationAdminAccount.

Disables an account as the delegated Amazon Macie administrator account for an organization in Organizations. Account-level operation — invoked with the caller’s request as-is. Provide the implementation with Effect.provide(AWS.Macie2.DisableOrganizationAdminAccountHttp).

DisableOrganizationAdminAccount: Organization & Members

// init — account-level binding, no resource argument
const disableOrganizationAdminAccount = yield* AWS.Macie2.DisableOrganizationAdminAccount();

// runtime
yield* disableOrganizationAdminAccount({ adminAccountId });

DisassociateFromAdministratorAccount

Source: src/AWS/Macie2/DisassociateFromAdministratorAccount.ts

Runtime binding for macie2:DisassociateFromAdministratorAccount.

Disassociates a member account from its Amazon Macie administrator account. Account-level operation — invoked with the caller’s request as-is. Provide the implementation with Effect.provide(AWS.Macie2.DisassociateFromAdministratorAccountHttp).

DisassociateFromAdministratorAccount: Administrator & Invitations

// init — account-level binding, no resource argument
const disassociateFromAdministratorAccount = yield* AWS.Macie2.DisassociateFromAdministratorAccount();

// runtime
yield* disassociateFromAdministratorAccount();

DisassociateMember

Source: src/AWS/Macie2/DisassociateMember.ts

Runtime binding for macie2:DisassociateMember.

Disassociates an Amazon Macie administrator account from a member account. Account-level operation — invoked with the caller’s request as-is. Provide the implementation with Effect.provide(AWS.Macie2.DisassociateMemberHttp).

DisassociateMember: Organization & Members

// init — account-level binding, no resource argument
const disassociateMember = yield* AWS.Macie2.DisassociateMember();

// runtime
yield* disassociateMember({ id: accountId });

EnableOrganizationAdminAccount

Source: src/AWS/Macie2/EnableOrganizationAdminAccount.ts

Runtime binding for macie2:EnableOrganizationAdminAccount.

Designates an account as the delegated Amazon Macie administrator account for an organization in Organizations. Account-level operation — invoked with the caller’s request as-is. Provide the implementation with Effect.provide(AWS.Macie2.EnableOrganizationAdminAccountHttp).

EnableOrganizationAdminAccount: Organization & Members

// init — account-level binding, no resource argument
const enableOrganizationAdminAccount = yield* AWS.Macie2.EnableOrganizationAdminAccount();

// runtime
yield* enableOrganizationAdminAccount({ adminAccountId });

FindingsFilter

Source: src/AWS/Macie2/FindingsFilter.ts

An Amazon Macie findings filter — matches findings against criteria and either keeps (NOOP) or auto-suppresses (ARCHIVE) them. Requires Macie to be enabled for the account (see Macie2.Session). Name, description, action, position, and criteria are all updatable in place.

FindingsFilter: Filtering findings

Suppress low-severity findings

const filter = yield* Macie2.FindingsFilter("LowSeverity", {
  action: "ARCHIVE",
  position: 1,
  findingCriteria: {
    criterion: { "severity.description": { eq: ["Low"] } },
  },
});

Keep a named filter for the console

const filter = yield* Macie2.FindingsFilter("ProdBuckets", {
  name: "prod-buckets-only",
  description: "Findings on production buckets",
  findingCriteria: {
    criterion: {
      "resourcesAffected.s3Bucket.name": { eq: ["prod-data"] },
    },
  },
});

GetAdministratorAccount

Source: src/AWS/Macie2/GetAdministratorAccount.ts

Runtime binding for macie2:GetAdministratorAccount.

Retrieves information about the Amazon Macie administrator account for an account. Account-level operation — invoked with the caller’s request as-is. Provide the implementation with Effect.provide(AWS.Macie2.GetAdministratorAccountHttp).

GetAdministratorAccount: Administrator & Invitations

// init — account-level binding, no resource argument
const getAdministratorAccount = yield* AWS.Macie2.GetAdministratorAccount();

// runtime
const { administrator } = yield* getAdministratorAccount();

GetAutomatedDiscoveryConfiguration

Source: src/AWS/Macie2/GetAutomatedDiscoveryConfiguration.ts

Runtime binding for macie2:GetAutomatedDiscoveryConfiguration.

Retrieves the configuration settings and status of automated sensitive data discovery for an organization or standalone account. Account-level operation — invoked with the caller’s request as-is. Provide the implementation with Effect.provide(AWS.Macie2.GetAutomatedDiscoveryConfigurationHttp).

GetAutomatedDiscoveryConfiguration: Automated Discovery

// init — account-level binding, no resource argument
const getAutomatedDiscoveryConfiguration = yield* AWS.Macie2.GetAutomatedDiscoveryConfiguration();

// runtime
const { status } = yield* getAutomatedDiscoveryConfiguration();

GetBucketStatistics

Source: src/AWS/Macie2/GetBucketStatistics.ts

Runtime binding for macie2:GetBucketStatistics.

Retrieves (queries) aggregated statistical data about all the S3 buckets that Amazon Macie monitors and analyzes for an account. Account-level operation — invoked with the caller’s request as-is. Provide the implementation with Effect.provide(AWS.Macie2.GetBucketStatisticsHttp).

GetBucketStatistics: S3 Bucket Inventory

// init — account-level binding, no resource argument
const getBucketStatistics = yield* AWS.Macie2.GetBucketStatistics();

// runtime
const { bucketCount } = yield* getBucketStatistics({});

GetClassificationExportConfiguration

Source: src/AWS/Macie2/GetClassificationExportConfiguration.ts

Runtime binding for macie2:GetClassificationExportConfiguration.

Retrieves the configuration settings for storing data classification results. Account-level operation — invoked with the caller’s request as-is. Provide the implementation with Effect.provide(AWS.Macie2.GetClassificationExportConfigurationHttp).

GetClassificationExportConfiguration: Classification Jobs & Export

// init — account-level binding, no resource argument
const getClassificationExportConfiguration = yield* AWS.Macie2.GetClassificationExportConfiguration();

// runtime
const { configuration } = yield* getClassificationExportConfiguration();

GetClassificationScope

Source: src/AWS/Macie2/GetClassificationScope.ts

Runtime binding for macie2:GetClassificationScope.

Retrieves the classification scope settings for an account. Account-level operation — invoked with the caller’s request as-is. Provide the implementation with Effect.provide(AWS.Macie2.GetClassificationScopeHttp).

GetClassificationScope: Automated Discovery

// init — account-level binding, no resource argument
const getClassificationScope = yield* AWS.Macie2.GetClassificationScope();

// runtime
const scope = yield* getClassificationScope({ id: scopeId });

GetFindings

Source: src/AWS/Macie2/GetFindings.ts

Runtime binding for macie2:GetFindings.

Retrieves the details of one or more findings. Account-level operation — invoked with the caller’s request as-is. Provide the implementation with Effect.provide(AWS.Macie2.GetFindingsHttp).

GetFindings: Working with Findings

// init — account-level binding, no resource argument
const getFindings = yield* AWS.Macie2.GetFindings();

// runtime
const { findings } = yield* getFindings({ findingIds });

GetFindingsPublicationConfiguration

Source: src/AWS/Macie2/GetFindingsPublicationConfiguration.ts

Runtime binding for macie2:GetFindingsPublicationConfiguration.

Retrieves the configuration settings for publishing findings to Security Hub. Account-level operation — invoked with the caller’s request as-is. Provide the implementation with Effect.provide(AWS.Macie2.GetFindingsPublicationConfigurationHttp).

GetFindingsPublicationConfiguration: Publishing Findings

// init — account-level binding, no resource argument
const getFindingsPublicationConfiguration = yield* AWS.Macie2.GetFindingsPublicationConfiguration();

// runtime
const { securityHubConfiguration } = yield* getFindingsPublicationConfiguration();

GetFindingStatistics

Source: src/AWS/Macie2/GetFindingStatistics.ts

Runtime binding for macie2:GetFindingStatistics.

Retrieves (queries) aggregated statistical data about findings. Account-level operation — invoked with the caller’s request as-is. Provide the implementation with Effect.provide(AWS.Macie2.GetFindingStatisticsHttp).

GetFindingStatistics: Working with Findings

// init — account-level binding, no resource argument
const getFindingStatistics = yield* AWS.Macie2.GetFindingStatistics();

// runtime
const { countsByGroup } = yield* getFindingStatistics({ groupBy: "severity.description" });

GetInvitationsCount

Source: src/AWS/Macie2/GetInvitationsCount.ts

Runtime binding for macie2:GetInvitationsCount.

Retrieves the count of Amazon Macie membership invitations that were received by an account. Account-level operation — invoked with the caller’s request as-is. Provide the implementation with Effect.provide(AWS.Macie2.GetInvitationsCountHttp).

GetInvitationsCount: Administrator & Invitations

// init — account-level binding, no resource argument
const getInvitationsCount = yield* AWS.Macie2.GetInvitationsCount();

// runtime
const { invitationsCount } = yield* getInvitationsCount();

GetMember

Source: src/AWS/Macie2/GetMember.ts

Runtime binding for macie2:GetMember.

Retrieves information about an account that’s associated with an Amazon Macie administrator account. Account-level operation — invoked with the caller’s request as-is. Provide the implementation with Effect.provide(AWS.Macie2.GetMemberHttp).

GetMember: Organization & Members

// init — account-level binding, no resource argument
const getMember = yield* AWS.Macie2.GetMember();

// runtime
const { relationshipStatus } = yield* getMember({ id: accountId });

GetResourceProfile

Source: src/AWS/Macie2/GetResourceProfile.ts

Runtime binding for macie2:GetResourceProfile.

Retrieves (queries) sensitive data discovery statistics and the sensitivity score for an S3 bucket. Account-level operation — invoked with the caller’s request as-is. Provide the implementation with Effect.provide(AWS.Macie2.GetResourceProfileHttp).

GetResourceProfile: Automated Discovery

// init — account-level binding, no resource argument
const getResourceProfile = yield* AWS.Macie2.GetResourceProfile();

// runtime
const profile = yield* getResourceProfile({ resourceArn: bucketArn });

GetRevealConfiguration

Source: src/AWS/Macie2/GetRevealConfiguration.ts

Runtime binding for macie2:GetRevealConfiguration.

Retrieves the status and configuration settings for retrieving occurrences of sensitive data reported by findings. Account-level operation — invoked with the caller’s request as-is. Provide the implementation with Effect.provide(AWS.Macie2.GetRevealConfigurationHttp).

GetRevealConfiguration: Retrieving Sensitive Data Samples

// init — account-level binding, no resource argument
const getRevealConfiguration = yield* AWS.Macie2.GetRevealConfiguration();

// runtime
const { configuration } = yield* getRevealConfiguration();

GetSensitiveDataOccurrences

Source: src/AWS/Macie2/GetSensitiveDataOccurrences.ts

Runtime binding for macie2:GetSensitiveDataOccurrences.

Retrieves occurrences of sensitive data reported by a finding. Account-level operation — invoked with the caller’s request as-is. Provide the implementation with Effect.provide(AWS.Macie2.GetSensitiveDataOccurrencesHttp).

GetSensitiveDataOccurrences: Retrieving Sensitive Data Samples

// init — account-level binding, no resource argument
const getSensitiveDataOccurrences = yield* AWS.Macie2.GetSensitiveDataOccurrences();

// runtime
const { sensitiveDataOccurrences } = yield* getSensitiveDataOccurrences({ findingId });

GetSensitiveDataOccurrencesAvailability

Source: src/AWS/Macie2/GetSensitiveDataOccurrencesAvailability.ts

Runtime binding for macie2:GetSensitiveDataOccurrencesAvailability.

Checks whether occurrences of sensitive data can be retrieved for a finding. Account-level operation — invoked with the caller’s request as-is. Provide the implementation with Effect.provide(AWS.Macie2.GetSensitiveDataOccurrencesAvailabilityHttp).

GetSensitiveDataOccurrencesAvailability: Retrieving Sensitive Data Samples

// init — account-level binding, no resource argument
const getSensitiveDataOccurrencesAvailability = yield* AWS.Macie2.GetSensitiveDataOccurrencesAvailability();

// runtime
const { code } = yield* getSensitiveDataOccurrencesAvailability({ findingId });

GetSensitivityInspectionTemplate

Source: src/AWS/Macie2/GetSensitivityInspectionTemplate.ts

Runtime binding for macie2:GetSensitivityInspectionTemplate.

Retrieves the settings for the sensitivity inspection template for an account. Account-level operation — invoked with the caller’s request as-is. Provide the implementation with Effect.provide(AWS.Macie2.GetSensitivityInspectionTemplateHttp).

GetSensitivityInspectionTemplate: Automated Discovery

// init — account-level binding, no resource argument
const getSensitivityInspectionTemplate = yield* AWS.Macie2.GetSensitivityInspectionTemplate();

// runtime
const template = yield* getSensitivityInspectionTemplate({ id: templateId });

GetUsageStatistics

Source: src/AWS/Macie2/GetUsageStatistics.ts

Runtime binding for macie2:GetUsageStatistics.

Retrieves (queries) quotas and aggregated usage data for one or more accounts. Account-level operation — invoked with the caller’s request as-is. Provide the implementation with Effect.provide(AWS.Macie2.GetUsageStatisticsHttp).

GetUsageStatistics: Usage & Quotas

// init — account-level binding, no resource argument
const getUsageStatistics = yield* AWS.Macie2.GetUsageStatistics();

// runtime
const { records } = yield* getUsageStatistics({});

GetUsageTotals

Source: src/AWS/Macie2/GetUsageTotals.ts

Runtime binding for macie2:GetUsageTotals.

Retrieves (queries) aggregated usage data for an account. Account-level operation — invoked with the caller’s request as-is. Provide the implementation with Effect.provide(AWS.Macie2.GetUsageTotalsHttp).

GetUsageTotals: Usage & Quotas

// init — account-level binding, no resource argument
const getUsageTotals = yield* AWS.Macie2.GetUsageTotals();

// runtime
const { usageTotals } = yield* getUsageTotals();

ListAllowLists

Source: src/AWS/Macie2/ListAllowLists.ts

Runtime binding for macie2:ListAllowLists.

Retrieves a subset of information about all the allow lists for an account. Account-level operation — invoked with the caller’s request as-is. Provide the implementation with Effect.provide(AWS.Macie2.ListAllowListsHttp).

ListAllowLists: Custom Data Identifiers & Lists

// init — account-level binding, no resource argument
const listAllowLists = yield* AWS.Macie2.ListAllowLists();

// runtime
const { allowLists } = yield* listAllowLists();

ListAutomatedDiscoveryAccounts

Source: src/AWS/Macie2/ListAutomatedDiscoveryAccounts.ts

Runtime binding for macie2:ListAutomatedDiscoveryAccounts.

Retrieves the status of automated sensitive data discovery for one or more accounts. Account-level operation — invoked with the caller’s request as-is. Provide the implementation with Effect.provide(AWS.Macie2.ListAutomatedDiscoveryAccountsHttp).

ListAutomatedDiscoveryAccounts: Automated Discovery

// init — account-level binding, no resource argument
const listAutomatedDiscoveryAccounts = yield* AWS.Macie2.ListAutomatedDiscoveryAccounts();

// runtime
const { items } = yield* listAutomatedDiscoveryAccounts();

ListClassificationJobs

Source: src/AWS/Macie2/ListClassificationJobs.ts

Runtime binding for macie2:ListClassificationJobs.

Retrieves a subset of information about one or more classification jobs. Account-level operation — invoked with the caller’s request as-is. Provide the implementation with Effect.provide(AWS.Macie2.ListClassificationJobsHttp).

ListClassificationJobs: Classification Jobs & Export

// init — account-level binding, no resource argument
const listClassificationJobs = yield* AWS.Macie2.ListClassificationJobs();

// runtime
const { items } = yield* listClassificationJobs();

ListClassificationScopes

Source: src/AWS/Macie2/ListClassificationScopes.ts

Runtime binding for macie2:ListClassificationScopes.

Retrieves a subset of information about the classification scope for an account. Account-level operation — invoked with the caller’s request as-is. Provide the implementation with Effect.provide(AWS.Macie2.ListClassificationScopesHttp).

ListClassificationScopes: Automated Discovery

// init — account-level binding, no resource argument
const listClassificationScopes = yield* AWS.Macie2.ListClassificationScopes();

// runtime
const { classificationScopes } = yield* listClassificationScopes();

ListCustomDataIdentifiers

Source: src/AWS/Macie2/ListCustomDataIdentifiers.ts

Runtime binding for macie2:ListCustomDataIdentifiers.

Retrieves a subset of information about the custom data identifiers for an account. Account-level operation — invoked with the caller’s request as-is. Provide the implementation with Effect.provide(AWS.Macie2.ListCustomDataIdentifiersHttp).

ListCustomDataIdentifiers: Custom Data Identifiers & Lists

// init — account-level binding, no resource argument
const listCustomDataIdentifiers = yield* AWS.Macie2.ListCustomDataIdentifiers();

// runtime
const { items } = yield* listCustomDataIdentifiers();

ListFindings

Source: src/AWS/Macie2/ListFindings.ts

Runtime binding for macie2:ListFindings.

Retrieves a subset of information about one or more findings. Account-level operation — invoked with the caller’s request as-is. Provide the implementation with Effect.provide(AWS.Macie2.ListFindingsHttp).

ListFindings: Working with Findings

// init — account-level binding, no resource argument
const listFindings = yield* AWS.Macie2.ListFindings();

// runtime
const { findingIds } = yield* listFindings();

ListFindingsFilters

Source: src/AWS/Macie2/ListFindingsFilters.ts

Runtime binding for macie2:ListFindingsFilters.

Retrieves a subset of information about all the findings filters for an account. Account-level operation — invoked with the caller’s request as-is. Provide the implementation with Effect.provide(AWS.Macie2.ListFindingsFiltersHttp).

ListFindingsFilters: Custom Data Identifiers & Lists

// init — account-level binding, no resource argument
const listFindingsFilters = yield* AWS.Macie2.ListFindingsFilters();

// runtime
const { findingsFilterListItems } = yield* listFindingsFilters();

ListInvitations

Source: src/AWS/Macie2/ListInvitations.ts

Runtime binding for macie2:ListInvitations.

Retrieves information about Amazon Macie membership invitations that were received by an account. Account-level operation — invoked with the caller’s request as-is. Provide the implementation with Effect.provide(AWS.Macie2.ListInvitationsHttp).

ListInvitations: Administrator & Invitations

// init — account-level binding, no resource argument
const listInvitations = yield* AWS.Macie2.ListInvitations();

// runtime
const { invitations } = yield* listInvitations();

ListManagedDataIdentifiers

Source: src/AWS/Macie2/ListManagedDataIdentifiers.ts

Runtime binding for macie2:ListManagedDataIdentifiers.

Retrieves information about all the managed data identifiers that Amazon Macie currently provides. Account-level operation — invoked with the caller’s request as-is. Provide the implementation with Effect.provide(AWS.Macie2.ListManagedDataIdentifiersHttp).

ListManagedDataIdentifiers: Custom Data Identifiers & Lists

// init — account-level binding, no resource argument
const listManagedDataIdentifiers = yield* AWS.Macie2.ListManagedDataIdentifiers();

// runtime
const { items } = yield* listManagedDataIdentifiers();

ListMembers

Source: src/AWS/Macie2/ListMembers.ts

Runtime binding for macie2:ListMembers.

Retrieves information about the accounts that are associated with an Amazon Macie administrator account. Account-level operation — invoked with the caller’s request as-is. Provide the implementation with Effect.provide(AWS.Macie2.ListMembersHttp).

ListMembers: Organization & Members

// init — account-level binding, no resource argument
const listMembers = yield* AWS.Macie2.ListMembers();

// runtime
const { members } = yield* listMembers();

ListOrganizationAdminAccounts

Source: src/AWS/Macie2/ListOrganizationAdminAccounts.ts

Runtime binding for macie2:ListOrganizationAdminAccounts.

Retrieves information about the delegated Amazon Macie administrator account for an organization in Organizations. Account-level operation — invoked with the caller’s request as-is. Provide the implementation with Effect.provide(AWS.Macie2.ListOrganizationAdminAccountsHttp).

ListOrganizationAdminAccounts: Organization & Members

// init — account-level binding, no resource argument
const listOrganizationAdminAccounts = yield* AWS.Macie2.ListOrganizationAdminAccounts();

// runtime
const { adminAccounts } = yield* listOrganizationAdminAccounts();

ListResourceProfileArtifacts

Source: src/AWS/Macie2/ListResourceProfileArtifacts.ts

Runtime binding for macie2:ListResourceProfileArtifacts.

Retrieves information about objects that Amazon Macie selected from an S3 bucket for automated sensitive data discovery. Account-level operation — invoked with the caller’s request as-is. Provide the implementation with Effect.provide(AWS.Macie2.ListResourceProfileArtifactsHttp).

ListResourceProfileArtifacts: Automated Discovery

// init — account-level binding, no resource argument
const listResourceProfileArtifacts = yield* AWS.Macie2.ListResourceProfileArtifacts();

// runtime
const { artifacts } = yield* listResourceProfileArtifacts({ resourceArn: bucketArn });

ListResourceProfileDetections

Source: src/AWS/Macie2/ListResourceProfileDetections.ts

Runtime binding for macie2:ListResourceProfileDetections.

Retrieves information about the types and amount of sensitive data that Amazon Macie found in an S3 bucket. Account-level operation — invoked with the caller’s request as-is. Provide the implementation with Effect.provide(AWS.Macie2.ListResourceProfileDetectionsHttp).

ListResourceProfileDetections: Automated Discovery

// init — account-level binding, no resource argument
const listResourceProfileDetections = yield* AWS.Macie2.ListResourceProfileDetections();

// runtime
const { detections } = yield* listResourceProfileDetections({ resourceArn: bucketArn });

ListSensitivityInspectionTemplates

Source: src/AWS/Macie2/ListSensitivityInspectionTemplates.ts

Runtime binding for macie2:ListSensitivityInspectionTemplates.

Retrieves a subset of information about the sensitivity inspection template for an account. Account-level operation — invoked with the caller’s request as-is. Provide the implementation with Effect.provide(AWS.Macie2.ListSensitivityInspectionTemplatesHttp).

ListSensitivityInspectionTemplates: Automated Discovery

// init — account-level binding, no resource argument
const listSensitivityInspectionTemplates = yield* AWS.Macie2.ListSensitivityInspectionTemplates();

// runtime
const { sensitivityInspectionTemplates } = yield* listSensitivityInspectionTemplates();

PutClassificationExportConfiguration

Source: src/AWS/Macie2/PutClassificationExportConfiguration.ts

Runtime binding for macie2:PutClassificationExportConfiguration.

Adds or updates the configuration settings for storing data classification results. Account-level operation — invoked with the caller’s request as-is. Provide the implementation with Effect.provide(AWS.Macie2.PutClassificationExportConfigurationHttp).

PutClassificationExportConfiguration: Classification Jobs & Export

// init — account-level binding, no resource argument
const putClassificationExportConfiguration = yield* AWS.Macie2.PutClassificationExportConfiguration();

// runtime
yield* putClassificationExportConfiguration({
  configuration: {
    s3Destination: { bucketName, keyPrefix: "macie/", kmsKeyArn },
  },
});

PutFindingsPublicationConfiguration

Source: src/AWS/Macie2/PutFindingsPublicationConfiguration.ts

Runtime binding for macie2:PutFindingsPublicationConfiguration.

Updates the configuration settings for publishing findings to Security Hub. Account-level operation — invoked with the caller’s request as-is. Provide the implementation with Effect.provide(AWS.Macie2.PutFindingsPublicationConfigurationHttp).

PutFindingsPublicationConfiguration: Publishing Findings

// init — account-level binding, no resource argument
const putFindingsPublicationConfiguration = yield* AWS.Macie2.PutFindingsPublicationConfiguration();

// runtime
yield* putFindingsPublicationConfiguration({
  securityHubConfiguration: {
    publishClassificationFindings: false,
    publishPolicyFindings: true,
  },
});

SearchResources

Source: src/AWS/Macie2/SearchResources.ts

Runtime binding for macie2:SearchResources.

Retrieves (queries) statistical data and other information about Amazon Web Services resources that Amazon Macie monitors and analyzes for an account. Account-level operation — invoked with the caller’s request as-is. Provide the implementation with Effect.provide(AWS.Macie2.SearchResourcesHttp).

SearchResources: S3 Bucket Inventory

// init — account-level binding, no resource argument
const searchResources = yield* AWS.Macie2.SearchResources();

// runtime
const { matchingResources } = yield* searchResources({});

Session

Source: src/AWS/Macie2/Session.ts

The Amazon Macie session — the account/region singleton that enables Macie data-security scanning. Only one session can exist per region, so this is a capture-and-restore singleton: Macie exposes no session tags, so ownership is tracked by Alchemy state. Adopting a session that Alchemy did not create requires --adopt, and destroy disables Macie for the account.

Session: Enabling Macie

Enable Macie

const macie = yield* Macie2.Session("Macie", {});

Enable with frequent findings and pause later

const macie = yield* Macie2.Session("Macie", {
  status: "ENABLED",
  findingPublishingFrequency: "FIFTEEN_MINUTES",
});

TestCustomDataIdentifier

Source: src/AWS/Macie2/TestCustomDataIdentifier.ts

Runtime binding for macie2:TestCustomDataIdentifier.

Tests criteria for a custom data identifier. Account-level operation — invoked with the caller’s request as-is. Provide the implementation with Effect.provide(AWS.Macie2.TestCustomDataIdentifierHttp).

TestCustomDataIdentifier: Custom Data Identifiers & Lists

// init — account-level binding, no resource argument
const testCustomDataIdentifier = yield* AWS.Macie2.TestCustomDataIdentifier();

// runtime
const { matchCount } = yield* testCustomDataIdentifier({
  regex: "EMP-[0-9]{8}",
  sampleText: "id EMP-12345678",
});

UpdateAutomatedDiscoveryConfiguration

Source: src/AWS/Macie2/UpdateAutomatedDiscoveryConfiguration.ts

Runtime binding for macie2:UpdateAutomatedDiscoveryConfiguration.

Changes the configuration settings and status of automated sensitive data discovery for an organization or standalone account. Account-level operation — invoked with the caller’s request as-is. Provide the implementation with Effect.provide(AWS.Macie2.UpdateAutomatedDiscoveryConfigurationHttp).

UpdateAutomatedDiscoveryConfiguration: Automated Discovery

// init — account-level binding, no resource argument
const updateAutomatedDiscoveryConfiguration = yield* AWS.Macie2.UpdateAutomatedDiscoveryConfiguration();

// runtime
yield* updateAutomatedDiscoveryConfiguration({ status: "ENABLED" });

UpdateClassificationScope

Source: src/AWS/Macie2/UpdateClassificationScope.ts

Runtime binding for macie2:UpdateClassificationScope.

Updates the classification scope settings for an account. Account-level operation — invoked with the caller’s request as-is. Provide the implementation with Effect.provide(AWS.Macie2.UpdateClassificationScopeHttp).

UpdateClassificationScope: Automated Discovery

// init — account-level binding, no resource argument
const updateClassificationScope = yield* AWS.Macie2.UpdateClassificationScope();

// runtime
yield* updateClassificationScope({
  id: scopeId,
  s3: { excludes: { bucketNames: ["logs-bucket"], operation: "ADD" } },
});

UpdateMemberSession

Source: src/AWS/Macie2/UpdateMemberSession.ts

Runtime binding for macie2:UpdateMemberSession.

Enables an Amazon Macie administrator to suspend or re-enable Macie for a member account. Account-level operation — invoked with the caller’s request as-is. Provide the implementation with Effect.provide(AWS.Macie2.UpdateMemberSessionHttp).

UpdateMemberSession: Organization & Members

// init — account-level binding, no resource argument
const updateMemberSession = yield* AWS.Macie2.UpdateMemberSession();

// runtime
yield* updateMemberSession({ id: accountId, status: "PAUSED" });

UpdateOrganizationConfiguration

Source: src/AWS/Macie2/UpdateOrganizationConfiguration.ts

Runtime binding for macie2:UpdateOrganizationConfiguration.

Updates the Amazon Macie configuration settings for an organization in Organizations. Account-level operation — invoked with the caller’s request as-is. Provide the implementation with Effect.provide(AWS.Macie2.UpdateOrganizationConfigurationHttp).

UpdateOrganizationConfiguration: Organization & Members

// init — account-level binding, no resource argument
const updateOrganizationConfiguration = yield* AWS.Macie2.UpdateOrganizationConfiguration();

// runtime
yield* updateOrganizationConfiguration({ autoEnable: true });

UpdateResourceProfile

Source: src/AWS/Macie2/UpdateResourceProfile.ts

Runtime binding for macie2:UpdateResourceProfile.

Updates the sensitivity score for an S3 bucket. Account-level operation — invoked with the caller’s request as-is. Provide the implementation with Effect.provide(AWS.Macie2.UpdateResourceProfileHttp).

UpdateResourceProfile: Automated Discovery

// init — account-level binding, no resource argument
const updateResourceProfile = yield* AWS.Macie2.UpdateResourceProfile();

// runtime
yield* updateResourceProfile({ resourceArn: bucketArn, sensitivityScoreOverride: 100 });

UpdateResourceProfileDetections

Source: src/AWS/Macie2/UpdateResourceProfileDetections.ts

Runtime binding for macie2:UpdateResourceProfileDetections.

Updates the sensitivity scoring settings for an S3 bucket. Account-level operation — invoked with the caller’s request as-is. Provide the implementation with Effect.provide(AWS.Macie2.UpdateResourceProfileDetectionsHttp).

UpdateResourceProfileDetections: Automated Discovery

// init — account-level binding, no resource argument
const updateResourceProfileDetections = yield* AWS.Macie2.UpdateResourceProfileDetections();

// runtime
yield* updateResourceProfileDetections({
  resourceArn: bucketArn,
  suppressDataIdentifiers: [{ id: identifierId, type: "MANAGED" }],
});

UpdateRevealConfiguration

Source: src/AWS/Macie2/UpdateRevealConfiguration.ts

Runtime binding for macie2:UpdateRevealConfiguration.

Updates the status and configuration settings for retrieving occurrences of sensitive data reported by findings. Account-level operation — invoked with the caller’s request as-is. Provide the implementation with Effect.provide(AWS.Macie2.UpdateRevealConfigurationHttp).

UpdateRevealConfiguration: Retrieving Sensitive Data Samples

// init — account-level binding, no resource argument
const updateRevealConfiguration = yield* AWS.Macie2.UpdateRevealConfiguration();

// runtime
yield* updateRevealConfiguration({
  configuration: { status: "ENABLED" },
});

UpdateSensitivityInspectionTemplate

Source: src/AWS/Macie2/UpdateSensitivityInspectionTemplate.ts

Runtime binding for macie2:UpdateSensitivityInspectionTemplate.

Updates the settings for the sensitivity inspection template for an account. Account-level operation — invoked with the caller’s request as-is. Provide the implementation with Effect.provide(AWS.Macie2.UpdateSensitivityInspectionTemplateHttp).

UpdateSensitivityInspectionTemplate: Automated Discovery

// init — account-level binding, no resource argument
const updateSensitivityInspectionTemplate = yield* AWS.Macie2.UpdateSensitivityInspectionTemplate();

// runtime
yield* updateSensitivityInspectionTemplate({
  id: templateId,
  includes: { managedDataIdentifierIds: ["CREDIT_CARD_NUMBER"] },
});