UpdateProfileCommand

Suggest an Edit

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.

Example Syntax

Use a bare-bones client and the command you need to make an API call.

import { TransferClient, UpdateProfileCommand } from "@aws-sdk/client-transfer"; // ES Modules import
// const { TransferClient, UpdateProfileCommand } = require("@aws-sdk/client-transfer"); // CommonJS import
const client = new TransferClient(config);
const input = { // UpdateProfileRequest
  ProfileId: "STRING_VALUE", // required
  CertificateIds: [ // CertificateIds
    "STRING_VALUE",
  ],
};
const command = new UpdateProfileCommand(input);
const response = await client.send(command);
// { // UpdateProfileResponse
//   ProfileId: "STRING_VALUE", // required
// };

UpdateProfileCommand Input

See UpdateProfileCommandInput for more details

Parameter
Type
Description
ProfileId
Required
string | undefined

The identifier of the profile object that you are updating.

CertificateIds
string[] | undefined

An array of identifiers for the imported certificates. You use this identifier for working with profiles and partner profiles.

UpdateProfileCommand Output

See UpdateProfileCommandOutput for details

Parameter
Type
Description
$metadata
Required
ResponseMetadata
Metadata pertaining to this request.
ProfileId
Required
string | undefined

Returns the identifier for the profile that's being updated.

Throws

Name
Fault
Details
InternalServiceError
server

This exception is thrown when an error occurs in the Transfer Family service.

InvalidRequestException
client

This exception is thrown when the client submits a malformed request.

ResourceNotFoundException
client

This exception is thrown when a resource is not found by the Amazon Web ServicesTransfer Family service.

ServiceUnavailableException
server

The request has failed because the Amazon Web ServicesTransfer Family service is not available.

ThrottlingException
client

The request was denied due to request throttling.

TransferServiceException
Base exception class for all service exceptions from Transfer service.