libZSservicesZSamazonka-kmsZSamazonka-kms
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.KMS.GetKeyRotationStatus

Description

Gets a Boolean value that indicates whether automatic rotation of the key material is enabled for the specified KMS key.

You cannot enable automatic rotation of asymmetric KMS keys, KMS keys with imported key material, or KMS keys in a custom key store. To enable or disable automatic rotation of a set of related multi-Region keys, set the property on the primary key. The key rotation status for these KMS keys is always false.

The KMS key that you use for this operation must be in a compatible key state. For details, see Key state: Effect on your KMS key in the Key Management Service Developer Guide.

  • Disabled: The key rotation status does not change when you disable a KMS key. However, while the KMS key is disabled, KMS does not rotate the key material.
  • Pending deletion: While a KMS key is pending deletion, its key rotation status is false and KMS does not rotate the key material. If you cancel the deletion, the original key rotation status is restored.

Cross-account use: Yes. To perform this operation on a KMS key in a different Amazon Web Services account, specify the key ARN in the value of the KeyId parameter.

Required permissions: kms:GetKeyRotationStatus (key policy)

Related operations:

  • DisableKeyRotation
  • EnableKeyRotation
Synopsis

Creating a Request

data GetKeyRotationStatus Source #

See: newGetKeyRotationStatus smart constructor.

Constructors

GetKeyRotationStatus' 

Fields

  • keyId :: Text

    Gets the rotation status for the specified KMS key.

    Specify the key ID or key ARN of the KMS key. To specify a KMS key in a different Amazon Web Services 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 KMS key, use ListKeys or DescribeKey.

Instances

Instances details
Eq GetKeyRotationStatus Source # 
Instance details

Defined in Amazonka.KMS.GetKeyRotationStatus

Methods

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

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

Read GetKeyRotationStatus Source # 
Instance details

Defined in Amazonka.KMS.GetKeyRotationStatus

Methods

readsPrec :: Int -> ReadS GetKeyRotationStatus #

readList :: ReadS [GetKeyRotationStatus] #

readPrec :: ReadPrec GetKeyRotationStatus #

readListPrec :: ReadPrec [GetKeyRotationStatus] #

Show GetKeyRotationStatus Source # 
Instance details

Defined in Amazonka.KMS.GetKeyRotationStatus

Methods

showsPrec :: Int -> GetKeyRotationStatus -> ShowS #

show :: GetKeyRotationStatus -> String #

showList :: [GetKeyRotationStatus] -> ShowS #

Generic GetKeyRotationStatus Source # 
Instance details

Defined in Amazonka.KMS.GetKeyRotationStatus

Associated Types

type Rep GetKeyRotationStatus :: Type -> Type #

Methods

from :: GetKeyRotationStatus -> Rep GetKeyRotationStatus x #

to :: Rep GetKeyRotationStatus x -> GetKeyRotationStatus #

NFData GetKeyRotationStatus Source # 
Instance details

Defined in Amazonka.KMS.GetKeyRotationStatus

Methods

rnf :: GetKeyRotationStatus -> () #

Hashable GetKeyRotationStatus Source # 
Instance details

Defined in Amazonka.KMS.GetKeyRotationStatus

Methods

hashWithSalt :: Int -> GetKeyRotationStatus -> Int #

hash :: GetKeyRotationStatus -> Int #

ToJSON GetKeyRotationStatus Source # 
Instance details

Defined in Amazonka.KMS.GetKeyRotationStatus

Methods

toJSON :: GetKeyRotationStatus -> Value #

toEncoding :: GetKeyRotationStatus -> Encoding #

toJSONList :: [GetKeyRotationStatus] -> Value #

toEncodingList :: [GetKeyRotationStatus] -> Encoding #

AWSRequest GetKeyRotationStatus Source # 
Instance details

Defined in Amazonka.KMS.GetKeyRotationStatus

Associated Types

type AWSResponse GetKeyRotationStatus #

Methods

request :: GetKeyRotationStatus -> Request GetKeyRotationStatus #

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

ToHeaders GetKeyRotationStatus Source # 
Instance details

Defined in Amazonka.KMS.GetKeyRotationStatus

Methods

toHeaders :: GetKeyRotationStatus -> [Header] #

ToPath GetKeyRotationStatus Source # 
Instance details

Defined in Amazonka.KMS.GetKeyRotationStatus

Methods

toPath :: GetKeyRotationStatus -> ByteString #

ToQuery GetKeyRotationStatus Source # 
Instance details

Defined in Amazonka.KMS.GetKeyRotationStatus

Methods

