Returns information about a specific Managed Service for Apache Flink application.
If you want to retrieve a list of all applications in your account, use the ListApplications operation.
Parameters:
-
application_name
(ApplicationName)
–
The name of the application.
-
include_additional_details
(Optional[BooleanObject], default:
None
)
–
Displays verbose information about a Managed Service for Apache Flink application, including the application's job plan.
Raises:
Source code in docs_src/capo_kinesis_analytics_v2/_services/kinesis_analytics_v2.py
| def describe_application(
self,
application_name: "capo_kinesis_analytics_v2.types.application_name.ApplicationName",
*,
config_overrides: Optional[KinesisAnalyticsV2ClientConfig] = None,
include_additional_details: Optional[
"capo_kinesis_analytics_v2.types.boolean_object.BooleanObject"
] = None,
) -> "capo_kinesis_analytics_v2.types.describe_application_response.DescribeApplicationResponse":
"""<p>Returns information about a specific Managed Service for Apache Flink application.</p> <p>If you want to retrieve a list of all applications in your account, use the <a>ListApplications</a> operation.</p>
Args:
application_name: <p>The name of the application.</p>
include_additional_details: <p>Displays verbose information about a Managed Service for Apache Flink application, including the application's job plan.</p>
Raises:
capo_kinesis_analytics_v2.errors.invalid_argument_exception.InvalidArgumentException: <p>The specified input parameter value is not valid.</p>
capo_kinesis_analytics_v2.errors.invalid_request_exception.InvalidRequestException: <p>The request JSON is not valid for the operation.</p>
capo_kinesis_analytics_v2.errors.resource_not_found_exception.ResourceNotFoundException: <p>Specified application can't be found.</p>
capo_kinesis_analytics_v2.errors.UnknownServiceError: The service returned an error code this client does not model.
"""
def _handler(
req: "OperationRequest[capo_kinesis_analytics_v2.types.describe_application_request.DescribeApplicationRequest]",
) -> OperationResponse[
"capo_kinesis_analytics_v2.types.describe_application_response.DescribeApplicationResponse"
]:
import capo_kinesis_analytics_v2._operations.kinesis_analytics_20180523.describe_application
output, http_response = (
capo_kinesis_analytics_v2._operations.kinesis_analytics_20180523.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_v2.types.describe_application_request.DescribeApplicationRequest = {
"application_name": application_name
}
if include_additional_details is not None:
input_["include_additional_details"] = include_additional_details
response = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|