Para novos projetos, recomendamos que você use o novo Managed Service for Apache Flink Studio em vez do Kinesis Data Analytics para aplicativos SQL. O Managed Service for Apache Flink Studio combina facilidade de uso com recursos analíticos avançados, permitindo que você crie aplicativos sofisticados de processamento de stream em minutos.
As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá.
DescribeApplication
nota
Esta documentação é para a versão 1 da API do Amazon Kinesis Data Analytics, que oferece suporte somente a aplicativos SQL. A versão 2 da API oferece suporte a aplicativos Java e SQL. Para obter mais informações sobre a versão 2, consulte Documentação da API V2 do Amazon Kinesis Data Analytics.
Retorna informações sobre um aplicativo específico do Amazon Kinesis Analytics.
Se você quiser recuperar uma lista de todos os aplicativos em sua conta, use a ListApplicationsoperação.
Essa operação exige permissões para executar a ação kinesisanalytics:DescribeApplication. Você pode usar DescribeApplication para obter o versionId atual do aplicativo, que você precisa para chamar outras operações, como Update.
Sintaxe da Solicitação
{
"ApplicationName": "string"
}Parâmetros da solicitação
A solicitação aceita os dados a seguir no formato JSON.
- ApplicationName
-
Nome do aplicativo.
Tipo: sequência
Restrições de tamanho: tamanho mínimo 1. O tamanho máximo é 128.
Padrão:
[a-zA-Z0-9_.-]+Exigido: Sim
Sintaxe da Resposta
{
"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"
}
]
}
}Elementos de Resposta
Se a ação for bem-sucedida, o serviço retornará uma resposta HTTP 200.
Os dados a seguir são retornados no formato JSON pelo serviço.
- ApplicationDetail
-
Fornece uma descrição do aplicativo, como o nome do recurso da Amazon (ARN) do aplicativo, status, versão mais recente e detalhes da configuração de entrada e saída.
Tipo: objeto ApplicationDetail
Erros
- ResourceNotFoundException
-
O aplicativo especificado não pode ser encontrado.
Código de Status HTTP: 400
- UnsupportedOperationException
-
A solicitação foi rejeitada porque um parâmetro especificado não é compatível ou um recurso especificado não é válido para esta operação.
Código de Status HTTP: 400
Consulte também
Para obter mais informações sobre como usar essa API em um dos AWS SDKs específicos da linguagem, consulte o seguinte:
