openapi: 3.0.0
info:
version: 2015-08-04
x-release: v4
title: 'Amazon Kinesis Firehose CreateSignalingChannel #X Amz Target=KinesisAnalytics 20180523.ListApplications API'
description:
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.ListApplications' paths: /#X-Amz-Target=KinesisAnalytics_20180523.ListApplications: 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: ListApplications description:Returns a list of Kinesis Data Analytics applications in your account. For each application, the response includes the application name, Amazon Resource Name (ARN), and status.
If you want detailed information about a specific application, use DescribeApplication.
responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListApplicationsResponse' '480': description: InvalidRequestException content: application/json: schema: $ref: '#/components/schemas/InvalidRequestException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ListApplicationsRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - KinesisAnalytics_20180523.ListApplications tags: - '#X Amz Target=KinesisAnalytics 20180523.ListApplications' 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 ListApplicationsRequest: type: object title: ListApplicationsRequest properties: Limit: allOf: - $ref: '#/components/schemas/ListApplicationsInputLimit' - description: The maximum number of applications to list. NextToken: allOf: - $ref: '#/components/schemas/ApplicationName' - description: If a previous command returned a pagination token, pass it into this value to retrieve the next set of results. For more information about pagination, see Using the Amazon Command Line Interface's Pagination Options. ApplicationVersionId: type: integer minimum: 1 maximum: 999999999 ResourceARN: type: string pattern: arn:.* minLength: 1 maxLength: 2048 RuntimeEnvironment: type: string enum: - SQL-1_0 - FLINK-1_6 - FLINK-1_8 - ZEPPELIN-FLINK-1_0 - FLINK-1_11 - FLINK-1_13 - ZEPPELIN-FLINK-2_0 - FLINK-1_15 ListApplicationsResponse: type: object required: - ApplicationSummaries properties: ApplicationSummaries: allOf: - $ref: '#/components/schemas/ApplicationSummaries' - description: A list ofApplicationSummary objects.
NextToken:
allOf:
- $ref: '#/components/schemas/ApplicationName'
- description: The pagination token for the next set of results, or null if there are no additional results. Pass this token into a subsequent command to retrieve the next set of items For more information about pagination, see Using the Amazon Command Line Interface's Pagination Options.
ApplicationStatus:
type: string
enum:
- DELETING
- STARTING
- STOPPING
- READY
- RUNNING
- UPDATING
- AUTOSCALING
- FORCE_STOPPING
- ROLLING_BACK
- MAINTENANCE
- ROLLED_BACK
ApplicationSummaries:
type: array
items:
$ref: '#/components/schemas/ApplicationSummary'
ApplicationSummary:
type: object
required:
- ApplicationName
- ApplicationARN
- ApplicationStatus
- ApplicationVersionId
- RuntimeEnvironment
properties:
ApplicationName:
allOf:
- $ref: '#/components/schemas/ApplicationName'
- description: The name of the application.
ApplicationARN:
allOf:
- $ref: '#/components/schemas/ResourceARN'
- description: The ARN of the application.
ApplicationStatus:
allOf:
- $ref: '#/components/schemas/ApplicationStatus'
- description: The status of the application.
ApplicationVersionId:
allOf:
- $ref: '#/components/schemas/ApplicationVersionId'
- description: Provides the current application version.
RuntimeEnvironment:
allOf:
- $ref: '#/components/schemas/RuntimeEnvironment'
- description: The runtime environment for the application.
ApplicationMode:
allOf:
- $ref: '#/components/schemas/ApplicationMode'
- description: For a Kinesis Data Analytics for Apache Flink application, the mode is STREAMING. For a Kinesis Data Analytics Studio notebook, it is INTERACTIVE.
description: Provides application summary information, including the application Amazon Resource Name (ARN), name, and status.
ListApplicationsInputLimit:
type: integer
minimum: 1
maximum: 50
InvalidRequestException: {}
ApplicationMode:
type: string
enum:
- STREAMING
- INTERACTIVE
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