import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { DescribeDataRepositoryAssociationsRequest, DescribeDataRepositoryAssociationsResponse } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; /** * @public * * The input for {@link DescribeDataRepositoryAssociationsCommand}. */ export interface DescribeDataRepositoryAssociationsCommandInput extends DescribeDataRepositoryAssociationsRequest { } /** * @public * * The output of {@link DescribeDataRepositoryAssociationsCommand}. */ export interface DescribeDataRepositoryAssociationsCommandOutput extends DescribeDataRepositoryAssociationsResponse, __MetadataBearer { } declare const DescribeDataRepositoryAssociationsCommand_base: { new (input: DescribeDataRepositoryAssociationsCommandInput): import("@smithy/core/client").CommandImpl; new (...[input]: [] | [DescribeDataRepositoryAssociationsCommandInput]): import("@smithy/core/client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions; }; /** *

Returns the description of specific Amazon FSx for Lustre or Amazon File Cache * data repository associations, if one or more AssociationIds values * are provided in the request, or if filters are used in the request. Data repository * associations are supported on Amazon File Cache resources and all FSx for Lustre * 2.12 and 2,15 file systems, excluding scratch_1 deployment type.

*

You can use filters to narrow the response to include just data repository * associations for specific file systems (use the file-system-id filter with * the ID of the file system) or caches (use the file-cache-id filter with * the ID of the cache), or data repository associations for a specific repository type * (use the data-repository-type filter with a value of S3 * or NFS). If you don't use filters, the response returns all data * repository associations owned by your Amazon Web Services account in the Amazon Web Services Region * of the endpoint that you're calling.

*

When retrieving all data repository associations, you can paginate the response by using * the optional MaxResults parameter to limit the number of data repository associations * returned in a response. If more data repository associations remain, a * NextToken value is returned in the response. In this case, send a later * request with the NextToken request parameter set to the value of * NextToken from the last response.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { FSxClient, DescribeDataRepositoryAssociationsCommand } from "@aws-sdk/client-fsx"; // ES Modules import * // const { FSxClient, DescribeDataRepositoryAssociationsCommand } = require("@aws-sdk/client-fsx"); // CommonJS import * // import type { FSxClientConfig } from "@aws-sdk/client-fsx"; * const config = {}; // type is FSxClientConfig * const client = new FSxClient(config); * const input = { // DescribeDataRepositoryAssociationsRequest * AssociationIds: [ // DataRepositoryAssociationIds * "STRING_VALUE", * ], * Filters: [ // Filters * { // Filter * Name: "file-system-id" || "backup-type" || "file-system-type" || "volume-id" || "data-repository-type" || "file-cache-id" || "file-cache-type", * Values: [ // FilterValues * "STRING_VALUE", * ], * }, * ], * MaxResults: Number("int"), * NextToken: "STRING_VALUE", * }; * const command = new DescribeDataRepositoryAssociationsCommand(input); * const response = await client.send(command); * // { // DescribeDataRepositoryAssociationsResponse * // Associations: [ // DataRepositoryAssociations * // { // DataRepositoryAssociation * // AssociationId: "STRING_VALUE", * // ResourceARN: "STRING_VALUE", * // FileSystemId: "STRING_VALUE", * // Lifecycle: "CREATING" || "AVAILABLE" || "MISCONFIGURED" || "UPDATING" || "DELETING" || "FAILED", * // FailureDetails: { // DataRepositoryFailureDetails * // Message: "STRING_VALUE", * // }, * // FileSystemPath: "STRING_VALUE", * // DataRepositoryPath: "STRING_VALUE", * // BatchImportMetaDataOnCreate: true || false, * // ImportedFileChunkSize: Number("int"), * // S3: { // S3DataRepositoryConfiguration * // AutoImportPolicy: { // AutoImportPolicy * // Events: [ // EventTypes * // "NEW" || "CHANGED" || "DELETED", * // ], * // }, * // AutoExportPolicy: { // AutoExportPolicy * // Events: [ * // "NEW" || "CHANGED" || "DELETED", * // ], * // }, * // }, * // Tags: [ // Tags * // { // Tag * // Key: "STRING_VALUE", // required * // Value: "STRING_VALUE", // required * // }, * // ], * // CreationTime: new Date("TIMESTAMP"), * // FileCacheId: "STRING_VALUE", * // FileCachePath: "STRING_VALUE", * // DataRepositorySubdirectories: [ // SubDirectoriesPaths * // "STRING_VALUE", * // ], * // NFS: { // NFSDataRepositoryConfiguration * // Version: "NFS3", // required * // DnsIps: [ // RepositoryDnsIps * // "STRING_VALUE", * // ], * // AutoExportPolicy: { * // Events: [ * // "NEW" || "CHANGED" || "DELETED", * // ], * // }, * // }, * // }, * // ], * // NextToken: "STRING_VALUE", * // }; * * ``` * * @param DescribeDataRepositoryAssociationsCommandInput - {@link DescribeDataRepositoryAssociationsCommandInput} * @returns {@link DescribeDataRepositoryAssociationsCommandOutput} * @see {@link DescribeDataRepositoryAssociationsCommandInput} for command's `input` shape. * @see {@link DescribeDataRepositoryAssociationsCommandOutput} for command's `response` shape. * @see {@link FSxClientResolvedConfig | config} for FSxClient's `config` shape. * * @throws {@link BadRequest} (client fault) *

A generic error indicating a failure with a client request.

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

No data repository associations were found based upon the supplied parameters.

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

No Amazon FSx file systems were found based upon supplied parameters.

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

A generic error indicating a server-side failure.

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

You have filtered the response to a data repository type that is not supported.

* * @throws {@link FSxServiceException} *

Base exception class for all service exceptions from FSx service.

* * * @public */ export declare class DescribeDataRepositoryAssociationsCommand extends DescribeDataRepositoryAssociationsCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: DescribeDataRepositoryAssociationsRequest; output: DescribeDataRepositoryAssociationsResponse; }; sdk: { input: DescribeDataRepositoryAssociationsCommandInput; output: DescribeDataRepositoryAssociationsCommandOutput; }; }; }