Amazonka.KMS.GetKeyRotationStatus

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

When you enable automatic rotation for customer managed KMS keys, KMS rotates the key material of the KMS key one year (approximately 365 days) from the enable date and every year thereafter. You can monitor rotation of the key material for your KMS keys in CloudTrail and Amazon CloudWatch.

Automatic key rotation is supported only on symmetric encryption KMS keys. You cannot enable automatic rotation of asymmetric KMS keys, HMAC 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..

You can enable (EnableKeyRotation) and disable automatic rotation (DisableKeyRotation) of the key material in customer managed KMS keys. Key material rotation of Amazon Web Services managed KMS keys is not configurable. KMS always rotates the key material in Amazon Web Services managed KMS keys every year. The key rotation status for Amazon Web Services managed KMS keys is always true.

In May 2022, KMS changed the rotation schedule for Amazon Web Services managed keys from every three years to every year. For details, see EnableKeyRotation.

The KMS key that you use for this operation must be in a compatible key state. For details, see Key states of KMS keys 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. When you re-enable the KMS key, rotation resumes. If the key material in the re-enabled KMS key hasn't been rotated in one year, KMS rotates it immediately, and every year thereafter. If it's been less than a year since the key material in the re-enabled KMS key was rotated, the KMS key resumes its prior rotation schedule.
• 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 returns to true.

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

Creating a Request

data GetKeyRotationStatus

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

ToJSON GetKeyRotationStatus

Defined in Amazonka.KMS.GetKeyRotationStatus

Methods

toJSON :: GetKeyRotationStatus -> Value

toEncoding :: GetKeyRotationStatus -> Encoding

toJSONList :: [GetKeyRotationStatus] -> Value

toEncodingList :: [GetKeyRotationStatus] -> Encoding

ToHeaders GetKeyRotationStatus

Defined in Amazonka.KMS.GetKeyRotationStatus

Methods

toHeaders :: GetKeyRotationStatus -> [Header]

ToPath GetKeyRotationStatus

Defined in Amazonka.KMS.GetKeyRotationStatus

Methods

toPath :: GetKeyRotationStatus -> ByteString

ToQuery GetKeyRotationStatus

Defined in Amazonka.KMS.GetKeyRotationStatus

Methods

toQuery :: GetKeyRotationStatus -> QueryString

AWSRequest GetKeyRotationStatus

Defined in Amazonka.KMS.GetKeyRotationStatus

Associated Types

type AWSResponse GetKeyRotationStatus

Methods

request :: (Service -> Service) -> GetKeyRotationStatus -> Request GetKeyRotationStatus

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

Generic GetKeyRotationStatus

Defined in Amazonka.KMS.GetKeyRotationStatus

Associated Types

type Rep GetKeyRotationStatus :: Type -> Type

Methods

from :: GetKeyRotationStatus -> Rep GetKeyRotationStatus x

to :: Rep GetKeyRotationStatus x -> GetKeyRotationStatus

Read GetKeyRotationStatus

Defined in Amazonka.KMS.GetKeyRotationStatus

Methods

readsPrec :: Int -> ReadS GetKeyRotationStatus

readList :: ReadS [GetKeyRotationStatus]

readPrec :: ReadPrec GetKeyRotationStatus

readListPrec :: ReadPrec [GetKeyRotationStatus]

Show GetKeyRotationStatus

Defined in Amazonka.KMS.GetKeyRotationStatus

Methods

showsPrec :: Int -> GetKeyRotationStatus -> ShowS

show :: GetKeyRotationStatus -> String

showList :: [GetKeyRotationStatus] -> ShowS

NFData GetKeyRotationStatus

Defined in Amazonka.KMS.GetKeyRotationStatus

Methods

rnf :: GetKeyRotationStatus -> ()

Eq GetKeyRotationStatus

Defined in Amazonka.KMS.GetKeyRotationStatus

Methods

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

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

Hashable GetKeyRotationStatus

Defined in Amazonka.KMS.GetKeyRotationStatus

Methods

hashWithSalt :: Int -> GetKeyRotationStatus -> Int

hash :: GetKeyRotationStatus -> Int

type AWSResponse GetKeyRotationStatus

Defined in Amazonka.KMS.GetKeyRotationStatus

type AWSResponse GetKeyRotationStatus = GetKeyRotationStatusResponse

type Rep GetKeyRotationStatus

Defined in Amazonka.KMS.GetKeyRotationStatus

type Rep GetKeyRotationStatus = D1 ('MetaData "GetKeyRotationStatus" "Amazonka.KMS.GetKeyRotationStatus" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'False) (C1 ('MetaCons "GetKeyRotationStatus'" 'PrefixI 'True) (S1 ('MetaSel ('Just "keyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newGetKeyRotationStatus

Arguments

:: Text

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:

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

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

See: newGetKeyRotationStatusResponse smart constructor.

Constructors

GetKeyRotationStatusResponse'

Fields

• keyRotationEnabled :: Maybe Bool

  A Boolean value that specifies whether key rotation is enabled.

• httpStatus :: Int

  The response's http status code.

Instances

Generic GetKeyRotationStatusResponse

Defined in Amazonka.KMS.GetKeyRotationStatus

Associated Types

type Rep GetKeyRotationStatusResponse :: Type -> Type

Methods

from :: GetKeyRotationStatusResponse -> Rep GetKeyRotationStatusResponse x

to :: Rep GetKeyRotationStatusResponse x -> GetKeyRotationStatusResponse

Read GetKeyRotationStatusResponse

Defined in Amazonka.KMS.GetKeyRotationStatus

Methods

readsPrec :: Int -> ReadS GetKeyRotationStatusResponse

readList :: ReadS [GetKeyRotationStatusResponse]

readPrec :: ReadPrec GetKeyRotationStatusResponse

readListPrec :: ReadPrec [GetKeyRotationStatusResponse]

Show GetKeyRotationStatusResponse

Defined in Amazonka.KMS.GetKeyRotationStatus

Methods

showsPrec :: Int -> GetKeyRotationStatusResponse -> ShowS

show :: GetKeyRotationStatusResponse -> String

showList :: [GetKeyRotationStatusResponse] -> ShowS

NFData GetKeyRotationStatusResponse

Defined in Amazonka.KMS.GetKeyRotationStatus

Methods

rnf :: GetKeyRotationStatusResponse -> ()

Eq GetKeyRotationStatusResponse

Defined in Amazonka.KMS.GetKeyRotationStatus

Methods

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

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

type Rep GetKeyRotationStatusResponse

Defined in Amazonka.KMS.GetKeyRotationStatus

type Rep GetKeyRotationStatusResponse = D1 ('MetaData "GetKeyRotationStatusResponse" "Amazonka.KMS.GetKeyRotationStatus" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" '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

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)

A Boolean value that specifies whether key rotation is enabled.

getKeyRotationStatusResponse_httpStatus :: Lens' GetKeyRotationStatusResponse Int

The response's http status code.