- Navigation GuideYou are on a Client landing page. Commands (operations) are listed on this page. The Client constructor type is linked at the bottom.
Macie2Client
Amazon Macie
Installation
npm install @aws-sdk/client-macie2
yarn add @aws-sdk/client-macie2
pnpm add @aws-sdk/client-macie2
Macie2Client Operations
Command | Summary |
---|
Command | Summary |
---|---|
AcceptInvitationCommand | Accepts an Amazon Macie membership invitation that was received from a specific account. |
BatchGetCustomDataIdentifiersCommand | Retrieves information about one or more custom data identifiers. |
BatchUpdateAutomatedDiscoveryAccountsCommand | Changes the status of automated sensitive data discovery for one or more accounts. |
CreateAllowListCommand | Creates and defines the settings for an allow list. |
CreateClassificationJobCommand | Creates and defines the settings for a classification job. |
CreateCustomDataIdentifierCommand | Creates and defines the criteria and other settings for a custom data identifier. |
CreateFindingsFilterCommand | Creates and defines the criteria and other settings for a findings filter. |
CreateInvitationsCommand | Sends an Amazon Macie membership invitation to one or more accounts. |
CreateMemberCommand | Associates an account with an Amazon Macie administrator account. |
CreateSampleFindingsCommand | Creates sample findings. |
DeclineInvitationsCommand | Declines Amazon Macie membership invitations that were received from specific accounts. |
DeleteAllowListCommand | Deletes an allow list. |
DeleteCustomDataIdentifierCommand | Soft deletes a custom data identifier. |
DeleteFindingsFilterCommand | Deletes a findings filter. |
DeleteInvitationsCommand | Deletes Amazon Macie membership invitations that were received from specific accounts. |
DeleteMemberCommand | Deletes the association between an Amazon Macie administrator account and an account. |
DescribeBucketsCommand | Retrieves (queries) statistical data and other information about one or more S3 buckets that Amazon Macie monitors and analyzes for an account. |
DescribeClassificationJobCommand | Retrieves the status and settings for a classification job. |
DescribeOrganizationConfigurationCommand | Retrieves the Amazon Macie configuration settings for an organization in Organizations. |
DisableMacieCommand | Disables Amazon Macie and deletes all settings and resources for a Macie account. |
DisableOrganizationAdminAccountCommand | Disables an account as the delegated Amazon Macie administrator account for an organization in Organizations. |
DisassociateFromAdministratorAccountCommand | Disassociates a member account from its Amazon Macie administrator account. |
DisassociateFromMasterAccountCommand | (Deprecated) Disassociates a member account from its Amazon Macie administrator account. This operation has been replaced by the DisassociateFromAdministratorAccount operation. |
DisassociateMemberCommand | Disassociates an Amazon Macie administrator account from a member account. |
EnableMacieCommand | Enables Amazon Macie and specifies the configuration settings for a Macie account. |
EnableOrganizationAdminAccountCommand | Designates an account as the delegated Amazon Macie administrator account for an organization in Organizations. |
GetAdministratorAccountCommand | Retrieves information about the Amazon Macie administrator account for an account. |
GetAllowListCommand | Retrieves the settings and status of an allow list. |
GetAutomatedDiscoveryConfigurationCommand | Retrieves the configuration settings and status of automated sensitive data discovery for an organization or standalone account. |
GetBucketStatisticsCommand | Retrieves (queries) aggregated statistical data about all the S3 buckets that Amazon Macie monitors and analyzes for an account. |
GetClassificationExportConfigurationCommand | Retrieves the configuration settings for storing data classification results. |
GetClassificationScopeCommand | Retrieves the classification scope settings for an account. |
GetCustomDataIdentifierCommand | Retrieves the criteria and other settings for a custom data identifier. |
GetFindingStatisticsCommand | Retrieves (queries) aggregated statistical data about findings. |
GetFindingsCommand | Retrieves the details of one or more findings. |
GetFindingsFilterCommand | Retrieves the criteria and other settings for a findings filter. |
GetFindingsPublicationConfigurationCommand | Retrieves the configuration settings for publishing findings to Security Hub. |
GetInvitationsCountCommand | Retrieves the count of Amazon Macie membership invitations that were received by an account. |
GetMacieSessionCommand | Retrieves the status and configuration settings for an Amazon Macie account. |
GetMasterAccountCommand | (Deprecated) Retrieves information about the Amazon Macie administrator account for an account. This operation has been replaced by the GetAdministratorAccount operation. |
GetMemberCommand | Retrieves information about an account that's associated with an Amazon Macie administrator account. |
GetResourceProfileCommand | Retrieves (queries) sensitive data discovery statistics and the sensitivity score for an S3 bucket. |
GetRevealConfigurationCommand | Retrieves the status and configuration settings for retrieving occurrences of sensitive data reported by findings. |
GetSensitiveDataOccurrencesAvailabilityCommand | Checks whether occurrences of sensitive data can be retrieved for a finding. |
GetSensitiveDataOccurrencesCommand | Retrieves occurrences of sensitive data reported by a finding. |
GetSensitivityInspectionTemplateCommand | Retrieves the settings for the sensitivity inspection template for an account. |
GetUsageStatisticsCommand | Retrieves (queries) quotas and aggregated usage data for one or more accounts. |
GetUsageTotalsCommand | Retrieves (queries) aggregated usage data for an account. |
ListAllowListsCommand | Retrieves a subset of information about all the allow lists for an account. |
ListAutomatedDiscoveryAccountsCommand | Retrieves the status of automated sensitive data discovery for one or more accounts. |
ListClassificationJobsCommand | Retrieves a subset of information about one or more classification jobs. |
ListClassificationScopesCommand | Retrieves a subset of information about the classification scope for an account. |
ListCustomDataIdentifiersCommand | Retrieves a subset of information about the custom data identifiers for an account. |
ListFindingsCommand | Retrieves a subset of information about one or more findings. |
ListFindingsFiltersCommand | Retrieves a subset of information about all the findings filters for an account. |
ListInvitationsCommand | Retrieves information about Amazon Macie membership invitations that were received by an account. |
ListManagedDataIdentifiersCommand | Retrieves information about all the managed data identifiers that Amazon Macie currently provides. |
ListMembersCommand | Retrieves information about the accounts that are associated with an Amazon Macie administrator account. |
ListOrganizationAdminAccountsCommand | Retrieves information about the delegated Amazon Macie administrator account for an organization in Organizations. |
ListResourceProfileArtifactsCommand | Retrieves information about objects that Amazon Macie selected from an S3 bucket for automated sensitive data discovery. |
ListResourceProfileDetectionsCommand | Retrieves information about the types and amount of sensitive data that Amazon Macie found in an S3 bucket. |
ListSensitivityInspectionTemplatesCommand | Retrieves a subset of information about the sensitivity inspection template for an account. |
ListTagsForResourceCommand | Retrieves the tags (keys and values) that are associated with an Amazon Macie resource. |
PutClassificationExportConfigurationCommand | Adds or updates the configuration settings for storing data classification results. |
PutFindingsPublicationConfigurationCommand | Updates the configuration settings for publishing findings to Security Hub. |
SearchResourcesCommand | Retrieves (queries) statistical data and other information about Amazon Web Services resources that Amazon Macie monitors and analyzes for an account. |
TagResourceCommand | Adds or updates one or more tags (keys and values) that are associated with an Amazon Macie resource. |
TestCustomDataIdentifierCommand | Tests criteria for a custom data identifier. |
UntagResourceCommand | Removes one or more tags (keys and values) from an Amazon Macie resource. |
UpdateAllowListCommand | Updates the settings for an allow list. |
UpdateAutomatedDiscoveryConfigurationCommand | Changes the configuration settings and status of automated sensitive data discovery for an organization or standalone account. |
UpdateClassificationJobCommand | Changes the status of a classification job. |
UpdateClassificationScopeCommand | Updates the classification scope settings for an account. |
UpdateFindingsFilterCommand | Updates the criteria and other settings for a findings filter. |
UpdateMacieSessionCommand | Suspends or re-enables Amazon Macie, or updates the configuration settings for a Macie account. |
UpdateMemberSessionCommand | Enables an Amazon Macie administrator to suspend or re-enable Macie for a member account. |
UpdateOrganizationConfigurationCommand | Updates the Amazon Macie configuration settings for an organization in Organizations. |
UpdateResourceProfileCommand | Updates the sensitivity score for an S3 bucket. |
UpdateResourceProfileDetectionsCommand | Updates the sensitivity scoring settings for an S3 bucket. |
UpdateRevealConfigurationCommand | Updates the status and configuration settings for retrieving occurrences of sensitive data reported by findings. |
UpdateSensitivityInspectionTemplateCommand | Updates the settings for the sensitivity inspection template for an account. |
Macie2Client Configuration
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
defaultsMode Optional | DefaultsMode | Provider<DefaultsMode> | The @smithy/smithy-client#DefaultsMode that will be used to determine how certain default configuration options are resolved in the SDK. |
disableHostPrefix Optional | boolean | Disable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation. |
extensions Optional | RuntimeExtension[] | Optional extensions |
logger Optional | Logger | Optional logger for logging debug/info/warn/error. |
maxAttempts Optional | number | Provider<number> | Value for how many times a request will be made at most in case of retry. |
profile Optional | string | Setting a client profile is similar to setting a value for the AWS_PROFILE environment variable. Setting a profile on a client in code only affects the single client instance, unlike AWS_PROFILE.When set, and only for environments where an AWS configuration file exists, fields configurable by this file will be retrieved from the specified profile within that file. Conflicting code configuration and environment variables will still have higher priority.For client credential resolution that involves checking the AWS configuration file, the client's profile (this value) will be used unless a different profile is set in the credential provider options. |
region Optional | string | Provider<string> | The AWS region to which this client will send requests |
requestHandler Optional | __HttpHandlerUserInput | The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs. |
retryMode Optional | string | Provider<string> | Specifies which retry algorithm to use. |
useDualstackEndpoint Optional | boolean | Provider<boolean> | Enables IPv6/IPv4 dualstack endpoint. |
useFipsEndpoint Optional | boolean | Provider<boolean> | Enables FIPS compatible endpoints. |
Additional config fields are described in the full configuration type: Macie2ClientConfig