@aws-sdk/client-sfn 3.616.0 → 3.620.0

package/dist-types/models/models_0.d.ts

@@ -1,5 +1,17 @@
 import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
 import { SFNServiceException as __BaseException } from "./SFNServiceException";
+/**
+ * <p>Activity already exists. <code>EncryptionConfiguration</code> may not be updated.</p>
+ * @public
+ */
+export declare class ActivityAlreadyExists extends __BaseException {
+    readonly name: "ActivityAlreadyExists";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<ActivityAlreadyExists, __BaseException>);
+}
 /**
  * <p>The specified activity does not exist.</p>
  * @public
@@ -202,6 +214,47 @@ export declare class ActivityWorkerLimitExceeded extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<ActivityWorkerLimitExceeded, __BaseException>);
 }
+/**
+ * @public
+ * @enum
+ */
+export declare const EncryptionType: {
+    readonly AWS_OWNED_KEY: "AWS_OWNED_KEY";
+    readonly CUSTOMER_MANAGED_KMS_KEY: "CUSTOMER_MANAGED_KMS_KEY";
+};
+/**
+ * @public
+ */
+export type EncryptionType = (typeof EncryptionType)[keyof typeof EncryptionType];
+/**
+ * <p>Settings to configure server-side encryption. </p>
+ *          <p>
+ *         For additional control over security, you can encrypt your data using a <b>customer-managed key</b> for  Step Functions state machines and activities. You can configure a symmetric KMS key and data key reuse period when creating or updating a <b>State Machine</b>, and when creating an <b>Activity</b>. The execution history and state machine definition will be encrypted with the key applied to the State Machine. Activity inputs will be encrypted with the key applied to the Activity.
+ *     </p>
+ *          <note>
+ *             <p> Step Functions automatically enables encryption at rest using  Amazon Web Services owned keys at no charge. However, KMS charges apply when using a customer managed key. For more information about pricing, see <a href="https://aws.amazon.com/kms/pricing/">Key Management Service pricing</a>.</p>
+ *          </note>
+ *          <p>For more information on KMS, see <a href="https://docs.aws.amazon.com/kms/latest/developerguide/overview.html">What is  Key Management Service?</a>
+ *          </p>
+ * @public
+ */
+export interface EncryptionConfiguration {
+    /**
+     * <p>An alias, alias ARN, key ID, or key ARN of a symmetric encryption KMS key to encrypt data. To specify a KMS key in a different Amazon Web Services  account, you must use the key ARN or alias ARN.</p>
+     * @public
+     */
+    kmsKeyId?: string;
+    /**
+     * <p>Maximum duration that Step Functions will reuse data keys. When the period expires, Step Functions will call <code>GenerateDataKey</code>. Only applies to customer managed keys.</p>
+     * @public
+     */
+    kmsDataKeyReusePeriodSeconds?: number;
+    /**
+     * <p>Encryption type</p>
+     * @public
+     */
+    type: EncryptionType | undefined;
+}
 /**
  * <p>Tags are key-value pairs that can be associated with Step Functions state machines and
  *       activities.</p>
@@ -267,6 +320,11 @@ export interface CreateActivityInput {
      * @public
      */
     tags?: Tag[];
+    /**
+     * <p>Settings to configure server-side encryption.</p>
+     * @public
+     */
+    encryptionConfiguration?: EncryptionConfiguration;
 }
 /**
  * @public
@@ -283,6 +341,18 @@ export interface CreateActivityOutput {
      */
     creationDate: Date | undefined;
 }
