UpdateFileCache - Amazon FSx

UpdateFileCache

Updates the configuration of an existing Amazon File Cache resource. You can update multiple properties in a single request.

Request Syntax

{ "ClientRequestToken": "string", "FileCacheId": "string", "LustreConfiguration": { "WeeklyMaintenanceStartTime": "string" } }

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

ClientRequestToken

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

Type: String

Length Constraints: Minimum length of 1. Maximum length of 63.

Pattern: [A-za-z0-9_.-]{0,63}$

Required: No

FileCacheId

The ID of the cache that you are updating.

Type: String

Length Constraints: Minimum length of 11. Maximum length of 21.

Pattern: ^(fc-[0-9a-f]{8,})$

Required: Yes

LustreConfiguration

The configuration updates for an Amazon File Cache resource.

Type: UpdateFileCacheLustreConfiguration object

Required: No

Response Syntax

{ "FileCache": { "CreationTime": number, "DataRepositoryAssociationIds": [ "string" ], "DNSName": "string", "FailureDetails": { "Message": "string" }, "FileCacheId": "string", "FileCacheType": "string", "FileCacheTypeVersion": "string", "KmsKeyId": "string", "Lifecycle": "string", "LustreConfiguration": { "DeploymentType": "string", "LogConfiguration": { "Destination": "string", "Level": "string" }, "MetadataConfiguration": { "StorageCapacity": number }, "MountName": "string", "PerUnitStorageThroughput": number, "WeeklyMaintenanceStartTime": "string" }, "NetworkInterfaceIds": [ "string" ], "OwnerId": "string", "ResourceARN": "string", "StorageCapacity": number, "SubnetIds": [ "string" ], "VpcId": "string" } }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

FileCache

A description of the cache that was updated.

Type: FileCache object

Errors

For information about the errors that are common to all actions, see Common Errors.

BadRequest

A generic error indicating a failure with a client request.

HTTP Status Code: 400

FileCacheNotFound

No caches were found based upon supplied parameters.

HTTP Status Code: 400

IncompatibleParameterError

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.

HTTP Status Code: 400

InternalServerError

A generic error indicating a server-side failure.

HTTP Status Code: 500

MissingFileCacheConfiguration

A cache configuration is required for this operation.

HTTP Status Code: 400

ServiceLimitExceeded

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

HTTP Status Code: 400

UnsupportedOperation

The requested operation is not supported for this resource or API.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: