npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@datafire/amazonaws_kms

v5.0.0

Published

DataFire integration for AWS Key Management Service

Downloads

1

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

datafiredatafire

Keywords

Readme

@datafire/amazonaws_kms

Client library for AWS Key Management Service

Installation and Usage

npm install --save @datafire/amazonaws_kms
let amazonaws_kms = require('@datafire/amazonaws_kms').create({
  accessKeyId: "",
  secretAccessKey: "",
  region: ""
});

amazonaws_kms.CancelKeyDeletion({
  "KeyId": ""
}).then(data => {
  console.log(data);
});

Description

AWS Key Management Service AWS Key Management Service (AWS KMS) is an encryption and key management web service. This guide describes the AWS KMS operations that you can call programmatically. For general information about AWS KMS, see the AWS Key Management Service Developer Guide. AWS provides SDKs that consist of libraries and sample code for various programming languages and platforms (Java, Ruby, .Net, iOS, Android, etc.). The SDKs provide a convenient way to create programmatic access to AWS KMS and other AWS services. For example, the SDKs take care of tasks such as signing requests (see below), managing errors, and retrying requests automatically. For more information about the AWS SDKs, including how to download and install them, see Tools for Amazon Web Services. We recommend that you use the AWS SDKs to make programmatic API calls to AWS KMS. Clients must support TLS (Transport Layer Security) 1.0. We recommend TLS 1.2. Clients must also support cipher suites with Perfect Forward Secrecy (PFS) such as Ephemeral Diffie-Hellman (DHE) or Elliptic Curve Ephemeral Diffie-Hellman (ECDHE). Most modern systems such as Java 7 and later support these modes. Signing Requests Requests must be signed by using an access key ID and a secret access key. We strongly recommend that you do not use your AWS account (root) access key ID and secret key for everyday work with AWS KMS. Instead, use the access key ID and secret access key for an IAM user, or you can use the AWS Security Token Service to generate temporary security credentials that you can use to sign requests. All AWS KMS operations require Signature Version 4. Logging API Requests AWS KMS supports AWS CloudTrail, a service that logs AWS API calls and related events for your AWS account and delivers them to an Amazon S3 bucket that you specify. By using the information collected by CloudTrail, you can determine what requests were made to AWS KMS, who made the request, when it was made, and so on. To learn more about CloudTrail, including how to turn it on and find your log files, see the AWS CloudTrail User Guide. Additional Resources For more information about credentials and request signing, see the following: AWS Security Credentials - This topic provides general information about the types of credentials used for accessing AWS. Temporary Security Credentials - This section of the IAM User Guide describes how to create and use temporary security credentials. Signature Version 4 Signing Process - This set of topics walks you through the process of signing a request using an access key ID and a secret access key. Commonly Used APIs Of the APIs discussed in this guide, the following will prove the most useful for most applications. You will likely perform actions other than these, such as creating keys and assigning policies, by using the console. Encrypt Decrypt GenerateDataKey GenerateDataKeyWithoutPlaintext

Actions

CancelKeyDeletion

amazonaws_kms.CancelKeyDeletion({
  "KeyId": ""
}, context)

Input

Output

CreateAlias

amazonaws_kms.CreateAlias({
  "AliasName": "",
  "TargetKeyId": ""
}, context)

Input

Output

Output schema unknown

CreateGrant

amazonaws_kms.CreateGrant({
  "KeyId": "",
  "GranteePrincipal": "",
  "Operations": []
}, context)

Input

Output

CreateKey

amazonaws_kms.CreateKey({}, context)

Input

Output

Decrypt

amazonaws_kms.Decrypt({
  "CiphertextBlob": ""
}, context)

Input

Output

DeleteAlias

amazonaws_kms.DeleteAlias({
  "AliasName": ""
}, context)

Input

Output

Output schema unknown

DeleteImportedKeyMaterial

amazonaws_kms.DeleteImportedKeyMaterial({
  "KeyId": ""
}, context)

Input

Output

Output schema unknown

DescribeKey

amazonaws_kms.DescribeKey({
  "KeyId": ""
}, context)

