This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see Amazon Kinesis Data Analytics API V2 Documentation.
Returns information about a specific Amazon Kinesis Analytics application.
If you want to retrieve a list of all applications in your account, use the ListApplications operation.
This operation requires permissions to perform the kinesisanalytics:DescribeApplication action. You can use DescribeApplication to get the current application versionId, which you need to call other operations such as Update.
Parameters:
Raises:
Source code in docs_src/capo_kinesis_analytics/_services/kinesis_analytics.py
| def describe_application(
self,
application_name: "capo_kinesis_analytics.types.application_name.ApplicationName",
*,
config_overrides: Optional[KinesisAnalyticsClientConfig] = None,
) -> "capo_kinesis_analytics.types.describe_application_response.DescribeApplicationResponse":
"""<note> <p>This documentation is for version 1 of the Amazon Kinesis Data Analytics API, which only supports SQL applications. Version 2 of the API supports SQL and Java applications. For more information about version 2, see <a href="/kinesisanalytics/latest/apiv2/Welcome.html">Amazon Kinesis Data Analytics API V2 Documentation</a>.</p> </note> <p>Returns information about a specific Amazon Kinesis Analytics application.</p> <p>If you want to retrieve a list of all applications in your account, use the <a href="https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_ListApplications.html">ListApplications</a> operation.</p> <p>This operation requires permissions to perform the <code>kinesisanalytics:DescribeApplication</code> action. You can use <code>DescribeApplication</code> to get the current application versionId, which you need to call other operations such as <code>Update</code>. </p>
Args:
application_name: <p>Name of the application.</p>
Raises:
capo_kinesis_analytics.errors.resource_not_found_exception.ResourceNotFoundException: <p>Specified application can't be found.</p>
capo_kinesis_analytics.errors.unsupported_operation_exception.UnsupportedOperationException: <p>The request was rejected because a specified parameter is not supported or a specified resource is not valid for this operation. </p>
capo_kinesis_analytics.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
def _handler(
req: "OperationRequest[capo_kinesis_analytics.types.describe_application_request.DescribeApplicationRequest]",
) -> OperationResponse[
"capo_kinesis_analytics.types.describe_application_response.DescribeApplicationResponse"
]:
import capo_kinesis_analytics._operations.kinesis_analytics_20150814.describe_application
output, http_response = (
capo_kinesis_analytics._operations.kinesis_analytics_20150814.describe_application.describe_application(
req.options, req.input
)
)
return OperationResponse(output=output, response=http_response)
interceptors_, options_ = self.operation_options(
config_overrides, OperationLogging("DescribeApplication")
)
input_: capo_kinesis_analytics.types.describe_application_request.DescribeApplicationRequest = {
"application_name": application_name
}
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|