@aws-sdk/client-macie2 3.325.0 → 3.327.0

package/dist-types/commands/DisableOrganizationAdminAccountCommand.d.ts

@@ -31,6 +31,8 @@ export interface DisableOrganizationAdminAccountCommandOutput extends DisableOrg
  * };
  * const command = new DisableOrganizationAdminAccountCommand(input);
  * const response = await client.send(command);
+ * // {};
+ *
  * ```
  *
  * @param DisableOrganizationAdminAccountCommandInput - {@link DisableOrganizationAdminAccountCommandInput}
@@ -60,6 +62,8 @@ export interface DisableOrganizationAdminAccountCommandOutput extends DisableOrg
  * @throws {@link ValidationException} (client fault)
  *  <p>Provides information about an error that occurred due to a syntax error in a request.</p>
  *
+ * @throws {@link Macie2ServiceException}
+ * <p>Base exception class for all service exceptions from Macie2 service.</p>
  *
  */
 export declare class DisableOrganizationAdminAccountCommand extends $Command<DisableOrganizationAdminAccountCommandInput, DisableOrganizationAdminAccountCommandOutput, Macie2ClientResolvedConfig> {

package/dist-types/commands/DisassociateFromAdministratorAccountCommand.d.ts

@@ -29,6 +29,8 @@ export interface DisassociateFromAdministratorAccountCommandOutput extends Disas
  * const input = {};
  * const command = new DisassociateFromAdministratorAccountCommand(input);
  * const response = await client.send(command);
+ * // {};
+ *
  * ```
  *
  * @param DisassociateFromAdministratorAccountCommandInput - {@link DisassociateFromAdministratorAccountCommandInput}
@@ -58,6 +60,8 @@ export interface DisassociateFromAdministratorAccountCommandOutput extends Disas
  * @throws {@link ValidationException} (client fault)
  *  <p>Provides information about an error that occurred due to a syntax error in a request.</p>
  *
