Modifies some configurations of an on-premises storage system resource that you're using with DataSync Discovery.
Request Syntax
{
"AgentArns": [ "string" ],
"CloudWatchLogGroupArn": "string",
"Credentials": {
"Password": "string",
"Username": "string"
},
"Name": "string",
"ServerConfiguration": {
"ServerHostname": "string",
"ServerPort": number
},
"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.
- AgentArns
-
Specifies the Amazon Resource Name (ARN) of the DataSync agent that connects to and reads your on-premises storage system. 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: No
- 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: No
- 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 your on-premises storage system's management interface.
Type: DiscoveryServerConfiguration object
Required: No
- StorageSystemArn
-
Specifies the ARN of the on-premises storage system that you want reconfigure.
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 Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
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:
