DescribeApplication - Amazon-Kinesis-Data-Analytics für SQL-Anwendungen

Für neue Projekte empfehlen wir, den neuen Managed Service für Apache Flink Studio anstelle von Kinesis-Data-Analytics-for-SQL-Anwendungen zu verwenden. Der Managed Service für Apache Flink Studio kombiniert Benutzerfreundlichkeit mit fortschrittlichen Analysefunktionen, sodass Sie in wenigen Minuten anspruchsvolle Anwendungen zur Stream-Verarbeitung erstellen können.

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

DescribeApplication

Anmerkung

Diese Dokumentation bezieht sich auf Version 1 der Amazon-Kinesis-Data-Analytics-API, die nur SQL-Anwendungen unterstützt. Version 2 der API unterstützt SQL- und Java-Anwendungen. Weitere Informationen zu Version 2 finden Sie in der Amazon-Kinesis-Data-Analytics-API-V2-Dokumentation.

Gibt Informationen hinsichtlich einer bestimmten Amazon-Kinesis-Analytics-Anwendung zurück.

Wenn Sie eine Liste aller Anwendungen in Ihrem Konto abrufen möchten, verwenden Sie den ListApplicationsVorgang.

Diese Operation erfordert zur Ausführung der kinesisanalytics:DescribeApplication-Aktion Berechtigungen. Sie können DescribeApplication verwenden, um die aktuelle versionId der Anwendung abzurufen, die Sie benötigen, um andere Operationen wie Update aufzurufen.

Anforderungssyntax

{ "ApplicationName": "string" }

Anforderungsparameter

Die Anforderung akzeptiert die folgenden Daten im JSON-Format.

ApplicationName

Name der Anwendung.

Typ: Zeichenfolge

Längenbeschränkungen: Minimale Länge beträgt 1 Zeichen. Maximale Länge beträgt 128 Zeichen.

Pattern: [a-zA-Z0-9_.-]+

Erforderlich: Ja

Antwortsyntax

{ "ApplicationDetail": { "ApplicationARN": "string", "ApplicationCode": "string", "ApplicationDescription": "string", "ApplicationName": "string", "ApplicationStatus": "string", "ApplicationVersionId": number, "CloudWatchLoggingOptionDescriptions": [ { "CloudWatchLoggingOptionId": "string", "LogStreamARN": "string", "RoleARN": "string" } ], "CreateTimestamp": number, "InputDescriptions": [ { "InAppStreamNames": [ "string" ], "InputId": "string", "InputParallelism": { "Count": number }, "InputProcessingConfigurationDescription": { "InputLambdaProcessorDescription": { "ResourceARN": "string", "RoleARN": "string" } }, "InputSchema": { "RecordColumns": [ { "Mapping": "string", "Name": "string", "SqlType": "string" } ], "RecordEncoding": "string", "RecordFormat": { "MappingParameters": { "CSVMappingParameters": { "RecordColumnDelimiter": "string", "RecordRowDelimiter": "string" }, "JSONMappingParameters": { "RecordRowPath": "string" } }, "RecordFormatType": "string" } }, "InputStartingPositionConfiguration": { "InputStartingPosition": "string" }, "KinesisFirehoseInputDescription": { "ResourceARN": "string", "RoleARN": "string" }, "KinesisStreamsInputDescription": { "ResourceARN": "string", "RoleARN": "string" }, "NamePrefix": "string" } ], "LastUpdateTimestamp": number, "OutputDescriptions": [ { "DestinationSchema": { "RecordFormatType": "string" }, "KinesisFirehoseOutputDescription": { "ResourceARN": "string", "RoleARN": "string" }, "KinesisStreamsOutputDescription": { "ResourceARN": "string", "RoleARN": "string" }, "LambdaOutputDescription": { "ResourceARN": "string", "RoleARN": "string" }, "Name": "string", "OutputId": "string" } ], "ReferenceDataSourceDescriptions": [ { "ReferenceId": "string", "ReferenceSchema": { "RecordColumns": [ { "Mapping": "string", "Name": "string", "SqlType": "string" } ], "RecordEncoding": "string", "RecordFormat": { "MappingParameters": { "CSVMappingParameters": { "RecordColumnDelimiter": "string", "RecordRowDelimiter": "string" }, "JSONMappingParameters": { "RecordRowPath": "string" } }, "RecordFormatType": "string" } }, "S3ReferenceDataSourceDescription": { "BucketARN": "string", "FileKey": "string", "ReferenceRoleARN": "string" }, "TableName": "string" } ] } }

Antwortelemente

Wenn die Aktion erfolgreich ist, sendet der Service eine HTTP 200-Antwort zurück.

Die folgenden Daten werden vom Service im JSON-Format zurückgegeben.

ApplicationDetail

Stellt eine Beschreibung der Anwendung bereit, z. B. den Amazon-Ressourcennamen (ARN) der Anwendung, den Status, die neueste Version sowie Informationen zur Eingabe- und Ausgabekonfiguration.

Typ: ApplicationDetail Objekt

Fehler

ResourceNotFoundException

Die angegebene Anwendung kann nicht gefunden werden.

HTTP Status Code: 400

UnsupportedOperationException

Die Anfrage wurde abgelehnt, weil ein bestimmter Parameter nicht unterstützt wird oder eine angegebene Ressource für diesen Vorgang nicht gültig ist.

HTTP Status Code: 400

Weitere Informationen finden Sie unter:

Weitere Informationen zur Verwendung dieser API in einem der sprachspezifischen AWS SDKs finden Sie im Folgenden: