Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.AppStream.CreateEntitlement

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a new entitlement. Entitlements control access to specific applications within a stack, based on user attributes. Entitlements apply to SAML 2.0 federated user identities. Amazon AppStream 2.0 user pool and streaming URL users are entitled to all applications in a stack. Entitlements don't apply to the desktop stream view application, or to applications managed by a dynamic app provider using the Dynamic Application Framework.

Synopsis

data CreateEntitlement = CreateEntitlement' {
- description :: Maybe Text
- name :: Text
- stackName :: Text
- appVisibility :: AppVisibility
- attributes :: NonEmpty EntitlementAttribute
}
newCreateEntitlement :: Text -> Text -> AppVisibility -> NonEmpty EntitlementAttribute -> CreateEntitlement
createEntitlement_description :: Lens' CreateEntitlement (Maybe Text)
createEntitlement_name :: Lens' CreateEntitlement Text
createEntitlement_stackName :: Lens' CreateEntitlement Text
createEntitlement_appVisibility :: Lens' CreateEntitlement AppVisibility
createEntitlement_attributes :: Lens' CreateEntitlement (NonEmpty EntitlementAttribute)
data CreateEntitlementResponse = CreateEntitlementResponse' {
- entitlement :: Maybe Entitlement
- httpStatus :: Int
}
newCreateEntitlementResponse :: Int -> CreateEntitlementResponse
createEntitlementResponse_entitlement :: Lens' CreateEntitlementResponse (Maybe Entitlement)
createEntitlementResponse_httpStatus :: Lens' CreateEntitlementResponse Int

Creating a Request

data CreateEntitlement Source #

See: newCreateEntitlement smart constructor.

Constructors

CreateEntitlement'
Fields description :: Maybe Text The description of the entitlement. name :: Text The name of the entitlement. stackName :: Text The name of the stack with which the entitlement is associated. appVisibility :: AppVisibility Specifies whether all or selected apps are entitled. attributes :: NonEmpty EntitlementAttribute The attributes of the entitlement.

Instances

Instances details

ToJSON CreateEntitlement Source #
Instance details Defined in Amazonka.AppStream.CreateEntitlement Methods toJSON :: CreateEntitlement -> Value # toEncoding :: CreateEntitlement -> Encoding # toJSONList :: [CreateEntitlement] -> Value # toEncodingList :: [CreateEntitlement] -> Encoding #
ToHeaders CreateEntitlement Source #
Instance details Defined in Amazonka.AppStream.CreateEntitlement Methods toHeaders :: CreateEntitlement -> [Header] #
ToPath CreateEntitlement Source #
Instance details Defined in Amazonka.AppStream.CreateEntitlement Methods toPath :: CreateEntitlement -> ByteString #
ToQuery CreateEntitlement Source #
Instance details Defined in Amazonka.AppStream.CreateEntitlement Methods toQuery :: CreateEntitlement -> QueryString #
AWSRequest CreateEntitlement Source #
Instance details Defined in Amazonka.AppStream.CreateEntitlement Associated Types type AWSResponse CreateEntitlement # Methods request :: (Service -> Service) -> CreateEntitlement -> Request CreateEntitlement # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateEntitlement -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateEntitlement))) #
Generic CreateEntitlement Source #
Instance details Defined in Amazonka.AppStream.CreateEntitlement Associated Types type Rep CreateEntitlement :: Type -> Type # Methods from :: CreateEntitlement -> Rep CreateEntitlement x # to :: Rep CreateEntitlement x -> CreateEntitlement #
Read CreateEntitlement Source #
Instance details Defined in Amazonka.AppStream.CreateEntitlement Methods readsPrec :: Int -> ReadS CreateEntitlement # readList :: ReadS [CreateEntitlement] # readPrec :: ReadPrec CreateEntitlement # readListPrec :: ReadPrec [CreateEntitlement] #
Show CreateEntitlement Source #
Instance details Defined in Amazonka.AppStream.CreateEntitlement Methods showsPrec :: Int -> CreateEntitlement -> ShowS # show :: CreateEntitlement -> String # showList :: [CreateEntitlement] -> ShowS #
NFData CreateEntitlement Source #
Instance details Defined in Amazonka.AppStream.CreateEntitlement Methods rnf :: CreateEntitlement -> () #
Eq CreateEntitlement Source #
Instance details Defined in Amazonka.AppStream.CreateEntitlement Methods (==) :: CreateEntitlement -> CreateEntitlement -> Bool # (/=) :: CreateEntitlement -> CreateEntitlement -> Bool #
Hashable CreateEntitlement Source #
Instance details Defined in Amazonka.AppStream.CreateEntitlement Methods hashWithSalt :: Int -> CreateEntitlement -> Int # hash :: CreateEntitlement -> Int #
type AWSResponse CreateEntitlement Source #
Instance details Defined in Amazonka.AppStream.CreateEntitlement type AWSResponse CreateEntitlement = CreateEntitlementResponse
type Rep CreateEntitlement Source #
Instance details Defined in Amazonka.AppStream.CreateEntitlement type Rep CreateEntitlement = D1 ('MetaData "CreateEntitlement" "Amazonka.AppStream.CreateEntitlement" "amazonka-appstream-2.0-2EgS7yjN1zMCngYkSFPgOd" 'False) (C1 ('MetaCons "CreateEntitlement'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "stackName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "appVisibility") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 AppVisibility) :: S1 ('MetaSel ('Just "attributes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty EntitlementAttribute))))))

