UpdateProfile
Updates some of the parameters for an existing profile. Provide the ProfileId
for the profile that you want to update, along with the new values for the parameters to
update.
Request Syntax
{
"CertificateIds": [ "string" ],
"ProfileId": "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.
- CertificateIds
-
An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.
Type: Array of strings
Length Constraints: Fixed length of 22.
Pattern:
cert-([0-9a-f]{17})Required: No
- ProfileId
-
The identifier of the profile object that you are updating.
Type: String
Length Constraints: Fixed length of 19.
Pattern:
p-([0-9a-f]{17})Required: Yes
Response Syntax
{
"ProfileId": "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.
- ProfileId
-
Returns the identifier for the profile that's being updated.
Type: String
Length Constraints: Fixed length of 19.
Pattern:
p-([0-9a-f]{17})
Errors
For information about the errors that are common to all actions, see Common Errors.
- InternalServiceError
-
This exception is thrown when an error occurs in the AWS Transfer Family service.
HTTP Status Code: 500
- InvalidRequestException
-
This exception is thrown when the client submits a malformed request.
HTTP Status Code: 400
- ResourceNotFoundException
-
This exception is thrown when a resource is not found by the AWSTransfer Family service.
HTTP Status Code: 400
- ServiceUnavailableException
-
The request has failed because the AWSTransfer Family service is not available.
HTTP Status Code: 500
- ThrottlingException
-
The request was denied due to request throttling.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
