libZSservicesZSamazonka-emrZSamazonka-emr
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.EMR.CreateStudioSessionMapping

Description

Maps a user or group to the Amazon EMR Studio specified by StudioId, and applies a session policy to refine Studio permissions for that user or group. Use CreateStudioSessionMapping to assign users to a Studio when you use Amazon Web Services SSO authentication. For instructions on how to assign users to a Studio when you use IAM authentication, see Assign a user or group to your EMR Studio.

Synopsis

Creating a Request

data CreateStudioSessionMapping Source #

See: newCreateStudioSessionMapping smart constructor.

Constructors

CreateStudioSessionMapping' 

Fields

  • identityId :: Maybe Text

    The globally unique identifier (GUID) of the user or group from the Amazon Web Services SSO Identity Store. For more information, see UserId and GroupId in the Amazon Web Services SSO Identity Store API Reference. Either IdentityName or IdentityId must be specified, but not both.

  • identityName :: Maybe Text

    The name of the user or group. For more information, see UserName and DisplayName in the Amazon Web Services SSO Identity Store API Reference. Either IdentityName or IdentityId must be specified, but not both.

  • studioId :: Text

    The ID of the Amazon EMR Studio to which the user or group will be mapped.

  • identityType :: IdentityType

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

  • sessionPolicyArn :: Text

    The Amazon Resource Name (ARN) for the session policy that will be applied to the user or group. You should specify the ARN for the session policy that you want to apply, not the ARN of your user role. For more information, see Create an EMR Studio User Role with Session Policies.

Instances

Instances details
Eq CreateStudioSessionMapping Source # 
Instance details

Defined in Amazonka.EMR.CreateStudioSessionMapping

Methods

(==) :: CreateStudioSessionMapping -> CreateStudioSessionMapping -> Bool #

(/=) :: CreateStudioSessionMapping -> CreateStudioSessionMapping -> Bool #

Read CreateStudioSessionMapping Source # 
Instance details

Defined in Amazonka.EMR.CreateStudioSessionMapping

Methods

readsPrec :: Int -> ReadS CreateStudioSessionMapping #

readList :: ReadS [CreateStudioSessionMapping] #

readPrec :: ReadPrec CreateStudioSessionMapping #

readListPrec :: ReadPrec [CreateStudioSessionMapping] #

Show CreateStudioSessionMapping Source # 
Instance details

Defined in Amazonka.EMR.CreateStudioSessionMapping

Methods

showsPrec :: Int -> CreateStudioSessionMapping -> ShowS #

show :: CreateStudioSessionMapping -> String #

showList :: [CreateStudioSessionMapping] -> ShowS #

Generic CreateStudioSessionMapping Source # 
Instance details

Defined in Amazonka.EMR.CreateStudioSessionMapping

Associated Types

type Rep CreateStudioSessionMapping :: Type -> Type #

Methods

from :: CreateStudioSessionMapping -> Rep CreateStudioSessionMapping x #

to :: Rep CreateStudioSessionMapping x -> CreateStudioSessionMapping #

NFData CreateStudioSessionMapping Source # 
Instance details

Defined in Amazonka.EMR.CreateStudioSessionMapping

Methods

rnf :: CreateStudioSessionMapping -> () #

Hashable CreateStudioSessionMapping Source # 
Instance details

Defined in Amazonka.EMR.CreateStudioSessionMapping

Methods

hashWithSalt :: Int -> CreateStudioSessionMapping -> Int #

hash :: CreateStudioSessionMapping -> Int #

ToJSON CreateStudioSessionMapping Source # 
Instance details

Defined in Amazonka.EMR.CreateStudioSessionMapping

Methods

toJSON :: CreateStudioSessionMapping -> Value #

toEncoding :: CreateStudioSessionMapping -> Encoding #

toJSONList :: [CreateStudioSessionMapping] -> Value #

toEncodingList :: [CreateStudioSessionMapping] -> Encoding #

AWSRequest CreateStudioSessionMapping Source # 
Instance details

Defined in Amazonka.EMR.CreateStudioSessionMapping

Associated Types

type AWSResponse CreateStudioSessionMapping #

Methods

request :: CreateStudioSessionMapping -> Request CreateStudioSessionMapping #

response :: MonadResource m => Logger -> Service -> Proxy CreateStudioSessionMapping -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateStudioSessionMapping))) #

ToHeaders CreateStudioSessionMapping Source # 
Instance details

Defined in Amazonka.EMR.CreateStudioSessionMapping

Methods

toHeaders :: CreateStudioSessionMapping -> [Header] #

ToPath CreateStudioSessionMapping Source # 
Instance details

Defined in Amazonka.EMR.CreateStudioSessionMapping

Methods

toPath :: CreateStudioSessionMapping -> ByteString #

ToQuery CreateStudioSessionMapping Source # 
Instance details

Defined in Amazonka.EMR.CreateStudioSessionMapping

Methods

toQuery :: CreateStudioSessionMapping -> QueryString #

type Rep CreateStudioSessionMapping Source # 
Instance details

Defined in Amazonka.EMR.CreateStudioSessionMapping

