ReleaseFileSystemNfsV3Locks

Releases the ﬁle system lock from an Amazon FSx for OpenZFS ﬁle system.

Request Syntax

{ "ClientRequestToken": "string", "FileSystemId": "string"

}

Request Parameters

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

The request accepts the following data in JSON format.

ClientRequestToken (p. 161)

(Optional) An idempotency token for resource creation, in a string of up to 64 ASCII characters. This token is automatically ﬁlled 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 FileSystemId (p. 161)

The globally unique ID of the ﬁle system, assigned by Amazon FSx.

Type: String

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

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

Required: Yes

Response Syntax

{ "FileSystem": {

"AdministrativeActions": [ {

"AdministrativeActionType": "string", "FailureDetails": {

"Message": "string"

"ProgressPercent": number, "RequestTime": number,

Response Syntax

"FileSystemId": "string", "FileSystemType": "string", "FileSystemTypeVersion": "string", "KmsKeyId": "string",

"Lifecycle": "string", "LustreConfiguration": {

"AutomaticBackupRetentionDays": number, "CopyTagsToBackups": boolean,

"DailyAutomaticBackupStartTime": "string", "DataCompressionType": "string",

"DataRepositoryConfiguration": {

"PerUnitStorageThroughput": number, "WeeklyMaintenanceStartTime": "string"

"NetworkInterfaceIds": [ "string" ], "OntapConfiguration": {

"AutomaticBackupRetentionDays": number, "DailyAutomaticBackupStartTime": "string", "DeploymentType": "string",

"DiskIopsConfiguration": {

Response Syntax

"Iops": number, "Mode": "string"

"EndpointIpAddressRange": "string", "Endpoints": {

"WeeklyMaintenanceStartTime": "string"

"OpenZFSConfiguration": {

"AutomaticBackupRetentionDays": number, "CopyTagsToBackups": boolean,

"CopyTagsToVolumes": boolean,

"DailyAutomaticBackupStartTime": "string", "DeploymentType": "string",

"WeeklyMaintenanceStartTime": "string"

"OwnerId": "string", "ResourceARN": "string", "StorageCapacity": number, "StorageType": "string", "SubnetIds": [ "string" ], "FileShareAccessAuditLogLevel": "string"

"AutomaticBackupRetentionDays": number, "CopyTagsToBackups": boolean,

"DailyAutomaticBackupStartTime": "string", "DeploymentType": "string",

"MaintenanceOperationsInProgress": [ "string" ], "PreferredFileServerIp": "string",

"PreferredSubnetId": "string",

"RemoteAdministrationEndpoint": "string",

Response Elements

"SelfManagedActiveDirectoryConfiguration": { "DnsIps": [ "string" ],

"DomainName": "string",

"FileSystemAdministratorsGroup": "string", "OrganizationalUnitDistinguishedName": "string", "UserName": "string"

"ThroughputCapacity": number,

"WeeklyMaintenanceStartTime": "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.

FileSystem (p. 161)

A description of a speciﬁc Amazon FSx ﬁle system.

Type: FileSystem (p. 264) object

Errors

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

BadRequest

A generic error indicating a failure with a client request.

HTTP Status Code: 400 FileSystemNotFound

No Amazon FSx ﬁle systems 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 diﬀerent 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 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

See Also

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

• AWS Command Line Interface

• AWS SDK for .NET

• AWS SDK for C++

• AWS SDK for Go

• AWS SDK for Java V2

• AWS SDK for JavaScript

• AWS SDK for PHP V3

• AWS SDK for Python

• AWS SDK for Ruby V3

RestoreVolumeFromSnapshot

Returns an Amazon FSx for OpenZFS volume to the state saved by the speciﬁed snapshot.

Request Syntax

{ "ClientRequestToken": "string", "Options": [ "string" ], "SnapshotId": "string", "VolumeId": "string"

}

Request Parameters

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

The request accepts the following data in JSON format.

ClientRequestToken (p. 167)

Type: String

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

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

Required: No Options (p. 167)

The settings used when restoring the speciﬁed volume from snapshot.

• DELETE_INTERMEDIATE_SNAPSHOTS - Deletes snapshots between the current state and the speciﬁed snapshot. If there are intermediate snapshots and this option isn't used, RestoreVolumeFromSnapshot fails.

• DELETE_CLONED_VOLUMES - Deletes any volumes cloned from this volume. If there are any cloned volumes and this option isn't used, RestoreVolumeFromSnapshot fails.

Type: Array of strings

Array Members: Maximum number of 2 items.

Valid Values: DELETE_INTERMEDIATE_SNAPSHOTS | DELETE_CLONED_VOLUMES Required: No

SnapshotId (p. 167)

The ID of the source snapshot. Speciﬁes the snapshot that you are restoring from.

Type: String

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

Response Syntax

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

Required: Yes VolumeId (p. 167)

The ID of the volume that you are restoring.

Type: String

Length Constraints: Fixed length of 23.

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

Required: Yes

Response Syntax

{

"Lifecycle": "string", "VolumeId": "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.

Lifecycle (p. 168)

The lifecycle state of the volume being restored.

Type: String

| AVAILABLE VolumeId (p. 168)

The ID of the volume that you restored.

Type: String

Length Constraints: Fixed length of 23.

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

Errors

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

BadRequest

A generic error indicating a failure with a client request.

HTTP Status Code: 400

See Also

InternalServerError

A generic error indicating a server-side failure.

HTTP Status Code: 500 VolumeNotFound

No Amazon FSx volumes were found based upon the supplied parameters.

HTTP Status Code: 400

Request Syntax

{ "ResourceARN": "string", "Tags": [

{

"Key": "string", "Value": "string"

} ]}

Request Parameters

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

The request accepts the following data in JSON format.

ResourceARN (p. 170)

The Amazon Resource Name (ARN) of the Amazon FSx resource that you want to tag.

Type: String

Length Constraints: Minimum length of 8. Maximum length of 512.

Pattern: ^arn:(?=[^:]+:fsx:[^:]+:\d{12}:)((|(?=[a-z0-9-.]{1,63})(?!\d{1,3}

(\.\d{1,3}){3})(?![^:]*-{2})(?![^:]*-\.)(?![^:]*\.-)[a-z0-9].*(?<!-)):){4}

(?!/).{0,1024}$

Required: Yes Tags (p. 170)

A list of tags for the resource. If a tag with a given key already exists, the value is replaced by the one speciﬁed in this parameter.

Type: Array of Tag (p. 315) objects

Array Members: Minimum number of 1 item. Maximum number of 50 items.

Required: Yes

Response Elements

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

Errors

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

See Also

BadRequest

A generic error indicating a failure with a client request.

HTTP Status Code: 400 InternalServerError

A generic error indicating a server-side failure.

HTTP Status Code: 500 NotServiceResourceError

The resource speciﬁed for the tagging operation is not a resource type owned by Amazon FSx. Use the API of the relevant service to perform the operation.

HTTP Status Code: 400 ResourceDoesNotSupportTagging

The resource speciﬁed does not support tagging.

HTTP Status Code: 400 ResourceNotFound

The resource speciﬁed by the Amazon Resource Name (ARN) can't be found.

HTTP Status Code: 400

Request Syntax

{

"ResourceARN": "string", "TagKeys": [ "string" ] }

Request Parameters

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

The request accepts the following data in JSON format.

ResourceARN (p. 172)

The ARN of the Amazon FSx resource to untag.

Type: String

Length Constraints: Minimum length of 8. Maximum length of 512.

Pattern: ^arn:(?=[^:]+:fsx:[^:]+:\d{12}:)((|(?=[a-z0-9-.]{1,63})(?!\d{1,3}

(\.\d{1,3}){3})(?![^:]*-{2})(?![^:]*-\.)(?![^:]*\.-)[a-z0-9].*(?<!-)):){4}

(?!/).{0,1024}$

Required: Yes TagKeys (p. 172)

A list of keys of tags on the resource to untag. In case the tag key doesn't exist, the call will still succeed to be idempotent.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 50 items.

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

Pattern: ^([\p{L}\p{Z}\p{N}_.:/=+\-@]*)$

Required: Yes

Response Elements

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

Errors

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

See Also

BadRequest

A generic error indicating a failure with a client request.

HTTP Status Code: 400 InternalServerError

A generic error indicating a server-side failure.

HTTP Status Code: 500 NotServiceResourceError

The resource speciﬁed for the tagging operation is not a resource type owned by Amazon FSx. Use the API of the relevant service to perform the operation.

HTTP Status Code: 400 ResourceDoesNotSupportTagging

The resource speciﬁed does not support tagging.

HTTP Status Code: 400 ResourceNotFound

The resource speciﬁed by the Amazon Resource Name (ARN) can't be found.

HTTP Status Code: 400

Request Syntax

{

"AssociationId": "string", "ClientRequestToken": "string", "ImportedFileChunkSize": number, "S3": {

"AutoExportPolicy": { "Events": [ "string" ] },

"AutoImportPolicy": { "Events": [ "string" ] }

}}

Request Parameters

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

The request accepts the following data in JSON format.

AssociationId (p. 174)

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

Type: String

Length Constraints: Minimum length of 13. Maximum length of 23.

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

Required: Yes

ClientRequestToken (p. 174)

Type: String

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

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

Required: No

ImportedFileChunkSize (p. 174)

For ﬁles imported from a data repository, this value determines the stripe count and maximum amount of data per ﬁle (in MiB) stored on a single physical disk. The maximum number of disks

Response Syntax

that a single ﬁle can be striped across is limited by the total number of disks that make up the ﬁle 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.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 512000.

Required: No S3 (p. 174)

The conﬁguration for an Amazon S3 data repository linked to an Amazon FSx Lustre ﬁle system with a data repository association. The conﬁguration deﬁnes which ﬁle events (new, changed, or deleted ﬁles or directories) are automatically imported from the linked data repository to the ﬁle system or automatically exported from the ﬁle system to the data repository.

Type: S3DataRepositoryConﬁguration (p. 298) object Required: No

Response Syntax

{

"Association": {

"AssociationId": "string",

"BatchImportMetaDataOnCreate": boolean, "CreationTime": number,

"DataRepositoryPath": "string", "FailureDetails": {

"Message": "string"

"FileSystemId": "string", "FileSystemPath": "string", "ImportedFileChunkSize": number, "Lifecycle": "string",

"ResourceARN": "string", "S3": {

"AutoExportPolicy": { "Events": [ "string" ] },

"AutoImportPolicy": { "Events": [ "string" ] }

"Tags": [ {

"Key": "string", "Value": "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.

Errors

Association (p. 175)

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

Type: DataRepositoryAssociation (p. 241) object

Errors

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

BadRequest

A generic error indicating a failure with a client request.

HTTP Status Code: 400

DataRepositoryAssociationNotFound

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

HTTP Status Code: 400 IncompatibleParameterError

The error returned when a second request is received with the same client request token but diﬀerent 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 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

Request Syntax

{ "ClientRequestToken": "string", "FileSystemId": "string", "LustreConfiguration": {

Request Parameters

"AutoImportPolicy": "string",

"AutomaticBackupRetentionDays": number, "DailyAutomaticBackupStartTime": "string", "DataCompressionType": "string",

"LogConfiguration": { "Destination": "string", "Level": "string"

"WeeklyMaintenanceStartTime": "string"

"OntapConfiguration": {

"AutomaticBackupRetentionDays": number, "DailyAutomaticBackupStartTime": "string", "DiskIopsConfiguration": {

"Iops": number, "Mode": "string"

"FsxAdminPassword": "string",

"WeeklyMaintenanceStartTime": "string"

"OpenZFSConfiguration": {

"AutomaticBackupRetentionDays": number, "CopyTagsToBackups": boolean,

"CopyTagsToVolumes": boolean,

"DailyAutomaticBackupStartTime": "string", "DiskIopsConfiguration": {

"Iops": number, "Mode": "string"

"ThroughputCapacity": number,

"WeeklyMaintenanceStartTime": "string"

"StorageCapacity": number, "WindowsConfiguration": { "AuditLogConfiguration": {

"AuditLogDestination": "string", "FileAccessAuditLogLevel": "string", "FileShareAccessAuditLogLevel": "string"

"AutomaticBackupRetentionDays": number, "DailyAutomaticBackupStartTime": "string", "SelfManagedActiveDirectoryConfiguration": { "DnsIps": [ "string" ],

"Password": "string", "UserName": "string"

"ThroughputCapacity": number,

"WeeklyMaintenanceStartTime": "string"

} }

Request Parameters

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

The request accepts the following data in JSON format.

ClientRequestToken (p. 177)

A string of up to 64 ASCII characters that Amazon FSx uses to ensure idempotent updates. This string is automatically ﬁlled on your behalf when you use the AWS Command Line Interface (AWS CLI) or an AWS SDK.

Request Parameters

Type: String

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

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

Required: No FileSystemId (p. 177)

The ID of the ﬁle system that you are updating.

Type: String

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

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

Required: Yes

LustreConﬁguration (p. 177)

The conﬁguration object for Amazon FSx for Lustre ﬁle systems used in the UpdateFileSystem operation.

Type: UpdateFileSystemLustreConﬁguration (p. 318) object Required: No

OntapConﬁguration (p. 177)

The conﬁguration updates for an Amazon FSx for NetApp ONTAP ﬁle system.

Type: UpdateFileSystemOntapConﬁguration (p. 320) object Required: No

OpenZFSConﬁguration (p. 177)

The conﬁguration updates for an Amazon FSx for OpenZFS ﬁle system.

Type: UpdateFileSystemOpenZFSConﬁguration (p. 322) object Required: No

StorageCapacity (p. 177)

Use this parameter to increase the storage capacity of an Amazon FSx for Windows File Server, Amazon FSx for Lustre, or Amazon FSx for NetApp ONTAP ﬁle system. Speciﬁes the storage capacity target value, in GiB, to increase the storage capacity for the ﬁle system that you're updating.

Note

You can't make a storage capacity increase request if there is an existing storage capacity increase request in progress.

For Windows ﬁle systems, the storage capacity target value must be at least 10 percent greater than the current storage capacity value. To increase storage capacity, the ﬁle system must have at least 16 MBps of throughput capacity. For more information, see Managing storage capacity in the Amazon FSx for Windows File Server User Guide.

For Lustre ﬁle systems, the storage capacity target value can be the following:

• For SCRATCH_2, PERSISTENT_1, and PERSISTENT_2 SSD deployment types, valid values are in multiples of 2400 GiB. The value must be greater than the current storage capacity.

Response Syntax

• For PERSISTENT HDD ﬁle systems, valid values are multiples of 6000 GiB for 12-MBps throughput per TiB ﬁle systems and multiples of 1800 GiB for 40-MBps throughput per TiB ﬁle systems. The values must be greater than the current storage capacity.

• For SCRATCH_1 ﬁle systems, you can't increase the storage capacity.

For more information, see Managing storage and throughput capacity in the Amazon FSx for Lustre User Guide.

For ONTAP ﬁle systems, the storage capacity target value must be at least 10 percent greater than the current storage capacity value. For more information, see Managing storage capacity and provisioned IOPS in the Amazon FSx for NetApp ONTAP User Guide.

Type: Integer

Valid Range: Minimum value of 0. Maximum value of 2147483647.

Required: No

WindowsConﬁguration (p. 177)

The conﬁguration updates for an Amazon FSx for Windows File Server ﬁle system.

Type: UpdateFileSystemWindowsConﬁguration (p. 324) object Required: No

Response Syntax

{ "FileSystem": {

"AdministrativeActions": [ {

"AdministrativeActionType": "string", "FailureDetails": {

"Message": "string"

"ProgressPercent": number, "RequestTime": number, "Status": "string",

"TargetFileSystemValues": "FileSystem", "TargetSnapshotValues": {

"AdministrativeActions": [ "AdministrativeAction"

"CreationTime": number, "Lifecycle": "string",

"LifecycleTransitionReason": { "Message": "string"

"Name": "string", "ResourceARN": "string", "SnapshotId": "string", "Tags": [

{

"Key": "string", "Value": "string"

} ],

"VolumeId": "string"

"TargetVolumeValues": { "AdministrativeActions": [

Response Syntax

"FileSystemId": "string", "FileSystemType": "string", "FileSystemTypeVersion": "string", "KmsKeyId": "string",

"Lifecycle": "string", "LustreConfiguration": {

"AutomaticBackupRetentionDays": number, "CopyTagsToBackups": boolean,

"DailyAutomaticBackupStartTime": "string", "DataCompressionType": "string",

"DataRepositoryConfiguration": {

"PerUnitStorageThroughput": number, "WeeklyMaintenanceStartTime": "string"

"NetworkInterfaceIds": [ "string" ], "OntapConfiguration": {

"AutomaticBackupRetentionDays": number, "DailyAutomaticBackupStartTime": "string", "DeploymentType": "string",

"DiskIopsConfiguration": { "Iops": number,

"Mode": "string"

"EndpointIpAddressRange": "string", "Endpoints": {

"WeeklyMaintenanceStartTime": "string"

"OpenZFSConfiguration": {

"AutomaticBackupRetentionDays": number, "CopyTagsToBackups": boolean,

"CopyTagsToVolumes": boolean,

"DailyAutomaticBackupStartTime": "string",

Response Elements

"WeeklyMaintenanceStartTime": "string"

"OwnerId": "string", "ResourceARN": "string", "StorageCapacity": number, "StorageType": "string", "SubnetIds": [ "string" ], "FileShareAccessAuditLogLevel": "string"

"AutomaticBackupRetentionDays": number, "CopyTagsToBackups": boolean,

"DailyAutomaticBackupStartTime": "string", "DeploymentType": "string",

"MaintenanceOperationsInProgress": [ "string" ], "PreferredFileServerIp": "string",

"PreferredSubnetId": "string",

"RemoteAdministrationEndpoint": "string", "SelfManagedActiveDirectoryConfiguration": { "DnsIps": [ "string" ],

"DomainName": "string",

"FileSystemAdministratorsGroup": "string", "OrganizationalUnitDistinguishedName": "string", "UserName": "string"

"ThroughputCapacity": number,

"WeeklyMaintenanceStartTime": "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.

FileSystem (p. 180)

A description of the ﬁle system that was updated.

Errors

Type: FileSystem (p. 264) object

Errors

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

BadRequest

A generic error indicating a failure with a client request.

HTTP Status Code: 400 FileSystemNotFound

No Amazon FSx ﬁle systems 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 diﬀerent 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 MissingFileSystemConﬁguration

A ﬁle system conﬁguration 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

Request Syntax

{ "ClientRequestToken": "string", "Name": "string",

"SnapshotId": "string"

}

Request Parameters

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

The request accepts the following data in JSON format.

ClientRequestToken (p. 186)

Type: String

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

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

Required: No Name (p. 186)

The name of the snapshot to update.

Type: String

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

在文檔中 Amazon FSx (頁 172-200)

ReleaseFileSystemNfsV3Locks