Copyright	(c) 2013-2017 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None
Language	Haskell2010

Network.AWS.KMS.GetKeyRotationStatus

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Gets a Boolean value that indicates whether automatic rotation of the key material is enabled for the specified customer master key (CMK).

To perform this operation on a CMK in a different AWS account, specify the key ARN in the value of the KeyId parameter.

Creating a Request

getKeyRotationStatus Source #

Arguments

:: Text	`gkrsKeyId`
-> GetKeyRotationStatus

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

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

gkrsKeyId - A unique identifier for the customer master key (CMK). Specify the key ID or the Amazon Resource Name (ARN) of the CMK. To specify a CMK in a different AWS account, you must use the key ARN. 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 .

data GetKeyRotationStatus Source #

See: getKeyRotationStatus smart constructor.

Instances

Eq GetKeyRotationStatus Source #
Methods (==) :: GetKeyRotationStatus -> GetKeyRotationStatus -> Bool # (/=) :: GetKeyRotationStatus -> GetKeyRotationStatus -> Bool #
Data GetKeyRotationStatus Source #
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> GetKeyRotationStatus -> c GetKeyRotationStatus # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c GetKeyRotationStatus # toConstr :: GetKeyRotationStatus -> Constr # dataTypeOf :: GetKeyRotationStatus -> DataType # dataCast1 :: Typeable (* -> ) t => (forall d. Data d => c (t d)) -> Maybe (c GetKeyRotationStatus) # dataCast2 :: Typeable ( -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c GetKeyRotationStatus) # gmapT :: (forall b. Data b => b -> b) -> GetKeyRotationStatus -> GetKeyRotationStatus # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> GetKeyRotationStatus -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> GetKeyRotationStatus -> r # gmapQ :: (forall d. Data d => d -> u) -> GetKeyRotationStatus -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> GetKeyRotationStatus -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> GetKeyRotationStatus -> m GetKeyRotationStatus # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> GetKeyRotationStatus -> m GetKeyRotationStatus # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> GetKeyRotationStatus -> m GetKeyRotationStatus #
Read GetKeyRotationStatus Source #
Methods readsPrec :: Int -> ReadS GetKeyRotationStatus # readList :: ReadS [GetKeyRotationStatus] # readPrec :: ReadPrec GetKeyRotationStatus # readListPrec :: ReadPrec [GetKeyRotationStatus] #
Show GetKeyRotationStatus Source #
Methods showsPrec :: Int -> GetKeyRotationStatus -> ShowS # show :: GetKeyRotationStatus -> String # showList :: [GetKeyRotationStatus] -> ShowS #
Generic GetKeyRotationStatus Source #
Associated Types type Rep GetKeyRotationStatus :: * -> * # Methods from :: GetKeyRotationStatus -> Rep GetKeyRotationStatus x # to :: Rep GetKeyRotationStatus x -> GetKeyRotationStatus #
Hashable GetKeyRotationStatus Source #
Methods hashWithSalt :: Int -> GetKeyRotationStatus -> Int # hash :: GetKeyRotationStatus -> Int #
ToJSON GetKeyRotationStatus Source #
Methods toJSON :: GetKeyRotationStatus -> Value # toEncoding :: GetKeyRotationStatus -> Encoding # toJSONList :: [GetKeyRotationStatus] -> Value # toEncodingList :: [GetKeyRotationStatus] -> Encoding #
NFData GetKeyRotationStatus Source #
Methods rnf :: GetKeyRotationStatus -> () #
AWSRequest GetKeyRotationStatus Source #
Associated Types type Rs GetKeyRotationStatus :: * # Methods request :: GetKeyRotationStatus -> Request GetKeyRotationStatus # response :: MonadResource m => Logger -> Service -> Proxy * GetKeyRotationStatus -> ClientResponse -> m (Response GetKeyRotationStatus) #
ToQuery GetKeyRotationStatus Source #
Methods toQuery :: GetKeyRotationStatus -> QueryString #
ToPath GetKeyRotationStatus Source #
Methods toPath :: GetKeyRotationStatus -> ByteString #
ToHeaders GetKeyRotationStatus Source #
Methods toHeaders :: GetKeyRotationStatus -> [Header] #
type Rep GetKeyRotationStatus Source #
type Rep GetKeyRotationStatus = D1 (MetaData "GetKeyRotationStatus" "Network.AWS.KMS.GetKeyRotationStatus" "amazonka-kms-1.5.0-1ul8bs34gET2EfYsh0ppOn" True) (C1 (MetaCons "GetKeyRotationStatus'" PrefixI True) (S1 (MetaSel (Just Symbol "_gkrsKeyId") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text)))
type Rs GetKeyRotationStatus Source #
type Rs GetKeyRotationStatus = GetKeyRotationStatusResponse