Input

Output

DisableKey

amazonaws_kms.DisableKey({
  "KeyId": ""
}, context)

Input

Output

Output schema unknown

DisableKeyRotation

amazonaws_kms.DisableKeyRotation({
  "KeyId": ""
}, context)

Input

Output

Output schema unknown

EnableKey

amazonaws_kms.EnableKey({
  "KeyId": ""
}, context)

Input

Output

Output schema unknown

EnableKeyRotation

amazonaws_kms.EnableKeyRotation({
  "KeyId": ""
}, context)

Input

Output

Output schema unknown

Encrypt

amazonaws_kms.Encrypt({
  "KeyId": "",
  "Plaintext": ""
}, context)

Input

Output

GenerateDataKey

amazonaws_kms.GenerateDataKey({
  "KeyId": ""
}, context)

Input

Output

GenerateDataKeyWithoutPlaintext

amazonaws_kms.GenerateDataKeyWithoutPlaintext({
  "KeyId": ""
}, context)

Input

Output

GenerateRandom

amazonaws_kms.GenerateRandom({}, context)

Input

Output

GetKeyPolicy

amazonaws_kms.GetKeyPolicy({
  "KeyId": "",
  "PolicyName": ""
}, context)

Input

Output

GetKeyRotationStatus

amazonaws_kms.GetKeyRotationStatus({
  "KeyId": ""
}, context)

Input

Output

GetParametersForImport

amazonaws_kms.GetParametersForImport({
  "KeyId": "",
  "WrappingAlgorithm": "",
  "WrappingKeySpec": ""
}, context)

Input

Output

ImportKeyMaterial

amazonaws_kms.ImportKeyMaterial({
  "KeyId": "",
  "ImportToken": "",
  "EncryptedKeyMaterial": ""
}, context)

Input

Output

ListAliases

amazonaws_kms.ListAliases({}, context)

Input

Output

ListGrants

amazonaws_kms.ListGrants({
  "KeyId": ""
}, context)

Input

Output

ListKeyPolicies

amazonaws_kms.ListKeyPolicies({
  "KeyId": ""
}, context)

Input

Output

ListKeys

amazonaws_kms.ListKeys({}, context)

Input

Output

ListResourceTags

amazonaws_kms.ListResourceTags({
  "KeyId": ""
}, context)

Input

Output

ListRetirableGrants

amazonaws_kms.ListRetirableGrants({
  "RetiringPrincipal": ""
}, context)

Input

Output

PutKeyPolicy

amazonaws_kms.PutKeyPolicy({
  "KeyId": "",
  "PolicyName": "",
  "Policy": ""
}, context)

Input

Output

Output schema unknown

ReEncrypt

amazonaws_kms.ReEncrypt({
  "CiphertextBlob": "",
  "DestinationKeyId": ""
}, context)

Input

Output

RetireGrant

amazonaws_kms.RetireGrant({}, context)

Input

Output

Output schema unknown

RevokeGrant

amazonaws_kms.RevokeGrant({
  "KeyId": "",
  "GrantId": ""
}, context)

Input

Output

Output schema unknown

ScheduleKeyDeletion

amazonaws_kms.ScheduleKeyDeletion({
  "KeyId": ""
}, context)

Input

Output

TagResource

amazonaws_kms.TagResource({
  "KeyId": "",
  "Tags": []
}, context)

Input

Output

Output schema unknown

UntagResource

amazonaws_kms.UntagResource({
  "KeyId": "",
  "TagKeys": []
}, context)

Input

Output

Output schema unknown

UpdateAlias

amazonaws_kms.UpdateAlias({
  "AliasName": "",
  "TargetKeyId": ""
}, context)

Input

Output

Output schema unknown

UpdateKeyDescription

amazonaws_kms.UpdateKeyDescription({
  "KeyId": "",
  "Description": ""
}, context)

Input

Output

Output schema unknown

Definitions

AWSAccountIdType

  • AWSAccountIdType string

AlgorithmSpec

  • AlgorithmSpec string (values: RSAES_PKCS1_V1_5, RSAES_OAEP_SHA_1, RSAES_OAEP_SHA_256)

