FSx / Client / delete_data_repository_association

delete_data_repository_association#

FSx.Client.delete_data_repository_association(**kwargs)#

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 for all file systems except for Scratch_1 deployment type.

See also: AWS API Documentation

Request Syntax

response = client.delete_data_repository_association(
    AssociationId='string',
    ClientRequestToken='string',
    DeleteDataInFileSystem=True|False
)
Parameters:

  • AssociationId (string) –

    [REQUIRED]

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

  • ClientRequestToken (string) –

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

    This field is autopopulated if not provided.

  • DeleteDataInFileSystem (boolean) – Set to true to delete the data in the file system that corresponds to the data repository association.

Return type:

dict

Returns:

Response Syntax

{
    'AssociationId': 'string',
    'Lifecycle': 'CREATING'|'AVAILABLE'|'MISCONFIGURED'|'UPDATING'|'DELETING'|'FAILED',
    'DeleteDataInFileSystem': True|False
}

Response Structure

  • (dict) –

    • AssociationId (string) –

      The ID of the data repository association being deleted.

    • Lifecycle (string) –

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

    • DeleteDataInFileSystem (boolean) –

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

Exceptions

  • FSx.Client.exceptions.BadRequest

  • FSx.Client.exceptions.IncompatibleParameterError

  • FSx.Client.exceptions.DataRepositoryAssociationNotFound

  • FSx.Client.exceptions.ServiceLimitExceeded

  • FSx.Client.exceptions.InternalServerError