+ * @throws {@link Macie2ServiceException}
+ * <p>Base exception class for all service exceptions from Macie2 service.</p>
  *
  */
 export declare class DisassociateFromAdministratorAccountCommand extends $Command<DisassociateFromAdministratorAccountCommandInput, DisassociateFromAdministratorAccountCommandOutput, Macie2ClientResolvedConfig> {

package/dist-types/commands/DisassociateFromMasterAccountCommand.d.ts

@@ -29,6 +29,8 @@ export interface DisassociateFromMasterAccountCommandOutput extends Disassociate
  * const input = {};
  * const command = new DisassociateFromMasterAccountCommand(input);
  * const response = await client.send(command);
+ * // {};
+ *
  * ```
  *
  * @param DisassociateFromMasterAccountCommandInput - {@link DisassociateFromMasterAccountCommandInput}
@@ -58,6 +60,8 @@ export interface DisassociateFromMasterAccountCommandOutput extends Disassociate
  * @throws {@link ValidationException} (client fault)
  *  <p>Provides information about an error that occurred due to a syntax error in a request.</p>
  *
+ * @throws {@link Macie2ServiceException}
+ * <p>Base exception class for all service exceptions from Macie2 service.</p>
  *
  */
 export declare class DisassociateFromMasterAccountCommand extends $Command<DisassociateFromMasterAccountCommandInput, DisassociateFromMasterAccountCommandOutput, Macie2ClientResolvedConfig> {

package/dist-types/commands/DisassociateMemberCommand.d.ts

@@ -31,6 +31,8 @@ export interface DisassociateMemberCommandOutput extends DisassociateMemberRespo
  * };
  * const command = new DisassociateMemberCommand(input);
  * const response = await client.send(command);
+ * // {};
+ *
  * ```
  *
  * @param DisassociateMemberCommandInput - {@link DisassociateMemberCommandInput}
@@ -60,6 +62,8 @@ export interface DisassociateMemberCommandOutput extends DisassociateMemberRespo
  * @throws {@link ValidationException} (client fault)
  *  <p>Provides information about an error that occurred due to a syntax error in a request.</p>
  *
+ * @throws {@link Macie2ServiceException}
+ * <p>Base exception class for all service exceptions from Macie2 service.</p>
  *
  */
 export declare class DisassociateMemberCommand extends $Command<DisassociateMemberCommandInput, DisassociateMemberCommandOutput, Macie2ClientResolvedConfig> {

package/dist-types/commands/EnableMacieCommand.d.ts

@@ -33,6 +33,8 @@ export interface EnableMacieCommandOutput extends EnableMacieResponse, __Metadat
  * };
  * const command = new EnableMacieCommand(input);
  * const response = await client.send(command);
+ * // {};
+ *
  * ```
  *
  * @param EnableMacieCommandInput - {@link EnableMacieCommandInput}
@@ -62,6 +64,8 @@ export interface EnableMacieCommandOutput extends EnableMacieResponse, __Metadat
  * @throws {@link ValidationException} (client fault)
  *  <p>Provides information about an error that occurred due to a syntax error in a request.</p>
  *
+ * @throws {@link Macie2ServiceException}
+ * <p>Base exception class for all service exceptions from Macie2 service.</p>
  *
  */
 export declare class EnableMacieCommand extends $Command<EnableMacieCommandInput, EnableMacieCommandOutput, Macie2ClientResolvedConfig> {

package/dist-types/commands/EnableOrganizationAdminAccountCommand.d.ts

@@ -32,6 +32,8 @@ export interface EnableOrganizationAdminAccountCommandOutput extends EnableOrgan
  * };
  * const command = new EnableOrganizationAdminAccountCommand(input);
  * const response = await client.send(command);
+ * // {};
+ *
  * ```
  *
  * @param EnableOrganizationAdminAccountCommandInput - {@link EnableOrganizationAdminAccountCommandInput}
@@ -61,6 +63,8 @@ export interface EnableOrganizationAdminAccountCommandOutput extends EnableOrgan
  * @throws {@link ValidationException} (client fault)
  *  <p>Provides information about an error that occurred due to a syntax error in a request.</p>
  *
+ * @throws {@link Macie2ServiceException}
+ * <p>Base exception class for all service exceptions from Macie2 service.</p>
  *
  */
 export declare class EnableOrganizationAdminAccountCommand extends $Command<EnableOrganizationAdminAccountCommandInput, EnableOrganizationAdminAccountCommandOutput, Macie2ClientResolvedConfig> {

package/dist-types/commands/GetAdministratorAccountCommand.d.ts

@@ -29,6 +29,15 @@ export interface GetAdministratorAccountCommandOutput extends GetAdministratorAc
  * const input = {};
  * const command = new GetAdministratorAccountCommand(input);
  * const response = await client.send(command);
+ * // { // GetAdministratorAccountResponse
+ * //   administrator: { // Invitation
+ * //     accountId: "STRING_VALUE",
+ * //     invitationId: "STRING_VALUE",
+ * //     invitedAt: new Date("TIMESTAMP"),
+ * //     relationshipStatus: "Enabled" || "Paused" || "Invited" || "Created" || "Removed" || "Resigned" || "EmailVerificationInProgress" || "EmailVerificationFailed" || "RegionDisabled" || "AccountSuspended",
+ * //   },
+ * // };
+ *
  * ```
  *
  * @param GetAdministratorAccountCommandInput - {@link GetAdministratorAccountCommandInput}
@@ -58,6 +67,8 @@ export interface GetAdministratorAccountCommandOutput extends GetAdministratorAc
  * @throws {@link ValidationException} (client fault)
  *  <p>Provides information about an error that occurred due to a syntax error in a request.</p>
  *
+ * @throws {@link Macie2ServiceException}
+ * <p>Base exception class for all service exceptions from Macie2 service.</p>
  *
  */
 export declare class GetAdministratorAccountCommand extends $Command<GetAdministratorAccountCommandInput, GetAdministratorAccountCommandOutput, Macie2ClientResolvedConfig> {

package/dist-types/commands/GetAllowListCommand.d.ts

@@ -31,6 +31,29 @@ export interface GetAllowListCommandOutput extends GetAllowListResponse, __Metad
  * };
  * const command = new GetAllowListCommand(input);
  * const response = await client.send(command);
+ * // { // GetAllowListResponse
+ * //   arn: "STRING_VALUE",
+ * //   createdAt: new Date("TIMESTAMP"),
+ * //   criteria: { // AllowListCriteria
+ * //     regex: "STRING_VALUE",
+ * //     s3WordsList: { // S3WordsList
+ * //       bucketName: "STRING_VALUE", // required
+ * //       objectKey: "STRING_VALUE", // required
+ * //     },
+ * //   },
+ * //   description: "STRING_VALUE",
+ * //   id: "STRING_VALUE",
+ * //   name: "STRING_VALUE",
+ * //   status: { // AllowListStatus
+ * //     code: "OK" || "S3_OBJECT_NOT_FOUND" || "S3_USER_ACCESS_DENIED" || "S3_OBJECT_ACCESS_DENIED" || "S3_THROTTLED" || "S3_OBJECT_OVERSIZE" || "S3_OBJECT_EMPTY" || "UNKNOWN_ERROR", // required
+ * //     description: "STRING_VALUE",
+ * //   },
+ * //   tags: { // TagMap
+ * //     "<keys>": "STRING_VALUE",
+ * //   },
+ * //   updatedAt: new Date("TIMESTAMP"),
+ * // };
+ *
  * ```
  *
  * @param GetAllowListCommandInput - {@link GetAllowListCommandInput}
@@ -54,6 +77,8 @@ export interface GetAllowListCommandOutput extends GetAllowListResponse, __Metad
  * @throws {@link ValidationException} (client fault)
  *  <p>Provides information about an error that occurred due to a syntax error in a request.</p>
  *
+ * @throws {@link Macie2ServiceException}
+ * <p>Base exception class for all service exceptions from Macie2 service.</p>
  *
  */
 export declare class GetAllowListCommand extends $Command<GetAllowListCommandInput, GetAllowListCommandOutput, Macie2ClientResolvedConfig> {

package/dist-types/commands/GetAutomatedDiscoveryConfigurationCommand.d.ts

@@ -29,6 +29,15 @@ export interface GetAutomatedDiscoveryConfigurationCommandOutput extends GetAuto
  * const input = {};
  * const command = new GetAutomatedDiscoveryConfigurationCommand(input);
  * const response = await client.send(command);
+ * // { // GetAutomatedDiscoveryConfigurationResponse
+ * //   classificationScopeId: "STRING_VALUE",
+ * //   disabledAt: new Date("TIMESTAMP"),
+ * //   firstEnabledAt: new Date("TIMESTAMP"),
+ * //   lastUpdatedAt: new Date("TIMESTAMP"),
+ * //   sensitivityInspectionTemplateId: "STRING_VALUE",
+ * //   status: "ENABLED" || "DISABLED",
+ * // };
+ *
  * ```
  *
  * @param GetAutomatedDiscoveryConfigurationCommandInput - {@link GetAutomatedDiscoveryConfigurationCommandInput}
@@ -49,6 +58,8 @@ export interface GetAutomatedDiscoveryConfigurationCommandOutput extends GetAuto
  * @throws {@link ValidationException} (client fault)
  *  <p>Provides information about an error that occurred due to a syntax error in a request.</p>
  *
+ * @throws {@link Macie2ServiceException}
+ * <p>Base exception class for all service exceptions from Macie2 service.</p>
  *
  */
 export declare class GetAutomatedDiscoveryConfigurationCommand extends $Command<GetAutomatedDiscoveryConfigurationCommandInput, GetAutomatedDiscoveryConfigurationCommandOutput, Macie2ClientResolvedConfig> {

package/dist-types/commands/GetBucketStatisticsCommand.d.ts

@@ -31,6 +31,75 @@ export interface GetBucketStatisticsCommandOutput extends GetBucketStatisticsRes
  * };
  * const command = new GetBucketStatisticsCommand(input);
  * const response = await client.send(command);
+ * // { // GetBucketStatisticsResponse
+ * //   bucketCount: Number("long"),
+ * //   bucketCountByEffectivePermission: { // BucketCountByEffectivePermission
+ * //     publiclyAccessible: Number("long"),
+ * //     publiclyReadable: Number("long"),
+ * //     publiclyWritable: Number("long"),
+ * //     unknown: Number("long"),
+ * //   },
+ * //   bucketCountByEncryptionType: { // BucketCountByEncryptionType
+ * //     kmsManaged: Number("long"),
+ * //     s3Managed: Number("long"),
+ * //     unencrypted: Number("long"),
+ * //     unknown: Number("long"),
+ * //   },
+ * //   bucketCountByObjectEncryptionRequirement: { // BucketCountPolicyAllowsUnencryptedObjectUploads
+ * //     allowsUnencryptedObjectUploads: Number("long"),
+ * //     deniesUnencryptedObjectUploads: Number("long"),
+ * //     unknown: Number("long"),
+ * //   },
+ * //   bucketCountBySharedAccessType: { // BucketCountBySharedAccessType
+ * //     external: Number("long"),
+ * //     internal: Number("long"),
+ * //     notShared: Number("long"),
+ * //     unknown: Number("long"),
+ * //   },
+ * //   bucketStatisticsBySensitivity: { // BucketStatisticsBySensitivity
+ * //     classificationError: { // SensitivityAggregations
+ * //       classifiableSizeInBytes: Number("long"),
+ * //       publiclyAccessibleCount: Number("long"),
+ * //       totalCount: Number("long"),
+ * //       totalSizeInBytes: Number("long"),
+ * //     },
+ * //     notClassified: {
+ * //       classifiableSizeInBytes: Number("long"),
+ * //       publiclyAccessibleCount: Number("long"),
+ * //       totalCount: Number("long"),
+ * //       totalSizeInBytes: Number("long"),
+ * //     },
+ * //     notSensitive: {
+ * //       classifiableSizeInBytes: Number("long"),
+ * //       publiclyAccessibleCount: Number("long"),
+ * //       totalCount: Number("long"),
+ * //       totalSizeInBytes: Number("long"),
+ * //     },
+ * //     sensitive: {
+ * //       classifiableSizeInBytes: Number("long"),
+ * //       publiclyAccessibleCount: Number("long"),
+ * //       totalCount: Number("long"),
+ * //       totalSizeInBytes: Number("long"),
+ * //     },
+ * //   },
+ * //   classifiableObjectCount: Number("long"),
+ * //   classifiableSizeInBytes: Number("long"),
+ * //   lastUpdated: new Date("TIMESTAMP"),
+ * //   objectCount: Number("long"),
+ * //   sizeInBytes: Number("long"),
+ * //   sizeInBytesCompressed: Number("long"),
+ * //   unclassifiableObjectCount: { // ObjectLevelStatistics
+ * //     fileType: Number("long"),
+ * //     storageClass: Number("long"),
+ * //     total: Number("long"),
+ * //   },
+ * //   unclassifiableObjectSizeInBytes: {
+ * //     fileType: Number("long"),
+ * //     storageClass: Number("long"),
+ * //     total: Number("long"),
+ * //   },
+ * // };
+ *
  * ```
  *
  * @param GetBucketStatisticsCommandInput - {@link GetBucketStatisticsCommandInput}
@@ -60,6 +129,8 @@ export interface GetBucketStatisticsCommandOutput extends GetBucketStatisticsRes
  * @throws {@link ValidationException} (client fault)
  *  <p>Provides information about an error that occurred due to a syntax error in a request.</p>
  *
+ * @throws {@link Macie2ServiceException}
+ * <p>Base exception class for all service exceptions from Macie2 service.</p>
  *
  */
 export declare class GetBucketStatisticsCommand extends $Command<GetBucketStatisticsCommandInput, GetBucketStatisticsCommandOutput, Macie2ClientResolvedConfig> {

package/dist-types/commands/GetClassificationExportConfigurationCommand.d.ts

@@ -29,6 +29,16 @@ export interface GetClassificationExportConfigurationCommandOutput extends GetCl
  * const input = {};
  * const command = new GetClassificationExportConfigurationCommand(input);
  * const response = await client.send(command);
+ * // { // GetClassificationExportConfigurationResponse
+ * //   configuration: { // ClassificationExportConfiguration
+ * //     s3Destination: { // S3Destination
+ * //       bucketName: "STRING_VALUE", // required
+ * //       keyPrefix: "STRING_VALUE",
+ * //       kmsKeyArn: "STRING_VALUE", // required
+ * //     },
+ * //   },
+ * // };
+ *
  * ```
  *
  * @param GetClassificationExportConfigurationCommandInput - {@link GetClassificationExportConfigurationCommandInput}
@@ -58,6 +68,8 @@ export interface GetClassificationExportConfigurationCommandOutput extends GetCl
  * @throws {@link ValidationException} (client fault)
  *  <p>Provides information about an error that occurred due to a syntax error in a request.</p>
  *
+ * @throws {@link Macie2ServiceException}
+ * <p>Base exception class for all service exceptions from Macie2 service.</p>
  *
  */
 export declare class GetClassificationExportConfigurationCommand extends $Command<GetClassificationExportConfigurationCommandInput, GetClassificationExportConfigurationCommandOutput, Macie2ClientResolvedConfig> {

package/dist-types/commands/GetClassificationScopeCommand.d.ts

@@ -31,6 +31,18 @@ export interface GetClassificationScopeCommandOutput extends GetClassificationSc
  * };
  * const command = new GetClassificationScopeCommand(input);
  * const response = await client.send(command);
+ * // { // GetClassificationScopeResponse
+ * //   id: "STRING_VALUE",
+ * //   name: "STRING_VALUE",
+ * //   s3: { // S3ClassificationScope
+ * //     excludes: { // S3ClassificationScopeExclusion
+ * //       bucketNames: [ // __listOfS3BucketName // required
+ * //         "STRING_VALUE",
+ * //       ],
+ * //     },
+ * //   },
+ * // };
+ *
  * ```
  *
  * @param GetClassificationScopeCommandInput - {@link GetClassificationScopeCommandInput}
@@ -54,6 +66,8 @@ export interface GetClassificationScopeCommandOutput extends GetClassificationSc
  * @throws {@link ValidationException} (client fault)
  *  <p>Provides information about an error that occurred due to a syntax error in a request.</p>
  *
+ * @throws {@link Macie2ServiceException}
+ * <p>Base exception class for all service exceptions from Macie2 service.</p>
  *
  */
 export declare class GetClassificationScopeCommand extends $Command<GetClassificationScopeCommandInput, GetClassificationScopeCommandOutput, Macie2ClientResolvedConfig> {

package/dist-types/commands/GetCustomDataIdentifierCommand.d.ts

@@ -31,6 +31,32 @@ export interface GetCustomDataIdentifierCommandOutput extends GetCustomDataIdent
  * };
  * const command = new GetCustomDataIdentifierCommand(input);
  * const response = await client.send(command);
+ * // { // GetCustomDataIdentifierResponse
+ * //   arn: "STRING_VALUE",
+ * //   createdAt: new Date("TIMESTAMP"),
+ * //   deleted: true || false,
+ * //   description: "STRING_VALUE",
+ * //   id: "STRING_VALUE",
+ * //   ignoreWords: [ // __listOf__string
+ * //     "STRING_VALUE",
+ * //   ],
+ * //   keywords: [
+ * //     "STRING_VALUE",
+ * //   ],
+ * //   maximumMatchDistance: Number("int"),
+ * //   name: "STRING_VALUE",
+ * //   regex: "STRING_VALUE",
+ * //   severityLevels: [ // SeverityLevelList
+ * //     { // SeverityLevel
+ * //       occurrencesThreshold: Number("long"), // required
+ * //       severity: "LOW" || "MEDIUM" || "HIGH", // required
+ * //     },
+ * //   ],
+ * //   tags: { // TagMap
+ * //     "<keys>": "STRING_VALUE",
+ * //   },
+ * // };
+ *
  * ```
  *
  * @param GetCustomDataIdentifierCommandInput - {@link GetCustomDataIdentifierCommandInput}
@@ -60,6 +86,8 @@ export interface GetCustomDataIdentifierCommandOutput extends GetCustomDataIdent
  * @throws {@link ValidationException} (client fault)
  *  <p>Provides information about an error that occurred due to a syntax error in a request.</p>
  *
+ * @throws {@link Macie2ServiceException}
+ * <p>Base exception class for all service exceptions from Macie2 service.</p>
  *
  */
 export declare class GetCustomDataIdentifierCommand extends $Command<GetCustomDataIdentifierCommandInput, GetCustomDataIdentifierCommandOutput, Macie2ClientResolvedConfig> {

package/dist-types/commands/GetFindingStatisticsCommand.d.ts

@@ -55,6 +55,15 @@ export interface GetFindingStatisticsCommandOutput extends GetFindingStatisticsR
  * };
  * const command = new GetFindingStatisticsCommand(input);
  * const response = await client.send(command);
+ * // { // GetFindingStatisticsResponse
+ * //   countsByGroup: [ // __listOfGroupCount
+ * //     { // GroupCount
+ * //       count: Number("long"),
+ * //       groupKey: "STRING_VALUE",
+ * //     },
+ * //   ],
+ * // };
+ *
  * ```
  *
  * @param GetFindingStatisticsCommandInput - {@link GetFindingStatisticsCommandInput}
@@ -84,6 +93,8 @@ export interface GetFindingStatisticsCommandOutput extends GetFindingStatisticsR
  * @throws {@link ValidationException} (client fault)
  *  <p>Provides information about an error that occurred due to a syntax error in a request.</p>
  *
+ * @throws {@link Macie2ServiceException}
+ * <p>Base exception class for all service exceptions from Macie2 service.</p>
  *
  */
 export declare class GetFindingStatisticsCommand extends $Command<GetFindingStatisticsCommandInput, GetFindingStatisticsCommandOutput, Macie2ClientResolvedConfig> {