+/**
+ * <p>Received when <code>encryptionConfiguration</code> is specified but various conditions exist which make the configuration invalid. For example, if <code>type</code> is set to <code>CUSTOMER_MANAGED_KMS_KEY</code>, but <code>kmsKeyId</code> is null, or <code>kmsDataKeyReusePeriodSeconds</code> is not between 60 and 900, or the KMS key is not symmetric or inactive.</p>
+ * @public
+ */
+export declare class InvalidEncryptionConfiguration extends __BaseException {
+    readonly name: "InvalidEncryptionConfiguration";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<InvalidEncryptionConfiguration, __BaseException>);
+}
 /**
  * <p>The provided name is not valid.</p>
  * @public
@@ -295,6 +365,30 @@ export declare class InvalidName extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<InvalidName, __BaseException>);
 }
+/**
+ * <p>Either your KMS key policy or API caller does not have the required permissions.</p>
+ * @public
+ */
+export declare class KmsAccessDeniedException extends __BaseException {
+    readonly name: "KmsAccessDeniedException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<KmsAccessDeniedException, __BaseException>);
+}
+/**
+ * <p>Received when KMS returns <code>ThrottlingException</code> for a KMS call that Step Functions makes on behalf of the caller.</p>
+ * @public
+ */
+export declare class KmsThrottlingException extends __BaseException {
+    readonly name: "KmsThrottlingException";
+    readonly $fault: "client";
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<KmsThrottlingException, __BaseException>);
+}
 /**
  * <p>You've exceeded the number of tags allowed for a resource. See the <a href="https://docs.aws.amazon.com/step-functions/latest/dg/limits.html"> Limits Topic</a> in the
  *       Step Functions Developer Guide.</p>
@@ -492,6 +586,11 @@ export interface CreateStateMachineInput {
      * @public
      */
     versionDescription?: string;
