update-application-maintenance-configuration¶

Description¶

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.

Synopsis¶

  update-application-maintenance-configuration
--application-name <value>
--application-maintenance-configuration-update <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options¶

--application-name (string)

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

--application-maintenance-configuration-update (structure)

Describes the application maintenance configuration update.

ApplicationMaintenanceWindowStartTimeUpdate -> (string)

The updated start time for the maintenance window.

Shorthand Syntax:

ApplicationMaintenanceWindowStartTimeUpdate=string

JSON Syntax:

{
  "ApplicationMaintenanceWindowStartTimeUpdate": "string"
}

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Output¶

ApplicationARN -> (string)

The Amazon Resource Name (ARN) of the application.

ApplicationMaintenanceConfigurationDescription -> (structure)

The application maintenance configuration description after the update.

ApplicationMaintenanceWindowStartTime -> (string)

The start time for the maintenance window.

ApplicationMaintenanceWindowEndTime -> (string)

The end time for the maintenance window.

Table of Contents

Feedback

User Guide