AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

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.

Note:

This is an asynchronous operation using the standard naming convention for .NET 4.5 or higher. For .NET 3.5 the operation is implemented as a pair of methods using the standard naming convention of BeginStartMaintenance and EndStartMaintenance.

Namespace: Amazon.OpsWorksCM
Assembly: AWSSDK.OpsWorksCM.dll
Version: 3.x.y.z

Syntax

C#
public virtual Task<StartMaintenanceResponse> StartMaintenanceAsync(
         StartMaintenanceRequest request,
         CancellationToken cancellationToken
)

Parameters

request
Type: Amazon.OpsWorksCM.Model.StartMaintenanceRequest

Container for the necessary parameters to execute the StartMaintenance service method.

cancellationToken
Type: System.Threading.CancellationToken

A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Return Value


The response from the StartMaintenance service method, as returned by OpsWorksCM.

Exceptions

ExceptionCondition
InvalidStateException The resource is in a state that does not allow you to perform a specified action.
ResourceNotFoundException The requested resource does not exist, or access was denied.
ValidationException One or more of the provided request parameters are not valid.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer

See Also