Request Syntax Request Parameters Response Syntax Response Elements Errors See Also

ListSessions

Lists the sessions on a cluster. You can filter the results by session state. Newer sessions are returned first.

Request Syntax


{
   "ClusterId": "string",
   "MaxResults": number,
   "NextToken": "string",
   "SessionStates": [ "string" ]
}

Request Parameters

For information about the parameters that are common to all actions, see Common Parameters.

The request accepts the following data in JSON format.

ClusterId

The ID of the cluster to list sessions for.

Type: String

Length Constraints: Maximum length of 256.

Required: Yes

MaxResults

The maximum number of sessions to return in each page of results.

Type: Integer

Valid Range: Minimum value of 1. Maximum value of 100.

Required: No

NextToken

The pagination token returned by a previous ListSessions call. Use it to retrieve the next page of results.

Type: String

Required: No

SessionStates

An optional filter that limits the results to sessions in the specified states.

Type: Array of strings

Required: No

Response Syntax


{
   "NextToken": "string",
   "Sessions": [ 
      { 
         "AccountId": "string",
         "Arn": "string",
         "ClusterId": "string",
         "CreatedAt": number,
         "EndedAt": number,
         "EngineConfigurations": [ 
            { 
               "Classification": "string",
               "Configurations": [ 
                  "Configuration"
               ],
               "Properties": { 
                  "string" : "string" 
               }
            }
         ],
         "ExecutionRoleArn": "string",
         "Id": "string",
         "IdleSince": number,
         "MonitoringConfiguration": { 
            "CloudWatchLoggingConfiguration": { 
               "Enabled": boolean,
               "EncryptionKeyArn": "string",
               "LogGroup": "string",
               "LogStreamNamePrefix": "string",
               "LogTypes": { 
                  "string" : [ "string" ]
               }
            },
            "ManagedLoggingConfiguration": { 
               "Enabled": boolean,
               "EncryptionKeyArn": "string"
            },
            "S3LoggingConfiguration": { 
               "Enabled": boolean,
               "EncryptionKeyArn": "string",
               "LogTypes": { 
                  "string" : [ "string" ]
               },
               "LogUri": "string"
            }
         },
         "Name": "string",
         "ReleaseLabel": "string",
         "ServerUrl": "string",
         "SessionIdleTimeoutInMinutes": number,
         "StartedAt": number,
         "State": "string",
         "StateChangeReason": "string",
         "Tags": [ 
            { 
               "Key": "string",
               "Value": "string"
            }
         ],
         "UpdatedAt": number
      }
   ]
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

NextToken

The pagination token to use in a subsequent ListSessions call to retrieve the next page of results. This field is absent when there are no more results.

Type: String

Sessions

The sessions that match the request.

Type: Array of Session objects

Errors

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

InternalServerException

This exception occurs when there is an internal failure in the Amazon EMR service.

Message: The message associated with the exception.

HTTP Status Code: 500

InvalidRequestException

This exception occurs when there is something wrong with user input.

ErrorCode: The error code associated with the exception.
Message: The message associated with the exception.

HTTP Status Code: 400