Sintaxis de la solicitud Parámetros de la solicitud Sintaxis de la respuesta Elementos de respuesta Errores Véase también

Para proyectos nuevos, le recomendamos que utilice el nuevo servicio gestionado para Apache Flink Studio en lugar de aplicaciones de Kinesis Data Analytics para SQL. El servicio gestionado para Apache Flink Studio combina la facilidad de uso con capacidades analíticas avanzadas, lo que le permite crear aplicaciones sofisticadas de procesamiento de flujos en cuestión de minutos.

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

DescribeApplication

nota

Esta documentación es para la versión 1 de la API de Amazon Kinesis Data Analytics, que solo admite aplicaciones SQL. La versión 2 de la API admite aplicaciones SQL y Java. Para obtener más información acerca de la versión 2, consulte la documentación de la API V2 de Amazon Kinesis Data Analytics.

Devuelve información sobre una aplicación específica de Amazon Kinesis Analytics.

Si desea recuperar una lista de todas las aplicaciones de su cuenta, utilice la ListApplicationsoperación.

Esto operación requiere permisos para realizar la acción kinesisanalytics:DescribeApplication. Puede usar DescribeApplication para obtener el VersionID de la aplicación actual, al que necesita para llamar a otras operaciones, como Update.

Sintaxis de la solicitud


{
   "ApplicationName": "string"
}

Parámetros de la solicitud

La solicitud acepta los siguientes datos en formato JSON.

ApplicationName

Nombre de la aplicación.

Tipo: string

Limitaciones de longitud: longitud mínima de 1. Longitud máxima de 128.

Patrón: [a-zA-Z0-9_.-]+

Obligatorio: sí

Sintaxis de la respuesta


{
   "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 respuesta

Si la acción se realiza correctamente, el servicio devuelve una respuesta HTTP 200.

El servicio devuelve los datos siguientes en formato JSON.

ApplicationDetail

Proporciona una descripción de la aplicación, como el nombre de recurso de Amazon (ARN) de la aplicación, el estado, la última versión y los detalles de configuración de entrada y salida.

Tipo: objeto ApplicationDetail