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.LicenseManager.CreateGrant

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates a grant for the specified license. A grant shares the use of license entitlements with specific Amazon Web Services accounts.

Synopsis

data CreateGrant = CreateGrant' {
- clientToken :: Text
- grantName :: Text
- licenseArn :: Text
- principals :: NonEmpty Text
- homeRegion :: Text
- allowedOperations :: NonEmpty AllowedOperation
}
newCreateGrant :: Text -> Text -> Text -> NonEmpty Text -> Text -> NonEmpty AllowedOperation -> CreateGrant
createGrant_clientToken :: Lens' CreateGrant Text
createGrant_grantName :: Lens' CreateGrant Text
createGrant_licenseArn :: Lens' CreateGrant Text
createGrant_principals :: Lens' CreateGrant (NonEmpty Text)
createGrant_homeRegion :: Lens' CreateGrant Text
createGrant_allowedOperations :: Lens' CreateGrant (NonEmpty AllowedOperation)
data CreateGrantResponse = CreateGrantResponse' {
- grantArn :: Maybe Text
- status :: Maybe GrantStatus
- version :: Maybe Text
- httpStatus :: Int
}
newCreateGrantResponse :: Int -> CreateGrantResponse
createGrantResponse_grantArn :: Lens' CreateGrantResponse (Maybe Text)
createGrantResponse_status :: Lens' CreateGrantResponse (Maybe GrantStatus)
createGrantResponse_version :: Lens' CreateGrantResponse (Maybe Text)
createGrantResponse_httpStatus :: Lens' CreateGrantResponse Int

Creating a Request

data CreateGrant Source #

See: newCreateGrant smart constructor.

Constructors

CreateGrant'

Fields

clientToken :: Text
Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
grantName :: Text
Grant name.
licenseArn :: Text
Amazon Resource Name (ARN) of the license.
principals :: NonEmpty Text
The grant principals. This value should be specified as an Amazon Resource Name (ARN).
homeRegion :: Text
Home Region of the grant.
allowedOperations :: NonEmpty AllowedOperation
Allowed operations for the grant.

Instances

Instances details

