Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

UpdateApplicationComponentConfig

Updates the configuration of an application component.

Request Syntax


POST /update-applicationcomponent-config/ HTTP/1.1
Content-type: application/json

{
   "applicationComponentId": "string",
   "appType": "string",
   "configureOnly": boolean,
   "inclusionStatus": "string",
   "secretsManagerKey": "string",
   "sourceCodeList": [ 
      { 
         "location": "string",
         "projectName": "string",
         "sourceVersion": "string",
         "versionControl": "string"
      }
   ],
   "strategyOption": { 
      "isPreferred": boolean,
      "strategy": "string",
      "targetDestination": "string",
      "toolName": "string"
   }
}

URI Request Parameters

The request does not use any URI parameters.

Request Body

The request accepts the following data in JSON format.

applicationComponentId

The ID of the application component. The ID is unique within an AWS account.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 44.

Pattern: [0-9a-zA-Z-]+

Required: Yes

appType

The type of known component.

Type: String

Required: No

configureOnly

Update the configuration request of an application component. If it is set to true, the source code and/or database credentials are updated. If it is set to false, the source code and/or database credentials are updated and an analysis is initiated.

Type: Boolean

Required: No

inclusionStatus

Indicates whether the application component has been included for server recommendation or not.

Type: String

Valid Values: excludeFromAssessment | includeInAssessment

Required: No

secretsManagerKey

Database credentials.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 512.

Pattern: .*

Required: No

sourceCodeList

The list of source code configurations to update for the application component.

Type: Array of SourceCode objects

Required: No

strategyOption

The preferred strategy options for the application component. Use values from the GetApplicationComponentStrategies response.

Type: StrategyOption object

Required: No

Response Syntax


HTTP/1.1 200

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.

InternalServerException

The server experienced an internal error. Try again.

HTTP Status Code: 500

ResourceNotFoundException

The specified ID in the request is not found.

HTTP Status Code: 404

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

The request body isn't valid.

HTTP Status Code: 400