Request Lenses

gkrsKeyId :: Lens' GetKeyRotationStatus Text Source #

A unique identifier for the customer master key (CMK). Specify the key ID or the Amazon Resource Name (ARN) of the CMK. To specify a CMK in a different AWS account, you must use the key ARN. 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 .

Destructuring the Response

getKeyRotationStatusResponse Source #

Arguments

:: Int	`gkrsrsResponseStatus`
-> GetKeyRotationStatusResponse

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

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

gkrsrsKeyRotationEnabled - A Boolean value that specifies whether key rotation is enabled.
gkrsrsResponseStatus - -- | The response status code.

data GetKeyRotationStatusResponse Source #

See: getKeyRotationStatusResponse smart constructor.

Instances

Eq GetKeyRotationStatusResponse Source #
Methods (==) :: GetKeyRotationStatusResponse -> GetKeyRotationStatusResponse -> Bool # (/=) :: GetKeyRotationStatusResponse -> GetKeyRotationStatusResponse -> Bool #
Data GetKeyRotationStatusResponse Source #
Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> GetKeyRotationStatusResponse -> c GetKeyRotationStatusResponse # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c GetKeyRotationStatusResponse # toConstr :: GetKeyRotationStatusResponse -> Constr # dataTypeOf :: GetKeyRotationStatusResponse -> DataType # dataCast1 :: Typeable (* -> ) t => (forall d. Data d => c (t d)) -> Maybe (c GetKeyRotationStatusResponse) # dataCast2 :: Typeable ( -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c GetKeyRotationStatusResponse) # gmapT :: (forall b. Data b => b -> b) -> GetKeyRotationStatusResponse -> GetKeyRotationStatusResponse # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> GetKeyRotationStatusResponse -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> GetKeyRotationStatusResponse -> r # gmapQ :: (forall d. Data d => d -> u) -> GetKeyRotationStatusResponse -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> GetKeyRotationStatusResponse -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> GetKeyRotationStatusResponse -> m GetKeyRotationStatusResponse # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> GetKeyRotationStatusResponse -> m GetKeyRotationStatusResponse # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> GetKeyRotationStatusResponse -> m GetKeyRotationStatusResponse #
Read GetKeyRotationStatusResponse Source #
Methods readsPrec :: Int -> ReadS GetKeyRotationStatusResponse # readList :: ReadS [GetKeyRotationStatusResponse] # readPrec :: ReadPrec GetKeyRotationStatusResponse # readListPrec :: ReadPrec [GetKeyRotationStatusResponse] #
Show GetKeyRotationStatusResponse Source #
Methods showsPrec :: Int -> GetKeyRotationStatusResponse -> ShowS # show :: GetKeyRotationStatusResponse -> String # showList :: [GetKeyRotationStatusResponse] -> ShowS #
Generic GetKeyRotationStatusResponse Source #
Associated Types type Rep GetKeyRotationStatusResponse :: * -> * # Methods from :: GetKeyRotationStatusResponse -> Rep GetKeyRotationStatusResponse x # to :: Rep GetKeyRotationStatusResponse x -> GetKeyRotationStatusResponse #
NFData GetKeyRotationStatusResponse Source #
Methods rnf :: GetKeyRotationStatusResponse -> () #
type Rep GetKeyRotationStatusResponse Source #
type Rep GetKeyRotationStatusResponse = D1 (MetaData "GetKeyRotationStatusResponse" "Network.AWS.KMS.GetKeyRotationStatus" "amazonka-kms-1.5.0-1ul8bs34gET2EfYsh0ppOn" False) (C1 (MetaCons "GetKeyRotationStatusResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_gkrsrsKeyRotationEnabled") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) (S1 (MetaSel (Just Symbol "_gkrsrsResponseStatus") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int))))

Response Lenses

gkrsrsKeyRotationEnabled :: Lens' GetKeyRotationStatusResponse (Maybe Bool) Source #

A Boolean value that specifies whether key rotation is enabled.

gkrsrsResponseStatus :: Lens' GetKeyRotationStatusResponse Int Source #

- | The response status code.