Hi there! Are you looking for the official Deno documentation? Try docs.deno.com for all your Deno learning needs.

Macie2

import { Macie2 } from "https://aws-api.deno.dev/v0.4/services/macie2.ts?docs=full";
class Macie2 {
constructor(apiFactory: client.ApiFactory);
async acceptInvitation(params: AcceptInvitationRequest, opts?: client.RequestOptions): Promise<void>;
async batchGetCustomDataIdentifiers(params?: BatchGetCustomDataIdentifiersRequest, opts?: client.RequestOptions): Promise<BatchGetCustomDataIdentifiersResponse>;
async createAllowList(params: CreateAllowListRequest, opts?: client.RequestOptions): Promise<CreateAllowListResponse>;
async createClassificationJob(params: CreateClassificationJobRequest, opts?: client.RequestOptions): Promise<CreateClassificationJobResponse>;
async createCustomDataIdentifier(params: CreateCustomDataIdentifierRequest, opts?: client.RequestOptions): Promise<CreateCustomDataIdentifierResponse>;
async createFindingsFilter(params: CreateFindingsFilterRequest, opts?: client.RequestOptions): Promise<CreateFindingsFilterResponse>;
async createInvitations(params: CreateInvitationsRequest, opts?: client.RequestOptions): Promise<CreateInvitationsResponse>;
async createMember(params: CreateMemberRequest, opts?: client.RequestOptions): Promise<CreateMemberResponse>;
async createSampleFindings(params?: CreateSampleFindingsRequest, opts?: client.RequestOptions): Promise<void>;
async declineInvitations(params: DeclineInvitationsRequest, opts?: client.RequestOptions): Promise<DeclineInvitationsResponse>;
async deleteAllowList(params: DeleteAllowListRequest, opts?: client.RequestOptions): Promise<void>;
async deleteCustomDataIdentifier(params: DeleteCustomDataIdentifierRequest, opts?: client.RequestOptions): Promise<void>;
async deleteFindingsFilter(params: DeleteFindingsFilterRequest, opts?: client.RequestOptions): Promise<void>;
async deleteInvitations(params: DeleteInvitationsRequest, opts?: client.RequestOptions): Promise<DeleteInvitationsResponse>;
async deleteMember(params: DeleteMemberRequest, opts?: client.RequestOptions): Promise<void>;
async describeBuckets(params?: DescribeBucketsRequest, opts?: client.RequestOptions): Promise<DescribeBucketsResponse>;
async describeClassificationJob(params: DescribeClassificationJobRequest, opts?: client.RequestOptions): Promise<DescribeClassificationJobResponse>;
async describeOrganizationConfiguration(opts?: client.RequestOptions): Promise<DescribeOrganizationConfigurationResponse>;
async disableMacie(opts?: client.RequestOptions): Promise<void>;
async disableOrganizationAdminAccount(params: DisableOrganizationAdminAccountRequest, opts?: client.RequestOptions): Promise<void>;
async disassociateFromAdministratorAccount(opts?: client.RequestOptions): Promise<void>;
async disassociateFromMasterAccount(opts?: client.RequestOptions): Promise<void>;
async disassociateMember(params: DisassociateMemberRequest, opts?: client.RequestOptions): Promise<void>;
async enableMacie(params?: EnableMacieRequest, opts?: client.RequestOptions): Promise<void>;
async enableOrganizationAdminAccount(params: EnableOrganizationAdminAccountRequest, opts?: client.RequestOptions): Promise<void>;
async getAdministratorAccount(opts?: client.RequestOptions): Promise<GetAdministratorAccountResponse>;
async getAllowList(params: GetAllowListRequest, opts?: client.RequestOptions): Promise<GetAllowListResponse>;
async getAutomatedDiscoveryConfiguration(opts?: client.RequestOptions): Promise<GetAutomatedDiscoveryConfigurationResponse>;
async getBucketStatistics(params?: GetBucketStatisticsRequest, opts?: client.RequestOptions): Promise<GetBucketStatisticsResponse>;
async getClassificationExportConfiguration(opts?: client.RequestOptions): Promise<GetClassificationExportConfigurationResponse>;
async getClassificationScope(params: GetClassificationScopeRequest, opts?: client.RequestOptions): Promise<GetClassificationScopeResponse>;
async getCustomDataIdentifier(params: GetCustomDataIdentifierRequest, opts?: client.RequestOptions): Promise<GetCustomDataIdentifierResponse>;
async getFindings(params: GetFindingsRequest, opts?: client.RequestOptions): Promise<GetFindingsResponse>;
async getFindingsFilter(params: GetFindingsFilterRequest, opts?: client.RequestOptions): Promise<GetFindingsFilterResponse>;
async getFindingsPublicationConfiguration(opts?: client.RequestOptions): Promise<GetFindingsPublicationConfigurationResponse>;
async getFindingStatistics(params: GetFindingStatisticsRequest, opts?: client.RequestOptions): Promise<GetFindingStatisticsResponse>;
async getInvitationsCount(opts?: client.RequestOptions): Promise<GetInvitationsCountResponse>;
async getMacieSession(opts?: client.RequestOptions): Promise<GetMacieSessionResponse>;
async getMasterAccount(opts?: client.RequestOptions): Promise<GetMasterAccountResponse>;
async getMember(params: GetMemberRequest, opts?: client.RequestOptions): Promise<GetMemberResponse>;
async getResourceProfile(params: GetResourceProfileRequest, opts?: client.RequestOptions): Promise<GetResourceProfileResponse>;
async getRevealConfiguration(opts?: client.RequestOptions): Promise<GetRevealConfigurationResponse>;
async getSensitiveDataOccurrences(params: GetSensitiveDataOccurrencesRequest, opts?: client.RequestOptions): Promise<GetSensitiveDataOccurrencesResponse>;
async getSensitiveDataOccurrencesAvailability(params: GetSensitiveDataOccurrencesAvailabilityRequest, opts?: client.RequestOptions): Promise<GetSensitiveDataOccurrencesAvailabilityResponse>;
async getSensitivityInspectionTemplate(params: GetSensitivityInspectionTemplateRequest, opts?: client.RequestOptions): Promise<GetSensitivityInspectionTemplateResponse>;
async getUsageStatistics(params?: GetUsageStatisticsRequest, opts?: client.RequestOptions): Promise<GetUsageStatisticsResponse>;
async getUsageTotals(params?: GetUsageTotalsRequest, opts?: client.RequestOptions): Promise<GetUsageTotalsResponse>;
async listAllowLists(params?: ListAllowListsRequest, opts?: client.RequestOptions): Promise<ListAllowListsResponse>;
async listClassificationJobs(params?: ListClassificationJobsRequest, opts?: client.RequestOptions): Promise<ListClassificationJobsResponse>;
async listClassificationScopes(params?: ListClassificationScopesRequest, opts?: client.RequestOptions): Promise<ListClassificationScopesResponse>;
async listCustomDataIdentifiers(params?: ListCustomDataIdentifiersRequest, opts?: client.RequestOptions): Promise<ListCustomDataIdentifiersResponse>;
async listFindings(params?: ListFindingsRequest, opts?: client.RequestOptions): Promise<ListFindingsResponse>;
async listFindingsFilters(params?: ListFindingsFiltersRequest, opts?: client.RequestOptions): Promise<ListFindingsFiltersResponse>;
async listInvitations(params?: ListInvitationsRequest, opts?: client.RequestOptions): Promise<ListInvitationsResponse>;
async listManagedDataIdentifiers(params?: ListManagedDataIdentifiersRequest, opts?: client.RequestOptions): Promise<ListManagedDataIdentifiersResponse>;
async listMembers(params?: ListMembersRequest, opts?: client.RequestOptions): Promise<ListMembersResponse>;
async listOrganizationAdminAccounts(params?: ListOrganizationAdminAccountsRequest, opts?: client.RequestOptions): Promise<ListOrganizationAdminAccountsResponse>;
async listResourceProfileArtifacts(params: ListResourceProfileArtifactsRequest, opts?: client.RequestOptions): Promise<ListResourceProfileArtifactsResponse>;
async listResourceProfileDetections(params: ListResourceProfileDetectionsRequest, opts?: client.RequestOptions): Promise<ListResourceProfileDetectionsResponse>;
async listSensitivityInspectionTemplates(params?: ListSensitivityInspectionTemplatesRequest, opts?: client.RequestOptions): Promise<ListSensitivityInspectionTemplatesResponse>;
async listTagsForResource(params: ListTagsForResourceRequest, opts?: client.RequestOptions): Promise<ListTagsForResourceResponse>;
async putClassificationExportConfiguration(params: PutClassificationExportConfigurationRequest, opts?: client.RequestOptions): Promise<PutClassificationExportConfigurationResponse>;
async putFindingsPublicationConfiguration(params?: PutFindingsPublicationConfigurationRequest, opts?: client.RequestOptions): Promise<void>;
async searchResources(params?: SearchResourcesRequest, opts?: client.RequestOptions): Promise<SearchResourcesResponse>;
async tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>;
async testCustomDataIdentifier(params: TestCustomDataIdentifierRequest, opts?: client.RequestOptions): Promise<TestCustomDataIdentifierResponse>;
async untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>;
async updateAllowList(params: UpdateAllowListRequest, opts?: client.RequestOptions): Promise<UpdateAllowListResponse>;
async updateAutomatedDiscoveryConfiguration(params: UpdateAutomatedDiscoveryConfigurationRequest, opts?: client.RequestOptions): Promise<void>;
async updateClassificationJob(params: UpdateClassificationJobRequest, opts?: client.RequestOptions): Promise<void>;
async updateClassificationScope(params: UpdateClassificationScopeRequest, opts?: client.RequestOptions): Promise<void>;
async updateFindingsFilter(params: UpdateFindingsFilterRequest, opts?: client.RequestOptions): Promise<UpdateFindingsFilterResponse>;
async updateMacieSession(params?: UpdateMacieSessionRequest, opts?: client.RequestOptions): Promise<void>;
async updateMemberSession(params: UpdateMemberSessionRequest, opts?: client.RequestOptions): Promise<void>;
async updateOrganizationConfiguration(params: UpdateOrganizationConfigurationRequest, opts?: client.RequestOptions): Promise<void>;
async updateResourceProfile(params: UpdateResourceProfileRequest, opts?: client.RequestOptions): Promise<void>;
async updateResourceProfileDetections(params: UpdateResourceProfileDetectionsRequest, opts?: client.RequestOptions): Promise<void>;
async updateRevealConfiguration(params: UpdateRevealConfigurationRequest, opts?: client.RequestOptions): Promise<UpdateRevealConfigurationResponse>;
async updateSensitivityInspectionTemplate(params: UpdateSensitivityInspectionTemplateRequest, opts?: client.RequestOptions): Promise<void>;
 
static ApiMetadata: client.ApiMetadata;
}

