openapi: 3.0.0
info:
version: 2015-08-04
x-release: v4
title: 'Amazon Kinesis Firehose CreateSignalingChannel #X Amz Target=KinesisAnalytics 20180523.UpdateApplicationMaintenanceConfiguration API'
description: Amazon Kinesis Data Firehose API Reference
Amazon Kinesis Data Firehose is a fully managed service that delivers real-time streaming data to destinations such as Amazon Simple Storage Service (Amazon S3), Amazon OpenSearch Service, Amazon Redshift, Splunk, and various other supportd destinations.
x-logo:
url: https://api.apis.guru/v2/cache/logo/https_twitter.com_awscloud_profile_image.png
backgroundColor: '#FFFFFF'
termsOfService: https://aws.amazon.com/service-terms/
contact:
name: Mike Ralphson
email: mike.ralphson@gmail.com
url: https://github.com/mermade/aws2openapi
x-twitter: PermittedSoc
license:
name: Apache 2.0 License
url: http://www.apache.org/licenses/
x-providerName: amazonaws.com
x-serviceName: firehose
x-origin:
- contentType: application/json
url: https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/firehose-2015-08-04.normal.json
converter:
url: https://github.com/mermade/aws2openapi
version: 1.0.0
x-apisguru-driver: external
x-apiClientRegistration:
url: https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct
x-apisguru-categories:
- cloud
x-preferred: true
servers:
- url: http://firehose.{region}.amazonaws.com
variables:
region:
description: The AWS region
enum:
- us-east-1
- us-east-2
- us-west-1
- us-west-2
- us-gov-west-1
- us-gov-east-1
- ca-central-1
- eu-north-1
- eu-west-1
- eu-west-2
- eu-west-3
- eu-central-1
- eu-south-1
- af-south-1
- ap-northeast-1
- ap-northeast-2
- ap-northeast-3
- ap-southeast-1
- ap-southeast-2
- ap-east-1
- ap-south-1
- sa-east-1
- me-south-1
default: us-east-1
description: The Firehose multi-region endpoint
- url: https://firehose.{region}.amazonaws.com
variables:
region:
description: The AWS region
enum:
- us-east-1
- us-east-2
- us-west-1
- us-west-2
- us-gov-west-1
- us-gov-east-1
- ca-central-1
- eu-north-1
- eu-west-1
- eu-west-2
- eu-west-3
- eu-central-1
- eu-south-1
- af-south-1
- ap-northeast-1
- ap-northeast-2
- ap-northeast-3
- ap-southeast-1
- ap-southeast-2
- ap-east-1
- ap-south-1
- sa-east-1
- me-south-1
default: us-east-1
description: The Firehose multi-region endpoint
- url: http://firehose.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The Firehose endpoint for China (Beijing) and China (Ningxia)
- url: https://firehose.{region}.amazonaws.com.cn
variables:
region:
description: The AWS region
enum:
- cn-north-1
- cn-northwest-1
default: cn-north-1
description: The Firehose endpoint for China (Beijing) and China (Ningxia)
security:
- hmac: []
tags:
- name: '#X Amz Target=KinesisAnalytics 20180523.UpdateApplicationMaintenanceConfiguration'
paths:
/#X-Amz-Target=KinesisAnalytics_20180523.UpdateApplicationMaintenanceConfiguration:
parameters:
- $ref: '#/components/parameters/X-Amz-Content-Sha256'
- $ref: '#/components/parameters/X-Amz-Date'
- $ref: '#/components/parameters/X-Amz-Algorithm'
- $ref: '#/components/parameters/X-Amz-Credential'
- $ref: '#/components/parameters/X-Amz-Security-Token'
- $ref: '#/components/parameters/X-Amz-Signature'
- $ref: '#/components/parameters/X-Amz-SignedHeaders'
post:
operationId: UpdateApplicationMaintenanceConfiguration
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.
This operation is supported only for Amazon Kinesis Data Analytics for Apache Flink.
'
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateApplicationMaintenanceConfigurationResponse'
'480':
description: ResourceNotFoundException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceNotFoundException'
'481':
description: ResourceInUseException
content:
application/json:
schema:
$ref: '#/components/schemas/ResourceInUseException'
'482':
description: InvalidArgumentException
content:
application/json:
schema:
$ref: '#/components/schemas/InvalidArgumentException'
'483':
description: ConcurrentModificationException
content:
application/json:
schema:
$ref: '#/components/schemas/ConcurrentModificationException'
'484':
description: UnsupportedOperationException
content:
application/json:
schema:
$ref: '#/components/schemas/UnsupportedOperationException'
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/UpdateApplicationMaintenanceConfigurationRequest'
parameters:
- name: X-Amz-Target
in: header
required: true
schema:
type: string
enum:
- KinesisAnalytics_20180523.UpdateApplicationMaintenanceConfiguration
tags:
- '#X Amz Target=KinesisAnalytics 20180523.UpdateApplicationMaintenanceConfiguration'
components:
parameters:
X-Amz-Credential:
name: X-Amz-Credential
in: header
schema:
type: string
required: false
X-Amz-Security-Token:
name: X-Amz-Security-Token
in: header
schema:
type: string
required: false
X-Amz-Date:
name: X-Amz-Date
in: header
schema:
type: string
required: false
X-Amz-Algorithm:
name: X-Amz-Algorithm
in: header
schema:
type: string
required: false
X-Amz-SignedHeaders:
name: X-Amz-SignedHeaders
in: header
schema:
type: string
required: false
X-Amz-Content-Sha256:
name: X-Amz-Content-Sha256
in: header
schema:
type: string
required: false
X-Amz-Signature:
name: X-Amz-Signature
in: header
schema:
type: string
required: false
schemas:
ApplicationName:
type: string
pattern: '[a-zA-Z0-9_.-]+'
minLength: 1
maxLength: 128
ResourceARN:
type: string
pattern: arn:.*
minLength: 1
maxLength: 2048
ApplicationMaintenanceWindowStartTime:
type: string
pattern: ([01][0-9]|2[0-3]):[0-5][0-9]
minLength: 5
maxLength: 5
UnsupportedOperationException: {}
UpdateApplicationMaintenanceConfigurationResponse:
type: object
properties:
ApplicationARN:
allOf:
- $ref: '#/components/schemas/ResourceARN'
- description: The Amazon Resource Name (ARN) of the application.
ApplicationMaintenanceConfigurationDescription:
allOf:
- $ref: '#/components/schemas/ApplicationMaintenanceConfigurationDescription'
- description: The application maintenance configuration description after the update.
ConcurrentModificationException: {}
InvalidArgumentException: {}
ApplicationMaintenanceConfigurationDescription:
type: object
required:
- ApplicationMaintenanceWindowStartTime
- ApplicationMaintenanceWindowEndTime
properties:
ApplicationMaintenanceWindowStartTime:
allOf:
- $ref: '#/components/schemas/ApplicationMaintenanceWindowStartTime'
- description: The start time for the maintenance window.
ApplicationMaintenanceWindowEndTime:
allOf:
- $ref: '#/components/schemas/ApplicationMaintenanceWindowEndTime'
- description: The end time for the maintenance window.
description: The details of the maintenance configuration for the application.
ResourceNotFoundException: {}
ResourceInUseException: {}
UpdateApplicationMaintenanceConfigurationRequest:
type: object
required:
- ApplicationName
- ApplicationMaintenanceConfigurationUpdate
title: UpdateApplicationMaintenanceConfigurationRequest
properties:
ApplicationName:
allOf:
- $ref: '#/components/schemas/ApplicationName'
- description: The name of the application for which you want to update the maintenance configuration.
ApplicationMaintenanceConfigurationUpdate:
allOf:
- $ref: '#/components/schemas/ApplicationMaintenanceConfigurationUpdate'
- description: Describes the application maintenance configuration update.
ApplicationMaintenanceConfigurationUpdate:
type: object
required:
- ApplicationMaintenanceWindowStartTimeUpdate
properties:
ApplicationMaintenanceWindowStartTimeUpdate:
allOf:
- $ref: '#/components/schemas/ApplicationMaintenanceWindowStartTime'
- description: The updated start time for the maintenance window.
description: Describes the updated maintenance configuration for the application.
ApplicationMaintenanceWindowEndTime:
type: string
pattern: ([01][0-9]|2[0-3]):[0-5][0-9]
minLength: 5
maxLength: 5
securitySchemes:
hmac:
type: apiKey
name: Authorization
in: header
description: Amazon Signature authorization v4
x-amazon-apigateway-authtype: awsSigv4
externalDocs:
description: Amazon Web Services documentation
url: https://docs.aws.amazon.com/firehose/
x-hasEquivalentPaths: true