openapi: 3.0.0
info:
version: 2015-08-04
x-release: v4
title: 'Amazon Kinesis Firehose CreateSignalingChannel #X Amz Target=KinesisAnalytics 20180523.ListApplicationSnapshots 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.ListApplicationSnapshots' paths: /#X-Amz-Target=KinesisAnalytics_20180523.ListApplicationSnapshots: 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: ListApplicationSnapshots description: Lists information about the current application snapshots. responses: '200': description: Success content: application/json: schema: $ref: '#/components/schemas/ListApplicationSnapshotsResponse' '480': description: InvalidArgumentException content: application/json: schema: $ref: '#/components/schemas/InvalidArgumentException' '481': description: UnsupportedOperationException content: application/json: schema: $ref: '#/components/schemas/UnsupportedOperationException' requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ListApplicationSnapshotsRequest' parameters: - name: X-Amz-Target in: header required: true schema: type: string enum: - KinesisAnalytics_20180523.ListApplicationSnapshots tags: - '#X Amz Target=KinesisAnalytics 20180523.ListApplicationSnapshots' 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: SnapshotSummaries: type: array items: $ref: '#/components/schemas/SnapshotDetails' ApplicationName: type: string pattern: '[a-zA-Z0-9_.-]+' minLength: 1 maxLength: 128 ApplicationVersionId: type: integer minimum: 1 maximum: 999999999 ListApplicationSnapshotsRequest: type: object required: - ApplicationName title: ListApplicationSnapshotsRequest properties: ApplicationName: allOf: - $ref: '#/components/schemas/ApplicationName' - description: The name of an existing application. Limit: allOf: - $ref: '#/components/schemas/ListSnapshotsInputLimit' - description: The maximum number of application snapshots to list. NextToken: allOf: - $ref: '#/components/schemas/NextToken' - description: 'Use this parameter if you receive aNextToken response in a previous request that indicates that there is more output available. Set it to the value of the previous call''s NextToken response to indicate where the output should continue from. '
ListApplicationSnapshotsResponse:
type: object
properties:
SnapshotSummaries:
allOf:
- $ref: '#/components/schemas/SnapshotSummaries'
- description: A collection of objects containing information about the application snapshots.
NextToken:
allOf:
- $ref: '#/components/schemas/NextToken'
- description: The token for the next set of results, or null if there are no additional results.
NextToken:
type: string
minLength: 1
maxLength: 512
UnsupportedOperationException: {}
InvalidArgumentException: {}
ListSnapshotsInputLimit:
type: integer
minimum: 1
maximum: 50
SnapshotName:
type: string
pattern: '[a-zA-Z0-9_.-]+'
minLength: 1
maxLength: 256
SnapshotDetails:
type: object
required:
- SnapshotName
- SnapshotStatus
- ApplicationVersionId
properties:
SnapshotName:
allOf:
- $ref: '#/components/schemas/SnapshotName'
- description: The identifier for the application snapshot.
SnapshotStatus:
allOf:
- $ref: '#/components/schemas/SnapshotStatus'
- description: The status of the application snapshot.
ApplicationVersionId:
allOf:
- $ref: '#/components/schemas/ApplicationVersionId'
- description: The current application version ID when the snapshot was created.
SnapshotCreationTimestamp:
allOf:
- $ref: '#/components/schemas/Timestamp'
- description: The timestamp of the application snapshot.
description: Provides details about a snapshot of application state.
SnapshotStatus:
type: string
enum:
- CREATING
- READY
- DELETING
- FAILED
Timestamp:
type: string
format: date-time
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