ToJSON CreateGrant Source #
Instance details Defined in Amazonka.LicenseManager.CreateGrant Methods toJSON :: CreateGrant -> Value # toEncoding :: CreateGrant -> Encoding # toJSONList :: [CreateGrant] -> Value # toEncodingList :: [CreateGrant] -> Encoding #
ToHeaders CreateGrant Source #
Instance details Defined in Amazonka.LicenseManager.CreateGrant Methods toHeaders :: CreateGrant -> [Header] #
ToPath CreateGrant Source #
Instance details Defined in Amazonka.LicenseManager.CreateGrant Methods toPath :: CreateGrant -> ByteString #
ToQuery CreateGrant Source #
Instance details Defined in Amazonka.LicenseManager.CreateGrant Methods toQuery :: CreateGrant -> QueryString #
AWSRequest CreateGrant Source #
Instance details Defined in Amazonka.LicenseManager.CreateGrant Associated Types type AWSResponse CreateGrant # Methods request :: (Service -> Service) -> CreateGrant -> Request CreateGrant # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateGrant -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateGrant))) #
Generic CreateGrant Source #
Instance details Defined in Amazonka.LicenseManager.CreateGrant Associated Types type Rep CreateGrant :: Type -> Type # Methods from :: CreateGrant -> Rep CreateGrant x # to :: Rep CreateGrant x -> CreateGrant #
Read CreateGrant Source #
Instance details Defined in Amazonka.LicenseManager.CreateGrant Methods readsPrec :: Int -> ReadS CreateGrant # readList :: ReadS [CreateGrant] # readPrec :: ReadPrec CreateGrant # readListPrec :: ReadPrec [CreateGrant] #
Show CreateGrant Source #
Instance details Defined in Amazonka.LicenseManager.CreateGrant Methods showsPrec :: Int -> CreateGrant -> ShowS # show :: CreateGrant -> String # showList :: [CreateGrant] -> ShowS #
NFData CreateGrant Source #
Instance details Defined in Amazonka.LicenseManager.CreateGrant Methods rnf :: CreateGrant -> () #
Eq CreateGrant Source #
Instance details Defined in Amazonka.LicenseManager.CreateGrant Methods (==) :: CreateGrant -> CreateGrant -> Bool # (/=) :: CreateGrant -> CreateGrant -> Bool #
Hashable CreateGrant Source #
Instance details Defined in Amazonka.LicenseManager.CreateGrant Methods hashWithSalt :: Int -> CreateGrant -> Int # hash :: CreateGrant -> Int #
type AWSResponse CreateGrant Source #
Instance details Defined in Amazonka.LicenseManager.CreateGrant type AWSResponse CreateGrant = CreateGrantResponse
type Rep CreateGrant Source #
Instance details Defined in Amazonka.LicenseManager.CreateGrant type Rep CreateGrant = D1 ('MetaData "CreateGrant" "Amazonka.LicenseManager.CreateGrant" "amazonka-license-manager-2.0-7MwrI8iJ3YaDRGRrldCApy" 'False) (C1 ('MetaCons "CreateGrant'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "clientToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "grantName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "licenseArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) :: (S1 ('MetaSel ('Just "principals") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty Text)) :: (S1 ('MetaSel ('Just "homeRegion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "allowedOperations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (NonEmpty AllowedOperation))))))

newCreateGrant Source #

Arguments

:: Text	`$sel:clientToken:CreateGrant'`
-> Text	`CreateGrant`
-> Text	`CreateGrant`
-> NonEmpty Text	`$sel:principals:CreateGrant'`
-> Text	`CreateGrant`
-> NonEmpty AllowedOperation	`CreateGrant`
-> CreateGrant

Create a value of CreateGrant 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:clientToken:CreateGrant', createGrant_clientToken - Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

CreateGrant, createGrant_grantName - Grant name.

CreateGrant, createGrant_licenseArn - Amazon Resource Name (ARN) of the license.

$sel:principals:CreateGrant', createGrant_principals - The grant principals. This value should be specified as an Amazon Resource Name (ARN).

CreateGrant, createGrant_homeRegion - Home Region of the grant.

CreateGrant, createGrant_allowedOperations - Allowed operations for the grant.

Request Lenses

createGrant_clientToken :: Lens' CreateGrant Text Source #

Unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

createGrant_grantName :: Lens' CreateGrant Text Source #

Grant name.

createGrant_licenseArn :: Lens' CreateGrant Text Source #

Amazon Resource Name (ARN) of the license.

createGrant_principals :: Lens' CreateGrant (NonEmpty Text) Source #

The grant principals. This value should be specified as an Amazon Resource Name (ARN).

createGrant_homeRegion :: Lens' CreateGrant Text Source #

Home Region of the grant.

createGrant_allowedOperations :: Lens' CreateGrant (NonEmpty AllowedOperation) Source #

Allowed operations for the grant.

Destructuring the Response

data CreateGrantResponse Source #

See: newCreateGrantResponse smart constructor.

Constructors

CreateGrantResponse'
Fields grantArn :: Maybe Text Grant ARN. status :: Maybe GrantStatus Grant status. version :: Maybe Text Grant version. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic CreateGrantResponse Source #
Instance details Defined in Amazonka.LicenseManager.CreateGrant Associated Types type Rep CreateGrantResponse :: Type -> Type # Methods from :: CreateGrantResponse -> Rep CreateGrantResponse x # to :: Rep CreateGrantResponse x -> CreateGrantResponse #
Read CreateGrantResponse Source #
Instance details Defined in Amazonka.LicenseManager.CreateGrant Methods readsPrec :: Int -> ReadS CreateGrantResponse # readList :: ReadS [CreateGrantResponse] # readPrec :: ReadPrec CreateGrantResponse # readListPrec :: ReadPrec [CreateGrantResponse] #
Show CreateGrantResponse Source #
Instance details Defined in Amazonka.LicenseManager.CreateGrant Methods showsPrec :: Int -> CreateGrantResponse -> ShowS # show :: CreateGrantResponse -> String # showList :: [CreateGrantResponse] -> ShowS #
NFData CreateGrantResponse Source #
Instance details Defined in Amazonka.LicenseManager.CreateGrant Methods rnf :: CreateGrantResponse -> () #
Eq CreateGrantResponse Source #
Instance details Defined in Amazonka.LicenseManager.CreateGrant Methods (==) :: CreateGrantResponse -> CreateGrantResponse -> Bool # (/=) :: CreateGrantResponse -> CreateGrantResponse -> Bool #
type Rep CreateGrantResponse Source #
Instance details Defined in Amazonka.LicenseManager.CreateGrant type Rep CreateGrantResponse = D1 ('MetaData "CreateGrantResponse" "Amazonka.LicenseManager.CreateGrant" "amazonka-license-manager-2.0-7MwrI8iJ3YaDRGRrldCApy" 'False) (C1 ('MetaCons "CreateGrantResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "grantArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe GrantStatus))) :: (S1 ('MetaSel ('Just "version") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))