Skip to main content Link Search Menu Expand Document (external link)

KMSService overview

Added in v1.0.0


Table of contents


constructors

makeKMSService

Signature

export declare const makeKMSService: Effect.Effect<any, unknown, unknown>

Added in v1.0.0

models

KMSService (class)

Signature

export declare class KMSService

Added in v1.0.0

KMSService$ (interface)

Signature

export interface KMSService$ {
  /**
   * @see {@link CancelKeyDeletionCommand}
   */
  cancelKeyDeletion(
    args: CancelKeyDeletionCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    CancelKeyDeletionCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | DependencyTimeoutError
    | InvalidArnError
    | KMSInternalError
    | KMSInvalidStateError
    | NotFoundError
  >

  /**
   * @see {@link ConnectCustomKeyStoreCommand}
   */
  connectCustomKeyStore(
    args: ConnectCustomKeyStoreCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    ConnectCustomKeyStoreCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | CloudHsmClusterInvalidConfigurationError
    | CloudHsmClusterNotActiveError
    | CustomKeyStoreInvalidStateError
    | CustomKeyStoreNotFoundError
    | KMSInternalError
  >

  /**
   * @see {@link CreateAliasCommand}
   */
  createAlias(
    args: CreateAliasCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    CreateAliasCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | AlreadyExistsError
    | DependencyTimeoutError
    | InvalidAliasNameError
    | KMSInternalError
    | KMSInvalidStateError
    | LimitExceededError
    | NotFoundError
  >

  /**
   * @see {@link CreateCustomKeyStoreCommand}
   */
  createCustomKeyStore(
    args: CreateCustomKeyStoreCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    CreateCustomKeyStoreCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | CloudHsmClusterInUseError
    | CloudHsmClusterInvalidConfigurationError
    | CloudHsmClusterNotActiveError
    | CloudHsmClusterNotFoundError
    | CustomKeyStoreNameInUseError
    | IncorrectTrustAnchorError
    | KMSInternalError
    | LimitExceededError
    | XksProxyIncorrectAuthenticationCredentialError
    | XksProxyInvalidConfigurationError
    | XksProxyInvalidResponseError
    | XksProxyUriEndpointInUseError
    | XksProxyUriInUseError
    | XksProxyUriUnreachableError
    | XksProxyVpcEndpointServiceInUseError
    | XksProxyVpcEndpointServiceInvalidConfigurationError
    | XksProxyVpcEndpointServiceNotFoundError
  >

  /**
   * @see {@link CreateGrantCommand}
   */
  createGrant(
    args: CreateGrantCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    CreateGrantCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | DependencyTimeoutError
    | DisabledError
    | DryRunOperationError
    | InvalidArnError
    | InvalidGrantTokenError
    | KMSInternalError
    | KMSInvalidStateError
    | LimitExceededError
    | NotFoundError
  >

  /**
   * @see {@link CreateKeyCommand}
   */
  createKey(
    args: CreateKeyCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    CreateKeyCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | CloudHsmClusterInvalidConfigurationError
    | CustomKeyStoreInvalidStateError
    | CustomKeyStoreNotFoundError
    | DependencyTimeoutError
    | InvalidArnError
    | KMSInternalError
    | LimitExceededError
    | MalformedPolicyDocumentError
    | TagError
    | UnsupportedOperationError
    | XksKeyAlreadyInUseError
    | XksKeyInvalidConfigurationError
    | XksKeyNotFoundError
  >

  /**
   * @see {@link DecryptCommand}
   */
  decrypt(
    args: DecryptCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    DecryptCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | DependencyTimeoutError
    | DisabledError
    | DryRunOperationError
    | IncorrectKeyError
    | InvalidCiphertextError
    | InvalidGrantTokenError
    | InvalidKeyUsageError
    | KeyUnavailableError
    | KMSInternalError
    | KMSInvalidStateError
    | NotFoundError
  >

  /**
   * @see {@link DeleteAliasCommand}
   */
  deleteAlias(
    args: DeleteAliasCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    DeleteAliasCommandOutput,
    Cause.TimeoutError | SdkError | DependencyTimeoutError | KMSInternalError | KMSInvalidStateError | NotFoundError
  >

  /**
   * @see {@link DeleteCustomKeyStoreCommand}
   */
  deleteCustomKeyStore(
    args: DeleteCustomKeyStoreCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    DeleteCustomKeyStoreCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | CustomKeyStoreHasCMKsError
    | CustomKeyStoreInvalidStateError
    | CustomKeyStoreNotFoundError
    | KMSInternalError
  >

  /**
   * @see {@link DeleteImportedKeyMaterialCommand}
   */
  deleteImportedKeyMaterial(
    args: DeleteImportedKeyMaterialCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    DeleteImportedKeyMaterialCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | DependencyTimeoutError
    | InvalidArnError
    | KMSInternalError
    | KMSInvalidStateError
    | NotFoundError
    | UnsupportedOperationError
  >

  /**
   * @see {@link DeriveSharedSecretCommand}
   */
  deriveSharedSecret(
    args: DeriveSharedSecretCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    DeriveSharedSecretCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | DependencyTimeoutError
    | DisabledError
    | DryRunOperationError
    | InvalidGrantTokenError
    | InvalidKeyUsageError
    | KeyUnavailableError
    | KMSInternalError
    | KMSInvalidStateError
    | NotFoundError
  >

  /**
   * @see {@link DescribeCustomKeyStoresCommand}
   */
  describeCustomKeyStores(
    args: DescribeCustomKeyStoresCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    DescribeCustomKeyStoresCommandOutput,
    Cause.TimeoutError | SdkError | CustomKeyStoreNotFoundError | InvalidMarkerError | KMSInternalError
  >

  describeCustomKeyStoresStream(
    args: DescribeCustomKeyStoresCommandInput,
    options?: HttpHandlerOptions
  ): Stream.Stream<
    DescribeCustomKeyStoresCommandOutput,
    Cause.TimeoutError | SdkError | CustomKeyStoreNotFoundError | InvalidMarkerError | KMSInternalError
  >

  /**
   * @see {@link DescribeKeyCommand}
   */
  describeKey(
    args: DescribeKeyCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    DescribeKeyCommandOutput,
    Cause.TimeoutError | SdkError | DependencyTimeoutError | InvalidArnError | KMSInternalError | NotFoundError
  >

  /**
   * @see {@link DisableKeyCommand}
   */
  disableKey(
    args: DisableKeyCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    DisableKeyCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | DependencyTimeoutError
    | InvalidArnError
    | KMSInternalError
    | KMSInvalidStateError
    | NotFoundError
  >

  /**
   * @see {@link DisableKeyRotationCommand}
   */
  disableKeyRotation(
    args: DisableKeyRotationCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    DisableKeyRotationCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | DependencyTimeoutError
    | DisabledError
    | InvalidArnError
    | KMSInternalError
    | KMSInvalidStateError
    | NotFoundError
    | UnsupportedOperationError
  >

  /**
   * @see {@link DisconnectCustomKeyStoreCommand}
   */
  disconnectCustomKeyStore(
    args: DisconnectCustomKeyStoreCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    DisconnectCustomKeyStoreCommandOutput,
    Cause.TimeoutError | SdkError | CustomKeyStoreInvalidStateError | CustomKeyStoreNotFoundError | KMSInternalError
  >

  /**
   * @see {@link EnableKeyCommand}
   */
  enableKey(
    args: EnableKeyCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    EnableKeyCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | DependencyTimeoutError
    | InvalidArnError
    | KMSInternalError
    | KMSInvalidStateError
    | LimitExceededError
    | NotFoundError
  >

  /**
   * @see {@link EnableKeyRotationCommand}
   */
  enableKeyRotation(
    args: EnableKeyRotationCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    EnableKeyRotationCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | DependencyTimeoutError
    | DisabledError
    | InvalidArnError
    | KMSInternalError
    | KMSInvalidStateError
    | NotFoundError
    | UnsupportedOperationError
  >

  /**
   * @see {@link EncryptCommand}
   */
  encrypt(
    args: EncryptCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    EncryptCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | DependencyTimeoutError
    | DisabledError
    | DryRunOperationError
    | InvalidGrantTokenError
    | InvalidKeyUsageError
    | KeyUnavailableError
    | KMSInternalError
    | KMSInvalidStateError
    | NotFoundError
  >

  /**
   * @see {@link GenerateDataKeyCommand}
   */
  generateDataKey(
    args: GenerateDataKeyCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    GenerateDataKeyCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | DependencyTimeoutError
    | DisabledError
    | DryRunOperationError
    | InvalidGrantTokenError
    | InvalidKeyUsageError
    | KeyUnavailableError
    | KMSInternalError
    | KMSInvalidStateError
    | NotFoundError
  >

  /**
   * @see {@link GenerateDataKeyPairCommand}
   */
  generateDataKeyPair(
    args: GenerateDataKeyPairCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    GenerateDataKeyPairCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | DependencyTimeoutError
    | DisabledError
    | DryRunOperationError
    | InvalidGrantTokenError
    | InvalidKeyUsageError
    | KeyUnavailableError
    | KMSInternalError
    | KMSInvalidStateError
    | NotFoundError
    | UnsupportedOperationError
  >

  /**
   * @see {@link GenerateDataKeyPairWithoutPlaintextCommand}
   */
  generateDataKeyPairWithoutPlaintext(
    args: GenerateDataKeyPairWithoutPlaintextCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    GenerateDataKeyPairWithoutPlaintextCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | DependencyTimeoutError
    | DisabledError
    | DryRunOperationError
    | InvalidGrantTokenError
    | InvalidKeyUsageError
    | KeyUnavailableError
    | KMSInternalError
    | KMSInvalidStateError
    | NotFoundError
    | UnsupportedOperationError
  >

  /**
   * @see {@link GenerateDataKeyWithoutPlaintextCommand}
   */
  generateDataKeyWithoutPlaintext(
    args: GenerateDataKeyWithoutPlaintextCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    GenerateDataKeyWithoutPlaintextCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | DependencyTimeoutError
    | DisabledError
    | DryRunOperationError
    | InvalidGrantTokenError
    | InvalidKeyUsageError
    | KeyUnavailableError
    | KMSInternalError
    | KMSInvalidStateError
    | NotFoundError
  >

  /**
   * @see {@link GenerateMacCommand}
   */
  generateMac(
    args: GenerateMacCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    GenerateMacCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | DisabledError
    | DryRunOperationError
    | InvalidGrantTokenError
    | InvalidKeyUsageError
    | KeyUnavailableError
    | KMSInternalError
    | KMSInvalidStateError
    | NotFoundError
  >

  /**
   * @see {@link GenerateRandomCommand}
   */
  generateRandom(
    args: GenerateRandomCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    GenerateRandomCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | CustomKeyStoreInvalidStateError
    | CustomKeyStoreNotFoundError
    | DependencyTimeoutError
    | KMSInternalError
    | UnsupportedOperationError
  >

  /**
   * @see {@link GetKeyLastUsageCommand}
   */
  getKeyLastUsage(
    args: GetKeyLastUsageCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    GetKeyLastUsageCommandOutput,
    Cause.TimeoutError | SdkError | DependencyTimeoutError | InvalidArnError | KMSInternalError | NotFoundError
  >

  /**
   * @see {@link GetKeyPolicyCommand}
   */
  getKeyPolicy(
    args: GetKeyPolicyCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    GetKeyPolicyCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | DependencyTimeoutError
    | InvalidArnError
    | KMSInternalError
    | KMSInvalidStateError
    | NotFoundError
  >

  /**
   * @see {@link GetKeyRotationStatusCommand}
   */
  getKeyRotationStatus(
    args: GetKeyRotationStatusCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    GetKeyRotationStatusCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | DependencyTimeoutError
    | InvalidArnError
    | KMSInternalError
    | KMSInvalidStateError
    | NotFoundError
    | UnsupportedOperationError
  >

  /**
   * @see {@link GetParametersForImportCommand}
   */
  getParametersForImport(
    args: GetParametersForImportCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    GetParametersForImportCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | DependencyTimeoutError
    | InvalidArnError
    | KMSInternalError
    | KMSInvalidStateError
    | NotFoundError
    | UnsupportedOperationError
  >

  /**
   * @see {@link GetPublicKeyCommand}
   */
  getPublicKey(
    args: GetPublicKeyCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    GetPublicKeyCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | DependencyTimeoutError
    | DisabledError
    | InvalidArnError
    | InvalidGrantTokenError
    | InvalidKeyUsageError
    | KeyUnavailableError
    | KMSInternalError
    | KMSInvalidStateError
    | NotFoundError
    | UnsupportedOperationError
  >

  /**
   * @see {@link ImportKeyMaterialCommand}
   */
  importKeyMaterial(
    args: ImportKeyMaterialCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    ImportKeyMaterialCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | DependencyTimeoutError
    | ExpiredImportTokenError
    | IncorrectKeyMaterialError
    | InvalidArnError
    | InvalidCiphertextError
    | InvalidImportTokenError
    | KMSInternalError
    | KMSInvalidStateError
    | NotFoundError
    | UnsupportedOperationError
  >

  /**
   * @see {@link ListAliasesCommand}
   */
  listAliases(
    args: ListAliasesCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    ListAliasesCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | DependencyTimeoutError
    | InvalidArnError
    | InvalidMarkerError
    | KMSInternalError
    | NotFoundError
  >

  listAliasesStream(
    args: ListAliasesCommandInput,
    options?: HttpHandlerOptions
  ): Stream.Stream<
    ListAliasesCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | DependencyTimeoutError
    | InvalidArnError
    | InvalidMarkerError
    | KMSInternalError
    | NotFoundError
  >

  /**
   * @see {@link ListGrantsCommand}
   */
  listGrants(
    args: ListGrantsCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    ListGrantsCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | DependencyTimeoutError
    | InvalidArnError
    | InvalidGrantIdError
    | InvalidMarkerError
    | KMSInternalError
    | KMSInvalidStateError
    | NotFoundError
  >

  listGrantsStream(
    args: ListGrantsCommandInput,
    options?: HttpHandlerOptions
  ): Stream.Stream<
    ListGrantsCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | DependencyTimeoutError
    | InvalidArnError
    | InvalidGrantIdError
    | InvalidMarkerError
    | KMSInternalError
    | KMSInvalidStateError
    | NotFoundError
  >

  /**
   * @see {@link ListKeyPoliciesCommand}
   */
  listKeyPolicies(
    args: ListKeyPoliciesCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    ListKeyPoliciesCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | DependencyTimeoutError
    | InvalidArnError
    | KMSInternalError
    | KMSInvalidStateError
    | NotFoundError
  >

  listKeyPoliciesStream(
    args: ListKeyPoliciesCommandInput,
    options?: HttpHandlerOptions
  ): Stream.Stream<
    ListKeyPoliciesCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | DependencyTimeoutError
    | InvalidArnError
    | KMSInternalError
    | KMSInvalidStateError
    | NotFoundError
  >

  /**
   * @see {@link ListKeyRotationsCommand}
   */
  listKeyRotations(
    args: ListKeyRotationsCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    ListKeyRotationsCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | InvalidArnError
    | InvalidMarkerError
    | KMSInternalError
    | KMSInvalidStateError
    | NotFoundError
    | UnsupportedOperationError
  >

  listKeyRotationsStream(
    args: ListKeyRotationsCommandInput,
    options?: HttpHandlerOptions
  ): Stream.Stream<
    ListKeyRotationsCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | InvalidArnError
    | InvalidMarkerError
    | KMSInternalError
    | KMSInvalidStateError
    | NotFoundError
    | UnsupportedOperationError
  >

  /**
   * @see {@link ListKeysCommand}
   */
  listKeys(
    args: ListKeysCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    ListKeysCommandOutput,
    Cause.TimeoutError | SdkError | DependencyTimeoutError | InvalidMarkerError | KMSInternalError
  >

  listKeysStream(
    args: ListKeysCommandInput,
    options?: HttpHandlerOptions
  ): Stream.Stream<
    ListKeysCommandOutput,
    Cause.TimeoutError | SdkError | DependencyTimeoutError | InvalidMarkerError | KMSInternalError
  >

  /**
   * @see {@link ListResourceTagsCommand}
   */
  listResourceTags(
    args: ListResourceTagsCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    ListResourceTagsCommandOutput,
    Cause.TimeoutError | SdkError | InvalidArnError | InvalidMarkerError | KMSInternalError | NotFoundError
  >

  listResourceTagsStream(
    args: ListResourceTagsCommandInput,
    options?: HttpHandlerOptions
  ): Stream.Stream<
    ListResourceTagsCommandOutput,
    Cause.TimeoutError | SdkError | InvalidArnError | InvalidMarkerError | KMSInternalError | NotFoundError
  >

  /**
   * @see {@link ListRetirableGrantsCommand}
   */
  listRetirableGrants(
    args: ListRetirableGrantsCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    ListRetirableGrantsCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | DependencyTimeoutError
    | InvalidArnError
    | InvalidMarkerError
    | KMSInternalError
    | NotFoundError
  >

  listRetirableGrantsStream(
    args: ListRetirableGrantsCommandInput,
    options?: HttpHandlerOptions
  ): Stream.Stream<
    ListRetirableGrantsCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | DependencyTimeoutError
    | InvalidArnError
    | InvalidMarkerError
    | KMSInternalError
    | NotFoundError
  >

  /**
   * @see {@link PutKeyPolicyCommand}
   */
  putKeyPolicy(
    args: PutKeyPolicyCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    PutKeyPolicyCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | DependencyTimeoutError
    | InvalidArnError
    | KMSInternalError
    | KMSInvalidStateError
    | LimitExceededError
    | MalformedPolicyDocumentError
    | NotFoundError
    | UnsupportedOperationError
  >

  /**
   * @see {@link ReEncryptCommand}
   */
  reEncrypt(
    args: ReEncryptCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    ReEncryptCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | DependencyTimeoutError
    | DisabledError
    | DryRunOperationError
    | IncorrectKeyError
    | InvalidCiphertextError
    | InvalidGrantTokenError
    | InvalidKeyUsageError
    | KeyUnavailableError
    | KMSInternalError
    | KMSInvalidStateError
    | NotFoundError
  >

  /**
   * @see {@link ReplicateKeyCommand}
   */
  replicateKey(
    args: ReplicateKeyCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    ReplicateKeyCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | AlreadyExistsError
    | DisabledError
    | InvalidArnError
    | KMSInternalError
    | KMSInvalidStateError
    | LimitExceededError
    | MalformedPolicyDocumentError
    | NotFoundError
    | TagError
    | UnsupportedOperationError
  >

  /**
   * @see {@link RetireGrantCommand}
   */
  retireGrant(
    args: RetireGrantCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    RetireGrantCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | DependencyTimeoutError
    | DryRunOperationError
    | InvalidArnError
    | InvalidGrantIdError
    | InvalidGrantTokenError
    | KMSInternalError
    | KMSInvalidStateError
    | NotFoundError
  >

  /**
   * @see {@link RevokeGrantCommand}
   */
  revokeGrant(
    args: RevokeGrantCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    RevokeGrantCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | DependencyTimeoutError
    | DryRunOperationError
    | InvalidArnError
    | InvalidGrantIdError
    | KMSInternalError
    | KMSInvalidStateError
    | NotFoundError
  >

  /**
   * @see {@link RotateKeyOnDemandCommand}
   */
  rotateKeyOnDemand(
    args: RotateKeyOnDemandCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    RotateKeyOnDemandCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | ConflictError
    | DependencyTimeoutError
    | DisabledError
    | InvalidArnError
    | KMSInternalError
    | KMSInvalidStateError
    | LimitExceededError
    | NotFoundError
    | UnsupportedOperationError
  >

  /**
   * @see {@link ScheduleKeyDeletionCommand}
   */
  scheduleKeyDeletion(
    args: ScheduleKeyDeletionCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    ScheduleKeyDeletionCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | DependencyTimeoutError
    | InvalidArnError
    | KMSInternalError
    | KMSInvalidStateError
    | NotFoundError
  >

  /**
   * @see {@link SignCommand}
   */
  sign(
    args: SignCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    SignCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | DependencyTimeoutError
    | DisabledError
    | DryRunOperationError
    | InvalidGrantTokenError
    | InvalidKeyUsageError
    | KeyUnavailableError
    | KMSInternalError
    | KMSInvalidStateError
    | NotFoundError
  >

  /**
   * @see {@link TagResourceCommand}
   */
  tagResource(
    args: TagResourceCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    TagResourceCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | InvalidArnError
    | KMSInternalError
    | KMSInvalidStateError
    | LimitExceededError
    | NotFoundError
    | TagError
  >

  /**
   * @see {@link UntagResourceCommand}
   */
  untagResource(
    args: UntagResourceCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    UntagResourceCommandOutput,
    Cause.TimeoutError | SdkError | InvalidArnError | KMSInternalError | KMSInvalidStateError | NotFoundError | TagError
  >

  /**
   * @see {@link UpdateAliasCommand}
   */
  updateAlias(
    args: UpdateAliasCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    UpdateAliasCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | DependencyTimeoutError
    | KMSInternalError
    | KMSInvalidStateError
    | LimitExceededError
    | NotFoundError
  >

  /**
   * @see {@link UpdateCustomKeyStoreCommand}
   */
  updateCustomKeyStore(
    args: UpdateCustomKeyStoreCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    UpdateCustomKeyStoreCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | CloudHsmClusterInvalidConfigurationError
    | CloudHsmClusterNotActiveError
    | CloudHsmClusterNotFoundError
    | CloudHsmClusterNotRelatedError
    | CustomKeyStoreInvalidStateError
    | CustomKeyStoreNameInUseError
    | CustomKeyStoreNotFoundError
    | KMSInternalError
    | XksProxyIncorrectAuthenticationCredentialError
    | XksProxyInvalidConfigurationError
    | XksProxyInvalidResponseError
    | XksProxyUriEndpointInUseError
    | XksProxyUriInUseError
    | XksProxyUriUnreachableError
    | XksProxyVpcEndpointServiceInUseError
    | XksProxyVpcEndpointServiceInvalidConfigurationError
    | XksProxyVpcEndpointServiceNotFoundError
  >

  /**
   * @see {@link UpdateKeyDescriptionCommand}
   */
  updateKeyDescription(
    args: UpdateKeyDescriptionCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    UpdateKeyDescriptionCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | DependencyTimeoutError
    | InvalidArnError
    | KMSInternalError
    | KMSInvalidStateError
    | NotFoundError
  >

  /**
   * @see {@link UpdatePrimaryRegionCommand}
   */
  updatePrimaryRegion(
    args: UpdatePrimaryRegionCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    UpdatePrimaryRegionCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | DisabledError
    | InvalidArnError
    | KMSInternalError
    | KMSInvalidStateError
    | NotFoundError
    | UnsupportedOperationError
  >

  /**
   * @see {@link VerifyCommand}
   */
  verify(
    args: VerifyCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    VerifyCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | DependencyTimeoutError
    | DisabledError
    | DryRunOperationError
    | InvalidGrantTokenError
    | InvalidKeyUsageError
    | KeyUnavailableError
    | KMSInternalError
    | KMSInvalidSignatureError
    | KMSInvalidStateError
    | NotFoundError
  >

  /**
   * @see {@link VerifyMacCommand}
   */
  verifyMac(
    args: VerifyMacCommandInput,
    options?: HttpHandlerOptions
  ): Effect.Effect<
    VerifyMacCommandOutput,
    | Cause.TimeoutError
    | SdkError
    | DisabledError
    | DryRunOperationError
    | InvalidGrantTokenError
    | InvalidKeyUsageError
    | KeyUnavailableError
    | KMSInternalError
    | KMSInvalidMacError
    | KMSInvalidStateError
    | NotFoundError
  >
}

Added in v1.0.0

utils

KMSService (namespace)

Added in v1.0.0

Config (interface)

Signature

export interface Config extends Omit<KMSClientConfig, "logger"> {
  readonly logger?: ServiceLogger.ServiceLoggerConstructorProps | true
}

Added in v1.0.0

Type (type alias)

Signature

export type Type = KMSService$

Added in v1.0.0