§Constructors

§
new Macie2(apiFactory: client.ApiFactory)
[src]

§Methods

§
acceptInvitation(params: AcceptInvitationRequest, opts?: client.RequestOptions): Promise<void>
[src]

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

§

Retrieves information about one or more custom data identifiers.

§

Creates and defines the settings for an allow list.

§

Creates and defines the settings for a classification job.

§

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

§

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

§

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

§

Associates an account with an Amazon Macie administrator account.

§
createSampleFindings(params?: CreateSampleFindingsRequest, opts?: client.RequestOptions): Promise<void>
[src]

Creates sample findings.

§

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

§
deleteAllowList(params: DeleteAllowListRequest, opts?: client.RequestOptions): Promise<void>
[src]

Deletes an allow list.

§
deleteCustomDataIdentifier(params: DeleteCustomDataIdentifierRequest, opts?: client.RequestOptions): Promise<void>
[src]

Soft deletes a custom data identifier.

§
deleteFindingsFilter(params: DeleteFindingsFilterRequest, opts?: client.RequestOptions): Promise<void>
[src]

Deletes a findings filter.

§

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

§
deleteMember(params: DeleteMemberRequest, opts?: client.RequestOptions): Promise<void>
[src]

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

§

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

§

Retrieves the status and settings for a classification job.

