Network.AWS.KMS.GetKeyPolicy

Gets a key policy attached to the specified customer master key (CMK). You cannot perform this operation on a CMK in a different AWS account.

Creating a Request

getKeyPolicy

Arguments

:: Text

gkpKeyId

-> Text

gkpPolicyName

-> GetKeyPolicy

Creates a value of GetKeyPolicy with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• gkpKeyId - A unique identifier for the customer master key (CMK). Specify the key ID or the Amazon Resource Name (ARN) of the CMK. For example: * Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab * Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey .
• gkpPolicyName - Specifies the name of the key policy. The only valid name is default . To get the names of key policies, use ListKeyPolicies .

data GetKeyPolicy

See: getKeyPolicy smart constructor.

Instances

Eq GetKeyPolicy

Methods

(==) :: GetKeyPolicy -> GetKeyPolicy -> Bool

(/=) :: GetKeyPolicy -> GetKeyPolicy -> Bool

Data GetKeyPolicy

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> GetKeyPolicy -> c GetKeyPolicy

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c GetKeyPolicy

toConstr :: GetKeyPolicy -> Constr

dataTypeOf :: GetKeyPolicy -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c GetKeyPolicy)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c GetKeyPolicy)

gmapT :: (forall b. Data b => b -> b) -> GetKeyPolicy -> GetKeyPolicy

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> GetKeyPolicy -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> GetKeyPolicy -> r

gmapQ :: (forall d. Data d => d -> u) -> GetKeyPolicy -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> GetKeyPolicy -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> GetKeyPolicy -> m GetKeyPolicy

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> GetKeyPolicy -> m GetKeyPolicy

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> GetKeyPolicy -> m GetKeyPolicy

Read GetKeyPolicy

Methods

readsPrec :: Int -> ReadS GetKeyPolicy

readList :: ReadS [GetKeyPolicy]

readPrec :: ReadPrec GetKeyPolicy

readListPrec :: ReadPrec [GetKeyPolicy]

Show GetKeyPolicy

Methods

showsPrec :: Int -> GetKeyPolicy -> ShowS

show :: GetKeyPolicy -> String

showList :: [GetKeyPolicy] -> ShowS

Generic GetKeyPolicy

Associated Types

type Rep GetKeyPolicy :: * -> *

Methods

from :: GetKeyPolicy -> Rep GetKeyPolicy x

to :: Rep GetKeyPolicy x -> GetKeyPolicy

Hashable GetKeyPolicy

Methods

hashWithSalt :: Int -> GetKeyPolicy -> Int

hash :: GetKeyPolicy -> Int

ToJSON GetKeyPolicy

Methods

toJSON :: GetKeyPolicy -> Value

toEncoding :: GetKeyPolicy -> Encoding

toJSONList :: [GetKeyPolicy] -> Value

toEncodingList :: [GetKeyPolicy] -> Encoding

NFData GetKeyPolicy

Methods

rnf :: GetKeyPolicy -> ()

AWSRequest GetKeyPolicy

Associated Types

type Rs GetKeyPolicy :: *

Methods

request :: GetKeyPolicy -> Request GetKeyPolicy

response :: (MonadResource m, MonadThrow m) => Logger -> Service -> Proxy * GetKeyPolicy -> ClientResponse -> m (Response GetKeyPolicy)

ToHeaders GetKeyPolicy

Methods

toHeaders :: GetKeyPolicy -> [Header]

ToPath GetKeyPolicy

Methods

toPath :: GetKeyPolicy -> ByteString

ToQuery GetKeyPolicy

Methods

toQuery :: GetKeyPolicy -> QueryString

type Rep GetKeyPolicy

type Rep GetKeyPolicy = D1 * (MetaData "GetKeyPolicy" "Network.AWS.KMS.GetKeyPolicy" "amazonka-kms-1.6.0-6a1SDMHmleyARI8mxMgB7S" False) (C1 * (MetaCons "GetKeyPolicy'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_gkpKeyId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text)) (S1 * (MetaSel (Just Symbol "_gkpPolicyName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Text))))