newCreateEntitlement Source #

Arguments

:: Text	`CreateEntitlement`
-> Text	`CreateEntitlement`
-> AppVisibility	`CreateEntitlement`
-> NonEmpty EntitlementAttribute	`CreateEntitlement`
-> CreateEntitlement

Create a value of CreateEntitlement 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:

CreateEntitlement, createEntitlement_description - The description of the entitlement.

CreateEntitlement, createEntitlement_name - The name of the entitlement.

CreateEntitlement, createEntitlement_stackName - The name of the stack with which the entitlement is associated.

CreateEntitlement, createEntitlement_appVisibility - Specifies whether all or selected apps are entitled.

CreateEntitlement, createEntitlement_attributes - The attributes of the entitlement.

Request Lenses

createEntitlement_description :: Lens' CreateEntitlement (Maybe Text) Source #

The description of the entitlement.

createEntitlement_name :: Lens' CreateEntitlement Text Source #

The name of the entitlement.

createEntitlement_stackName :: Lens' CreateEntitlement Text Source #

The name of the stack with which the entitlement is associated.

createEntitlement_appVisibility :: Lens' CreateEntitlement AppVisibility Source #

Specifies whether all or selected apps are entitled.

createEntitlement_attributes :: Lens' CreateEntitlement (NonEmpty EntitlementAttribute) Source #

The attributes of the entitlement.

Destructuring the Response

data CreateEntitlementResponse Source #

See: newCreateEntitlementResponse smart constructor.

Constructors

CreateEntitlementResponse'
Fields entitlement :: Maybe Entitlement The entitlement. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic CreateEntitlementResponse Source #
Instance details Defined in Amazonka.AppStream.CreateEntitlement Associated Types type Rep CreateEntitlementResponse :: Type -> Type # Methods from :: CreateEntitlementResponse -> Rep CreateEntitlementResponse x # to :: Rep CreateEntitlementResponse x -> CreateEntitlementResponse #
Read CreateEntitlementResponse Source #
Instance details Defined in Amazonka.AppStream.CreateEntitlement Methods readsPrec :: Int -> ReadS CreateEntitlementResponse # readList :: ReadS [CreateEntitlementResponse] # readPrec :: ReadPrec CreateEntitlementResponse # readListPrec :: ReadPrec [CreateEntitlementResponse] #
Show CreateEntitlementResponse Source #
Instance details Defined in Amazonka.AppStream.CreateEntitlement Methods showsPrec :: Int -> CreateEntitlementResponse -> ShowS # show :: CreateEntitlementResponse -> String # showList :: [CreateEntitlementResponse] -> ShowS #
NFData CreateEntitlementResponse Source #
Instance details Defined in Amazonka.AppStream.CreateEntitlement Methods rnf :: CreateEntitlementResponse -> () #
Eq CreateEntitlementResponse Source #
Instance details Defined in Amazonka.AppStream.CreateEntitlement Methods (==) :: CreateEntitlementResponse -> CreateEntitlementResponse -> Bool # (/=) :: CreateEntitlementResponse -> CreateEntitlementResponse -> Bool #
type Rep CreateEntitlementResponse Source #
Instance details Defined in Amazonka.AppStream.CreateEntitlement type Rep CreateEntitlementResponse = D1 ('MetaData "CreateEntitlementResponse" "Amazonka.AppStream.CreateEntitlement" "amazonka-appstream-2.0-2EgS7yjN1zMCngYkSFPgOd" 'False) (C1 ('MetaCons "CreateEntitlementResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "entitlement") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Entitlement)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateEntitlementResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateEntitlementResponse'`
-> CreateEntitlementResponse

Create a value of CreateEntitlementResponse 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:entitlement:CreateEntitlementResponse', createEntitlementResponse_entitlement - The entitlement.

$sel:httpStatus:CreateEntitlementResponse', createEntitlementResponse_httpStatus - The response's http status code.

Response Lenses

createEntitlementResponse_entitlement :: Lens' CreateEntitlementResponse (Maybe Entitlement) Source #

The entitlement.

createEntitlementResponse_httpStatus :: Lens' CreateEntitlementResponse Int Source #

The response's http status code.