@alma-cdk/cross-region-parameter
Version:
Store AWS SSM Parameter Store Parameters into another AWS Region with AWS CDK
751 lines (750 loc) • 212 kB
TypeScript
import {Request} from '../lib/request';
import {Response} from '../lib/response';
import {AWSError} from '../lib/error';
import {Service} from '../lib/service';
import {WaiterConfiguration} from '../lib/service';
import {ServiceConfigurationOptions} from '../lib/service';
import {ConfigBase as Config} from '../lib/config-base';
interface Blob {}
declare class Macie2 extends Service {
/**
* Constructs a service object. This object has one method for each API operation.
*/
constructor(options?: Macie2.Types.ClientConfiguration)
config: Config & Macie2.Types.ClientConfiguration;
/**
* Accepts an Amazon Macie membership invitation that was received from a specific account.
*/
acceptInvitation(params: Macie2.Types.AcceptInvitationRequest, callback?: (err: AWSError, data: Macie2.Types.AcceptInvitationResponse) => void): Request<Macie2.Types.AcceptInvitationResponse, AWSError>;
/**
* Accepts an Amazon Macie membership invitation that was received from a specific account.
*/
acceptInvitation(callback?: (err: AWSError, data: Macie2.Types.AcceptInvitationResponse) => void): Request<Macie2.Types.AcceptInvitationResponse, AWSError>;
/**
* Retrieves information about one or more custom data identifiers.
*/
batchGetCustomDataIdentifiers(params: Macie2.Types.BatchGetCustomDataIdentifiersRequest, callback?: (err: AWSError, data: Macie2.Types.BatchGetCustomDataIdentifiersResponse) => void): Request<Macie2.Types.BatchGetCustomDataIdentifiersResponse, AWSError>;
/**
* Retrieves information about one or more custom data identifiers.
*/
batchGetCustomDataIdentifiers(callback?: (err: AWSError, data: Macie2.Types.BatchGetCustomDataIdentifiersResponse) => void): Request<Macie2.Types.BatchGetCustomDataIdentifiersResponse, AWSError>;
/**
* Creates and defines the settings for an allow list.
*/
createAllowList(params: Macie2.Types.CreateAllowListRequest, callback?: (err: AWSError, data: Macie2.Types.CreateAllowListResponse) => void): Request<Macie2.Types.CreateAllowListResponse, AWSError>;
/**
* Creates and defines the settings for an allow list.
*/
createAllowList(callback?: (err: AWSError, data: Macie2.Types.CreateAllowListResponse) => void): Request<Macie2.Types.CreateAllowListResponse, AWSError>;
/**
* Creates and defines the settings for a classification job.
*/
createClassificationJob(params: Macie2.Types.CreateClassificationJobRequest, callback?: (err: AWSError, data: Macie2.Types.CreateClassificationJobResponse) => void): Request<Macie2.Types.CreateClassificationJobResponse, AWSError>;
/**
* Creates and defines the settings for a classification job.
*/
createClassificationJob(callback?: (err: AWSError, data: Macie2.Types.CreateClassificationJobResponse) => void): Request<Macie2.Types.CreateClassificationJobResponse, AWSError>;
/**
* Creates and defines the criteria and other settings for a custom data identifier.
*/
createCustomDataIdentifier(params: Macie2.Types.CreateCustomDataIdentifierRequest, callback?: (err: AWSError, data: Macie2.Types.CreateCustomDataIdentifierResponse) => void): Request<Macie2.Types.CreateCustomDataIdentifierResponse, AWSError>;
/**
* Creates and defines the criteria and other settings for a custom data identifier.
*/
createCustomDataIdentifier(callback?: (err: AWSError, data: Macie2.Types.CreateCustomDataIdentifierResponse) => void): Request<Macie2.Types.CreateCustomDataIdentifierResponse, AWSError>;
/**
* Creates and defines the criteria and other settings for a findings filter.
*/
createFindingsFilter(params: Macie2.Types.CreateFindingsFilterRequest, callback?: (err: AWSError, data: Macie2.Types.CreateFindingsFilterResponse) => void): Request<Macie2.Types.CreateFindingsFilterResponse, AWSError>;
/**
* Creates and defines the criteria and other settings for a findings filter.
*/
createFindingsFilter(callback?: (err: AWSError, data: Macie2.Types.CreateFindingsFilterResponse) => void): Request<Macie2.Types.CreateFindingsFilterResponse, AWSError>;
/**
* Sends an Amazon Macie membership invitation to one or more accounts.
*/
createInvitations(params: Macie2.Types.CreateInvitationsRequest, callback?: (err: AWSError, data: Macie2.Types.CreateInvitationsResponse) => void): Request<Macie2.Types.CreateInvitationsResponse, AWSError>;
/**
* Sends an Amazon Macie membership invitation to one or more accounts.
*/
createInvitations(callback?: (err: AWSError, data: Macie2.Types.CreateInvitationsResponse) => void): Request<Macie2.Types.CreateInvitationsResponse, AWSError>;
/**
* Associates an account with an Amazon Macie administrator account.
*/
createMember(params: Macie2.Types.CreateMemberRequest, callback?: (err: AWSError, data: Macie2.Types.CreateMemberResponse) => void): Request<Macie2.Types.CreateMemberResponse, AWSError>;
/**
* Associates an account with an Amazon Macie administrator account.
*/
createMember(callback?: (err: AWSError, data: Macie2.Types.CreateMemberResponse) => void): Request<Macie2.Types.CreateMemberResponse, AWSError>;
/**
* Creates sample findings.
*/
createSampleFindings(params: Macie2.Types.CreateSampleFindingsRequest, callback?: (err: AWSError, data: Macie2.Types.CreateSampleFindingsResponse) => void): Request<Macie2.Types.CreateSampleFindingsResponse, AWSError>;
/**
* Creates sample findings.
*/
createSampleFindings(callback?: (err: AWSError, data: Macie2.Types.CreateSampleFindingsResponse) => void): Request<Macie2.Types.CreateSampleFindingsResponse, AWSError>;
/**
* Declines Amazon Macie membership invitations that were received from specific accounts.
*/
declineInvitations(params: Macie2.Types.DeclineInvitationsRequest, callback?: (err: AWSError, data: Macie2.Types.DeclineInvitationsResponse) => void): Request<Macie2.Types.DeclineInvitationsResponse, AWSError>;
/**
* Declines Amazon Macie membership invitations that were received from specific accounts.
*/
declineInvitations(callback?: (err: AWSError, data: Macie2.Types.DeclineInvitationsResponse) => void): Request<Macie2.Types.DeclineInvitationsResponse, AWSError>;
/**
* Deletes an allow list.
*/
deleteAllowList(params: Macie2.Types.DeleteAllowListRequest, callback?: (err: AWSError, data: Macie2.Types.DeleteAllowListResponse) => void): Request<Macie2.Types.DeleteAllowListResponse, AWSError>;
/**
* Deletes an allow list.
*/
deleteAllowList(callback?: (err: AWSError, data: Macie2.Types.DeleteAllowListResponse) => void): Request<Macie2.Types.DeleteAllowListResponse, AWSError>;
/**
* Soft deletes a custom data identifier.
*/
deleteCustomDataIdentifier(params: Macie2.Types.DeleteCustomDataIdentifierRequest, callback?: (err: AWSError, data: Macie2.Types.DeleteCustomDataIdentifierResponse) => void): Request<Macie2.Types.DeleteCustomDataIdentifierResponse, AWSError>;
/**
* Soft deletes a custom data identifier.
*/
deleteCustomDataIdentifier(callback?: (err: AWSError, data: Macie2.Types.DeleteCustomDataIdentifierResponse) => void): Request<Macie2.Types.DeleteCustomDataIdentifierResponse, AWSError>;
/**
* Deletes a findings filter.
*/
deleteFindingsFilter(params: Macie2.Types.DeleteFindingsFilterRequest, callback?: (err: AWSError, data: Macie2.Types.DeleteFindingsFilterResponse) => void): Request<Macie2.Types.DeleteFindingsFilterResponse, AWSError>;
/**
* Deletes a findings filter.
*/
deleteFindingsFilter(callback?: (err: AWSError, data: Macie2.Types.DeleteFindingsFilterResponse) => void): Request<Macie2.Types.DeleteFindingsFilterResponse, AWSError>;
/**
* Deletes Amazon Macie membership invitations that were received from specific accounts.
*/
deleteInvitations(params: Macie2.Types.DeleteInvitationsRequest, callback?: (err: AWSError, data: Macie2.Types.DeleteInvitationsResponse) => void): Request<Macie2.Types.DeleteInvitationsResponse, AWSError>;
/**
* Deletes Amazon Macie membership invitations that were received from specific accounts.
*/
deleteInvitations(callback?: (err: AWSError, data: Macie2.Types.DeleteInvitationsResponse) => void): Request<Macie2.Types.DeleteInvitationsResponse, AWSError>;
/**
* Deletes the association between an Amazon Macie administrator account and an account.
*/
deleteMember(params: Macie2.Types.DeleteMemberRequest, callback?: (err: AWSError, data: Macie2.Types.DeleteMemberResponse) => void): Request<Macie2.Types.DeleteMemberResponse, AWSError>;
/**
* Deletes the association between an Amazon Macie administrator account and an account.
*/
deleteMember(callback?: (err: AWSError, data: Macie2.Types.DeleteMemberResponse) => void): Request<Macie2.Types.DeleteMemberResponse, AWSError>;
/**
* Retrieves (queries) statistical data and other information about one or more S3 buckets that Amazon Macie monitors and analyzes.
*/
describeBuckets(params: Macie2.Types.DescribeBucketsRequest, callback?: (err: AWSError, data: Macie2.Types.DescribeBucketsResponse) => void): Request<Macie2.Types.DescribeBucketsResponse, AWSError>;
/**
* Retrieves (queries) statistical data and other information about one or more S3 buckets that Amazon Macie monitors and analyzes.
*/
describeBuckets(callback?: (err: AWSError, data: Macie2.Types.DescribeBucketsResponse) => void): Request<Macie2.Types.DescribeBucketsResponse, AWSError>;
/**
* Retrieves the status and settings for a classification job.
*/
describeClassificationJob(params: Macie2.Types.DescribeClassificationJobRequest, callback?: (err: AWSError, data: Macie2.Types.DescribeClassificationJobResponse) => void): Request<Macie2.Types.DescribeClassificationJobResponse, AWSError>;
/**
* Retrieves the status and settings for a classification job.
*/
describeClassificationJob(callback?: (err: AWSError, data: Macie2.Types.DescribeClassificationJobResponse) => void): Request<Macie2.Types.DescribeClassificationJobResponse, AWSError>;
/**
* Retrieves the Amazon Macie configuration settings for an organization in Organizations.
*/
describeOrganizationConfiguration(params: Macie2.Types.DescribeOrganizationConfigurationRequest, callback?: (err: AWSError, data: Macie2.Types.DescribeOrganizationConfigurationResponse) => void): Request<Macie2.Types.DescribeOrganizationConfigurationResponse, AWSError>;
/**
* Retrieves the Amazon Macie configuration settings for an organization in Organizations.
*/
describeOrganizationConfiguration(callback?: (err: AWSError, data: Macie2.Types.DescribeOrganizationConfigurationResponse) => void): Request<Macie2.Types.DescribeOrganizationConfigurationResponse, AWSError>;
/**
* Disables Amazon Macie and deletes all settings and resources for a Macie account.
*/
disableMacie(params: Macie2.Types.DisableMacieRequest, callback?: (err: AWSError, data: Macie2.Types.DisableMacieResponse) => void): Request<Macie2.Types.DisableMacieResponse, AWSError>;
/**
* Disables Amazon Macie and deletes all settings and resources for a Macie account.
*/
disableMacie(callback?: (err: AWSError, data: Macie2.Types.DisableMacieResponse) => void): Request<Macie2.Types.DisableMacieResponse, AWSError>;
/**
* Disables an account as the delegated Amazon Macie administrator account for an organization in Organizations.
*/
disableOrganizationAdminAccount(params: Macie2.Types.DisableOrganizationAdminAccountRequest, callback?: (err: AWSError, data: Macie2.Types.DisableOrganizationAdminAccountResponse) => void): Request<Macie2.Types.DisableOrganizationAdminAccountResponse, AWSError>;
/**
* Disables an account as the delegated Amazon Macie administrator account for an organization in Organizations.
*/
disableOrganizationAdminAccount(callback?: (err: AWSError, data: Macie2.Types.DisableOrganizationAdminAccountResponse) => void): Request<Macie2.Types.DisableOrganizationAdminAccountResponse, AWSError>;
/**
* Disassociates a member account from its Amazon Macie administrator account.
*/
disassociateFromAdministratorAccount(params: Macie2.Types.DisassociateFromAdministratorAccountRequest, callback?: (err: AWSError, data: Macie2.Types.DisassociateFromAdministratorAccountResponse) => void): Request<Macie2.Types.DisassociateFromAdministratorAccountResponse, AWSError>;
/**
* Disassociates a member account from its Amazon Macie administrator account.
*/
disassociateFromAdministratorAccount(callback?: (err: AWSError, data: Macie2.Types.DisassociateFromAdministratorAccountResponse) => void): Request<Macie2.Types.DisassociateFromAdministratorAccountResponse, AWSError>;
/**
* (Deprecated) Disassociates a member account from its Amazon Macie administrator account. This operation has been replaced by the DisassociateFromAdministratorAccount operation.
*/
disassociateFromMasterAccount(params: Macie2.Types.DisassociateFromMasterAccountRequest, callback?: (err: AWSError, data: Macie2.Types.DisassociateFromMasterAccountResponse) => void): Request<Macie2.Types.DisassociateFromMasterAccountResponse, AWSError>;
/**
* (Deprecated) Disassociates a member account from its Amazon Macie administrator account. This operation has been replaced by the DisassociateFromAdministratorAccount operation.
*/
disassociateFromMasterAccount(callback?: (err: AWSError, data: Macie2.Types.DisassociateFromMasterAccountResponse) => void): Request<Macie2.Types.DisassociateFromMasterAccountResponse, AWSError>;
/**
* Disassociates an Amazon Macie administrator account from a member account.
*/
disassociateMember(params: Macie2.Types.DisassociateMemberRequest, callback?: (err: AWSError, data: Macie2.Types.DisassociateMemberResponse) => void): Request<Macie2.Types.DisassociateMemberResponse, AWSError>;
/**
* Disassociates an Amazon Macie administrator account from a member account.
*/
disassociateMember(callback?: (err: AWSError, data: Macie2.Types.DisassociateMemberResponse) => void): Request<Macie2.Types.DisassociateMemberResponse, AWSError>;
/**
* Enables Amazon Macie and specifies the configuration settings for a Macie account.
*/
enableMacie(params: Macie2.Types.EnableMacieRequest, callback?: (err: AWSError, data: Macie2.Types.EnableMacieResponse) => void): Request<Macie2.Types.EnableMacieResponse, AWSError>;
/**
* Enables Amazon Macie and specifies the configuration settings for a Macie account.
*/
enableMacie(callback?: (err: AWSError, data: Macie2.Types.EnableMacieResponse) => void): Request<Macie2.Types.EnableMacieResponse, AWSError>;
/**
* Designates an account as the delegated Amazon Macie administrator account for an organization in Organizations.
*/
enableOrganizationAdminAccount(params: Macie2.Types.EnableOrganizationAdminAccountRequest, callback?: (err: AWSError, data: Macie2.Types.EnableOrganizationAdminAccountResponse) => void): Request<Macie2.Types.EnableOrganizationAdminAccountResponse, AWSError>;
/**
* Designates an account as the delegated Amazon Macie administrator account for an organization in Organizations.
*/
enableOrganizationAdminAccount(callback?: (err: AWSError, data: Macie2.Types.EnableOrganizationAdminAccountResponse) => void): Request<Macie2.Types.EnableOrganizationAdminAccountResponse, AWSError>;
/**
* Retrieves information about the Amazon Macie administrator account for an account.
*/
getAdministratorAccount(params: Macie2.Types.GetAdministratorAccountRequest, callback?: (err: AWSError, data: Macie2.Types.GetAdministratorAccountResponse) => void): Request<Macie2.Types.GetAdministratorAccountResponse, AWSError>;
/**
* Retrieves information about the Amazon Macie administrator account for an account.
*/
getAdministratorAccount(callback?: (err: AWSError, data: Macie2.Types.GetAdministratorAccountResponse) => void): Request<Macie2.Types.GetAdministratorAccountResponse, AWSError>;
/**
* Retrieves the settings and status of an allow list.
*/
getAllowList(params: Macie2.Types.GetAllowListRequest, callback?: (err: AWSError, data: Macie2.Types.GetAllowListResponse) => void): Request<Macie2.Types.GetAllowListResponse, AWSError>;
/**
* Retrieves the settings and status of an allow list.
*/
getAllowList(callback?: (err: AWSError, data: Macie2.Types.GetAllowListResponse) => void): Request<Macie2.Types.GetAllowListResponse, AWSError>;
/**
* Retrieves (queries) aggregated statistical data about S3 buckets that Amazon Macie monitors and analyzes.
*/
getBucketStatistics(params: Macie2.Types.GetBucketStatisticsRequest, callback?: (err: AWSError, data: Macie2.Types.GetBucketStatisticsResponse) => void): Request<Macie2.Types.GetBucketStatisticsResponse, AWSError>;
/**
* Retrieves (queries) aggregated statistical data about S3 buckets that Amazon Macie monitors and analyzes.
*/
getBucketStatistics(callback?: (err: AWSError, data: Macie2.Types.GetBucketStatisticsResponse) => void): Request<Macie2.Types.GetBucketStatisticsResponse, AWSError>;
/**
* Retrieves the configuration settings for storing data classification results.
*/
getClassificationExportConfiguration(params: Macie2.Types.GetClassificationExportConfigurationRequest, callback?: (err: AWSError, data: Macie2.Types.GetClassificationExportConfigurationResponse) => void): Request<Macie2.Types.GetClassificationExportConfigurationResponse, AWSError>;
/**
* Retrieves the configuration settings for storing data classification results.
*/
getClassificationExportConfiguration(callback?: (err: AWSError, data: Macie2.Types.GetClassificationExportConfigurationResponse) => void): Request<Macie2.Types.GetClassificationExportConfigurationResponse, AWSError>;
/**
* Retrieves the criteria and other settings for a custom data identifier.
*/
getCustomDataIdentifier(params: Macie2.Types.GetCustomDataIdentifierRequest, callback?: (err: AWSError, data: Macie2.Types.GetCustomDataIdentifierResponse) => void): Request<Macie2.Types.GetCustomDataIdentifierResponse, AWSError>;
/**
* Retrieves the criteria and other settings for a custom data identifier.
*/
getCustomDataIdentifier(callback?: (err: AWSError, data: Macie2.Types.GetCustomDataIdentifierResponse) => void): Request<Macie2.Types.GetCustomDataIdentifierResponse, AWSError>;
/**
* Retrieves (queries) aggregated statistical data about findings.
*/
getFindingStatistics(params: Macie2.Types.GetFindingStatisticsRequest, callback?: (err: AWSError, data: Macie2.Types.GetFindingStatisticsResponse) => void): Request<Macie2.Types.GetFindingStatisticsResponse, AWSError>;
/**
* Retrieves (queries) aggregated statistical data about findings.
*/
getFindingStatistics(callback?: (err: AWSError, data: Macie2.Types.GetFindingStatisticsResponse) => void): Request<Macie2.Types.GetFindingStatisticsResponse, AWSError>;
/**
* Retrieves the details of one or more findings.
*/
getFindings(params: Macie2.Types.GetFindingsRequest, callback?: (err: AWSError, data: Macie2.Types.GetFindingsResponse) => void): Request<Macie2.Types.GetFindingsResponse, AWSError>;
/**
* Retrieves the details of one or more findings.
*/
getFindings(callback?: (err: AWSError, data: Macie2.Types.GetFindingsResponse) => void): Request<Macie2.Types.GetFindingsResponse, AWSError>;
/**
* Retrieves the criteria and other settings for a findings filter.
*/
getFindingsFilter(params: Macie2.Types.GetFindingsFilterRequest, callback?: (err: AWSError, data: Macie2.Types.GetFindingsFilterResponse) => void): Request<Macie2.Types.GetFindingsFilterResponse, AWSError>;
/**
* Retrieves the criteria and other settings for a findings filter.
*/
getFindingsFilter(callback?: (err: AWSError, data: Macie2.Types.GetFindingsFilterResponse) => void): Request<Macie2.Types.GetFindingsFilterResponse, AWSError>;
/**
* Retrieves the configuration settings for publishing findings to Security Hub.
*/
getFindingsPublicationConfiguration(params: Macie2.Types.GetFindingsPublicationConfigurationRequest, callback?: (err: AWSError, data: Macie2.Types.GetFindingsPublicationConfigurationResponse) => void): Request<Macie2.Types.GetFindingsPublicationConfigurationResponse, AWSError>;
/**
* Retrieves the configuration settings for publishing findings to Security Hub.
*/
getFindingsPublicationConfiguration(callback?: (err: AWSError, data: Macie2.Types.GetFindingsPublicationConfigurationResponse) => void): Request<Macie2.Types.GetFindingsPublicationConfigurationResponse, AWSError>;
/**
* Retrieves the count of Amazon Macie membership invitations that were received by an account.
*/
getInvitationsCount(params: Macie2.Types.GetInvitationsCountRequest, callback?: (err: AWSError, data: Macie2.Types.GetInvitationsCountResponse) => void): Request<Macie2.Types.GetInvitationsCountResponse, AWSError>;
/**
* Retrieves the count of Amazon Macie membership invitations that were received by an account.
*/
getInvitationsCount(callback?: (err: AWSError, data: Macie2.Types.GetInvitationsCountResponse) => void): Request<Macie2.Types.GetInvitationsCountResponse, AWSError>;
/**
* Retrieves the current status and configuration settings for an Amazon Macie account.
*/
getMacieSession(params: Macie2.Types.GetMacieSessionRequest, callback?: (err: AWSError, data: Macie2.Types.GetMacieSessionResponse) => void): Request<Macie2.Types.GetMacieSessionResponse, AWSError>;
/**
* Retrieves the current status and configuration settings for an Amazon Macie account.
*/
getMacieSession(callback?: (err: AWSError, data: Macie2.Types.GetMacieSessionResponse) => void): Request<Macie2.Types.GetMacieSessionResponse, AWSError>;
/**
* (Deprecated) Retrieves information about the Amazon Macie administrator account for an account. This operation has been replaced by the GetAdministratorAccount operation.
*/
getMasterAccount(params: Macie2.Types.GetMasterAccountRequest, callback?: (err: AWSError, data: Macie2.Types.GetMasterAccountResponse) => void): Request<Macie2.Types.GetMasterAccountResponse, AWSError>;
/**
* (Deprecated) Retrieves information about the Amazon Macie administrator account for an account. This operation has been replaced by the GetAdministratorAccount operation.
*/
getMasterAccount(callback?: (err: AWSError, data: Macie2.Types.GetMasterAccountResponse) => void): Request<Macie2.Types.GetMasterAccountResponse, AWSError>;
/**
* Retrieves information about an account that's associated with an Amazon Macie administrator account.
*/
getMember(params: Macie2.Types.GetMemberRequest, callback?: (err: AWSError, data: Macie2.Types.GetMemberResponse) => void): Request<Macie2.Types.GetMemberResponse, AWSError>;
/**
* Retrieves information about an account that's associated with an Amazon Macie administrator account.
*/
getMember(callback?: (err: AWSError, data: Macie2.Types.GetMemberResponse) => void): Request<Macie2.Types.GetMemberResponse, AWSError>;
/**
* Retrieves the status and configuration settings for retrieving occurrences of sensitive data reported by findings.
*/
getRevealConfiguration(params: Macie2.Types.GetRevealConfigurationRequest, callback?: (err: AWSError, data: Macie2.Types.GetRevealConfigurationResponse) => void): Request<Macie2.Types.GetRevealConfigurationResponse, AWSError>;
/**
* Retrieves the status and configuration settings for retrieving occurrences of sensitive data reported by findings.
*/
getRevealConfiguration(callback?: (err: AWSError, data: Macie2.Types.GetRevealConfigurationResponse) => void): Request<Macie2.Types.GetRevealConfigurationResponse, AWSError>;
/**
* Retrieves occurrences of sensitive data reported by a finding.
*/
getSensitiveDataOccurrences(params: Macie2.Types.GetSensitiveDataOccurrencesRequest, callback?: (err: AWSError, data: Macie2.Types.GetSensitiveDataOccurrencesResponse) => void): Request<Macie2.Types.GetSensitiveDataOccurrencesResponse, AWSError>;
/**
* Retrieves occurrences of sensitive data reported by a finding.
*/
getSensitiveDataOccurrences(callback?: (err: AWSError, data: Macie2.Types.GetSensitiveDataOccurrencesResponse) => void): Request<Macie2.Types.GetSensitiveDataOccurrencesResponse, AWSError>;
/**
* Checks whether occurrences of sensitive data can be retrieved for a finding.
*/
getSensitiveDataOccurrencesAvailability(params: Macie2.Types.GetSensitiveDataOccurrencesAvailabilityRequest, callback?: (err: AWSError, data: Macie2.Types.GetSensitiveDataOccurrencesAvailabilityResponse) => void): Request<Macie2.Types.GetSensitiveDataOccurrencesAvailabilityResponse, AWSError>;
/**
* Checks whether occurrences of sensitive data can be retrieved for a finding.
*/
getSensitiveDataOccurrencesAvailability(callback?: (err: AWSError, data: Macie2.Types.GetSensitiveDataOccurrencesAvailabilityResponse) => void): Request<Macie2.Types.GetSensitiveDataOccurrencesAvailabilityResponse, AWSError>;
/**
* Retrieves (queries) quotas and aggregated usage data for one or more accounts.
*/
getUsageStatistics(params: Macie2.Types.GetUsageStatisticsRequest, callback?: (err: AWSError, data: Macie2.Types.GetUsageStatisticsResponse) => void): Request<Macie2.Types.GetUsageStatisticsResponse, AWSError>;
/**
* Retrieves (queries) quotas and aggregated usage data for one or more accounts.
*/
getUsageStatistics(callback?: (err: AWSError, data: Macie2.Types.GetUsageStatisticsResponse) => void): Request<Macie2.Types.GetUsageStatisticsResponse, AWSError>;
/**
* Retrieves (queries) aggregated usage data for an account.
*/
getUsageTotals(params: Macie2.Types.GetUsageTotalsRequest, callback?: (err: AWSError, data: Macie2.Types.GetUsageTotalsResponse) => void): Request<Macie2.Types.GetUsageTotalsResponse, AWSError>;
/**
* Retrieves (queries) aggregated usage data for an account.
*/
getUsageTotals(callback?: (err: AWSError, data: Macie2.Types.GetUsageTotalsResponse) => void): Request<Macie2.Types.GetUsageTotalsResponse, AWSError>;
/**
* Retrieves a subset of information about all the allow lists for an account.
*/
listAllowLists(params: Macie2.Types.ListAllowListsRequest, callback?: (err: AWSError, data: Macie2.Types.ListAllowListsResponse) => void): Request<Macie2.Types.ListAllowListsResponse, AWSError>;
/**
* Retrieves a subset of information about all the allow lists for an account.
*/
listAllowLists(callback?: (err: AWSError, data: Macie2.Types.ListAllowListsResponse) => void): Request<Macie2.Types.ListAllowListsResponse, AWSError>;
/**
* Retrieves a subset of information about one or more classification jobs.
*/
listClassificationJobs(params: Macie2.Types.ListClassificationJobsRequest, callback?: (err: AWSError, data: Macie2.Types.ListClassificationJobsResponse) => void): Request<Macie2.Types.ListClassificationJobsResponse, AWSError>;
/**
* Retrieves a subset of information about one or more classification jobs.
*/
listClassificationJobs(callback?: (err: AWSError, data: Macie2.Types.ListClassificationJobsResponse) => void): Request<Macie2.Types.ListClassificationJobsResponse, AWSError>;
/**
* Retrieves a subset of information about all the custom data identifiers for an account.
*/
listCustomDataIdentifiers(params: Macie2.Types.ListCustomDataIdentifiersRequest, callback?: (err: AWSError, data: Macie2.Types.ListCustomDataIdentifiersResponse) => void): Request<Macie2.Types.ListCustomDataIdentifiersResponse, AWSError>;
/**
* Retrieves a subset of information about all the custom data identifiers for an account.
*/
listCustomDataIdentifiers(callback?: (err: AWSError, data: Macie2.Types.ListCustomDataIdentifiersResponse) => void): Request<Macie2.Types.ListCustomDataIdentifiersResponse, AWSError>;
/**
* Retrieves a subset of information about one or more findings.
*/
listFindings(params: Macie2.Types.ListFindingsRequest, callback?: (err: AWSError, data: Macie2.Types.ListFindingsResponse) => void): Request<Macie2.Types.ListFindingsResponse, AWSError>;
/**
* Retrieves a subset of information about one or more findings.
*/
listFindings(callback?: (err: AWSError, data: Macie2.Types.ListFindingsResponse) => void): Request<Macie2.Types.ListFindingsResponse, AWSError>;
/**
* Retrieves a subset of information about all the findings filters for an account.
*/
listFindingsFilters(params: Macie2.Types.ListFindingsFiltersRequest, callback?: (err: AWSError, data: Macie2.Types.ListFindingsFiltersResponse) => void): Request<Macie2.Types.ListFindingsFiltersResponse, AWSError>;
/**
* Retrieves a subset of information about all the findings filters for an account.
*/
listFindingsFilters(callback?: (err: AWSError, data: Macie2.Types.ListFindingsFiltersResponse) => void): Request<Macie2.Types.ListFindingsFiltersResponse, AWSError>;
/**
* Retrieves information about the Amazon Macie membership invitations that were received by an account.
*/
listInvitations(params: Macie2.Types.ListInvitationsRequest, callback?: (err: AWSError, data: Macie2.Types.ListInvitationsResponse) => void): Request<Macie2.Types.ListInvitationsResponse, AWSError>;
/**
* Retrieves information about the Amazon Macie membership invitations that were received by an account.
*/
listInvitations(callback?: (err: AWSError, data: Macie2.Types.ListInvitationsResponse) => void): Request<Macie2.Types.ListInvitationsResponse, AWSError>;
/**
* Retrieves information about all the managed data identifiers that Amazon Macie currently provides.
*/
listManagedDataIdentifiers(params: Macie2.Types.ListManagedDataIdentifiersRequest, callback?: (err: AWSError, data: Macie2.Types.ListManagedDataIdentifiersResponse) => void): Request<Macie2.Types.ListManagedDataIdentifiersResponse, AWSError>;
/**
* Retrieves information about all the managed data identifiers that Amazon Macie currently provides.
*/
listManagedDataIdentifiers(callback?: (err: AWSError, data: Macie2.Types.ListManagedDataIdentifiersResponse) => void): Request<Macie2.Types.ListManagedDataIdentifiersResponse, AWSError>;
/**
* Retrieves information about the accounts that are associated with an Amazon Macie administrator account.
*/
listMembers(params: Macie2.Types.ListMembersRequest, callback?: (err: AWSError, data: Macie2.Types.ListMembersResponse) => void): Request<Macie2.Types.ListMembersResponse, AWSError>;
/**
* Retrieves information about the accounts that are associated with an Amazon Macie administrator account.
*/
listMembers(callback?: (err: AWSError, data: Macie2.Types.ListMembersResponse) => void): Request<Macie2.Types.ListMembersResponse, AWSError>;
/**
* Retrieves information about the delegated Amazon Macie administrator account for an organization in Organizations.
*/
listOrganizationAdminAccounts(params: Macie2.Types.ListOrganizationAdminAccountsRequest, callback?: (err: AWSError, data: Macie2.Types.ListOrganizationAdminAccountsResponse) => void): Request<Macie2.Types.ListOrganizationAdminAccountsResponse, AWSError>;
/**
* Retrieves information about the delegated Amazon Macie administrator account for an organization in Organizations.
*/
listOrganizationAdminAccounts(callback?: (err: AWSError, data: Macie2.Types.ListOrganizationAdminAccountsResponse) => void): Request<Macie2.Types.ListOrganizationAdminAccountsResponse, AWSError>;
/**
* Retrieves the tags (keys and values) that are associated with an Amazon Macie resource.
*/
listTagsForResource(params: Macie2.Types.ListTagsForResourceRequest, callback?: (err: AWSError, data: Macie2.Types.ListTagsForResourceResponse) => void): Request<Macie2.Types.ListTagsForResourceResponse, AWSError>;
/**
* Retrieves the tags (keys and values) that are associated with an Amazon Macie resource.
*/
listTagsForResource(callback?: (err: AWSError, data: Macie2.Types.ListTagsForResourceResponse) => void): Request<Macie2.Types.ListTagsForResourceResponse, AWSError>;
/**
* Creates or updates the configuration settings for storing data classification results.
*/
putClassificationExportConfiguration(params: Macie2.Types.PutClassificationExportConfigurationRequest, callback?: (err: AWSError, data: Macie2.Types.PutClassificationExportConfigurationResponse) => void): Request<Macie2.Types.PutClassificationExportConfigurationResponse, AWSError>;
/**
* Creates or updates the configuration settings for storing data classification results.
*/
putClassificationExportConfiguration(callback?: (err: AWSError, data: Macie2.Types.PutClassificationExportConfigurationResponse) => void): Request<Macie2.Types.PutClassificationExportConfigurationResponse, AWSError>;
/**
* Updates the configuration settings for publishing findings to Security Hub.
*/
putFindingsPublicationConfiguration(params: Macie2.Types.PutFindingsPublicationConfigurationRequest, callback?: (err: AWSError, data: Macie2.Types.PutFindingsPublicationConfigurationResponse) => void): Request<Macie2.Types.PutFindingsPublicationConfigurationResponse, AWSError>;
/**
* Updates the configuration settings for publishing findings to Security Hub.
*/
putFindingsPublicationConfiguration(callback?: (err: AWSError, data: Macie2.Types.PutFindingsPublicationConfigurationResponse) => void): Request<Macie2.Types.PutFindingsPublicationConfigurationResponse, AWSError>;
/**
* Retrieves (queries) statistical data and other information about Amazon Web Services resources that Amazon Macie monitors and analyzes.
*/
searchResources(params: Macie2.Types.SearchResourcesRequest, callback?: (err: AWSError, data: Macie2.Types.SearchResourcesResponse) => void): Request<Macie2.Types.SearchResourcesResponse, AWSError>;
/**
* Retrieves (queries) statistical data and other information about Amazon Web Services resources that Amazon Macie monitors and analyzes.
*/
searchResources(callback?: (err: AWSError, data: Macie2.Types.SearchResourcesResponse) => void): Request<Macie2.Types.SearchResourcesResponse, AWSError>;
/**
* Adds or updates one or more tags (keys and values) that are associated with an Amazon Macie resource.
*/
tagResource(params: Macie2.Types.TagResourceRequest, callback?: (err: AWSError, data: Macie2.Types.TagResourceResponse) => void): Request<Macie2.Types.TagResourceResponse, AWSError>;
/**
* Adds or updates one or more tags (keys and values) that are associated with an Amazon Macie resource.
*/
tagResource(callback?: (err: AWSError, data: Macie2.Types.TagResourceResponse) => void): Request<Macie2.Types.TagResourceResponse, AWSError>;
/**
* Tests a custom data identifier.
*/
testCustomDataIdentifier(params: Macie2.Types.TestCustomDataIdentifierRequest, callback?: (err: AWSError, data: Macie2.Types.TestCustomDataIdentifierResponse) => void): Request<Macie2.Types.TestCustomDataIdentifierResponse, AWSError>;
/**
* Tests a custom data identifier.
*/
testCustomDataIdentifier(callback?: (err: AWSError, data: Macie2.Types.TestCustomDataIdentifierResponse) => void): Request<Macie2.Types.TestCustomDataIdentifierResponse, AWSError>;
/**
* Removes one or more tags (keys and values) from an Amazon Macie resource.
*/
untagResource(params: Macie2.Types.UntagResourceRequest, callback?: (err: AWSError, data: Macie2.Types.UntagResourceResponse) => void): Request<Macie2.Types.UntagResourceResponse, AWSError>;
/**
* Removes one or more tags (keys and values) from an Amazon Macie resource.
*/
untagResource(callback?: (err: AWSError, data: Macie2.Types.UntagResourceResponse) => void): Request<Macie2.Types.UntagResourceResponse, AWSError>;
/**
* Updates the settings for an allow list.
*/
updateAllowList(params: Macie2.Types.UpdateAllowListRequest, callback?: (err: AWSError, data: Macie2.Types.UpdateAllowListResponse) => void): Request<Macie2.Types.UpdateAllowListResponse, AWSError>;
/**
* Updates the settings for an allow list.
*/
updateAllowList(callback?: (err: AWSError, data: Macie2.Types.UpdateAllowListResponse) => void): Request<Macie2.Types.UpdateAllowListResponse, AWSError>;
/**
* Changes the status of a classification job.
*/
updateClassificationJob(params: Macie2.Types.UpdateClassificationJobRequest, callback?: (err: AWSError, data: Macie2.Types.UpdateClassificationJobResponse) => void): Request<Macie2.Types.UpdateClassificationJobResponse, AWSError>;
/**
* Changes the status of a classification job.
*/
updateClassificationJob(callback?: (err: AWSError, data: Macie2.Types.UpdateClassificationJobResponse) => void): Request<Macie2.Types.UpdateClassificationJobResponse, AWSError>;
/**
* Updates the criteria and other settings for a findings filter.
*/
updateFindingsFilter(params: Macie2.Types.UpdateFindingsFilterRequest, callback?: (err: AWSError, data: Macie2.Types.UpdateFindingsFilterResponse) => void): Request<Macie2.Types.UpdateFindingsFilterResponse, AWSError>;
/**
* Updates the criteria and other settings for a findings filter.
*/
updateFindingsFilter(callback?: (err: AWSError, data: Macie2.Types.UpdateFindingsFilterResponse) => void): Request<Macie2.Types.UpdateFindingsFilterResponse, AWSError>;
/**
* Suspends or re-enables Amazon Macie, or updates the configuration settings for a Macie account.
*/
updateMacieSession(params: Macie2.Types.UpdateMacieSessionRequest, callback?: (err: AWSError, data: Macie2.Types.UpdateMacieSessionResponse) => void): Request<Macie2.Types.UpdateMacieSessionResponse, AWSError>;
/**
* Suspends or re-enables Amazon Macie, or updates the configuration settings for a Macie account.
*/
updateMacieSession(callback?: (err: AWSError, data: Macie2.Types.UpdateMacieSessionResponse) => void): Request<Macie2.Types.UpdateMacieSessionResponse, AWSError>;
/**
* Enables an Amazon Macie administrator to suspend or re-enable Macie for a member account.
*/
updateMemberSession(params: Macie2.Types.UpdateMemberSessionRequest, callback?: (err: AWSError, data: Macie2.Types.UpdateMemberSessionResponse) => void): Request<Macie2.Types.UpdateMemberSessionResponse, AWSError>;
/**
* Enables an Amazon Macie administrator to suspend or re-enable Macie for a member account.
*/
updateMemberSession(callback?: (err: AWSError, data: Macie2.Types.UpdateMemberSessionResponse) => void): Request<Macie2.Types.UpdateMemberSessionResponse, AWSError>;
/**
* Updates the Amazon Macie configuration settings for an organization in Organizations.
*/
updateOrganizationConfiguration(params: Macie2.Types.UpdateOrganizationConfigurationRequest, callback?: (err: AWSError, data: Macie2.Types.UpdateOrganizationConfigurationResponse) => void): Request<Macie2.Types.UpdateOrganizationConfigurationResponse, AWSError>;
/**
* Updates the Amazon Macie configuration settings for an organization in Organizations.
*/
updateOrganizationConfiguration(callback?: (err: AWSError, data: Macie2.Types.UpdateOrganizationConfigurationResponse) => void): Request<Macie2.Types.UpdateOrganizationConfigurationResponse, AWSError>;
/**
* Updates the status and configuration settings for retrieving occurrences of sensitive data reported by findings.
*/
updateRevealConfiguration(params: Macie2.Types.UpdateRevealConfigurationRequest, callback?: (err: AWSError, data: Macie2.Types.UpdateRevealConfigurationResponse) => void): Request<Macie2.Types.UpdateRevealConfigurationResponse, AWSError>;
/**
* Updates the status and configuration settings for retrieving occurrences of sensitive data reported by findings.
*/
updateRevealConfiguration(callback?: (err: AWSError, data: Macie2.Types.UpdateRevealConfigurationResponse) => void): Request<Macie2.Types.UpdateRevealConfigurationResponse, AWSError>;
/**
* Waits for the findingRevealed state by periodically calling the underlying Macie2.getSensitiveDataOccurrencesoperation every 2 seconds (at most 60 times). Wait until the sensitive data occurrences are ready.
*/
waitFor(state: "findingRevealed", params: Macie2.Types.GetSensitiveDataOccurrencesRequest & {$waiter?: WaiterConfiguration}, callback?: (err: AWSError, data: Macie2.Types.GetSensitiveDataOccurrencesResponse) => void): Request<Macie2.Types.GetSensitiveDataOccurrencesResponse, AWSError>;
/**
* Waits for the findingRevealed state by periodically calling the underlying Macie2.getSensitiveDataOccurrencesoperation every 2 seconds (at most 60 times). Wait until the sensitive data occurrences are ready.
*/
waitFor(state: "findingRevealed", callback?: (err: AWSError, data: Macie2.Types.GetSensitiveDataOccurrencesResponse) => void): Request<Macie2.Types.GetSensitiveDataOccurrencesResponse, AWSError>;
}
declare namespace Macie2 {
export interface AcceptInvitationRequest {
/**
* The Amazon Web Services account ID for the account that sent the invitation.
*/
administratorAccountId?: __string;
/**
* The unique identifier for the invitation to accept.
*/
invitationId: __string;
/**
* (Deprecated) The Amazon Web Services account ID for the account that sent the invitation. This property has been replaced by the administratorAccountId property and is retained only for backward compatibility.
*/
masterAccount?: __string;
}
export interface AcceptInvitationResponse {
}
export interface AccessControlList {
/**
* Specifies whether the ACL grants the general public with read access permissions for the bucket.
*/
allowsPublicReadAccess?: __boolean;
/**
* Specifies whether the ACL grants the general public with write access permissions for the bucket.
*/
allowsPublicWriteAccess?: __boolean;
}
export interface AccountDetail {
/**
* The Amazon Web Services account ID for the account.
*/
accountId: __string;
/**
* The email address for the account.
*/
email: __string;
}
export interface AccountLevelPermissions {
/**
* The block public access settings for the Amazon Web Services account that owns the bucket.
*/
blockPublicAccess?: BlockPublicAccess;
}
export interface AdminAccount {
/**
* The Amazon Web Services account ID for the account.
*/
accountId?: __string;
/**
* The current status of the account as the delegated Amazon Macie administrator account for the organization.
*/
status?: AdminStatus;
}
export type AdminStatus = "ENABLED"|"DISABLING_IN_PROGRESS"|string;
export interface AllowListCriteria {
/**
* The regular expression (regex) that defines the text pattern to ignore. The expression can contain as many as 512 characters.
*/
regex?: __stringMin1Max512PatternSS;
/**
* The location and name of the S3 object that lists specific text to ignore.
*/
s3WordsList?: S3WordsList;
}
export interface AllowListStatus {
/**
* The current status of the allow list. If the list's criteria specify a regular expression (regex), this value is typically OK. Amazon Macie can compile the expression. If the list's criteria specify an S3 object, possible values are: OK - Macie can retrieve and parse the contents of the object. S3_OBJECT_ACCESS_DENIED - Macie isn't allowed to access the object or the object is encrypted with a customer managed KMS key that Macie isn't allowed to use. Check the bucket policy and other permissions settings for the bucket and the object. If the object is encrypted, also ensure that it's encrypted with a key that Macie is allowed to use. S3_OBJECT_EMPTY - Macie can retrieve the object but the object doesn't contain any content. Ensure that the object contains the correct entries. Also ensure that the list's criteria specify the correct bucket and object names. S3_OBJECT_NOT_FOUND - The object doesn't exist in Amazon S3. Ensure that the list's criteria specify the correct bucket and object names. S3_OBJECT_OVERSIZE - Macie can retrieve the object. However, the object contains too many entries or its storage size exceeds the quota for an allow list. Try breaking the list into multiple files and ensure that each file doesn't exceed any quotas. Then configure list settings in Macie for each file. S3_THROTTLED - Amazon S3 throttled the request to retrieve the object. Wait a few minutes and then try again. S3_USER_ACCESS_DENIED - Amazon S3 denied the request to retrieve the object. If the specified object exists, you're not allowed to access it or it's encrypted with an KMS key that you're not allowed to use. Work with your Amazon Web Services administrator to ensure that the list's criteria specify the correct bucket and object names, and you have read access to the bucket and the object. If the object is encrypted, also ensure that it's encrypted with a key that you're allowed to use. UNKNOWN_ERROR - A transient or internal error occurred when Macie attempted to retrieve or parse the object. Wait a few minutes and then try again. A list can also have this status if it's encrypted with a key that Amazon S3 and Macie can't access or use.
*/
code: AllowListStatusCode;
/**
* A brief description of the status of the allow list. Amazon Macie uses this value to provide additional information about an error that occurred when Macie tried to access and use the list's criteria.
*/
description?: __stringMin1Max1024PatternSS;
}
export type AllowListStatusCode = "OK"|"S3_OBJECT_NOT_FOUND"|"S3_USER_ACCESS_DENIED"|"S3_OBJECT_ACCESS_DENIED"|"S3_THROTTLED"|"S3_OBJECT_OVERSIZE"|"S3_OBJECT_EMPTY"|"UNKNOWN_ERROR"|string;
export interface AllowListSummary {
/**
* The Amazon Resource Name (ARN) of the allow list.
*/
arn?: __stringMin71Max89PatternArnAwsAwsCnAwsUsGovMacie2AZ19920D12AllowListAZ0922;
/**
* The date and time, in UTC and extended ISO 8601 format, when the allow list was created in Amazon Macie.
*/
createdAt?: __timestampIso8601;
/**
* The custom description of the allow list.
*/
description?: __stringMin1Max512PatternSS;
/**
* The unique identifier for the allow list.
*/
id?: __stringMin22Max22PatternAZ0922;
/**
* The custom name of the allow list.
*/
name?: __stringMin1Max128Pattern;
/**
* The date and time, in UTC and extended ISO 8601 format, when the allow list's settings were most recently changed in Amazon Macie.
*/
updatedAt?: __timestampIso8601;
}
export type AllowsUnencryptedObjectUploads = "TRUE"|"FALSE"|"UNKNOWN"|string;
export interface ApiCallDetails {
/**
* The name of the operation that was invoked most recently and produced the finding.
*/
api?: __string;
/**
* The URL of the Amazon Web Service that provides the operation, for example: s3.amazonaws.com.
*/
apiServiceName?: __string;
/**
* The first date and time, in UTC and extended ISO 8601 format, when any operation was invoked and produced the finding.
*/
firstSeen?: __timestampIso8601;
/**
* The most recent date and time, in UTC and extended ISO 8601 format, when the specified operation (api) was invoked and produced the finding.
*/
lastSeen?: __timestampIso8601;
}
export interface AssumedRole {
/**
* The Amazon Web Services access key ID that identifies the credentials.
*/
accessKeyId?: __string;
/**
* The unique identifier for the Amazon Web Services account that owns the entity that was used to get the credentials.
*/
accountId?: __string;
/**
* The Amazon Resource Name (ARN) of the entity that was used to get the credentials.
*/
arn?: __string;
/**
* The unique identifier for the entity that was used to get the credentials.
*/
principalId?: __string;
/**
* The details of the session that was created for the credentials, including the entity that issued the session.
*/
sessionContext?: SessionContext;
}
export type AvailabilityCode = "AVAILABLE"|"UNAVAILABLE"|string;
export interface AwsAccount {
/**
* The unique identifier for the Amazon Web Services account.
*/
accountId?: __string;
/**
* The unique identifier for the entity that performed the action.
*/
principalId?: __string;
}
export interface AwsService {
/**
* The name of the Amazon Web Service that performed the action.
*/
invokedBy?: __string;
}
export interface BatchGetCustomDataIdentifierSummary {
/**
* The Amazon Resource Name (ARN) of the custom data identifier.
*/
arn?: __string;
/**
* The date and time, in UTC and extended ISO 8601 format, when the custom data identifier was created.
*/
createdAt?: __timestampIso8601;
/**
* Specifies whether the custom data identifier was deleted. If you delete a custom data identifier, Amazon Macie doesn't delete it permanently. Instead, it soft deletes the identifier.
*/
deleted?: __boolean;
/**
* The custom description of the custom data identifier.
*/
description?: __string;
/**
* The unique identifier for the custom data identifier.
*/
id?: __string;
/**
* The custom name of the custom data identifier.
*/
name?: __string;
}
export interface BatchGetCustomDataIdentifiersRequest {
/**
* An array of custom data identifier IDs, one for each custom data identifier to retrieve information about.
*/
ids?: __listOf__string;
}
export interface BatchGetCustomDataIdentifiersResponse {
/**
* An array of objects, one for each custom data identifier that meets the criteria specified in the request.
*/
customDataIdentifiers?: __listOfBatchGetCustomDataIdentifierSummary;
/**
* An array of custom data identifier IDs, one for each custom data identifier that was specified in the request but doesn't correlate to an existing custom data identifier.
*/