StartMaintenance
Manually starts server maintenance. This command can be useful if an earlier maintenance attempt failed, and the underlying
cause of maintenance failure has been resolved. The server is in an UNDER_MAINTENANCE
state while maintenance is in progress.
Maintenance can only be started on servers in HEALTHY
and UNHEALTHY
states. Otherwise, an InvalidStateException
is thrown.
A ResourceNotFoundException
is thrown when the server does not exist. A ValidationException
is raised when parameters of the request are not valid.
Request Syntax
{
"EngineAttributes": [
{
"Name": "string
",
"Value": "string
"
}
],
"ServerName": "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.
- EngineAttributes
-
Engine attributes that are specific to the server on which you want to run maintenance.
Attributes accepted in a StartMaintenance request for Chef
-
CHEF_MAJOR_UPGRADE
: If a Chef Automate server is eligible for upgrade to Chef Automate 2, add this engine attribute to aStartMaintenance
request and set the value totrue
to upgrade the server to Chef Automate 2. For more information, see Upgrade an AWS OpsWorks for Chef Automate Server to Chef Automate 2.
Type: Array of EngineAttribute objects
Required: No
-
- ServerName
-
The name of the server on which to run maintenance.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 40.
Pattern:
[a-zA-Z][a-zA-Z0-9\-]*
Required: Yes
Response Syntax
{
"Server": {
"AssociatePublicIpAddress": boolean,
"BackupRetentionCount": number,
"CloudFormationStackArn": "string",
"CreatedAt": number,
"CustomDomain": "string",
"DisableAutomatedBackup": boolean,
"Endpoint": "string",
"Engine": "string",
"EngineAttributes": [
{
"Name": "string",
"Value": "string"
}
],
"EngineModel": "string",
"EngineVersion": "string",
"InstanceProfileArn": "string",
"InstanceType": "string",
"KeyPair": "string",
"MaintenanceStatus": "string",
"PreferredBackupWindow": "string",
"PreferredMaintenanceWindow": "string",
"SecurityGroupIds": [ "string" ],
"ServerArn": "string",
"ServerName": "string",
"ServiceRoleArn": "string",
"Status": "string",
"StatusReason": "string",
"SubnetIds": [ "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.
Errors
For information about the errors that are common to all actions, see Common Errors.
- InvalidStateException
-
The resource is in a state that does not allow you to perform a specified action.
HTTP Status Code: 400
- ResourceNotFoundException
-
The requested resource does not exist, or access was denied.
HTTP Status Code: 400
- ValidationException
-
One or more of the provided request parameters are not valid.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: