Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . emr ]

get-studio-session-mapping

Description

Fetches mapping details for the specified Amazon EMR Studio and identity (user or group).

See also: AWS API Documentation

Synopsis

  get-studio-session-mapping
--studio-id <value>
[--identity-id <value>]
[--identity-name <value>]
--identity-type <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options

--studio-id (string)

The ID of the Amazon EMR Studio.

--identity-id (string)

The globally unique identifier (GUID) of the user or group. For more information, see UserId and GroupId in the IAM Identity Center Identity Store API Reference . Either IdentityName or IdentityId must be specified.

--identity-name (string)

The name of the user or group to fetch. For more information, see UserName and DisplayName in the IAM Identity Center Identity Store API Reference . Either IdentityName or IdentityId must be specified.

--identity-type (string)

Specifies whether the identity to fetch is a user or a group.

Possible values:

• USER
• GROUP

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

• json
• text
• table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

• on
• off
• auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output

SessionMapping -> (structure)

The session mapping details for the specified Amazon EMR Studio and identity, including session policy ARN and creation time.

StudioId -> (string)

The ID of the Amazon EMR Studio.

IdentityId -> (string)

The globally unique identifier (GUID) of the user or group.

IdentityName -> (string)

The name of the user or group. For more information, see UserName and DisplayName in the IAM Identity Center Identity Store API Reference .

IdentityType -> (string)

Specifies whether the identity mapped to the Amazon EMR Studio is a user or a group.

SessionPolicyArn -> (string)

The Amazon Resource Name (ARN) of the session policy associated with the user or group.

CreationTime -> (timestamp)

The time the session mapping was created.

LastModifiedTime -> (timestamp)

The time the session mapping was last modified.