DataSync / Client / describe_storage_system



Returns information about an on-premises storage system that you’re using with DataSync Discovery.

See also: AWS API Documentation

Request Syntax

response = client.describe_storage_system(

StorageSystemArn (string) –


Specifies the Amazon Resource Name (ARN) of an on-premises storage system that you’re using with DataSync Discovery.

Return type:



Response Syntax

    'StorageSystemArn': 'string',
    'ServerConfiguration': {
        'ServerHostname': 'string',
        'ServerPort': 123
    'SystemType': 'NetAppONTAP',
    'AgentArns': [
    'Name': 'string',
    'ErrorMessage': 'string',
    'ConnectivityStatus': 'PASS'|'FAIL'|'UNKNOWN',
    'CloudWatchLogGroupArn': 'string',
    'CreationTime': datetime(2015, 1, 1),
    'SecretsManagerArn': 'string'

Response Structure

  • (dict) –

    • StorageSystemArn (string) –

      The ARN of the on-premises storage system that the discovery job looked at.

    • ServerConfiguration (dict) –

      The server name and network port required to connect with your on-premises storage system’s management interface.

      • ServerHostname (string) –

        The domain name or IP address of your storage system’s management interface.

      • ServerPort (integer) –

        The network port for accessing the storage system’s management interface.

    • SystemType (string) –

      The type of on-premises storage system.


      DataSync Discovery currently only supports NetApp Fabric-Attached Storage (FAS) and All Flash FAS (AFF) systems running ONTAP 9.7 or later.

    • AgentArns (list) –

      The ARN of the DataSync agent that connects to and reads from your on-premises storage system.

      • (string) –

    • Name (string) –

      The name that you gave your on-premises storage system when adding it to DataSync Discovery.

    • ErrorMessage (string) –

      Describes the connectivity error that the DataSync agent is encountering with your on-premises storage system.

    • ConnectivityStatus (string) –

      Indicates whether your DataSync agent can connect to your on-premises storage system.

    • CloudWatchLogGroupArn (string) –

      The ARN of the Amazon CloudWatch log group that’s used to monitor and log discovery job events.

    • CreationTime (datetime) –

      The time when you added the on-premises storage system to DataSync Discovery.

    • SecretsManagerArn (string) –

      The ARN of the secret that stores your on-premises storage system’s credentials. DataSync Discovery stores these credentials in Secrets Manager.


  • DataSync.Client.exceptions.InvalidRequestException

  • DataSync.Client.exceptions.InternalException