§
describeOrganizationConfiguration(opts?: client.RequestOptions): Promise<DescribeOrganizationConfigurationResponse>
[src]

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

§
disableMacie(opts?: client.RequestOptions): Promise<void>
[src]

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

§
disableOrganizationAdminAccount(params: DisableOrganizationAdminAccountRequest, opts?: client.RequestOptions): Promise<void>
[src]

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

§
disassociateFromAdministratorAccount(opts?: client.RequestOptions): Promise<void>
[src]

Disassociates a member account from its Amazon Macie administrator account.

§
disassociateFromMasterAccount(opts?: client.RequestOptions): Promise<void>
[src]

TODO: Failed to render documentation: unhandled paragraph inner tag link

§
disassociateMember(params: DisassociateMemberRequest, opts?: client.RequestOptions): Promise<void>
[src]

Disassociates an Amazon Macie administrator account from a member account.

§
enableMacie(params?: EnableMacieRequest, opts?: client.RequestOptions): Promise<void>
[src]

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

§
enableOrganizationAdminAccount(params: EnableOrganizationAdminAccountRequest, opts?: client.RequestOptions): Promise<void>
[src]

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

§
getAdministratorAccount(opts?: client.RequestOptions): Promise<GetAdministratorAccountResponse>
[src]

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

