View a markdown version of this page

StopTelemetryQuerySession - Amazon CloudWatch Omni

StopTelemetryQuerySession

Stops a telemetry query session.

Terminates the specified session. After a session is stopped it cannot be reused.

Request Parameters

sessionId

The unique ID of the session.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 64.

Pattern: [a-z0-9-]+

Required: Yes

Errors

For information about the errors that are common to all actions, see Common Error Types.

InternalServerException

An unexpected error occurred while processing the request.

errorCode

The error code associated with the internal error.

HTTP Status Code: 500

ResourceNotFoundException

The specified resource does not exist.

errorCode

The error code associated with the failure.

resourceId

The identifier of the resource that could not be found. Not always present.

resourceType

The type of the resource that could not be found. Not always present.

HTTP Status Code: 404

ThrottlingException

The request was throttled due to exceeding the allowed request rate.

retryAfterSeconds

The number of seconds to wait before retrying the request. Not always present.

HTTP Status Code: 429

ValidationException

A parameter is specified incorrectly.

errorCode

The error code associated with the validation failure.

HTTP Status Code: 400

Examples

Stop a telemetry query session

The following example terminates the specified session. Payloads are shown as JSON; on the wire they are CBOR-encoded.

Sample Request

{ "sessionId": "9f8c7d6e-5b4a-4c3d-9e2f-1a0b2c3d4e5f" }

Sample Response

{}

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: