import { Command as $Command } from "@smithy/core/client"; import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { Macie2ClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../Macie2Client"; import type { DescribeBucketsRequest, DescribeBucketsResponse } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; export { $Command }; /** * @public * * The input for {@link DescribeBucketsCommand}. */ export interface DescribeBucketsCommandInput extends DescribeBucketsRequest { } /** * @public * * The output of {@link DescribeBucketsCommand}. */ export interface DescribeBucketsCommandOutput extends DescribeBucketsResponse, __MetadataBearer { } declare const DescribeBucketsCommand_base: { new (input: DescribeBucketsCommandInput): import("@smithy/core/client").CommandImpl; new (...[input]: [] | [DescribeBucketsCommandInput]): import("@smithy/core/client").CommandImpl; getEndpointParameterInstructions(): { [x: string]: unknown; }; }; /** *

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

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { Macie2Client, DescribeBucketsCommand } from "@aws-sdk/client-macie2"; // ES Modules import * // const { Macie2Client, DescribeBucketsCommand } = require("@aws-sdk/client-macie2"); // CommonJS import * // import type { Macie2ClientConfig } from "@aws-sdk/client-macie2"; * const config = {}; // type is Macie2ClientConfig * const client = new Macie2Client(config); * const input = { // DescribeBucketsRequest * criteria: { // BucketCriteria * "": { // BucketCriteriaAdditionalProperties * eq: [ // __listOf__string * "STRING_VALUE", * ], * gt: Number("long"), * gte: Number("long"), * lt: Number("long"), * lte: Number("long"), * neq: [ * "STRING_VALUE", * ], * prefix: "STRING_VALUE", * }, * }, * maxResults: Number("int"), * nextToken: "STRING_VALUE", * sortCriteria: { // BucketSortCriteria * attributeName: "STRING_VALUE", * orderBy: "ASC" || "DESC", * }, * }; * const command = new DescribeBucketsCommand(input); * const response = await client.send(command); * // { // DescribeBucketsResponse * // buckets: [ // __listOfBucketMetadata * // { // BucketMetadata * // accountId: "STRING_VALUE", * // allowsUnencryptedObjectUploads: "TRUE" || "FALSE" || "UNKNOWN", * // automatedDiscoveryMonitoringStatus: "MONITORED" || "NOT_MONITORED", * // bucketArn: "STRING_VALUE", * // bucketCreatedAt: new Date("TIMESTAMP"), * // bucketName: "STRING_VALUE", * // classifiableObjectCount: Number("long"), * // classifiableSizeInBytes: Number("long"), * // errorCode: "ACCESS_DENIED" || "BUCKET_COUNT_EXCEEDS_QUOTA", * // errorMessage: "STRING_VALUE", * // jobDetails: { // JobDetails * // isDefinedInJob: "TRUE" || "FALSE" || "UNKNOWN", * // isMonitoredByJob: "TRUE" || "FALSE" || "UNKNOWN", * // lastJobId: "STRING_VALUE", * // lastJobRunTime: new Date("TIMESTAMP"), * // }, * // lastAutomatedDiscoveryTime: new Date("TIMESTAMP"), * // lastUpdated: new Date("TIMESTAMP"), * // objectCount: Number("long"), * // objectCountByEncryptionType: { // ObjectCountByEncryptionType * // customerManaged: Number("long"), * // kmsManaged: Number("long"), * // s3Managed: Number("long"), * // unencrypted: Number("long"), * // unknown: Number("long"), * // }, * // publicAccess: { // BucketPublicAccess * // effectivePermission: "PUBLIC" || "NOT_PUBLIC" || "UNKNOWN", * // permissionConfiguration: { // BucketPermissionConfiguration * // accountLevelPermissions: { // AccountLevelPermissions * // blockPublicAccess: { // BlockPublicAccess * // blockPublicAcls: true || false, * // blockPublicPolicy: true || false, * // ignorePublicAcls: true || false, * // restrictPublicBuckets: true || false, * // }, * // }, * // bucketLevelPermissions: { // BucketLevelPermissions * // accessControlList: { // AccessControlList * // allowsPublicReadAccess: true || false, * // allowsPublicWriteAccess: true || false, * // }, * // blockPublicAccess: { * // blockPublicAcls: true || false, * // blockPublicPolicy: true || false, * // ignorePublicAcls: true || false, * // restrictPublicBuckets: true || false, * // }, * // bucketPolicy: { // BucketPolicy * // allowsPublicReadAccess: true || false, * // allowsPublicWriteAccess: true || false, * // }, * // }, * // }, * // }, * // region: "STRING_VALUE", * // replicationDetails: { // ReplicationDetails * // replicated: true || false, * // replicatedExternally: true || false, * // replicationAccounts: [ // __listOf__string * // "STRING_VALUE", * // ], * // }, * // sensitivityScore: Number("int"), * // serverSideEncryption: { // BucketServerSideEncryption * // kmsMasterKeyId: "STRING_VALUE", * // type: "NONE" || "AES256" || "aws:kms" || "aws:kms:dsse", * // }, * // sharedAccess: "EXTERNAL" || "INTERNAL" || "NOT_SHARED" || "UNKNOWN", * // sizeInBytes: Number("long"), * // sizeInBytesCompressed: Number("long"), * // tags: [ // __listOfKeyValuePair * // { // KeyValuePair * // key: "STRING_VALUE", * // value: "STRING_VALUE", * // }, * // ], * // unclassifiableObjectCount: { // ObjectLevelStatistics * // fileType: Number("long"), * // storageClass: Number("long"), * // total: Number("long"), * // }, * // unclassifiableObjectSizeInBytes: { * // fileType: Number("long"), * // storageClass: Number("long"), * // total: Number("long"), * // }, * // versioning: true || false, * // }, * // ], * // nextToken: "STRING_VALUE", * // }; * * ``` * * @param DescribeBucketsCommandInput - {@link DescribeBucketsCommandInput} * @returns {@link DescribeBucketsCommandOutput} * @see {@link DescribeBucketsCommandInput} for command's `input` shape. * @see {@link DescribeBucketsCommandOutput} for command's `response` shape. * @see {@link Macie2ClientResolvedConfig | config} for Macie2Client's `config` shape. * * @throws {@link AccessDeniedException} (client fault) *

Provides information about an error that occurred due to insufficient access to a specified resource.

* * @throws {@link ConflictException} (client fault) *

Provides information about an error that occurred due to a versioning conflict for a specified resource.

* * @throws {@link InternalServerException} (server fault) *

Provides information about an error that occurred due to an unknown internal server error, exception, or failure.

* * @throws {@link ResourceNotFoundException} (client fault) *

Provides information about an error that occurred because a specified resource wasn't found.

* * @throws {@link ServiceQuotaExceededException} (client fault) *

Provides information about an error that occurred due to one or more service quotas for an account.

* * @throws {@link ThrottlingException} (client fault) *

Provides information about an error that occurred because too many requests were sent during a certain amount of time.

* * @throws {@link ValidationException} (client fault) *

Provides information about an error that occurred due to a syntax error in a request.

* * @throws {@link Macie2ServiceException} *

Base exception class for all service exceptions from Macie2 service.

* * * @public */ export declare class DescribeBucketsCommand extends DescribeBucketsCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: DescribeBucketsRequest; output: DescribeBucketsResponse; }; sdk: { input: DescribeBucketsCommandInput; output: DescribeBucketsCommandOutput; }; }; }