- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
UpdateApplicationSettingsCommand
Updates the settings of an application registered with AWS Systems Manager for SAP.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { SsmSapClient, UpdateApplicationSettingsCommand } from "@aws-sdk/client-ssm-sap"; // ES Modules import
// const { SsmSapClient, UpdateApplicationSettingsCommand } = require("@aws-sdk/client-ssm-sap"); // CommonJS import
const client = new SsmSapClient(config);
const input = { // UpdateApplicationSettingsInput
ApplicationId: "STRING_VALUE", // required
CredentialsToAddOrUpdate: [ // ApplicationCredentialList
{ // ApplicationCredential
DatabaseName: "STRING_VALUE", // required
CredentialType: "ADMIN", // required
SecretId: "STRING_VALUE", // required
},
],
CredentialsToRemove: [
{
DatabaseName: "STRING_VALUE", // required
CredentialType: "ADMIN", // required
SecretId: "STRING_VALUE", // required
},
],
Backint: { // BackintConfig
BackintMode: "AWSBackup", // required
EnsureNoBackupInProcess: true || false, // required
},
DatabaseArn: "STRING_VALUE",
};
const command = new UpdateApplicationSettingsCommand(input);
const response = await client.send(command);
// { // UpdateApplicationSettingsOutput
// Message: "STRING_VALUE",
// OperationIds: [ // OperationIdList
// "STRING_VALUE",
// ],
// };
UpdateApplicationSettingsCommand Input
See UpdateApplicationSettingsCommandInput for more details
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
ApplicationId Required | string | undefined | The ID of the application. |
Backint | BackintConfig | undefined | Installation of AWS Backint Agent for SAP HANA. |
CredentialsToAddOrUpdate | ApplicationCredential[] | undefined | The credentials to be added or updated. |
CredentialsToRemove | ApplicationCredential[] | undefined | The credentials to be removed. |
DatabaseArn | string | undefined | The Amazon Resource Name of the SAP HANA database that replaces the current SAP HANA connection with the SAP_ABAP application. |
UpdateApplicationSettingsCommand Output
See UpdateApplicationSettingsCommandOutput for details
Parameter | Type | Description |
---|
Parameter | Type | Description |
---|---|---|
$metadata Required | ResponseMetadata | Metadata pertaining to this request. |
Message | string | undefined | The update message. |
OperationIds | string[] | undefined | The IDs of the operations. |
Throws
Name | Fault | Details |
---|
Name | Fault | Details |
---|---|---|
ConflictException | client | A conflict has occurred. |
InternalServerException | server | An internal error has occurred. |
ResourceNotFoundException | client | The resource is not available. |
UnauthorizedException | client | The request is not authorized. |
ValidationException | client | The input fails to satisfy the constraints specified by an AWS service. |
SsmSapServiceException | Base exception class for all service exceptions from SsmSap service. |