type Rs GetKeyPolicy

type Rs GetKeyPolicy = GetKeyPolicyResponse

Request Lenses

gkpKeyId :: Lens' GetKeyPolicy Text

A unique identifier for the customer master key (CMK). Specify the key ID or the Amazon Resource Name (ARN) of the CMK. For example: * Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab * Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab To get the key ID and key ARN for a CMK, use ListKeys or DescribeKey .

gkpPolicyName :: Lens' GetKeyPolicy Text

Specifies the name of the key policy. The only valid name is default . To get the names of key policies, use ListKeyPolicies .

Destructuring the Response

getKeyPolicyResponse

Arguments

:: Int

gkprsResponseStatus

-> GetKeyPolicyResponse

Creates a value of GetKeyPolicyResponse with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• gkprsPolicy - A key policy document in JSON format.
• gkprsResponseStatus - -- | The response status code.

data GetKeyPolicyResponse

See: getKeyPolicyResponse smart constructor.

Instances

Eq GetKeyPolicyResponse

Methods

(==) :: GetKeyPolicyResponse -> GetKeyPolicyResponse -> Bool

(/=) :: GetKeyPolicyResponse -> GetKeyPolicyResponse -> Bool

Data GetKeyPolicyResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> GetKeyPolicyResponse -> c GetKeyPolicyResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c GetKeyPolicyResponse

toConstr :: GetKeyPolicyResponse -> Constr

dataTypeOf :: GetKeyPolicyResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c GetKeyPolicyResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c GetKeyPolicyResponse)

gmapT :: (forall b. Data b => b -> b) -> GetKeyPolicyResponse -> GetKeyPolicyResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> GetKeyPolicyResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> GetKeyPolicyResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> GetKeyPolicyResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> GetKeyPolicyResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> GetKeyPolicyResponse -> m GetKeyPolicyResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> GetKeyPolicyResponse -> m GetKeyPolicyResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> GetKeyPolicyResponse -> m GetKeyPolicyResponse

Read GetKeyPolicyResponse

Methods

readsPrec :: Int -> ReadS GetKeyPolicyResponse

readList :: ReadS [GetKeyPolicyResponse]

readPrec :: ReadPrec GetKeyPolicyResponse

readListPrec :: ReadPrec [GetKeyPolicyResponse]

Show GetKeyPolicyResponse

Methods

showsPrec :: Int -> GetKeyPolicyResponse -> ShowS

show :: GetKeyPolicyResponse -> String

showList :: [GetKeyPolicyResponse] -> ShowS

Generic GetKeyPolicyResponse

Associated Types

type Rep GetKeyPolicyResponse :: * -> *

Methods

from :: GetKeyPolicyResponse -> Rep GetKeyPolicyResponse x

to :: Rep GetKeyPolicyResponse x -> GetKeyPolicyResponse

NFData GetKeyPolicyResponse

Methods

rnf :: GetKeyPolicyResponse -> ()

type Rep GetKeyPolicyResponse

type Rep GetKeyPolicyResponse = D1 * (MetaData "GetKeyPolicyResponse" "Network.AWS.KMS.GetKeyPolicy" "amazonka-kms-1.6.0-6a1SDMHmleyARI8mxMgB7S" False) (C1 * (MetaCons "GetKeyPolicyResponse'" PrefixI True) ((:*:) * (S1 * (MetaSel (Just Symbol "_gkprsPolicy") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * (Maybe Text))) (S1 * (MetaSel (Just Symbol "_gkprsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 * Int))))

Response Lenses

gkprsPolicy :: Lens' GetKeyPolicyResponse (Maybe Text)

A key policy document in JSON format.

gkprsResponseStatus :: Lens' GetKeyPolicyResponse Int

• - | The response status code.