Class StopStreamingSessionCommandProtected

Transitions sessions from the READY state into the STOPPED state. The STOP_IN_PROGRESS state is the intermediate state between the READY and STOPPED states.

Example

Use a bare-bones client and the command you need to make an API call.

import { NimbleClient, StopStreamingSessionCommand } from "@aws-sdk/client-nimble"; // ES Modules import
// const { NimbleClient, StopStreamingSessionCommand } = require("@aws-sdk/client-nimble"); // CommonJS import
const client = new NimbleClient(config);
const input = { // StopStreamingSessionRequest
  clientToken: "STRING_VALUE",
  sessionId: "STRING_VALUE", // required
  studioId: "STRING_VALUE", // required
  volumeRetentionMode: "RETAIN" || "DELETE",
};
const command = new StopStreamingSessionCommand(input);
const response = await client.send(command);
// { // StopStreamingSessionResponse
//   session: { // StreamingSession
//     arn: "STRING_VALUE",
//     createdAt: new Date("TIMESTAMP"),
//     createdBy: "STRING_VALUE",
//     ec2InstanceType: "STRING_VALUE",
//     launchProfileId: "STRING_VALUE",
//     ownedBy: "STRING_VALUE",
//     sessionId: "STRING_VALUE",
//     state: "CREATE_IN_PROGRESS" || "DELETE_IN_PROGRESS" || "READY" || "DELETED" || "CREATE_FAILED" || "DELETE_FAILED" || "STOP_IN_PROGRESS" || "START_IN_PROGRESS" || "STOPPED" || "STOP_FAILED" || "START_FAILED",
//     statusCode: "STREAMING_SESSION_READY" || "STREAMING_SESSION_DELETED" || "STREAMING_SESSION_CREATE_IN_PROGRESS" || "STREAMING_SESSION_DELETE_IN_PROGRESS" || "INTERNAL_ERROR" || "INSUFFICIENT_CAPACITY" || "ACTIVE_DIRECTORY_DOMAIN_JOIN_ERROR" || "NETWORK_CONNECTION_ERROR" || "INITIALIZATION_SCRIPT_ERROR" || "DECRYPT_STREAMING_IMAGE_ERROR" || "NETWORK_INTERFACE_ERROR" || "STREAMING_SESSION_STOPPED" || "STREAMING_SESSION_STARTED" || "STREAMING_SESSION_STOP_IN_PROGRESS" || "STREAMING_SESSION_START_IN_PROGRESS" || "AMI_VALIDATION_ERROR",
//     statusMessage: "STRING_VALUE",
//     streamingImageId: "STRING_VALUE",
//     tags: { // Tags
//       "<keys>": "STRING_VALUE",
//     },
//     terminateAt: new Date("TIMESTAMP"),
//     updatedAt: new Date("TIMESTAMP"),
//     updatedBy: "STRING_VALUE",
//     stoppedAt: new Date("TIMESTAMP"),
//     stoppedBy: "STRING_VALUE",
//     startedAt: new Date("TIMESTAMP"),
//     startedBy: "STRING_VALUE",
//     stopAt: new Date("TIMESTAMP"),
//     startedFromBackupId: "STRING_VALUE",
//     backupMode: "AUTOMATIC" || "DEACTIVATED",
//     maxBackupsToRetain: Number("int"),
//     volumeRetentionMode: "RETAIN" || "DELETE",
//     sessionPersistenceMode: "DEACTIVATED" || "ACTIVATED",
//     volumeConfiguration: { // VolumeConfiguration
//       size: Number("int"),
//       throughput: Number("int"),
//       iops: Number("int"),
//     },
//     automaticTerminationMode: "DEACTIVATED" || "ACTIVATED",
//   },
// };

Param

StopStreamingSessionCommandInput

Returns

StopStreamingSessionCommandOutput

See

• StopStreamingSessionCommandInput for command's input shape.
• StopStreamingSessionCommandOutput for command's response shape.
• config for NimbleClient's config shape.

Throws

AccessDeniedException (client fault)

You are not authorized to perform this operation. Check your IAM policies, and ensure that you are using the correct access keys.

Throws

ConflictException (client fault)

Another operation is in progress.

Throws

InternalServerErrorException (server fault)

An internal error has occurred. Please retry your request.

Throws

ResourceNotFoundException (client fault)

The specified resource could not be found.

Throws

ServiceQuotaExceededException (client fault)

Your current quota does not allow you to perform the request action. You can request increases for some quotas, and other quotas cannot be increased.

Please use Amazon Web Services Service Quotas to request an increase.

Throws

ThrottlingException (client fault)

The request throughput limit was exceeded.

Throws

ValidationException (client fault)

One of the parameters in the request is invalid.

Throws

NimbleServiceException

Base exception class for all service exceptions from Nimble service.