Skip to content

list_application_snapshots async

list_application_snapshots(
    application_name: ApplicationName,
    *,
    config_overrides: Optional[AsyncKinesisAnalyticsV2ClientConfig] = None,
    limit: Optional[ListSnapshotsInputLimit] = None,
    next_token: Optional[NextToken] = None,
) -> ListApplicationSnapshotsResponse

Lists information about the current application snapshots.

Parameters:

  • application_name (ApplicationName) –

    The name of an existing application.

  • limit (Optional[ListSnapshotsInputLimit], default: None ) –

    The maximum number of application snapshots to list.

  • next_token (Optional[NextToken], default: None ) –

    Use this parameter if you receive a NextToken response in a previous request that indicates that there is more output available. Set it to the value of the previous call's NextToken response to indicate where the output should continue from.

Raises:

Source code in docs_src/capo_kinesis_analytics_v2/_services/async_kinesis_analytics_v2.py
async def list_application_snapshots(
    self,
    application_name: "capo_kinesis_analytics_v2.types.application_name.ApplicationName",
    *,
    config_overrides: Optional[AsyncKinesisAnalyticsV2ClientConfig] = None,
    limit: Optional[
        "capo_kinesis_analytics_v2.types.list_snapshots_input_limit.ListSnapshotsInputLimit"
    ] = None,
    next_token: Optional[
        "capo_kinesis_analytics_v2.types.next_token.NextToken"
    ] = None,
) -> "capo_kinesis_analytics_v2.types.list_application_snapshots_response.ListApplicationSnapshotsResponse":
    """<p>Lists information about the current application snapshots.</p>

    Args:
        application_name: <p>The name of an existing application.</p>
        limit: <p>The maximum number of application snapshots to list.</p>
        next_token: <p>Use this parameter if you receive a <code>NextToken</code> response in a previous request that indicates that there is more output available. Set it to the value of the previous call's <code>NextToken</code> response to indicate where the output should continue from. </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.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_v2.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_kinesis_analytics_v2.types.list_application_snapshots_request.ListApplicationSnapshotsRequest]",
    ) -> AsyncOperationResponse[
        "capo_kinesis_analytics_v2.types.list_application_snapshots_response.ListApplicationSnapshotsResponse"
    ]:
        import capo_kinesis_analytics_v2._operations.kinesis_analytics_20180523.list_application_snapshots

        (
            output,
            http_response,
        ) = await capo_kinesis_analytics_v2._operations.kinesis_analytics_20180523.list_application_snapshots.async_list_application_snapshots(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListApplicationSnapshots")
    )
    input_: capo_kinesis_analytics_v2.types.list_application_snapshots_request.ListApplicationSnapshotsRequest = {
        "application_name": application_name
    }
    if limit is not None:
        input_["limit"] = limit
    if next_token is not None:
        input_["next_token"] = next_token

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