Amazonka.KMS.GetKeyPolicy

Gets a key policy attached to the specified KMS key.

Cross-account use: No. You cannot perform this operation on a KMS key in a different Amazon Web Services account.

Required permissions: kms:GetKeyPolicy (key policy)

Related operations: PutKeyPolicy

Creating a Request

data GetKeyPolicy

See: newGetKeyPolicy smart constructor.

Constructors

GetKeyPolicy'

Fields

• keyId :: Text

  Gets the key policy for the specified KMS key.

  Specify the key ID or key ARN of the KMS key.

  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.

• policyName :: Text

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

Instances

ToJSON GetKeyPolicy

Defined in Amazonka.KMS.GetKeyPolicy

Methods

toJSON :: GetKeyPolicy -> Value

toEncoding :: GetKeyPolicy -> Encoding

toJSONList :: [GetKeyPolicy] -> Value

toEncodingList :: [GetKeyPolicy] -> Encoding

ToHeaders GetKeyPolicy

Defined in Amazonka.KMS.GetKeyPolicy

Methods

toHeaders :: GetKeyPolicy -> [Header]

ToPath GetKeyPolicy

Defined in Amazonka.KMS.GetKeyPolicy

Methods

toPath :: GetKeyPolicy -> ByteString

ToQuery GetKeyPolicy

Defined in Amazonka.KMS.GetKeyPolicy

Methods

toQuery :: GetKeyPolicy -> QueryString

AWSRequest GetKeyPolicy

Defined in Amazonka.KMS.GetKeyPolicy

Associated Types

type AWSResponse GetKeyPolicy

Methods

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

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

Generic GetKeyPolicy

Defined in Amazonka.KMS.GetKeyPolicy

Associated Types

type Rep GetKeyPolicy :: Type -> Type

Methods

from :: GetKeyPolicy -> Rep GetKeyPolicy x

to :: Rep GetKeyPolicy x -> GetKeyPolicy

Read GetKeyPolicy

Defined in Amazonka.KMS.GetKeyPolicy

Methods

readsPrec :: Int -> ReadS GetKeyPolicy

readList :: ReadS [GetKeyPolicy]

readPrec :: ReadPrec GetKeyPolicy

readListPrec :: ReadPrec [GetKeyPolicy]

Show GetKeyPolicy

Defined in Amazonka.KMS.GetKeyPolicy

Methods

showsPrec :: Int -> GetKeyPolicy -> ShowS

show :: GetKeyPolicy -> String

showList :: [GetKeyPolicy] -> ShowS

NFData GetKeyPolicy

Defined in Amazonka.KMS.GetKeyPolicy

Methods

rnf :: GetKeyPolicy -> ()

Eq GetKeyPolicy

Defined in Amazonka.KMS.GetKeyPolicy

Methods

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

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

Hashable GetKeyPolicy

Defined in Amazonka.KMS.GetKeyPolicy

Methods

hashWithSalt :: Int -> GetKeyPolicy -> Int

hash :: GetKeyPolicy -> Int

type AWSResponse GetKeyPolicy

Defined in Amazonka.KMS.GetKeyPolicy

type AWSResponse GetKeyPolicy = GetKeyPolicyResponse

type Rep GetKeyPolicy

Defined in Amazonka.KMS.GetKeyPolicy

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

newGetKeyPolicy

Arguments

:: Text

GetKeyPolicy

-> Text

$sel:policyName:GetKeyPolicy'

-> GetKeyPolicy

Create a value of GetKeyPolicy 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:

GetKeyPolicy, getKeyPolicy_keyId - Gets the key policy for the specified KMS key.

Specify the key ID or key ARN of the KMS key.

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.

$sel:policyName:GetKeyPolicy', getKeyPolicy_policyName - Specifies the name of the key policy. The only valid name is default. To get the names of key policies, use ListKeyPolicies.

Request Lenses

getKeyPolicy_keyId :: Lens' GetKeyPolicy Text

Gets the key policy for the specified KMS key.

Specify the key ID or key ARN of the KMS key.

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.

getKeyPolicy_policyName :: 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

data GetKeyPolicyResponse

See: newGetKeyPolicyResponse smart constructor.

Constructors

GetKeyPolicyResponse'

Fields

• policy :: Maybe Text

  A key policy document in JSON format.

• httpStatus :: Int

  The response's http status code.

Instances

Generic GetKeyPolicyResponse

Defined in Amazonka.KMS.GetKeyPolicy

Associated Types

type Rep GetKeyPolicyResponse :: Type -> Type

Methods

from :: GetKeyPolicyResponse -> Rep GetKeyPolicyResponse x

to :: Rep GetKeyPolicyResponse x -> GetKeyPolicyResponse

Read GetKeyPolicyResponse

Defined in Amazonka.KMS.GetKeyPolicy

Methods

readsPrec :: Int -> ReadS GetKeyPolicyResponse

readList :: ReadS [GetKeyPolicyResponse]

readPrec :: ReadPrec GetKeyPolicyResponse

readListPrec :: ReadPrec [GetKeyPolicyResponse]

Show GetKeyPolicyResponse

Defined in Amazonka.KMS.GetKeyPolicy

Methods

showsPrec :: Int -> GetKeyPolicyResponse -> ShowS

show :: GetKeyPolicyResponse -> String

showList :: [GetKeyPolicyResponse] -> ShowS

NFData GetKeyPolicyResponse

Defined in Amazonka.KMS.GetKeyPolicy

Methods

rnf :: GetKeyPolicyResponse -> ()

Eq GetKeyPolicyResponse

Defined in Amazonka.KMS.GetKeyPolicy

Methods

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

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

type Rep GetKeyPolicyResponse

Defined in Amazonka.KMS.GetKeyPolicy

type Rep GetKeyPolicyResponse = D1 ('MetaData "GetKeyPolicyResponse" "Amazonka.KMS.GetKeyPolicy" "amazonka-kms-2.0-6YhT3Ymbf9Z5PoaGoz7tbG" 'False) (C1 ('MetaCons "GetKeyPolicyResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "policy") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newGetKeyPolicyResponse

Arguments

:: Int

$sel:httpStatus:GetKeyPolicyResponse'

-> GetKeyPolicyResponse

Create a value of GetKeyPolicyResponse 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:policy:GetKeyPolicyResponse', getKeyPolicyResponse_policy - A key policy document in JSON format.

$sel:httpStatus:GetKeyPolicyResponse', getKeyPolicyResponse_httpStatus - The response's http status code.

Response Lenses

getKeyPolicyResponse_policy :: Lens' GetKeyPolicyResponse (Maybe Text)

A key policy document in JSON format.

getKeyPolicyResponse_httpStatus :: Lens' GetKeyPolicyResponse Int

The response's http status code.