AliasList

AliasListEntry

AliasNameType

  • AliasNameType string

AlreadyExistsException

  • AlreadyExistsException object: The request was rejected because it attempted to create a resource that already exists.

ArnType

  • ArnType string

BooleanType

  • BooleanType boolean

CancelKeyDeletionRequest

  • CancelKeyDeletionRequest object

CancelKeyDeletionResponse

  • CancelKeyDeletionResponse object

CiphertextType

  • CiphertextType string

CreateAliasRequest

CreateGrantRequest

CreateGrantResponse

CreateKeyRequest

CreateKeyResponse

DataKeySpec

  • DataKeySpec string (values: AES_256, AES_128)

DateType

  • DateType string

DecryptRequest

DecryptResponse

DeleteAliasRequest

DeleteImportedKeyMaterialRequest

  • DeleteImportedKeyMaterialRequest object

DependencyTimeoutException

  • DependencyTimeoutException object: The system timed out while trying to fulfill the request. The request can be retried.

DescribeKeyRequest

DescribeKeyResponse

DescriptionType

  • DescriptionType string

DisableKeyRequest

  • DisableKeyRequest object

DisableKeyRotationRequest

  • DisableKeyRotationRequest object

DisabledException

  • DisabledException object: The request was rejected because the specified CMK is not enabled.

EnableKeyRequest

  • EnableKeyRequest object

EnableKeyRotationRequest

  • EnableKeyRotationRequest object

EncryptRequest

EncryptResponse

EncryptionContextKey

  • EncryptionContextKey string

EncryptionContextType

EncryptionContextValue

  • EncryptionContextValue string

ErrorMessageType

  • ErrorMessageType string

ExpirationModelType

  • ExpirationModelType string (values: KEY_MATERIAL_EXPIRES, KEY_MATERIAL_DOES_NOT_EXPIRE)

ExpiredImportTokenException

  • ExpiredImportTokenException object: The request was rejected because the provided import token is expired. Use GetParametersForImport to get a new import token and public key, use the new public key to encrypt the key material, and then try the request again.

GenerateDataKeyRequest

GenerateDataKeyResponse

GenerateDataKeyWithoutPlaintextRequest

GenerateDataKeyWithoutPlaintextResponse

GenerateRandomRequest

GenerateRandomResponse

GetKeyPolicyRequest

GetKeyPolicyResponse

GetKeyRotationStatusRequest

  • GetKeyRotationStatusRequest object

GetKeyRotationStatusResponse

  • GetKeyRotationStatusResponse object

GetParametersForImportRequest

GetParametersForImportResponse

GrantConstraints

  • GrantConstraints object: A structure that you can use to allow certain operations in the grant only when the desired encryption context is present. For more information about encryption context, see Encryption Context in the AWS Key Management Service Developer Guide. Grant constraints apply only to operations that accept encryption context as input. For example, the DescribeKey operation does not accept encryption context as input. A grant that allows the DescribeKey operation does so regardless of the grant constraints. In constrast, the Encrypt operation accepts encryption context as input. A grant that allows the Encrypt operation does so only when the encryption context of the Encrypt operation satisfies the grant constraints.

GrantIdType

  • GrantIdType string

GrantList

GrantListEntry

GrantNameType

  • GrantNameType string

GrantOperation

  • GrantOperation string (values: Decrypt, Encrypt, GenerateDataKey, GenerateDataKeyWithoutPlaintext, ReEncryptFrom, ReEncryptTo, CreateGrant, RetireGrant, DescribeKey)

GrantOperationList

GrantTokenList

GrantTokenType

  • GrantTokenType string

ImportKeyMaterialRequest

ImportKeyMaterialResponse

  • ImportKeyMaterialResponse object

IncorrectKeyMaterialException

  • IncorrectKeyMaterialException object: The request was rejected because the provided key material is invalid or is not the same key material that was previously imported into this customer master key (CMK).

InvalidAliasNameException

  • InvalidAliasNameException object: The request was rejected because the specified alias name is not valid.

InvalidArnException

  • InvalidArnException object: The request was rejected because a specified ARN was not valid.

InvalidCiphertextException

  • InvalidCiphertextException object: The request was rejected because the specified ciphertext, or additional authenticated data incorporated into the ciphertext, such as the encryption context, is corrupted, missing, or otherwise invalid.

InvalidGrantIdException

  • InvalidGrantIdException object: The request was rejected because the specified GrantId is not valid.

InvalidGrantTokenException

  • InvalidGrantTokenException object: The request was rejected because the specified grant token is not valid.

InvalidImportTokenException

  • InvalidImportTokenException object: The request was rejected because the provided import token is invalid or is associated with a different customer master key (CMK).

InvalidKeyUsageException

  • InvalidKeyUsageException object: The request was rejected because the specified KeySpec value is not valid.

InvalidMarkerException

  • InvalidMarkerException object: The request was rejected because the marker that specifies where pagination should next begin is not valid.

KMSInternalException

  • KMSInternalException object: The request was rejected because an internal exception occurred. The request can be retried.

KMSInvalidStateException

  • KMSInvalidStateException object: The request was rejected because the state of the specified resource is not valid for this request. For more information about how key state affects the use of a CMK, see How Key State Affects Use of a Customer Master Key in the AWS Key Management Service Developer Guide.

KeyIdType

  • KeyIdType string

KeyList

KeyListEntry

  • KeyListEntry object: Contains information about each entry in the key list.

KeyManagerType

  • KeyManagerType string (values: AWS, CUSTOMER)

KeyMetadata

KeyState

  • KeyState string (values: Enabled, Disabled, PendingDeletion, PendingImport)

KeyUnavailableException

  • KeyUnavailableException object: The request was rejected because the specified CMK was not available. The request can be retried.

KeyUsageType

  • KeyUsageType string (values: ENCRYPT_DECRYPT)

LimitExceededException

  • LimitExceededException object: The request was rejected because a limit was exceeded. For more information, see Limits in the AWS Key Management Service Developer Guide.

LimitType

  • LimitType integer

ListAliasesRequest

ListAliasesResponse

ListGrantsRequest

ListGrantsResponse

ListKeyPoliciesRequest

ListKeyPoliciesResponse

ListKeysRequest

ListKeysResponse

ListResourceTagsRequest

ListResourceTagsResponse

ListRetirableGrantsRequest

MalformedPolicyDocumentException

  • MalformedPolicyDocumentException object: The request was rejected because the specified policy is not syntactically or semantically correct.

MarkerType

  • MarkerType string

NotFoundException

  • NotFoundException object: The request was rejected because the specified entity or resource could not be found.

NumberOfBytesType

  • NumberOfBytesType integer

OriginType

  • OriginType string (values: AWS_KMS, EXTERNAL)

PendingWindowInDaysType

  • PendingWindowInDaysType integer

PlaintextType

  • PlaintextType string

PolicyNameList

PolicyNameType

  • PolicyNameType string

PolicyType

  • PolicyType string

PrincipalIdType

  • PrincipalIdType string

PutKeyPolicyRequest

ReEncryptRequest

ReEncryptResponse

RetireGrantRequest

RevokeGrantRequest

ScheduleKeyDeletionRequest

ScheduleKeyDeletionResponse

Tag

  • Tag object: A key-value pair. A tag consists of a tag key and a tag value. Tag keys and tag values are both required, but tag values can be empty (null) strings. For information about the rules that apply to tag keys and tag values, see User-Defined Tag Restrictions in the AWS Billing and Cost Management User Guide.

TagException

  • TagException object: The request was rejected because one or more tags are not valid.

TagKeyList

TagKeyType

  • TagKeyType string

TagList

  • TagList array

TagResourceRequest

TagValueType

  • TagValueType string

UnsupportedOperationException

  • UnsupportedOperationException object: The request was rejected because a specified parameter is not supported or a specified resource is not valid for this operation.

UntagResourceRequest

UpdateAliasRequest

UpdateKeyDescriptionRequest

WrappingKeySpec

  • WrappingKeySpec string (values: RSA_2048)