toQuery :: GetKeyRotationStatus -> QueryString #

type Rep GetKeyRotationStatus Source # 
Instance details

Defined in Amazonka.KMS.GetKeyRotationStatus

type Rep GetKeyRotationStatus = D1 ('MetaData "GetKeyRotationStatus" "Amazonka.KMS.GetKeyRotationStatus" "libZSservicesZSamazonka-kmsZSamazonka-kms" 'False) (C1 ('MetaCons "GetKeyRotationStatus'" 'PrefixI 'True) (S1 ('MetaSel ('Just "keyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse GetKeyRotationStatus Source # 
Instance details

Defined in Amazonka.KMS.GetKeyRotationStatus

type AWSResponse GetKeyRotationStatus = GetKeyRotationStatusResponse

newGetKeyRotationStatus Source #

Arguments

:: Text

$sel:keyId:GetKeyRotationStatus'

-> GetKeyRotationStatus 

Create a value of GetKeyRotationStatus 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:keyId:GetKeyRotationStatus', getKeyRotationStatus_keyId - Gets the rotation status for the specified KMS key.

Specify the key ID or key ARN of the KMS key. To specify a KMS key in a different Amazon Web Services 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 KMS key, use ListKeys or DescribeKey.

Request Lenses

getKeyRotationStatus_keyId :: Lens' GetKeyRotationStatus Text Source #

Gets the rotation status for the specified KMS key.

Specify the key ID or key ARN of the KMS key. To specify a KMS key in a different Amazon Web Services 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 KMS key, use ListKeys or DescribeKey.

Destructuring the Response

data GetKeyRotationStatusResponse Source #

See: newGetKeyRotationStatusResponse smart constructor.

Constructors

GetKeyRotationStatusResponse' 

Fields

Instances

Instances details
Eq GetKeyRotationStatusResponse Source # 
Instance details

Defined in Amazonka.KMS.GetKeyRotationStatus

Methods

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

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

Read GetKeyRotationStatusResponse Source # 
Instance details

Defined in Amazonka.KMS.GetKeyRotationStatus

Methods

readsPrec :: Int -> ReadS GetKeyRotationStatusResponse #

readList :: ReadS [GetKeyRotationStatusResponse] #

readPrec :: ReadPrec GetKeyRotationStatusResponse #

readListPrec :: ReadPrec [GetKeyRotationStatusResponse] #

Show GetKeyRotationStatusResponse Source # 
Instance details

Defined in Amazonka.KMS.GetKeyRotationStatus

Methods

showsPrec :: Int -> GetKeyRotationStatusResponse -> ShowS #

show :: GetKeyRotationStatusResponse -> String #

showList :: [GetKeyRotationStatusResponse] -> ShowS #

Generic GetKeyRotationStatusResponse Source # 
Instance details

Defined in Amazonka.KMS.GetKeyRotationStatus

Associated Types

type Rep GetKeyRotationStatusResponse :: Type -> Type #

Methods

from :: GetKeyRotationStatusResponse -> Rep GetKeyRotationStatusResponse x #

to :: Rep GetKeyRotationStatusResponse x -> GetKeyRotationStatusResponse #

NFData GetKeyRotationStatusResponse Source # 
Instance details

Defined in Amazonka.KMS.GetKeyRotationStatus

Methods

rnf :: GetKeyRotationStatusResponse -> () #

type Rep GetKeyRotationStatusResponse Source # 
Instance details

Defined in Amazonka.KMS.GetKeyRotationStatus

type Rep GetKeyRotationStatusResponse = D1 ('MetaData "GetKeyRotationStatusResponse" "Amazonka.KMS.GetKeyRotationStatus" "libZSservicesZSamazonka-kmsZSamazonka-kms" 'False) (C1 ('MetaCons "GetKeyRotationStatusResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "keyRotationEnabled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newGetKeyRotationStatusResponse Source #

Arguments

:: Int

$sel:httpStatus:GetKeyRotationStatusResponse'

-> GetKeyRotationStatusResponse 

Create a value of GetKeyRotationStatusResponse 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:keyRotationEnabled:GetKeyRotationStatusResponse', getKeyRotationStatusResponse_keyRotationEnabled - A Boolean value that specifies whether key rotation is enabled.

$sel:httpStatus:GetKeyRotationStatusResponse', getKeyRotationStatusResponse_httpStatus - The response's http status code.

Response Lenses

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

A Boolean value that specifies whether key rotation is enabled.

getKeyRotationStatusResponse_httpStatus :: Lens' GetKeyRotationStatusResponse Int Source #

The response's http status code.