UpdateApplicationMaintenanceConfiguration - Kinesis Data Analytics
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China.

UpdateApplicationMaintenanceConfiguration

Updates the maintenance configuration of the Kinesis Data Analytics application.

You can invoke this operation on an application that is in one of the two following states: READY or RUNNING. If you invoke it when the application is in a state other than these two states, it throws a ResourceInUseException. The service makes use of the updated configuration the next time it schedules maintenance for the application. If you invoke this operation after the service schedules maintenance, the service will apply the configuration update the next time it schedules maintenance for the application. This means that you might not see the maintenance configuration update applied to the maintenance process that follows a successful invocation of this operation, but to the following maintenance process instead.

To see the current maintenance configuration of your application, invoke the DescribeApplication operation.

For information about application maintenance, see Kinesis Data Analytics for Apache Flink Maintenance.

Note

This operation is supported only for Amazon Kinesis Data Analytics for Apache Flink.

Request Syntax

{ "ApplicationMaintenanceConfigurationUpdate": { "ApplicationMaintenanceWindowStartTimeUpdate": "string" }, "ApplicationName": "string" }

Request Parameters

The request accepts the following data in JSON format.

ApplicationMaintenanceConfigurationUpdate

Describes the application maintenance configuration update.

Type: ApplicationMaintenanceConfigurationUpdate object

Required: Yes

ApplicationName

The name of the application for which you want to update the maintenance configuration.

Type: String

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

Pattern: [a-zA-Z0-9_.-]+

Required: Yes

Response Syntax

{ "ApplicationARN": "string", "ApplicationMaintenanceConfigurationDescription": { "ApplicationMaintenanceWindowEndTime": "string", "ApplicationMaintenanceWindowStartTime": "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.

ApplicationARN

The Amazon Resource Name (ARN) of the application.

Type: String

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

Pattern: arn:.*

ApplicationMaintenanceConfigurationDescription

The application maintenance configuration description after the update.

Type: ApplicationMaintenanceConfigurationDescription object

Errors

ConcurrentModificationException

Exception thrown as a result of concurrent modifications to an application. This error can be the result of attempting to modify an application without using the current application ID.

HTTP Status Code: 400

InvalidArgumentException

The specified input parameter value is not valid.

HTTP Status Code: 400

ResourceInUseException

The application is not available for this operation.

HTTP Status Code: 400

ResourceNotFoundException

Specified application can't be found.

HTTP Status Code: 400

UnsupportedOperationException

The request was rejected because a specified parameter is not supported or a specified resource is not valid for this operation.

HTTP Status Code: 400

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: