DeleteDataRepositoryAssociation - Amazon FSx

DeleteDataRepositoryAssociation

Deletes a data repository association on an Amazon FSx for Lustre file system. Deleting the data repository association unlinks the file system from the Amazon S3 bucket. When deleting a data repository association, you have the option of deleting the data in the file system that corresponds to the data repository association. Data repository associations are supported only for file systems with the Persistent_2 deployment type.

Request Syntax

{ "AssociationId": "string", "ClientRequestToken": "string", "DeleteDataInFileSystem": boolean }

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.

AssociationId

The ID of the data repository association that you want to delete.

Type: String

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

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

Required: Yes

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

DeleteDataInFileSystem

Set to true to delete the data in the file system that corresponds to the data repository association.

Type: Boolean

Required: Yes

Response Syntax

{ "AssociationId": "string", "DeleteDataInFileSystem": boolean, "Lifecycle": "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.

AssociationId

The ID of the data repository association being deleted.

Type: String

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

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

DeleteDataInFileSystem

Indicates whether data in the file system that corresponds to the data repository association is being deleted. Default is false.

Type: Boolean

Lifecycle

Describes the lifecycle state of the data repository association being deleted.

Type: String

Valid Values: CREATING | AVAILABLE | MISCONFIGURED | UPDATING | DELETING | FAILED

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

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 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

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-specific AWS SDKs, see the following: