@aws-sdk/client-fsx 3.180.0 → 3.183.0

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

@@ -7,23 +7,25 @@ export interface DescribeDataRepositoryAssociationsCommandInput extends Describe
 export interface DescribeDataRepositoryAssociationsCommandOutput extends DescribeDataRepositoryAssociationsResponse, __MetadataBearer {
 }
 /**
- * <p>Returns the description of specific Amazon FSx for Lustre data repository associations, if
- *             one or more <code>AssociationIds</code> values are provided in the request, or if filters are
- *             used in the request. Data repository associations are supported only
- *             for file systems with the <code>Persistent_2</code> deployment type.</p>
+ * <p>Returns the description of specific Amazon FSx for Lustre or Amazon File Cache
+ *             data repository associations, if one or more <code>AssociationIds</code> values
+ *             are provided in the request, or if filters are used in the request. Data repository
+ *             associations are supported only for Amazon FSx for Lustre file systems with the
+ *             <code>Persistent_2</code> deployment type and for Amazon File Cache resources.</p>
  *
  *         <p>You can use filters to narrow the response to include just data repository
  *             associations for specific file systems (use the <code>file-system-id</code> filter with
- *             the ID of the file system) or data repository associations for a specific repository type
- *             (use the <code>data-repository-type</code> filter with a value of <code>S3</code>).
- *             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.</p>
+ *             the ID of the file system) or caches (use the <code>file-cache-id</code> filter with
+ *             the ID of the cache), or data repository associations for a specific repository type
+ *             (use the <code>data-repository-type</code> filter with a value of <code>S3</code>
+ *             or <code>NFS</code>). 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.</p>
  *
  *         <p>When retrieving all data repository associations, you can paginate the response by using
  *             the optional <code>MaxResults</code> parameter to limit the number of data repository associations
- *             returned in a response. If more data repository associations remain, Amazon FSx returns a
- *             <code>NextToken</code> value in the response. In this case, send a later
+ *             returned in a response. If more data repository associations remain, a
+ *             <code>NextToken</code> value is returned in the response. In this case, send a later
  *             request with the <code>NextToken</code> request parameter set to the value of
  *             <code>NextToken</code> from the last response.</p>
  * @example

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

@@ -7,15 +7,15 @@ export interface DescribeDataRepositoryTasksCommandInput extends DescribeDataRep
 export interface DescribeDataRepositoryTasksCommandOutput extends DescribeDataRepositoryTasksResponse, __MetadataBearer {
 }
 /**
- * <p>Returns the description of specific Amazon FSx for Lustre data repository tasks, if
+ * <p>Returns the description of specific Amazon FSx for Lustre or Amazon File Cache data repository tasks, if
  *             one or more <code>TaskIds</code> values are provided in the request, or if filters are used in the request.
- *             You can use filters to narrow the response to include just tasks for specific file systems,
+ *             You can use filters to narrow the response to include just tasks for specific file systems or caches,
  *             or tasks in a specific lifecycle state. Otherwise, it returns all data repository tasks owned
  *             by your Amazon Web Services account in the Amazon Web Services Region of the endpoint that you're calling.</p>
  *
  *         <p>When retrieving all tasks, you can paginate the response by using  the optional <code>MaxResults</code>
- *             parameter to limit the number of tasks returned in a response. If more tasks remain, Amazon
- *             FSx returns a <code>NextToken</code> value in the response. In this case, send a later
+ *             parameter to limit the number of tasks returned in a response. If more tasks remain,
+ *             a <code>NextToken</code> value is returned in the response. In this case, send a later
  *             request with the <code>NextToken</code> request parameter set to the value of
  *             <code>NextToken</code> from the last response.</p>
  * @example

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

@@ -0,0 +1,65 @@
+import { Command as $Command } from "@aws-sdk/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
+import { FSxClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../FSxClient";
+import { DescribeFileCachesRequest, DescribeFileCachesResponse } from "../models/models_0";
+export interface DescribeFileCachesCommandInput extends DescribeFileCachesRequest {
+}
+export interface DescribeFileCachesCommandOutput extends DescribeFileCachesResponse, __MetadataBearer {
+}
+/**
+ * <p>Returns the description of a specific Amazon File Cache resource, if a
+ *             <code>FileCacheIds</code> value is provided for that cache. Otherwise, it
+ *             returns descriptions of all caches owned by your Amazon Web Services account in the
+ *             Amazon Web Services Region of the endpoint that you're calling.</p>
+ *
+ *         <p>When retrieving all cache descriptions, you can optionally specify the
+ *             <code>MaxResults</code> parameter to limit the number of descriptions in a response.
+ *             If more cache descriptions remain, the operation returns a
+ *             <code>NextToken</code> value in the response. In this case, send a later request
+ *             with the <code>NextToken</code> request parameter set to the value of
+ *             <code>NextToken</code> from the last response.</p>
+ *
+ *         <p>This operation is used in an iterative process to retrieve a list of your cache
+ *             descriptions. <code>DescribeFileCaches</code> is called first without a
+ *             <code>NextToken</code>value. Then the operation continues to be called with the
+ *             <code>NextToken</code> parameter set to the value of the last <code>NextToken</code>
+ *             value until a response has no <code>NextToken</code>.</p>
+ *
+ *         <p>When using this operation, keep the following in mind:</p>
+ *         <ul>
+ *             <li>
+ *                 <p>The implementation might return fewer than <code>MaxResults</code>
+ *                     cache descriptions while still including a <code>NextToken</code>
+ *                     value.</p>
+ *             </li>
+ *             <li>
+ *                 <p>The order of caches returned in the response of one
+ *                     <code>DescribeFileCaches</code> call and the order of caches returned
+ *                     across the responses of a multicall iteration is unspecified.</p>
+ *             </li>
+ *          </ul>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { FSxClient, DescribeFileCachesCommand } from "@aws-sdk/client-fsx"; // ES Modules import
+ * // const { FSxClient, DescribeFileCachesCommand } = require("@aws-sdk/client-fsx"); // CommonJS import
+ * const client = new FSxClient(config);
+ * const command = new DescribeFileCachesCommand(input);
+ * const response = await client.send(command);
+ * ```
+ *
+ * @see {@link DescribeFileCachesCommandInput} for command's `input` shape.
+ * @see {@link DescribeFileCachesCommandOutput} for command's `response` shape.
+ * @see {@link FSxClientResolvedConfig | config} for FSxClient's `config` shape.
+ *
+ */
+export declare class DescribeFileCachesCommand extends $Command<DescribeFileCachesCommandInput, DescribeFileCachesCommandOutput, FSxClientResolvedConfig> {
+    readonly input: DescribeFileCachesCommandInput;
+    constructor(input: DescribeFileCachesCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: FSxClientResolvedConfig, options?: __HttpHandlerOptions): Handler<DescribeFileCachesCommandInput, DescribeFileCachesCommandOutput>;
+    private serialize;
+    private deserialize;
+}

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

