- Navigation GuideYou are on a Command (operation) page with structural examples. Use the navigation breadcrumb if you would like to return to the Client landing page.
StopSessionCommand
Stops the session.
Example Syntax
Use a bare-bones client and the command you need to make an API call.
import { GlueClient, StopSessionCommand } from "@aws-sdk/client-glue"; // ES Modules import
// const { GlueClient, StopSessionCommand } = require("@aws-sdk/client-glue"); // CommonJS import
const client = new GlueClient(config);
const input = { // StopSessionRequest
Id: "STRING_VALUE", // required
RequestOrigin: "STRING_VALUE",
};
const command = new StopSessionCommand(input);
const response = await client.send(command);
// { // StopSessionResponse
// Id: "STRING_VALUE",
// };
StopSessionCommand Input
See StopSessionCommandInput for more details
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
IdRequired | string | undefined | The ID of the session to be stopped. |
RequestOrigin | string | undefined | The origin of the request. |
StopSessionCommand Output
See StopSessionCommandOutput for details
Parameter | Type | Description |
|---|
Parameter | Type | Description |
|---|---|---|
$metadataRequired | ResponseMetadata | Metadata pertaining to this request. |
Id | string | undefined | Returns the Id of the stopped session. |
Throws
Name | Fault | Details |
|---|
Name | Fault | Details |
|---|---|---|
| AccessDeniedException | client | Access to a resource was denied. |
| ConcurrentModificationException | client | Two processes are trying to modify a resource simultaneously. |
| IllegalSessionStateException | client | The session is in an invalid state to perform a requested operation. |
| InternalServiceException | server | An internal service error occurred. |
| InvalidInputException | client | The input provided was not valid. |
| OperationTimeoutException | client | The operation timed out. |
| GlueServiceException | Base exception class for all service exceptions from Glue service. |