import type { MetadataBearer as __MetadataBearer } from "@smithy/types"; import type { DescribeApplicationRequest, DescribeApplicationResponse } from "../models/models_0"; /** * @public */ export type { __MetadataBearer }; /** * @public * * The input for {@link DescribeApplicationCommand}. */ export interface DescribeApplicationCommandInput extends DescribeApplicationRequest { } /** * @public * * The output of {@link DescribeApplicationCommand}. */ export interface DescribeApplicationCommandOutput extends DescribeApplicationResponse, __MetadataBearer { } declare const DescribeApplicationCommand_base: { new (input: DescribeApplicationCommandInput): import("@smithy/core/client").CommandImpl; new (input: DescribeApplicationCommandInput): import("@smithy/core/client").CommandImpl; getEndpointParameterInstructions(): import("@smithy/types").EndpointParameterInstructions; }; /** *

Returns information about a specific Managed Service for Apache Flink application.

*

If you want to retrieve a list of all applications in your account, * use the ListApplications operation.

* @example * Use a bare-bones client and the command you need to make an API call. * ```javascript * import { KinesisAnalyticsV2Client, DescribeApplicationCommand } from "@aws-sdk/client-kinesis-analytics-v2"; // ES Modules import * // const { KinesisAnalyticsV2Client, DescribeApplicationCommand } = require("@aws-sdk/client-kinesis-analytics-v2"); // CommonJS import * // import type { KinesisAnalyticsV2ClientConfig } from "@aws-sdk/client-kinesis-analytics-v2"; * const config = {}; // type is KinesisAnalyticsV2ClientConfig * const client = new KinesisAnalyticsV2Client(config); * const input = { // DescribeApplicationRequest * ApplicationName: "STRING_VALUE", // required * IncludeAdditionalDetails: true || false, * }; * const command = new DescribeApplicationCommand(input); * const response = await client.send(command); * // { // DescribeApplicationResponse * // ApplicationDetail: { // ApplicationDetail * // ApplicationARN: "STRING_VALUE", // required * // ApplicationDescription: "STRING_VALUE", * // ApplicationName: "STRING_VALUE", // required * // RuntimeEnvironment: "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" || "ZEPPELIN-FLINK-3_0" || "FLINK-1_18" || "FLINK-1_19" || "FLINK-1_20" || "FLINK-2_2" || "FLINK-2_3", // required * // ServiceExecutionRole: "STRING_VALUE", * // ApplicationStatus: "DELETING" || "STARTING" || "STOPPING" || "READY" || "RUNNING" || "UPDATING" || "AUTOSCALING" || "FORCE_STOPPING" || "ROLLING_BACK" || "MAINTENANCE" || "ROLLED_BACK", // required * // ApplicationVersionId: Number("long"), // required * // CreateTimestamp: new Date("TIMESTAMP"), * // LastUpdateTimestamp: new Date("TIMESTAMP"), * // ApplicationConfigurationDescription: { // ApplicationConfigurationDescription * // SqlApplicationConfigurationDescription: { // SqlApplicationConfigurationDescription * // InputDescriptions: [ // InputDescriptions * // { // InputDescription * // InputId: "STRING_VALUE", * // NamePrefix: "STRING_VALUE", * // InAppStreamNames: [ // InAppStreamNames * // "STRING_VALUE", * // ], * // InputProcessingConfigurationDescription: { // InputProcessingConfigurationDescription * // InputLambdaProcessorDescription: { // InputLambdaProcessorDescription * // ResourceARN: "STRING_VALUE", // required * // RoleARN: "STRING_VALUE", * // }, * // }, * // KinesisStreamsInputDescription: { // KinesisStreamsInputDescription * // ResourceARN: "STRING_VALUE", // required * // RoleARN: "STRING_VALUE", * // }, * // KinesisFirehoseInputDescription: { // KinesisFirehoseInputDescription * // ResourceARN: "STRING_VALUE", // required * // RoleARN: "STRING_VALUE", * // }, * // InputSchema: { // SourceSchema * // RecordFormat: { // RecordFormat * // RecordFormatType: "JSON" || "CSV", // required * // MappingParameters: { // MappingParameters * // JSONMappingParameters: { // JSONMappingParameters * // RecordRowPath: "STRING_VALUE", // required * // }, * // CSVMappingParameters: { // CSVMappingParameters * // RecordRowDelimiter: "STRING_VALUE", // required * // RecordColumnDelimiter: "STRING_VALUE", // required * // }, * // }, * // }, * // RecordEncoding: "STRING_VALUE", * // RecordColumns: [ // RecordColumns // required * // { // RecordColumn * // Name: "STRING_VALUE", // required * // Mapping: "STRING_VALUE", * // SqlType: "STRING_VALUE", // required * // }, * // ], * // }, * // InputParallelism: { // InputParallelism * // Count: Number("int"), * // }, * // InputStartingPositionConfiguration: { // InputStartingPositionConfiguration * // InputStartingPosition: "NOW" || "TRIM_HORIZON" || "LAST_STOPPED_POINT", * // }, * // }, * // ], * // OutputDescriptions: [ // OutputDescriptions * // { // OutputDescription * // OutputId: "STRING_VALUE", * // Name: "STRING_VALUE", * // KinesisStreamsOutputDescription: { // KinesisStreamsOutputDescription * // ResourceARN: "STRING_VALUE", // required * // RoleARN: "STRING_VALUE", * // }, * // KinesisFirehoseOutputDescription: { // KinesisFirehoseOutputDescription * // ResourceARN: "STRING_VALUE", // required * // RoleARN: "STRING_VALUE", * // }, * // LambdaOutputDescription: { // LambdaOutputDescription * // ResourceARN: "STRING_VALUE", // required * // RoleARN: "STRING_VALUE", * // }, * // DestinationSchema: { // DestinationSchema * // RecordFormatType: "JSON" || "CSV", // required * // }, * // }, * // ], * // ReferenceDataSourceDescriptions: [ // ReferenceDataSourceDescriptions * // { // ReferenceDataSourceDescription * // ReferenceId: "STRING_VALUE", // required * // TableName: "STRING_VALUE", // required * // S3ReferenceDataSourceDescription: { // S3ReferenceDataSourceDescription * // BucketARN: "STRING_VALUE", // required * // FileKey: "STRING_VALUE", // required * // ReferenceRoleARN: "STRING_VALUE", * // }, * // ReferenceSchema: { * // RecordFormat: { * // RecordFormatType: "JSON" || "CSV", // required * // MappingParameters: { * // JSONMappingParameters: { * // RecordRowPath: "STRING_VALUE", // required * // }, * // CSVMappingParameters: { * // RecordRowDelimiter: "STRING_VALUE", // required * // RecordColumnDelimiter: "STRING_VALUE", // required * // }, * // }, * // }, * // RecordEncoding: "STRING_VALUE", * // RecordColumns: [ // required * // { * // Name: "STRING_VALUE", // required * // Mapping: "STRING_VALUE", * // SqlType: "STRING_VALUE", // required * // }, * // ], * // }, * // }, * // ], * // }, * // ApplicationCodeConfigurationDescription: { // ApplicationCodeConfigurationDescription * // CodeContentType: "PLAINTEXT" || "ZIPFILE", // required * // CodeContentDescription: { // CodeContentDescription * // TextContent: "STRING_VALUE", * // CodeMD5: "STRING_VALUE", * // CodeSize: Number("long"), * // S3ApplicationCodeLocationDescription: { // S3ApplicationCodeLocationDescription * // BucketARN: "STRING_VALUE", // required * // FileKey: "STRING_VALUE", // required * // ObjectVersion: "STRING_VALUE", * // }, * // }, * // }, * // RunConfigurationDescription: { // RunConfigurationDescription * // ApplicationRestoreConfigurationDescription: { // ApplicationRestoreConfiguration * // ApplicationRestoreType: "SKIP_RESTORE_FROM_SNAPSHOT" || "RESTORE_FROM_LATEST_SNAPSHOT" || "RESTORE_FROM_CUSTOM_SNAPSHOT", // required * // SnapshotName: "STRING_VALUE", * // }, * // FlinkRunConfigurationDescription: { // FlinkRunConfiguration * // AllowNonRestoredState: true || false, * // }, * // }, * // FlinkApplicationConfigurationDescription: { // FlinkApplicationConfigurationDescription * // CheckpointConfigurationDescription: { // CheckpointConfigurationDescription * // ConfigurationType: "DEFAULT" || "CUSTOM", * // CheckpointingEnabled: true || false, * // CheckpointInterval: Number("long"), * // MinPauseBetweenCheckpoints: Number("long"), * // }, * // MonitoringConfigurationDescription: { // MonitoringConfigurationDescription * // ConfigurationType: "DEFAULT" || "CUSTOM", * // MetricsLevel: "APPLICATION" || "TASK" || "OPERATOR" || "PARALLELISM", * // LogLevel: "INFO" || "WARN" || "ERROR" || "DEBUG", * // }, * // ParallelismConfigurationDescription: { // ParallelismConfigurationDescription * // ConfigurationType: "DEFAULT" || "CUSTOM", * // Parallelism: Number("int"), * // ParallelismPerKPU: Number("int"), * // CurrentParallelism: Number("int"), * // AutoScalingEnabled: true || false, * // }, * // JobPlanDescription: "STRING_VALUE", * // }, * // EnvironmentPropertyDescriptions: { // EnvironmentPropertyDescriptions * // PropertyGroupDescriptions: [ // PropertyGroups * // { // PropertyGroup * // PropertyGroupId: "STRING_VALUE", // required * // PropertyMap: { // PropertyMap // required * // "": "STRING_VALUE", * // }, * // }, * // ], * // }, * // ApplicationSnapshotConfigurationDescription: { // ApplicationSnapshotConfigurationDescription * // SnapshotsEnabled: true || false, // required * // }, * // ApplicationSystemRollbackConfigurationDescription: { // ApplicationSystemRollbackConfigurationDescription * // RollbackEnabled: true || false, // required * // }, * // VpcConfigurationDescriptions: [ // VpcConfigurationDescriptions * // { // VpcConfigurationDescription * // VpcConfigurationId: "STRING_VALUE", // required * // VpcId: "STRING_VALUE", // required * // SubnetIds: [ // SubnetIds // required * // "STRING_VALUE", * // ], * // SecurityGroupIds: [ // SecurityGroupIds // required * // "STRING_VALUE", * // ], * // }, * // ], * // ZeppelinApplicationConfigurationDescription: { // ZeppelinApplicationConfigurationDescription * // MonitoringConfigurationDescription: { // ZeppelinMonitoringConfigurationDescription * // LogLevel: "INFO" || "WARN" || "ERROR" || "DEBUG", * // }, * // CatalogConfigurationDescription: { // CatalogConfigurationDescription * // GlueDataCatalogConfigurationDescription: { // GlueDataCatalogConfigurationDescription * // DatabaseARN: "STRING_VALUE", // required * // }, * // }, * // DeployAsApplicationConfigurationDescription: { // DeployAsApplicationConfigurationDescription * // S3ContentLocationDescription: { // S3ContentBaseLocationDescription * // BucketARN: "STRING_VALUE", // required * // BasePath: "STRING_VALUE", * // }, * // }, * // CustomArtifactsConfigurationDescription: [ // CustomArtifactsConfigurationDescriptionList * // { // CustomArtifactConfigurationDescription * // ArtifactType: "UDF" || "DEPENDENCY_JAR", * // S3ContentLocationDescription: { // S3ContentLocation * // BucketARN: "STRING_VALUE", // required * // FileKey: "STRING_VALUE", // required * // ObjectVersion: "STRING_VALUE", * // }, * // MavenReferenceDescription: { // MavenReference * // GroupId: "STRING_VALUE", // required * // ArtifactId: "STRING_VALUE", // required * // Version: "STRING_VALUE", // required * // }, * // }, * // ], * // }, * // ApplicationEncryptionConfigurationDescription: { // ApplicationEncryptionConfigurationDescription * // KeyId: "STRING_VALUE", * // KeyType: "AWS_OWNED_KEY" || "CUSTOMER_MANAGED_KEY", // required * // }, * // }, * // CloudWatchLoggingOptionDescriptions: [ // CloudWatchLoggingOptionDescriptions * // { // CloudWatchLoggingOptionDescription * // CloudWatchLoggingOptionId: "STRING_VALUE", * // LogStreamARN: "STRING_VALUE", // required * // RoleARN: "STRING_VALUE", * // }, * // ], * // ApplicationMaintenanceConfigurationDescription: { // ApplicationMaintenanceConfigurationDescription * // ApplicationMaintenanceWindowStartTime: "STRING_VALUE", // required * // ApplicationMaintenanceWindowEndTime: "STRING_VALUE", // required * // }, * // ApplicationVersionUpdatedFrom: Number("long"), * // ApplicationVersionRolledBackFrom: Number("long"), * // ApplicationVersionCreateTimestamp: new Date("TIMESTAMP"), * // ConditionalToken: "STRING_VALUE", * // ApplicationVersionRolledBackTo: Number("long"), * // ApplicationMode: "STREAMING" || "INTERACTIVE", * // }, * // }; * * ``` * * @param DescribeApplicationCommandInput - {@link DescribeApplicationCommandInput} * @returns {@link DescribeApplicationCommandOutput} * @see {@link DescribeApplicationCommandInput} for command's `input` shape. * @see {@link DescribeApplicationCommandOutput} for command's `response` shape. * @see {@link KinesisAnalyticsV2ClientResolvedConfig | config} for KinesisAnalyticsV2Client's `config` shape. * * @throws {@link InvalidArgumentException} (client fault) *

The specified input parameter value is not valid.

* * @throws {@link InvalidRequestException} (client fault) *

The request JSON is not valid for the operation.

* * @throws {@link ResourceNotFoundException} (client fault) *

Specified application can't be found.

* * @throws {@link KinesisAnalyticsV2ServiceException} *

Base exception class for all service exceptions from KinesisAnalyticsV2 service.

* * * @public */ export declare class DescribeApplicationCommand extends DescribeApplicationCommand_base { /** @internal type navigation helper, not in runtime. */ protected static __types: { api: { input: DescribeApplicationRequest; output: DescribeApplicationResponse; }; sdk: { input: DescribeApplicationCommandInput; output: DescribeApplicationCommandOutput; }; }; }