§

Retrieves the settings and status of an allow list.

§
getAutomatedDiscoveryConfiguration(opts?: client.RequestOptions): Promise<GetAutomatedDiscoveryConfigurationResponse>
[src]

Retrieves the configuration settings and status of automated sensitive data discovery for an account.

§

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

§
getClassificationExportConfiguration(opts?: client.RequestOptions): Promise<GetClassificationExportConfigurationResponse>
[src]

Retrieves the configuration settings for storing data classification results.

§

Retrieves the classification scope settings for an account.

§

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

§

Retrieves the details of one or more findings.

§

Retrieves the criteria and other settings for a findings filter.

§
getFindingsPublicationConfiguration(opts?: client.RequestOptions): Promise<GetFindingsPublicationConfigurationResponse>
[src]

Retrieves the configuration settings for publishing findings to Security Hub.

§

Retrieves (queries) aggregated statistical data about findings.

§
getInvitationsCount(opts?: client.RequestOptions): Promise<GetInvitationsCountResponse>
[src]

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

§
getMacieSession(opts?: client.RequestOptions): Promise<GetMacieSessionResponse>
[src]

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

§
getMasterAccount(opts?: client.RequestOptions): Promise<GetMasterAccountResponse>
[src]

TODO: Failed to render documentation: unhandled paragraph inner tag link

§

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

§

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

§
getRevealConfiguration(opts?: client.RequestOptions): Promise<GetRevealConfigurationResponse>
[src]

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

§

Retrieves occurrences of sensitive data reported by a finding.

§

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

§

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

§

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

§

Retrieves (queries) aggregated usage data for an account.

§

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

§

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

§

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

§

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

§

Retrieves a subset of information about one or more findings.

§

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

§

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

§

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

§
listMembers(params?: ListMembersRequest, opts?: client.RequestOptions): Promise<ListMembersResponse>
[src]

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

§

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

§

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

§

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

§

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

§

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

§

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

§
putFindingsPublicationConfiguration(params?: PutFindingsPublicationConfigurationRequest, opts?: client.RequestOptions): Promise<void>
[src]

Updates the configuration settings for publishing findings to Security Hub.

§

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

§
tagResource(params: TagResourceRequest, opts?: client.RequestOptions): Promise<void>
[src]

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

§

Tests a custom data identifier.

§
untagResource(params: UntagResourceRequest, opts?: client.RequestOptions): Promise<void>
[src]

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

§

Updates the settings for an allow list.

§
updateAutomatedDiscoveryConfiguration(params: UpdateAutomatedDiscoveryConfigurationRequest, opts?: client.RequestOptions): Promise<void>
[src]

Enables or disables automated sensitive data discovery for an account.

§
updateClassificationJob(params: UpdateClassificationJobRequest, opts?: client.RequestOptions): Promise<void>
[src]

Changes the status of a classification job.

§
updateClassificationScope(params: UpdateClassificationScopeRequest, opts?: client.RequestOptions): Promise<void>
[src]

Updates the classification scope settings for an account.

§

Updates the criteria and other settings for a findings filter.

§
updateMacieSession(params?: UpdateMacieSessionRequest, opts?: client.RequestOptions): Promise<void>
[src]

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

§
updateMemberSession(params: UpdateMemberSessionRequest, opts?: client.RequestOptions): Promise<void>
[src]

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

§
updateOrganizationConfiguration(params: UpdateOrganizationConfigurationRequest, opts?: client.RequestOptions): Promise<void>
[src]

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

§
updateResourceProfile(params: UpdateResourceProfileRequest, opts?: client.RequestOptions): Promise<void>
[src]

Updates the sensitivity score for an S3 bucket.

§
updateResourceProfileDetections(params: UpdateResourceProfileDetectionsRequest, opts?: client.RequestOptions): Promise<void>
[src]

Updates the sensitivity scoring settings for an S3 bucket.

§

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

§
updateSensitivityInspectionTemplate(params: UpdateSensitivityInspectionTemplateRequest, opts?: client.RequestOptions): Promise<void>
[src]

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

§

Wait until the sensitive data occurrences are ready. Checks state up to 60 times, 2 seconds apart (about 2 minutes max wait time).

§Static Properties