@@ -31,7 +31,6 @@ export interface DescribeFileSystemsCommandOutput extends DescribeFileSystemsRes
  *                 <p>The implementation might return fewer than <code>MaxResults</code> file
  *                     system descriptions while still including a <code>NextToken</code>
  *                     value.</p>
- *
  *             </li>
  *             <li>
  *                 <p>The order of file systems returned in the response of one

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

@@ -0,0 +1,36 @@
+import { Command as $Command } from "@aws-sdk/smithy-client";
+import { Handler, HttpHandlerOptions as __HttpHandlerOptions, MetadataBearer as __MetadataBearer, MiddlewareStack } from "@aws-sdk/types";
+import { FSxClientResolvedConfig, ServiceInputTypes, ServiceOutputTypes } from "../FSxClient";
+import { UpdateFileCacheRequest, UpdateFileCacheResponse } from "../models/models_0";
+export interface UpdateFileCacheCommandInput extends UpdateFileCacheRequest {
+}
+export interface UpdateFileCacheCommandOutput extends UpdateFileCacheResponse, __MetadataBearer {
+}
+/**
+ * <p>Updates the configuration of an existing Amazon File Cache resource.
+ *             You can update multiple properties in a single request.</p>
+ * @example
+ * Use a bare-bones client and the command you need to make an API call.
+ * ```javascript
+ * import { FSxClient, UpdateFileCacheCommand } from "@aws-sdk/client-fsx"; // ES Modules import
+ * // const { FSxClient, UpdateFileCacheCommand } = require("@aws-sdk/client-fsx"); // CommonJS import
+ * const client = new FSxClient(config);
+ * const command = new UpdateFileCacheCommand(input);
+ * const response = await client.send(command);
+ * ```
+ *
+ * @see {@link UpdateFileCacheCommandInput} for command's `input` shape.
+ * @see {@link UpdateFileCacheCommandOutput} for command's `response` shape.
+ * @see {@link FSxClientResolvedConfig | config} for FSxClient's `config` shape.
+ *
+ */
+export declare class UpdateFileCacheCommand extends $Command<UpdateFileCacheCommandInput, UpdateFileCacheCommandOutput, FSxClientResolvedConfig> {
+    readonly input: UpdateFileCacheCommandInput;
+    constructor(input: UpdateFileCacheCommandInput);
+    /**
+     * @internal
+     */
+    resolveMiddleware(clientStack: MiddlewareStack<ServiceInputTypes, ServiceOutputTypes>, configuration: FSxClientResolvedConfig, options?: __HttpHandlerOptions): Handler<UpdateFileCacheCommandInput, UpdateFileCacheCommandOutput>;
+    private serialize;
+    private deserialize;
+}

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

@@ -4,6 +4,7 @@ export * from "./CopyBackupCommand";
 export * from "./CreateBackupCommand";
 export * from "./CreateDataRepositoryAssociationCommand";
 export * from "./CreateDataRepositoryTaskCommand";
+export * from "./CreateFileCacheCommand";
 export * from "./CreateFileSystemCommand";
 export * from "./CreateFileSystemFromBackupCommand";
 export * from "./CreateSnapshotCommand";
@@ -12,6 +13,7 @@ export * from "./CreateVolumeCommand";
 export * from "./CreateVolumeFromBackupCommand";
 export * from "./DeleteBackupCommand";
 export * from "./DeleteDataRepositoryAssociationCommand";
+export * from "./DeleteFileCacheCommand";
 export * from "./DeleteFileSystemCommand";
 export * from "./DeleteSnapshotCommand";
 export * from "./DeleteStorageVirtualMachineCommand";
@@ -19,6 +21,7 @@ export * from "./DeleteVolumeCommand";
 export * from "./DescribeBackupsCommand";
 export * from "./DescribeDataRepositoryAssociationsCommand";
 export * from "./DescribeDataRepositoryTasksCommand";
+export * from "./DescribeFileCachesCommand";
 export * from "./DescribeFileSystemAliasesCommand";
 export * from "./DescribeFileSystemsCommand";
 export * from "./DescribeSnapshotsCommand";
@@ -31,6 +34,7 @@ export * from "./RestoreVolumeFromSnapshotCommand";
 export * from "./TagResourceCommand";
 export * from "./UntagResourceCommand";
 export * from "./UpdateDataRepositoryAssociationCommand";
+export * from "./UpdateFileCacheCommand";
 export * from "./UpdateFileSystemCommand";
 export * from "./UpdateSnapshotCommand";
 export * from "./UpdateStorageVirtualMachineCommand";