DescribeStorageSystem
Returns information about an on-premises storage system that you're using with DataSync Discovery.
Request Syntax
{
"StorageSystemArn": "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.
- StorageSystemArn
-
Specifies the Amazon Resource Name (ARN) of an on-premises storage system that you're using with DataSync Discovery.
Type: String
Length Constraints: Maximum length of 128.
Pattern:
^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:system/storage-system-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$Required: Yes
Response Syntax
{
"AgentArns": [ "string" ],
"CloudWatchLogGroupArn": "string",
"ConnectivityStatus": "string",
"CreationTime": number,
"ErrorMessage": "string",
"Name": "string",
"SecretsManagerArn": "string",
"ServerConfiguration": {
"ServerHostname": "string",
"ServerPort": number
},
"StorageSystemArn": "string",
"SystemType": "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.
- AgentArns
-
The ARN of the DataSync agent that connects to and reads from your on-premises storage system.
Type: Array of strings
Array Members: Fixed number of 1 item.
Length Constraints: Maximum length of 128.
Pattern:
^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:agent/agent-[0-9a-z]{17}$ - CloudWatchLogGroupArn
-
The ARN of the Amazon CloudWatch log group that's used to monitor and log discovery job events.
Type: String
Length Constraints: Maximum length of 562.
Pattern:
^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):logs:[a-z\-0-9]+:[0-9]{12}:log-group:([^:\*]*)(:\*)?$ - ConnectivityStatus
-
Indicates whether your DataSync agent can connect to your on-premises storage system.
Type: String
Valid Values:
PASS | FAIL | UNKNOWN - CreationTime
-
The time when you added the on-premises storage system to DataSync Discovery.
Type: Timestamp
- ErrorMessage
-
Describes the connectivity error that the DataSync agent is encountering with your on-premises storage system.
Type: String
Length Constraints: Maximum length of 128.
Pattern:
.* - Name
-
The name that you gave your on-premises storage system when adding it to DataSync Discovery.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Pattern:
^[\p{L}\p{M}\p{N}\s+=._:@\/-]+$ - SecretsManagerArn
-
The ARN of the secret that stores your on-premises storage system's credentials. DataSync Discovery stores these credentials in AWS Secrets Manager.
Type: String
Length Constraints: Maximum length of 2048.
Pattern:
^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):secretsmanager:[a-z\-0-9]+:[0-9]{12}:secret:.* - ServerConfiguration
-
The server name and network port required to connect with your on-premises storage system's management interface.
Type: DiscoveryServerConfiguration object
- StorageSystemArn
-
The ARN of the on-premises storage system that the discovery job looked at.
Type: String
Length Constraints: Maximum length of 128.
Pattern:
^arn:(aws|aws-cn|aws-us-gov|aws-iso|aws-iso-b):datasync:[a-z\-0-9]+:[0-9]{12}:system/storage-system-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$ - SystemType
-
The type of on-premises storage system.
Note
DataSync Discovery currently only supports NetApp Fabric-Attached Storage (FAS) and All Flash FAS (AFF) systems running ONTAP 9.7 or later.
Type: String
Valid Values:
NetAppONTAP
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalException
-
This exception is thrown when an error occurs in the AWS DataSync service.
HTTP Status Code: 500
- InvalidRequestException
-
This exception is thrown when the client submits a malformed request.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
