ListStudioSessionMappings - Amazon Elastic MapReduce

ListStudioSessionMappings

Note

The Amazon EMR Studio APIs are in preview release for Amazon EMR and are subject to change.

Returns a list of all user or group session mappings for the EMR Studio specified by StudioId.

Request Syntax

{ "IdentityType": "string", "Marker": "string", "StudioId": "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.

IdentityType

Specifies whether to return session mappings for users or groups. If not specified, the results include session mapping details for both users and groups.

Type: String

Valid Values: USER | GROUP

Required: No

Marker

The pagination token that indicates the set of results to retrieve.

Type: String

Required: No

StudioId

The ID of the Amazon EMR Studio.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 256.

Pattern: [\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*

Required: No

Response Syntax

{ "Marker": "string", "SessionMappings": [ { "CreationTime": number, "IdentityId": "string", "IdentityName": "string", "IdentityType": "string", "SessionPolicyArn": "string", "StudioId": "string" } ] }

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.

Marker

The pagination token that indicates the next set of results to retrieve.

Type: String

SessionMappings

A list of session mapping summary objects. Each object includes session mapping details such as creation time, identity type (user or group), and Studio ID.

Type: Array of SessionMappingSummary objects

Errors

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

InternalServerError

Indicates that an error occurred while processing the request and that the request was not completed.

HTTP Status Code: 400

InvalidRequestException

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

HTTP Status Code: 400

See Also

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