import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { DescribeDatasetRequest, DescribeDatasetResponse } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; /** * @public * * The input for {@link DescribeDatasetCommand}. */ export interface DescribeDatasetCommandInput extends DescribeDatasetRequest { } /** * @public * * The output of {@link DescribeDatasetCommand}. */ export interface DescribeDatasetCommandOutput extends DescribeDatasetResponse, __MetadataBearer { } declare const DescribeDatasetCommand_base: { new (input: DescribeDatasetCommandInput): import("@smithy/core/client").CommandImpl; new (input: DescribeDatasetCommandInput): import("@smithy/core/client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions; }; /** *

Gets meta data about a dataset by identity and dataset name. With Amazon Cognito Sync, each * identity has access only to its own data. Thus, the credentials used to make this API call * need to have access to the identity data.

*

This API can be called with temporary user credentials provided by Cognito Identity or with developer credentials. You should use Cognito Identity credentials to make this API call.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { CognitoSyncClient, DescribeDatasetCommand } from "@aws-sdk/client-cognito-sync"; // ES Modules import * // const { CognitoSyncClient, DescribeDatasetCommand } = require("@aws-sdk/client-cognito-sync"); // CommonJS import * // import type { CognitoSyncClientConfig } from "@aws-sdk/client-cognito-sync"; * const config = {}; // type is CognitoSyncClientConfig * const client = new CognitoSyncClient(config); * const input = { // DescribeDatasetRequest * IdentityPoolId: "STRING_VALUE", // required * IdentityId: "STRING_VALUE", // required * DatasetName: "STRING_VALUE", // required * }; * const command = new DescribeDatasetCommand(input); * const response = await client.send(command); * // { // DescribeDatasetResponse * // Dataset: { // Dataset * // IdentityId: "STRING_VALUE", * // DatasetName: "STRING_VALUE", * // CreationDate: new Date("TIMESTAMP"), * // LastModifiedDate: new Date("TIMESTAMP"), * // LastModifiedBy: "STRING_VALUE", * // DataStorage: Number("long"), * // NumRecords: Number("long"), * // }, * // }; * * ``` * * @param DescribeDatasetCommandInput - {@link DescribeDatasetCommandInput} * @returns {@link DescribeDatasetCommandOutput} * @see {@link DescribeDatasetCommandInput} for command's `input` shape. * @see {@link DescribeDatasetCommandOutput} for command's `response` shape. * @see {@link CognitoSyncClientResolvedConfig | config} for CognitoSyncClient's `config` shape. * * @throws {@link InternalErrorException} (server fault) * Indicates an internal service * error. * * @throws {@link InvalidParameterException} (client fault) * Thrown when a request parameter does not comply * with the associated constraints. * * @throws {@link NotAuthorizedException} (client fault) * Thrown when a user is not authorized to access the * requested resource. * * @throws {@link ResourceNotFoundException} (client fault) * Thrown if the resource doesn't * exist. * * @throws {@link TooManyRequestsException} (client fault) * Thrown if the request is * throttled. * * @throws {@link CognitoSyncServiceException} *

Base exception class for all service exceptions from CognitoSync service.

* * * @public */ export declare class DescribeDatasetCommand extends DescribeDatasetCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: DescribeDatasetRequest; output: DescribeDatasetResponse; }; sdk: { input: DescribeDatasetCommandInput; output: DescribeDatasetCommandOutput; }; }; }