+    /**
+     * <p>Settings to configure server-side encryption.</p>
+     * @public
+     */
+    encryptionConfiguration?: EncryptionConfiguration;
 }
 /**
  * @public
@@ -538,7 +637,7 @@ export declare class InvalidDefinition extends __BaseException {
     constructor(opts: __ExceptionOptionType<InvalidDefinition, __BaseException>);
 }
 /**
- * <p></p>
+ * <p>Configuration is not valid.</p>
  * @public
  */
 export declare class InvalidLoggingConfiguration extends __BaseException {
@@ -601,7 +700,7 @@ export declare class StateMachineLimitExceeded extends __BaseException {
     constructor(opts: __ExceptionOptionType<StateMachineLimitExceeded, __BaseException>);
 }
 /**
- * <p></p>
+ * <p>State machine type is not supported.</p>
  * @public
  */
 export declare class StateMachineTypeNotSupported extends __BaseException {
@@ -657,9 +756,8 @@ export interface RoutingConfigurationListItem {
      */
     stateMachineVersionArn: string | undefined;
     /**
-     * <p>The percentage of traffic you want to route to a state machine
-     *       version. The sum of the weights in the routing
-     *       configuration must be equal to 100.</p>
+     * <p>The percentage of traffic you want to route to a state machine version. The sum of the
+     *       weights in the routing configuration must be equal to 100.</p>
      * @public
      */
     weight: number | undefined;
@@ -841,7 +939,24 @@ export interface DescribeActivityOutput {
      * @public
      */
     creationDate: Date | undefined;
+    /**
+     * <p>Settings for configured server-side encryption.</p>
+     * @public
+     */
+    encryptionConfiguration?: EncryptionConfiguration;
 }
+/**
+ * @public
+ * @enum
+ */
+export declare const IncludedData: {
+    readonly ALL_DATA: "ALL_DATA";
+    readonly METADATA_ONLY: "METADATA_ONLY";
+};
+/**
+ * @public
+ */
+export type IncludedData = (typeof IncludedData)[keyof typeof IncludedData];
 /**
  * @public
  */
@@ -851,6 +966,11 @@ export interface DescribeExecutionInput {
      * @public
      */
     executionArn: string | undefined;
+    /**
+     * <p>If your state machine definition is encrypted with a KMS key, callers must have <code>kms:Decrypt</code> permission to decrypt the definition. Alternatively, you can call DescribeStateMachine API with <code>includedData = METADATA_ONLY</code> to get a successful response without the encrypted definition.</p>
+     * @public
+     */
+    includedData?: IncludedData;
 }
 /**
  * <p>Provides details about execution input or output.</p>
@@ -1091,6 +1211,38 @@ export declare class ExecutionDoesNotExist extends __BaseException {
      */
     constructor(opts: __ExceptionOptionType<ExecutionDoesNotExist, __BaseException>);
 }
+/**
+ * @public
+ * @enum
+ */
+export declare const KmsKeyState: {
+    readonly CREATING: "CREATING";
+    readonly DISABLED: "DISABLED";
+    readonly PENDING_DELETION: "PENDING_DELETION";
+    readonly PENDING_IMPORT: "PENDING_IMPORT";
+    readonly UNAVAILABLE: "UNAVAILABLE";
+};
+/**
+ * @public
+ */
+export type KmsKeyState = (typeof KmsKeyState)[keyof typeof KmsKeyState];
+/**
+ * <p>The KMS key is not in valid state, for example: Disabled or Deleted.</p>
+ * @public
+ */
+export declare class KmsInvalidStateException extends __BaseException {
+    readonly name: "KmsInvalidStateException";
+    readonly $fault: "client";
+    /**
+     * <p>Current status of the KMS; key. For example: <code>DISABLED</code>, <code>PENDING_DELETION</code>, <code>PENDING_IMPORT</code>, <code>UNAVAILABLE</code>, <code>CREATING</code>.</p>
+     * @public
+     */
+    kmsKeyState?: KmsKeyState;
+    /**
+     * @internal
+     */
+    constructor(opts: __ExceptionOptionType<KmsInvalidStateException, __BaseException>);
+}
 /**
  * @public
  */
@@ -1302,6 +1454,16 @@ export interface DescribeStateMachineInput {
      * @public
      */
     stateMachineArn: string | undefined;
+    /**
+     * <p>If your state machine definition is encrypted with a KMS key, callers must have <code>kms:Decrypt</code> permission to decrypt the definition. Alternatively, you can call the API with <code>includedData = METADATA_ONLY</code> to get a successful response without the encrypted definition.</p>
+     *          <note>
+     *             <p>
+     *             When calling a labelled ARN for an encrypted state machine, the <code>includedData = METADATA_ONLY</code> parameter will not apply because Step Functions needs to decrypt the entire state machine definition to get the Distributed Map state’s definition. In this case, the API caller needs to have <code>kms:Decrypt</code> permission.
+     *         </p>
+     *          </note>
+     * @public
+     */
+    includedData?: IncludedData;
 }
 /**
  * @public
@@ -1359,6 +1521,7 @@ export interface DescribeStateMachineOutput {
     status?: StateMachineStatus;
     /**
      * <p>The Amazon States Language definition of the state machine. See <a href="https://docs.aws.amazon.com/step-functions/latest/dg/concepts-amazon-states-language.html">Amazon States Language</a>.</p>
+     *          <p>If called with <code>includedData = METADATA_ONLY</code>, the returned definition will be <code>\{\}</code>.</p>
      * @public
      */
     definition: string | undefined;
@@ -1409,6 +1572,11 @@ export interface DescribeStateMachineOutput {
      * @public
      */
     description?: string;
+    /**
+     * <p>Settings to configure server-side encryption. </p>
+     * @public
+     */
+    encryptionConfiguration?: EncryptionConfiguration;
 }
 /**
  * <p>The specified state machine does not exist.</p>
@@ -1477,6 +1645,11 @@ export interface DescribeStateMachineForExecutionInput {
      * @public
      */
     executionArn: string | undefined;
+    /**
+     * <p>If your state machine definition is encrypted with a KMS key, callers must have <code>kms:Decrypt</code> permission to decrypt the definition. Alternatively, you can call the API with <code>includedData = METADATA_ONLY</code> to get a successful response without the encrypted definition.</p>
+     * @public
+     */
+    includedData?: IncludedData;
 }
 /**
  * @public
@@ -1535,6 +1708,11 @@ export interface DescribeStateMachineForExecutionOutput {
      * @public
      */
     revisionId?: string;
+    /**
+     * <p>Settings to configure server-side encryption. </p>
+     * @public
+     */
+    encryptionConfiguration?: EncryptionConfiguration;
 }
 /**
  * @public
@@ -3233,8 +3411,7 @@ export interface StartExecutionInput {
      */
     stateMachineArn: string | undefined;
     /**
-     * <p>Optional name of the execution.
-     *       This name must be unique for your Amazon Web Services account, Region, and state machine for 90 days. For more information,
+     * <p>Optional name of the execution. This name must be unique for your Amazon Web Services account, Region, and state machine for 90 days. For more information,
      *     see <a href="https://docs.aws.amazon.com/step-functions/latest/dg/limits.html#service-limits-state-machine-executions">
      *     Limits Related to State Machine Executions</a> in the <i>Step Functions Developer Guide</i>.</p>
      *          <p>If you don't provide a name for the execution, Step Functions automatically generates a universally unique identifier (UUID) as the execution name.</p>
@@ -3333,6 +3510,11 @@ export interface StartSyncExecutionInput {
      * @public
      */
     traceHeader?: string;
