DescribeStorageSystemResources
Returns information that DataSync Discovery collects about resources in your on-premises storage system.
Request Syntax
{
"DiscoveryJobArn": "string",
"Filter": {
"string" : [ "string" ]
},
"MaxResults": number,
"NextToken": "string",
"ResourceIds": [ "string" ],
"ResourceType": "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.
- DiscoveryJobArn
-
Specifies the Amazon Resource Name (ARN) of the discovery job that's collecting data from your on-premises storage system.
Type: String
Length Constraints: Maximum length of 256.
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}/job/discovery-job-[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$Required: Yes
- Filter
-
Filters the storage system resources that you want returned. For example, this might be volumes associated with a specific storage virtual machine (SVM).
Type: String to array of strings map
Valid Keys:
SVMLength Constraints: Maximum length of 1024.
Pattern:
^.{0,1024}$Required: No
- MaxResults
-
Specifies the maximum number of storage system resources that you want to list in a response.
Type: Integer
Valid Range: Minimum value of 1. Maximum value of 100.
Required: No
- NextToken
-
Specifies an opaque string that indicates the position to begin the next list of results in the response.
Type: String
Length Constraints: Maximum length of 65535.
Pattern:
[a-zA-Z0-9=_-]+Required: No
- ResourceIds
-
Specifies the universally unique identifiers (UUIDs) of the storage system resources that you want information about. You can't use this parameter in combination with the
Filterparameter.Type: Array of strings
Array Members: Minimum number of 1 item. Maximum number of 100 items.
Pattern:
[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}Required: No
- ResourceType
-
Specifies what kind of storage system resources that you want information about.
Type: String
Valid Values:
SVM | VOLUME | CLUSTERRequired: Yes
Response Syntax
{
"NextToken": "string",
"ResourceDetails": {
"NetAppONTAPClusters": [
{
"CifsShareCount": number,
"ClusterBlockStorageLogicalUsed": number,
"ClusterBlockStorageSize": number,
"ClusterBlockStorageUsed": number,
"ClusterCloudStorageUsed": number,
"ClusterName": "string",
"LunCount": number,
"MaxP95Performance": {
"IopsOther": number,
"IopsRead": number,
"IopsTotal": number,
"IopsWrite": number,
"LatencyOther": number,
"LatencyRead": number,
"LatencyWrite": number,
"ThroughputOther": number,
"ThroughputRead": number,
"ThroughputTotal": number,
"ThroughputWrite": number
},
"NfsExportedVolumes": number,
"Recommendations": [
{
"EstimatedMonthlyStorageCost": "string",
"StorageConfiguration": {
"string" : "string"
},
"StorageType": "string"
}
],
"RecommendationStatus": "string",
"ResourceId": "string"
}
],
"NetAppONTAPSVMs": [
{
"CifsShareCount": number,
"ClusterUuid": "string",
"EnabledProtocols": [ "string" ],
"LunCount": number,
"MaxP95Performance": {
"IopsOther": number,
"IopsRead": number,
"IopsTotal": number,
"IopsWrite": number,
"LatencyOther": number,
"LatencyRead": number,
"LatencyWrite": number,
"ThroughputOther": number,
"ThroughputRead": number,
"ThroughputTotal": number,
"ThroughputWrite": number
},
"NfsExportedVolumes": number,
"Recommendations": [
{
"EstimatedMonthlyStorageCost": "string",
"StorageConfiguration": {
"string" : "string"
},
"StorageType": "string"
}
],
"RecommendationStatus": "string",
"ResourceId": "string",
"SvmName": "string",
"TotalCapacityProvisioned": number,
"TotalCapacityUsed": number,
"TotalLogicalCapacityUsed": number,
"TotalSnapshotCapacityUsed": number
}
],
"NetAppONTAPVolumes": [
{
"CapacityProvisioned": number,
"CapacityUsed": number,
"CifsShareCount": number,
"LogicalCapacityUsed": number,
"LunCount": number,
"MaxP95Performance": {
"IopsOther": number,
"IopsRead": number,
"IopsTotal": number,
"IopsWrite": number,
"LatencyOther": number,
"LatencyRead": number,
"LatencyWrite": number,
"ThroughputOther": number,
"ThroughputRead": number,
"ThroughputTotal": number,
"ThroughputWrite": number
},
"NfsExported": boolean,
"Recommendations": [
{
"EstimatedMonthlyStorageCost": "string",
"StorageConfiguration": {
"string" : "string"
},
"StorageType": "string"
}
],
"RecommendationStatus": "string",
"ResourceId": "string",
"SecurityStyle": "string",
"SnapshotCapacityUsed": number,
"SvmName": "string",
"SvmUuid": "string",
"VolumeName": "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.
- NextToken
-
The opaque string that indicates the position to begin the next list of results in the response.
Type: String
Length Constraints: Maximum length of 65535.
Pattern:
[a-zA-Z0-9=_-]+ - ResourceDetails
-
The information collected about your storage system's resources. A response can also include AWS storage service recommendations.
For more information, see storage resource information collected by and recommendations provided by DataSync Discovery.
Type: ResourceDetails object
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
Examples
Sample Request
The following example requests information about volumes in an on-premises storage system.
{ "DiscoveryJobArn": "arn:aws:datasync:us-east-1:123456789012:system/storage-system-abcdef01234567890/job/discovery-job-12345678-90ab-cdef-0abc-021345abcdef6", "ResourceType": "VOLUME" }
Sample Response
The following example response includes information about volumes in the on-premises storage system, including recommendations about where to move the volume data to in AWS (such as Amazon FSx for NetApp ONTAP or Amazon EFS).
{ "ResourceDetails": { "NetAppONTAPVolumes": [ { "VolumeName": "vol1", "ResourceId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE11111", "CifsShareCount": 0, "SecurityStyle": "unix", "SvmUuid": "a1b2c3d4-5678-90ab-cdef-EXAMPLEaaaaa", "SvmName": "my-svm", "CapacityUsed": 409600, "CapacityProvisioned": 1099511627776, "LogicalCapacityUsed": 409600, "NfsExported": true, "SnapshotCapacityUsed": 573440, "MaxP95Performance": { "IopsRead": 251.0, "IopsWrite": 44.0, "IopsOther": 17.0, "IopsTotal": 345.0, "ThroughputRead": 2.06, "ThroughputWrite": 0.88, "ThroughputOther": 0.11, "ThroughputTotal": 2.17, "LatencyRead": 0.06, "LatencyWrite": 0.07, "LatencyOther": 0.13 }, "Recommendations": [ { "StorageType": "fsxOntap", "StorageConfiguration": { "StorageCapacityGB": "1024", "ProvisionedIOpsMode": "AUTOMATIC", "CapacityPoolGB": "0", "TotalIOps": "0", "DeploymentType": "Multi-AZ", "ThroughputCapacity": "128" }, "EstimatedMonthlyStorageCost": "410.0" }, { "StorageType": "efs", "StorageConfiguration": { "InfrequentAccessStorageGB": "1", "StandardStorageGB": "1", "InfrequentAccessRequests": "0", "ProvisionedThroughputMBps": "0", "PerformanceMode": "General Purpose", "ThroughputMode": "Bursting" }, "EstimatedMonthlyStorageCost": "1.0" } ], "RecommendationStatus": "COMPLETED" }, { "VolumeName": "root_vol", "ResourceId": "a1b2c3d4-5678-90ab-cdef-EXAMPLE22222", "CifsShareCount": 0, "SecurityStyle": "unix", "SvmUuid": "a1b2c3d4-5678-90ab-cdef-EXAMPLEaaaaa", "SvmName": "my-svm", "CapacityUsed": 462848, "CapacityProvisioned": 1073741824, "LogicalCapacityUsed": 462848, "NfsExported": true, "SnapshotCapacityUsed": 421888, "MaxP95Performance": { "IopsRead": 261.0, "IopsWrite": 53.0, "IopsOther": 23.0, "IopsTotal": 360.0, "ThroughputRead": 10.0, "ThroughputWrite": 2.0, "ThroughputOther": 4.0, "ThroughputTotal": 12.0, "LatencyRead": 0.25, "LatencyWrite": 0.3, "LatencyOther": 0.55 }, "Recommendations": [ { "StorageType": "fsxOntap", "StorageConfiguration": { "StorageCapacityGB": "1024", "ProvisionedIOpsMode": "AUTOMATIC", "CapacityPoolGB": "0", "TotalIOps": "0", "DeploymentType": "Multi-AZ", "ThroughputCapacity": "128" }, "EstimatedMonthlyStorageCost": "410.0" }, { "StorageType": "efs", "StorageConfiguration": { "InfrequentAccessStorageGB": "1", "StandardStorageGB": "1", "InfrequentAccessRequests": "0", "ProvisionedThroughputMBps": "0", "PerformanceMode": "General Purpose", "ThroughputMode": "Bursting" }, "EstimatedMonthlyStorageCost": "1.0" } ], "RecommendationStatus": "COMPLETED" } ] } }
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
