UpdateDataRepositoryAssociationCommand

Suggest an Edit

Updates the configuration of an existing data repository association on an Amazon FSx for Lustre file system. Data repository associations are supported on all FSx for Lustre 2.12 and 2.15 file systems, excluding scratch_1 deployment type.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { FSxClient, UpdateDataRepositoryAssociationCommand } from "@aws-sdk/client-fsx"; // ES Modules import
// const { FSxClient, UpdateDataRepositoryAssociationCommand } = require("@aws-sdk/client-fsx"); // CommonJS import
const client = new FSxClient(config);
const input = { // UpdateDataRepositoryAssociationRequest
  AssociationId: "STRING_VALUE", // required
  ClientRequestToken: "STRING_VALUE",
  ImportedFileChunkSize: Number("int"),
  S3: { // S3DataRepositoryConfiguration
    AutoImportPolicy: { // AutoImportPolicy
      Events: [ // EventTypes
        "NEW" || "CHANGED" || "DELETED",
      ],
    },
    AutoExportPolicy: { // AutoExportPolicy
      Events: [
        "NEW" || "CHANGED" || "DELETED",
      ],
    },
  },
};
const command = new UpdateDataRepositoryAssociationCommand(input);
const response = await client.send(command);
// { // UpdateDataRepositoryAssociationResponse
//   Association: { // 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",
//         ],
//       },
//     },
//   },
// };

UpdateDataRepositoryAssociationCommand Input

See UpdateDataRepositoryAssociationCommandInput for more details

Parameter
Type
Description
AssociationId
Required
string | undefined

The ID of the data repository association that you are updating.

ClientRequestToken
string | undefined

(Optional) An idempotency token for resource creation, in a string of up to 63 ASCII characters. This token is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.

ImportedFileChunkSize
number | undefined

For files imported from a data repository, this value determines the stripe count and maximum amount of data per file (in MiB) stored on a single physical disk. The maximum number of disks that a single file can be striped across is limited by the total number of disks that make up the file system.

The default chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB (500 GiB). Amazon S3 objects have a maximum size of 5 TB.

S3
S3DataRepositoryConfiguration | undefined

The configuration for an Amazon S3 data repository linked to an Amazon FSx Lustre file system with a data repository association. The configuration defines which file events (new, changed, or deleted files or directories) are automatically imported from the linked data repository to the file system or automatically exported from the file system to the data repository.

UpdateDataRepositoryAssociationCommand Output

See UpdateDataRepositoryAssociationCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
Association
DataRepositoryAssociation | undefined

The response object returned after the data repository association is updated.

Throws

Name
Fault
Details
BadRequest
client

A generic error indicating a failure with a client request.

DataRepositoryAssociationNotFound
client

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

IncompatibleParameterError
client

The error returned when a second request is received with the same client request token but different parameters settings. A client request token should always uniquely identify a single request.

InternalServerError
server

A generic error indicating a server-side failure.

ServiceLimitExceeded
client

An error indicating that a particular service limit was exceeded. You can increase some service limits by contacting Amazon Web Services Support.

FSxServiceException
Base exception class for all service exceptions from FSx service.