list_applications `async` ¶

list_applications(
    *,
    config_overrides: Optional[AsyncKinesisAnalyticsClientConfig] = None,
    limit: Optional[ListApplicationsInputLimit] = None,
    exclusive_start_application_name: Optional[ApplicationName] = None,
) -> ListApplicationsResponse

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 a list of Amazon Kinesis Analytics applications in your account. For each application, the response includes the application name, Amazon Resource Name (ARN), and status. If the response returns the HasMoreApplications value as true, you can send another request by adding the ExclusiveStartApplicationName in the request body, and set the value of this to the last application name from the previous response.

If you want detailed information about a specific application, use DescribeApplication.

This operation requires permissions to perform the kinesisanalytics:ListApplications action.

Parameters:

limit (Optional[ListApplicationsInputLimit], default: None ) –

Maximum number of applications to list.
exclusive_start_application_name (Optional[ApplicationName], default: None ) –

Name of the application to start the list with. When using pagination to retrieve the list, you don't need to specify this parameter in the first request. However, in subsequent requests, you add the last application name from the previous response to get the next page of applications.

Raises:

UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_kinesis_analytics/_services/async_kinesis_analytics.py

async def list_applications(
    self,
    *,
    config_overrides: Optional[AsyncKinesisAnalyticsClientConfig] = None,
    limit: Optional[
        "capo_kinesis_analytics.types.list_applications_input_limit.ListApplicationsInputLimit"
    ] = None,
    exclusive_start_application_name: Optional[
        "capo_kinesis_analytics.types.application_name.ApplicationName"
    ] = None,
) -> "capo_kinesis_analytics.types.list_applications_response.ListApplicationsResponse":
    """<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 a list of Amazon Kinesis Analytics applications in your account. For each application, the response includes the application name, Amazon Resource Name (ARN), and status. If the response returns the <code>HasMoreApplications</code> value as true, you can send another request by adding the <code>ExclusiveStartApplicationName</code> in the request body, and set the value of this to the last application name from the previous response. </p> <p>If you want detailed information about a specific application, use <a href="https://docs.aws.amazon.com/kinesisanalytics/latest/dev/API_DescribeApplication.html">DescribeApplication</a>.</p> <p>This operation requires permissions to perform the <code>kinesisanalytics:ListApplications</code> action.</p>

    Args:
        limit: <p>Maximum number of applications to list.</p>
        exclusive_start_application_name: <p>Name of the application to start the list with. When using pagination to retrieve the list, you don't need to specify this parameter in the first request. However, in subsequent requests, you add the last application name from the previous response to get the next page of applications.</p>

    Raises:
        capo_kinesis_analytics.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_kinesis_analytics.types.list_applications_request.ListApplicationsRequest]",
    ) -> AsyncOperationResponse[
        "capo_kinesis_analytics.types.list_applications_response.ListApplicationsResponse"
    ]:
        import capo_kinesis_analytics._operations.kinesis_analytics_20150814.list_applications

        (
            output,
            http_response,
        ) = await capo_kinesis_analytics._operations.kinesis_analytics_20150814.list_applications.async_list_applications(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListApplications")
    )
    input_: capo_kinesis_analytics.types.list_applications_request.ListApplicationsRequest = {}
    if limit is not None:
        input_["limit"] = limit
    if exclusive_start_application_name is not None:
        input_["exclusive_start_application_name"] = (
            exclusive_start_application_name
        )

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

list_applications async ¶

list_applications `async` ¶