Request Syntax Request Parameters Response Syntax Response Elements Errors Examples See Also

AddStorageSystem

Creates an AWS resource for an on-premises storage system that you want DataSync Discovery to collect information about.

Request Syntax


{
   "AgentArns": [ "string" ],
   "ClientToken": "string",
   "CloudWatchLogGroupArn": "string",
   "Credentials": { 
      "Password": "string",
      "Username": "string"
   },
   "Name": "string",
   "ServerConfiguration": { 
      "ServerHostname": "string",
      "ServerPort": number
   },
   "SystemType": "string",
   "Tags": [ 
      { 
         "Key": "string",
         "Value": "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.

AgentArns

Specifies the Amazon Resource Name (ARN) of the DataSync agent that connects to and reads from your on-premises storage system's management interface. You can only specify one ARN.

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

Required: Yes

ClientToken

Specifies a client token to make sure requests with this API operation are idempotent. If you don't specify a client token, DataSync generates one for you automatically.

Type: String

Pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}

Required: Yes

CloudWatchLogGroupArn

Specifies the ARN of the Amazon CloudWatch log group for monitoring and logging 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:([^:\*]*)(:\*)?$

Required: No

Credentials

Specifies the user name and password for accessing your on-premises storage system's management interface.

Type: Credentials object

Required: Yes

Name

Specifies a familiar name for your on-premises storage system.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: ^[\p{L}\p{M}\p{N}\s+=._:@\/-]+$

Required: No

ServerConfiguration

Specifies the server name and network port required to connect with the management interface of your on-premises storage system.

Type: DiscoveryServerConfiguration object

Required: Yes

SystemType

Specifies the type of on-premises storage system that you want DataSync Discovery to collect information about.

Note

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

Type: String

Valid Values: NetAppONTAP

Required: Yes

Tags

Specifies labels that help you categorize, filter, and search for your AWS resources. We recommend creating at least a name tag for your on-premises storage system.

Type: Array of TagListEntry objects

Array Members: Minimum number of 0 items. Maximum number of 50 items.

Required: No

Response Syntax


{
   "StorageSystemArn": "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.

StorageSystemArn

The ARN of the on-premises storage system that you can use 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}$

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 adds an on-premises storage system to DataSync Discovery.


{
    "ServerConfiguration": {
        "ServerHostname": "172.16.0.0",
        "ServerPort": 443
    },
    "SystemType": "NetAppONTAP",
    "AgentArns": [
        "arn:aws:datasync:us-east-1:111222333444:agent/agent-012345abcde012345"
    ],
    "CloudWatchLogGroupArn": "arn:aws:logs:us-east-1:111222333444:log-group:/aws/datasync/discovery:*",
    "Tags": [
        {
            "Key": "Migration Plan",
            "Value": "1"
        }
    ],
    "Name": "MyOnPremStorage",
    "Credentials": {
        "Username": "admin",
        "Password": "1234"
    }
}

Sample Response

A response returns the ARN of the on-premises storage system that you just added to DataSync Discovery.


{
    "StorageSystemArn": "arn:aws:datasync:us-east-1:111222333444:system/storage-system-abcdef01234567890"
}