type Rep CreateStudioSessionMapping = D1 ('MetaData "CreateStudioSessionMapping" "Amazonka.EMR.CreateStudioSessionMapping" "libZSservicesZSamazonka-emrZSamazonka-emr" 'False) (C1 ('MetaCons "CreateStudioSessionMapping'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "identityId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "identityName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "studioId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: (S1 ('MetaSel ('Just "identityType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 IdentityType) :*: S1 ('MetaSel ('Just "sessionPolicyArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))
type AWSResponse CreateStudioSessionMapping Source # 
Instance details

Defined in Amazonka.EMR.CreateStudioSessionMapping

type AWSResponse CreateStudioSessionMapping = CreateStudioSessionMappingResponse

newCreateStudioSessionMapping Source #

Arguments

:: Text

$sel:studioId:CreateStudioSessionMapping'

-> IdentityType

$sel:identityType:CreateStudioSessionMapping'

-> Text

$sel:sessionPolicyArn:CreateStudioSessionMapping'

-> CreateStudioSessionMapping 

Create a value of CreateStudioSessionMapping with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:identityId:CreateStudioSessionMapping', createStudioSessionMapping_identityId - The globally unique identifier (GUID) of the user or group from the Amazon Web Services SSO Identity Store. For more information, see UserId and GroupId in the Amazon Web Services SSO Identity Store API Reference. Either IdentityName or IdentityId must be specified, but not both.

$sel:identityName:CreateStudioSessionMapping', createStudioSessionMapping_identityName - The name of the user or group. For more information, see UserName and DisplayName in the Amazon Web Services SSO Identity Store API Reference. Either IdentityName or IdentityId must be specified, but not both.

$sel:studioId:CreateStudioSessionMapping', createStudioSessionMapping_studioId - The ID of the Amazon EMR Studio to which the user or group will be mapped.

$sel:identityType:CreateStudioSessionMapping', createStudioSessionMapping_identityType - Specifies whether the identity to map to the Amazon EMR Studio is a user or a group.

$sel:sessionPolicyArn:CreateStudioSessionMapping', createStudioSessionMapping_sessionPolicyArn - The Amazon Resource Name (ARN) for the session policy that will be applied to the user or group. You should specify the ARN for the session policy that you want to apply, not the ARN of your user role. For more information, see Create an EMR Studio User Role with Session Policies.

Request Lenses

createStudioSessionMapping_identityId :: Lens' CreateStudioSessionMapping (Maybe Text) Source #

The globally unique identifier (GUID) of the user or group from the Amazon Web Services SSO Identity Store. For more information, see UserId and GroupId in the Amazon Web Services SSO Identity Store API Reference. Either IdentityName or IdentityId must be specified, but not both.

createStudioSessionMapping_identityName :: Lens' CreateStudioSessionMapping (Maybe Text) Source #

The name of the user or group. For more information, see UserName and DisplayName in the Amazon Web Services SSO Identity Store API Reference. Either IdentityName or IdentityId must be specified, but not both.

createStudioSessionMapping_studioId :: Lens' CreateStudioSessionMapping Text Source #

The ID of the Amazon EMR Studio to which the user or group will be mapped.

createStudioSessionMapping_identityType :: Lens' CreateStudioSessionMapping IdentityType Source #

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

createStudioSessionMapping_sessionPolicyArn :: Lens' CreateStudioSessionMapping Text Source #

The Amazon Resource Name (ARN) for the session policy that will be applied to the user or group. You should specify the ARN for the session policy that you want to apply, not the ARN of your user role. For more information, see Create an EMR Studio User Role with Session Policies.

Destructuring the Response

data CreateStudioSessionMappingResponse Source #

See: newCreateStudioSessionMappingResponse smart constructor.

Constructors

CreateStudioSessionMappingResponse' 

Instances

Instances details
Eq CreateStudioSessionMappingResponse Source # 
Instance details

Defined in Amazonka.EMR.CreateStudioSessionMapping

Methods

(==) :: CreateStudioSessionMappingResponse -> CreateStudioSessionMappingResponse -> Bool #

(/=) :: CreateStudioSessionMappingResponse -> CreateStudioSessionMappingResponse -> Bool #

Read CreateStudioSessionMappingResponse Source # 
Instance details

Defined in Amazonka.EMR.CreateStudioSessionMapping

Methods

readsPrec :: Int -> ReadS CreateStudioSessionMappingResponse #

readList :: ReadS [CreateStudioSessionMappingResponse] #

readPrec :: ReadPrec CreateStudioSessionMappingResponse #

readListPrec :: ReadPrec [CreateStudioSessionMappingResponse] #

Show CreateStudioSessionMappingResponse Source # 
Instance details

Defined in Amazonka.EMR.CreateStudioSessionMapping

Methods

showsPrec :: Int -> CreateStudioSessionMappingResponse -> ShowS #

show :: CreateStudioSessionMappingResponse -> String #

showList :: [CreateStudioSessionMappingResponse] -> ShowS #

Generic CreateStudioSessionMappingResponse Source # 
Instance details

Defined in Amazonka.EMR.CreateStudioSessionMapping

Associated Types

type Rep CreateStudioSessionMappingResponse :: Type -> Type #

Methods

from :: CreateStudioSessionMappingResponse -> Rep CreateStudioSessionMappingResponse x #

to :: Rep CreateStudioSessionMappingResponse x -> CreateStudioSessionMappingResponse #

NFData CreateStudioSessionMappingResponse Source # 
Instance details

Defined in Amazonka.EMR.CreateStudioSessionMapping

Methods

rnf :: CreateStudioSessionMappingResponse -> () #

type Rep CreateStudioSessionMappingResponse Source # 
Instance details

Defined in Amazonka.EMR.CreateStudioSessionMapping

type Rep CreateStudioSessionMappingResponse = D1 ('MetaData "CreateStudioSessionMappingResponse" "Amazonka.EMR.CreateStudioSessionMapping" "libZSservicesZSamazonka-emrZSamazonka-emr" 'False) (C1 ('MetaCons "CreateStudioSessionMappingResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newCreateStudioSessionMappingResponse :: CreateStudioSessionMappingResponse Source #

Create a value of CreateStudioSessionMappingResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.