Skip to content

describe_application_snapshot 

describe_application_snapshot(
    application_name: ApplicationName,
    snapshot_name: SnapshotName,
    *,
    config_overrides: Optional[KinesisAnalyticsV2ClientConfig] = None,
) -> DescribeApplicationSnapshotResponse

Returns information about a snapshot of application state data.

Parameters:

  • application_name (ApplicationName) –

    The name of an existing application.

  • snapshot_name (SnapshotName) –

    The identifier of an application snapshot. You can retrieve this value using .

Raises:

Source code in docs_src/capo_kinesis_analytics_v2/_services/kinesis_analytics_v2.py 
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
def describe_application_snapshot(
    self,
    application_name: "capo_kinesis_analytics_v2.types.application_name.ApplicationName",
    snapshot_name: "capo_kinesis_analytics_v2.types.snapshot_name.SnapshotName",
    *,
    config_overrides: Optional[KinesisAnalyticsV2ClientConfig] = None,
) -> "capo_kinesis_analytics_v2.types.describe_application_snapshot_response.DescribeApplicationSnapshotResponse":
    """<p>Returns information about a snapshot of application state data.</p>

    Args:
        application_name: <p>The name of an existing application.</p>
        snapshot_name: <p>The identifier of an application snapshot. You can retrieve this value using .</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.resource_not_found_exception.ResourceNotFoundException: <p>Specified application can't be found.</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.
    """

    def _handler(
        req: "OperationRequest[capo_kinesis_analytics_v2.types.describe_application_snapshot_request.DescribeApplicationSnapshotRequest]",
    ) -> OperationResponse[
        "capo_kinesis_analytics_v2.types.describe_application_snapshot_response.DescribeApplicationSnapshotResponse"
    ]:
        import capo_kinesis_analytics_v2._operations.kinesis_analytics_20180523.describe_application_snapshot

        output, http_response = (
            capo_kinesis_analytics_v2._operations.kinesis_analytics_20180523.describe_application_snapshot.describe_application_snapshot(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeApplicationSnapshot")
    )
    input_: capo_kinesis_analytics_v2.types.describe_application_snapshot_request.DescribeApplicationSnapshotRequest = {
        "application_name": application_name,
        "snapshot_name": snapshot_name,
    }

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output