UpdateLocationObjectStorage - AWS DataSync

UpdateLocationObjectStorage

Updates some of the parameters of a previously created location for self-managed object storage server access. For information about creating a self-managed object storage location, see Creating a location for object storage.

Request Syntax

{ "AccessKey": "string", "AgentArns": [ "string" ], "LocationArn": "string", "SecretKey": "string", "ServerPort": number, "ServerProtocol": "string", "Subdirectory": "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.

AccessKey

Optional. The access key is used if credentials are required to access the self-managed object storage server. If your object storage requires a user name and password to authenticate, use AccessKey and SecretKey to provide the user name and password, respectively.

Type: String

Length Constraints: Minimum length of 8. Maximum length of 200.

Pattern: ^.+$

Required: No

AgentArns

The Amazon Resource Name (ARN) of the agents associated with the self-managed object storage server location.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 4 items.

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

LocationArn

The Amazon Resource Name (ARN) of the self-managed object storage server location to be updated.

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}:location/loc-[0-9a-z]{17}$

Required: Yes

SecretKey

Optional. The secret key is used if credentials are required to access the self-managed object storage server. If your object storage requires a user name and password to authenticate, use AccessKey and SecretKey to provide the user name and password, respectively.

Type: String

Length Constraints: Minimum length of 8. Maximum length of 200.

Pattern: ^.+$

Required: No

ServerPort

The port that your self-managed object storage server accepts inbound network traffic on. The server port is set by default to TCP 80 (HTTP) or TCP 443 (HTTPS). You can specify a custom port if your self-managed object storage server requires one.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 65536.

Required: No

ServerProtocol

The protocol that the object storage server uses to communicate. Valid values are HTTP or HTTPS.

Type: String

Valid Values: HTTPS | HTTP

Required: No

Subdirectory

The subdirectory in the self-managed object storage server that is used to read data from.

Type: String

Length Constraints: Maximum length of 4096.

Pattern: ^[a-zA-Z0-9_\-\+\./\(\)\p{Zs}]*$

Required: No

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: