새 프로젝트의 경우 Kinesis Data Analytics for SQL 애플리케이션보다 새로운 Managed Service for Apache Flink Studio를 사용하는 것이 좋습니다. Managed Service for Apache Flink Studio는 사용 편의성과 고급 분석 기능을 결합하여 정교한 스트림 처리 애플리케이션을 몇 분 만에 구축할 수 있도록 합니다.
기계 번역으로 제공되는 번역입니다. 제공된 번역과 원본 영어의 내용이 상충하는 경우에는 영어 버전이 우선합니다.
DescribeApplication
참고
이 설명서는 Amazon Kinesis Data Analytics API 버전 1용이며, SQL 애플리케이션만 지원합니다. API 버전 2에서 SQL 및 Java 애플리케이션을 지원합니다. 버전 2에 대한 자세한 설명은 Amazon Kinesis Data Analytics API V2 설명서를 참조하십시오.
Amazon Kinesis Analytics 애플리케이션에 대한 정보를 반환합니다.
계정의 모든 애플리케이션 목록을 검색하려면 ListApplications작업을 사용하십시오.
이 작업에는 kinesisanalytics:DescribeApplication
조치를 수행할 권한이 요구됩니다. Update
와 같은 다른 작업을 호출하는 데 필요한 현재 애플리케이션 버전 ID를 가져오는 데 DescribeApplication
을 사용할 수 있습니다.
구문 요청
{
"ApplicationName": "string
"
}
요청 파라미터
요청은 JSON 형식으로 다음 데이터를 받습니다.
- ApplicationName
-
애플리케이션의 명칭.
유형: 문자열
길이 제약: 최소 길이는 1. 최대 길이 128.
패턴:
[a-zA-Z0-9_.-]+
필수 항목 여부: 예
응답 구문
{
"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"
}
]
}
}
응답 요소
작업이 성공하면 서비스가 HTTP 200 응답을 반송합니다.
다음 데이터는 서비스에 의해 JSON 형식으로 반환됩니다.
- ApplicationDetail
-
애플리케이션 Amazon 리소스 이름(ARN), 상태, 최신 버전, 입력 및 출력 구성 세부 정보와 같은 애플리케이션에 대한 설명을 제공합니다.
유형: ApplicationDetail객체
Errors
- ResourceNotFoundException
-
지정된 애플리케이션을 찾을 수 없습니다.
HTTP 상태 코드: 400
- UnsupportedOperationException
-
지정된 파라미터가 지원되지 않거나 지정된 리소스가 이 작업에 유효하지 않아 요청이 거부되었습니다.
HTTP 상태 코드: 400
참고
언어별 AWS SDK 중 하나에서 이 API를 사용하는 방법에 대한 자세한 내용은 다음을 참조하십시오.