+    /**
+     * <p>If your state machine definition is encrypted with a KMS key, callers must have <code>kms:Decrypt</code> permission to decrypt the definition. Alternatively, you can call the API with <code>includedData = METADATA_ONLY</code> to get a successful response without the encrypted definition.</p>
+     * @public
+     */
+    includedData?: IncludedData;
 }
 /**
  * <p>An object that describes workflow billing details.</p>
@@ -3817,6 +3999,11 @@ export interface UpdateStateMachineInput {
      * @public
      */
     versionDescription?: string;
+    /**
+     * <p>Settings to configure server-side encryption. </p>
+     * @public
+     */
+    encryptionConfiguration?: EncryptionConfiguration;
 }
 /**
  * @public

package/dist-types/ts3.4/models/models_0.d.ts

@@ -1,5 +1,12 @@
 import { ExceptionOptionType as __ExceptionOptionType } from "@smithy/smithy-client";
 import { SFNServiceException as __BaseException } from "./SFNServiceException";
+export declare class ActivityAlreadyExists extends __BaseException {
+  readonly name: "ActivityAlreadyExists";
+  readonly $fault: "client";
+  constructor(
+    opts: __ExceptionOptionType<ActivityAlreadyExists, __BaseException>
+  );
+}
 export declare class ActivityDoesNotExist extends __BaseException {
   readonly name: "ActivityDoesNotExist";
   readonly $fault: "client";
@@ -55,6 +62,17 @@ export declare class ActivityWorkerLimitExceeded extends __BaseException {
     opts: __ExceptionOptionType<ActivityWorkerLimitExceeded, __BaseException>
   );
 }
+export declare const EncryptionType: {
+  readonly AWS_OWNED_KEY: "AWS_OWNED_KEY";
+  readonly CUSTOMER_MANAGED_KMS_KEY: "CUSTOMER_MANAGED_KMS_KEY";
+};
+export type EncryptionType =
+  (typeof EncryptionType)[keyof typeof EncryptionType];
+export interface EncryptionConfiguration {
+  kmsKeyId?: string;
+  kmsDataKeyReusePeriodSeconds?: number;
+  type: EncryptionType | undefined;
+}
 export interface Tag {
   key?: string;
   value?: string;
@@ -62,16 +80,38 @@ export interface Tag {
 export interface CreateActivityInput {
   name: string | undefined;
   tags?: Tag[];
+  encryptionConfiguration?: EncryptionConfiguration;
 }
 export interface CreateActivityOutput {
   activityArn: string | undefined;
   creationDate: Date | undefined;
 }
+export declare class InvalidEncryptionConfiguration extends __BaseException {
+  readonly name: "InvalidEncryptionConfiguration";
+  readonly $fault: "client";
+  constructor(
+    opts: __ExceptionOptionType<InvalidEncryptionConfiguration, __BaseException>
+  );
+}
 export declare class InvalidName extends __BaseException {
   readonly name: "InvalidName";
   readonly $fault: "client";
   constructor(opts: __ExceptionOptionType<InvalidName, __BaseException>);
 }
+export declare class KmsAccessDeniedException extends __BaseException {
+  readonly name: "KmsAccessDeniedException";
+  readonly $fault: "client";
+  constructor(
+    opts: __ExceptionOptionType<KmsAccessDeniedException, __BaseException>
+  );
+}
+export declare class KmsThrottlingException extends __BaseException {
+  readonly name: "KmsThrottlingException";
+  readonly $fault: "client";
+  constructor(
+    opts: __ExceptionOptionType<KmsThrottlingException, __BaseException>
+  );
+}
 export declare class TooManyTags extends __BaseException {
   readonly name: "TooManyTags";
   readonly $fault: "client";
@@ -120,6 +160,7 @@ export interface CreateStateMachineInput {
   tracingConfiguration?: TracingConfiguration;
   publish?: boolean;
   versionDescription?: string;
+  encryptionConfiguration?: EncryptionConfiguration;
 }
 export interface CreateStateMachineOutput {
   stateMachineArn: string | undefined;
@@ -243,9 +284,16 @@ export interface DescribeActivityOutput {
   activityArn: string | undefined;
   name: string | undefined;
   creationDate: Date | undefined;
+  encryptionConfiguration?: EncryptionConfiguration;
 }
+export declare const IncludedData: {
+  readonly ALL_DATA: "ALL_DATA";
+  readonly METADATA_ONLY: "METADATA_ONLY";
+};
+export type IncludedData = (typeof IncludedData)[keyof typeof IncludedData];
 export interface DescribeExecutionInput {
   executionArn: string | undefined;
+  includedData?: IncludedData;
 }
 export interface CloudWatchEventsExecutionDataDetails {
   included?: boolean;
@@ -296,6 +344,22 @@ export declare class ExecutionDoesNotExist extends __BaseException {
     opts: __ExceptionOptionType<ExecutionDoesNotExist, __BaseException>
   );
 }
+export declare const KmsKeyState: {
+  readonly CREATING: "CREATING";
+  readonly DISABLED: "DISABLED";
+  readonly PENDING_DELETION: "PENDING_DELETION";
+  readonly PENDING_IMPORT: "PENDING_IMPORT";
+  readonly UNAVAILABLE: "UNAVAILABLE";
+};
+export type KmsKeyState = (typeof KmsKeyState)[keyof typeof KmsKeyState];
+export declare class KmsInvalidStateException extends __BaseException {
+  readonly name: "KmsInvalidStateException";
+  readonly $fault: "client";
+  kmsKeyState?: KmsKeyState;
+  constructor(
+    opts: __ExceptionOptionType<KmsInvalidStateException, __BaseException>
+  );
+}
 export interface DescribeMapRunInput {
   mapRunArn: string | undefined;
 }
@@ -346,6 +410,7 @@ export interface DescribeMapRunOutput {
 }
 export interface DescribeStateMachineInput {
   stateMachineArn: string | undefined;
+  includedData?: IncludedData;
 }
 export declare const StateMachineStatus: {
   readonly ACTIVE: "ACTIVE";
@@ -366,6 +431,7 @@ export interface DescribeStateMachineOutput {
   label?: string;
   revisionId?: string;
   description?: string;
+  encryptionConfiguration?: EncryptionConfiguration;
 }
 export declare class StateMachineDoesNotExist extends __BaseException {
   readonly name: "StateMachineDoesNotExist";
@@ -387,6 +453,7 @@ export interface DescribeStateMachineAliasOutput {
 }
 export interface DescribeStateMachineForExecutionInput {
   executionArn: string | undefined;
+  includedData?: IncludedData;
 }
 export interface DescribeStateMachineForExecutionOutput {
   stateMachineArn: string | undefined;
@@ -399,6 +466,7 @@ export interface DescribeStateMachineForExecutionOutput {
   mapRunArn?: string;
   label?: string;
   revisionId?: string;
+  encryptionConfiguration?: EncryptionConfiguration;
 }
 export interface GetActivityTaskInput {
   activityArn: string | undefined;
@@ -855,6 +923,7 @@ export interface StartSyncExecutionInput {
   name?: string;
   input?: string;
   traceHeader?: string;
+  includedData?: IncludedData;
 }
 export interface BillingDetails {
   billedMemoryUsedInMB?: number;
@@ -977,6 +1046,7 @@ export interface UpdateStateMachineInput {
   tracingConfiguration?: TracingConfiguration;
   publish?: boolean;
   versionDescription?: string;
+  encryptionConfiguration?: EncryptionConfiguration;
 }
 export interface UpdateStateMachineOutput {
   updateDate: Date | undefined;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@aws-sdk/client-sfn",
   "description": "AWS SDK for JavaScript Sfn Client for Node.js, Browser and React Native",
-  "version": "3.616.0",
+  "version": "3.620.0",
   "scripts": {
     "build": "concurrently 'yarn:build:cjs' 'yarn:build:es' 'yarn:build:types'",
     "build:cjs": "node ../../scripts/compilation/inline client-sfn",
@@ -20,40 +20,40 @@
   "dependencies": {
     "@aws-crypto/sha256-browser": "5.2.0",
     "@aws-crypto/sha256-js": "5.2.0",
-    "@aws-sdk/client-sso-oidc": "3.616.0",
-    "@aws-sdk/client-sts": "3.616.0",
-    "@aws-sdk/core": "3.616.0",
-    "@aws-sdk/credential-provider-node": "3.616.0",
-    "@aws-sdk/middleware-host-header": "3.616.0",
+    "@aws-sdk/client-sso-oidc": "3.620.0",
+    "@aws-sdk/client-sts": "3.620.0",
+    "@aws-sdk/core": "3.620.0",
+    "@aws-sdk/credential-provider-node": "3.620.0",
+    "@aws-sdk/middleware-host-header": "3.620.0",
     "@aws-sdk/middleware-logger": "3.609.0",
-    "@aws-sdk/middleware-recursion-detection": "3.616.0",
-    "@aws-sdk/middleware-user-agent": "3.616.0",
+    "@aws-sdk/middleware-recursion-detection": "3.620.0",
+    "@aws-sdk/middleware-user-agent": "3.620.0",
     "@aws-sdk/region-config-resolver": "3.614.0",
     "@aws-sdk/types": "3.609.0",
     "@aws-sdk/util-endpoints": "3.614.0",
     "@aws-sdk/util-user-agent-browser": "3.609.0",
     "@aws-sdk/util-user-agent-node": "3.614.0",
     "@smithy/config-resolver": "^3.0.5",
-    "@smithy/core": "^2.2.7",
-    "@smithy/fetch-http-handler": "^3.2.2",
+    "@smithy/core": "^2.3.0",
+    "@smithy/fetch-http-handler": "^3.2.3",
     "@smithy/hash-node": "^3.0.3",
     "@smithy/invalid-dependency": "^3.0.3",
-    "@smithy/middleware-content-length": "^3.0.4",
-    "@smithy/middleware-endpoint": "^3.0.5",
-    "@smithy/middleware-retry": "^3.0.10",
+    "@smithy/middleware-content-length": "^3.0.5",
+    "@smithy/middleware-endpoint": "^3.1.0",
+    "@smithy/middleware-retry": "^3.0.12",
     "@smithy/middleware-serde": "^3.0.3",
     "@smithy/middleware-stack": "^3.0.3",
     "@smithy/node-config-provider": "^3.1.4",
-    "@smithy/node-http-handler": "^3.1.3",
-    "@smithy/protocol-http": "^4.0.4",
-    "@smithy/smithy-client": "^3.1.8",
+    "@smithy/node-http-handler": "^3.1.4",
+    "@smithy/protocol-http": "^4.1.0",
+    "@smithy/smithy-client": "^3.1.10",
     "@smithy/types": "^3.3.0",
     "@smithy/url-parser": "^3.0.3",
     "@smithy/util-base64": "^3.0.0",
     "@smithy/util-body-length-browser": "^3.0.0",
     "@smithy/util-body-length-node": "^3.0.0",
-    "@smithy/util-defaults-mode-browser": "^3.0.10",
-    "@smithy/util-defaults-mode-node": "^3.0.10",
+    "@smithy/util-defaults-mode-browser": "^3.0.12",
+    "@smithy/util-defaults-mode-node": "^3.0.12",
     "@smithy/util-endpoints": "^2.0.5",
     "@smithy/util-middleware": "^3.0.3",
     "@smithy/util-retry": "^3.0.3",