@aws-sdk/client-sfn 3.616.0 → 3.620.0

package/dist-types/commands/CreateStateMachineCommand.d.ts

@@ -35,6 +35,9 @@ declare const CreateStateMachineCommand_base: {
  *         Language</a> in the Step Functions User Guide.</p>
  *          <p>If you set the <code>publish</code> parameter of this API action to <code>true</code>, it
  *       publishes version <code>1</code> as the first revision of the state machine.</p>
+ *          <p>
+ *         For additional control over security, you can encrypt your data using a <b>customer-managed key</b> for Step Functions state machines. You can configure a symmetric KMS key and data key reuse period when creating or updating a <b>State Machine</b>. The execution history and state machine definition will be encrypted with the key applied to the State Machine.
+ *     </p>
  *          <note>
  *             <p>This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.</p>
  *          </note>
@@ -43,8 +46,8 @@ declare const CreateStateMachineCommand_base: {
  *                <code>CreateStateMachine</code> is an idempotent API. Subsequent requests won’t create a
  *         duplicate resource if it was already created. <code>CreateStateMachine</code>'s idempotency
  *         check is based on the state machine <code>name</code>, <code>definition</code>,
- *           <code>type</code>, <code>LoggingConfiguration</code>, and
- *         <code>TracingConfiguration</code>. The check is also based on the <code>publish</code> and <code>versionDescription</code> parameters. If a following request has a different
+ *           <code>type</code>, <code>LoggingConfiguration</code>,
+ *         <code>TracingConfiguration</code>, and <code>EncryptionConfiguration</code> The check is also based on the <code>publish</code> and <code>versionDescription</code> parameters. If a following request has a different
  *           <code>roleArn</code> or <code>tags</code>, Step Functions will ignore these differences and treat
  *         it as an idempotent request of the previous. In this case, <code>roleArn</code> and
  *           <code>tags</code> will not be updated, even if they are different.</p>
@@ -82,6 +85,11 @@ declare const CreateStateMachineCommand_base: {
  *   },
  *   publish: true || false,
  *   versionDescription: "STRING_VALUE",
+ *   encryptionConfiguration: { // EncryptionConfiguration
+ *     kmsKeyId: "STRING_VALUE",
+ *     kmsDataKeyReusePeriodSeconds: Number("int"),
+ *     type: "AWS_OWNED_KEY" || "CUSTOMER_MANAGED_KMS_KEY", // required
+ *   },
  * };
  * const command = new CreateStateMachineCommand(input);
  * const response = await client.send(command);
@@ -109,8 +117,11 @@ declare const CreateStateMachineCommand_base: {
  * @throws {@link InvalidDefinition} (client fault)
  *  <p>The provided Amazon States Language definition is not valid.</p>
  *
+ * @throws {@link InvalidEncryptionConfiguration} (client fault)
+ *  <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>
+ *
  * @throws {@link InvalidLoggingConfiguration} (client fault)
- *  <p></p>
+ *  <p>Configuration is not valid.</p>
  *
  * @throws {@link InvalidName} (client fault)
  *  <p>The provided name is not valid.</p>
@@ -119,6 +130,12 @@ declare const CreateStateMachineCommand_base: {
  *  <p>Your <code>tracingConfiguration</code> key does not match, or <code>enabled</code> has not
  *       been set to <code>true</code> or <code>false</code>.</p>
  *
+ * @throws {@link KmsAccessDeniedException} (client fault)
+ *  <p>Either your KMS key policy or API caller does not have the required permissions.</p>
+ *
+ * @throws {@link KmsThrottlingException} (client fault)
+ *  <p>Received when KMS returns <code>ThrottlingException</code> for a KMS call that Step Functions makes on behalf of the caller.</p>
+ *
  * @throws {@link StateMachineAlreadyExists} (client fault)
  *  <p>A state machine with the same name but a different definition or role ARN already
  *       exists.</p>
@@ -131,7 +148,7 @@ declare const CreateStateMachineCommand_base: {
  *       deleted before a new state machine can be created.</p>
  *
  * @throws {@link StateMachineTypeNotSupported} (client fault)
- *  <p></p>
+ *  <p>State machine type is not supported.</p>
  *
  * @throws {@link TooManyTags} (client fault)
  *  <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

package/dist-types/commands/DeleteStateMachineVersionCommand.d.ts

@@ -29,9 +29,7 @@ declare const DeleteStateMachineVersionCommand_base: {
 /**
  * <p>Deletes a state machine <a href="https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-version.html">version</a>. After
  *       you delete a version, you can't call <a>StartExecution</a> using that version's ARN
- *       or use
- *       the
- *       version with a state machine <a href="https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-alias.html">alias</a>.</p>
+ *       or use the version with a state machine <a href="https://docs.aws.amazon.com/step-functions/latest/dg/concepts-state-machine-alias.html">alias</a>.</p>
  *          <note>
  *             <p>Deleting a state machine version won't terminate its in-progress executions.</p>
  *          </note>

package/dist-types/commands/DescribeActivityCommand.d.ts

@@ -46,6 +46,11 @@ declare const DescribeActivityCommand_base: {
  * //   activityArn: "STRING_VALUE", // required
  * //   name: "STRING_VALUE", // required
  * //   creationDate: new Date("TIMESTAMP"), // required
+ * //   encryptionConfiguration: { // EncryptionConfiguration
+ * //     kmsKeyId: "STRING_VALUE",
+ * //     kmsDataKeyReusePeriodSeconds: Number("int"),
+ * //     type: "AWS_OWNED_KEY" || "CUSTOMER_MANAGED_KMS_KEY", // required
+ * //   },
  * // };
  *
  * ```

package/dist-types/commands/DescribeExecutionCommand.d.ts

@@ -42,6 +42,7 @@ declare const DescribeExecutionCommand_base: {
  * const client = new SFNClient(config);
  * const input = { // DescribeExecutionInput
  *   executionArn: "STRING_VALUE", // required
+ *   includedData: "ALL_DATA" || "METADATA_ONLY",
  * };
  * const command = new DescribeExecutionCommand(input);
  * const response = await client.send(command);
@@ -86,6 +87,15 @@ declare const DescribeExecutionCommand_base: {
  * @throws {@link InvalidArn} (client fault)
  *  <p>The provided Amazon Resource Name (ARN) is not valid.</p>
  *
+ * @throws {@link KmsAccessDeniedException} (client fault)
+ *  <p>Either your KMS key policy or API caller does not have the required permissions.</p>
+ *
+ * @throws {@link KmsInvalidStateException} (client fault)
+ *  <p>The KMS key is not in valid state, for example: Disabled or Deleted.</p>
+ *
+ * @throws {@link KmsThrottlingException} (client fault)
+ *  <p>Received when KMS returns <code>ThrottlingException</code> for a KMS call that Step Functions makes on behalf of the caller.</p>
+ *
  * @throws {@link SFNServiceException}
  * <p>Base exception class for all service exceptions from SFN service.</p>
  *

package/dist-types/commands/DescribeStateMachineCommand.d.ts

@@ -69,6 +69,7 @@ declare const DescribeStateMachineCommand_base: {
  * const client = new SFNClient(config);
  * const input = { // DescribeStateMachineInput
  *   stateMachineArn: "STRING_VALUE", // required
+ *   includedData: "ALL_DATA" || "METADATA_ONLY",
  * };
  * const command = new DescribeStateMachineCommand(input);
  * const response = await client.send(command);
@@ -97,6 +98,11 @@ declare const DescribeStateMachineCommand_base: {
  * //   label: "STRING_VALUE",
  * //   revisionId: "STRING_VALUE",
  * //   description: "STRING_VALUE",
+ * //   encryptionConfiguration: { // EncryptionConfiguration
+ * //     kmsKeyId: "STRING_VALUE",
+ * //     kmsDataKeyReusePeriodSeconds: Number("int"),
+ * //     type: "AWS_OWNED_KEY" || "CUSTOMER_MANAGED_KMS_KEY", // required
+ * //   },
  * // };
  *
  * ```
@@ -110,6 +116,15 @@ declare const DescribeStateMachineCommand_base: {
  * @throws {@link InvalidArn} (client fault)
  *  <p>The provided Amazon Resource Name (ARN) is not valid.</p>
  *
+ * @throws {@link KmsAccessDeniedException} (client fault)
+ *  <p>Either your KMS key policy or API caller does not have the required permissions.</p>
+ *
+ * @throws {@link KmsInvalidStateException} (client fault)
+ *  <p>The KMS key is not in valid state, for example: Disabled or Deleted.</p>
+ *
+ * @throws {@link KmsThrottlingException} (client fault)
+ *  <p>Received when KMS returns <code>ThrottlingException</code> for a KMS call that Step Functions makes on behalf of the caller.</p>
+ *
  * @throws {@link StateMachineDoesNotExist} (client fault)
  *  <p>The specified state machine does not exist.</p>
  *

package/dist-types/commands/DescribeStateMachineForExecutionCommand.d.ts

@@ -29,9 +29,7 @@ declare const DescribeStateMachineForExecutionCommand_base: {
 /**
  * <p>Provides information about a state machine's definition, its execution role ARN, and
  *       configuration. If a Map Run dispatched the execution, this action returns the Map Run
- *       Amazon Resource Name (ARN) in the response.
- *       The
- *       state machine returned is the state machine associated with the
+ *       Amazon Resource Name (ARN) in the response. The state machine returned is the state machine associated with the
  *       Map Run.</p>
  *          <note>
  *             <p>This operation is eventually consistent. The results are best effort and may not reflect very recent updates and changes.</p>
@@ -45,6 +43,7 @@ declare const DescribeStateMachineForExecutionCommand_base: {
  * const client = new SFNClient(config);
  * const input = { // DescribeStateMachineForExecutionInput
  *   executionArn: "STRING_VALUE", // required
+ *   includedData: "ALL_DATA" || "METADATA_ONLY",
  * };
  * const command = new DescribeStateMachineForExecutionCommand(input);
  * const response = await client.send(command);
@@ -71,6 +70,11 @@ declare const DescribeStateMachineForExecutionCommand_base: {
  * //   mapRunArn: "STRING_VALUE",
  * //   label: "STRING_VALUE",
  * //   revisionId: "STRING_VALUE",
+ * //   encryptionConfiguration: { // EncryptionConfiguration
+ * //     kmsKeyId: "STRING_VALUE",
+ * //     kmsDataKeyReusePeriodSeconds: Number("int"),
+ * //     type: "AWS_OWNED_KEY" || "CUSTOMER_MANAGED_KMS_KEY", // required
+ * //   },
  * // };
  *
  * ```
@@ -87,6 +91,15 @@ declare const DescribeStateMachineForExecutionCommand_base: {
  * @throws {@link InvalidArn} (client fault)
  *  <p>The provided Amazon Resource Name (ARN) is not valid.</p>
  *
+ * @throws {@link KmsAccessDeniedException} (client fault)
+ *  <p>Either your KMS key policy or API caller does not have the required permissions.</p>
+ *
+ * @throws {@link KmsInvalidStateException} (client fault)
+ *  <p>The KMS key is not in valid state, for example: Disabled or Deleted.</p>
+ *
+ * @throws {@link KmsThrottlingException} (client fault)
+ *  <p>Received when KMS returns <code>ThrottlingException</code> for a KMS call that Step Functions makes on behalf of the caller.</p>
+ *
  * @throws {@link SFNServiceException}
  * <p>Base exception class for all service exceptions from SFN service.</p>
  *

package/dist-types/commands/GetActivityTaskCommand.d.ts

@@ -78,6 +78,15 @@ declare const GetActivityTaskCommand_base: {
  * @throws {@link InvalidArn} (client fault)
  *  <p>The provided Amazon Resource Name (ARN) is not valid.</p>
  *
+ * @throws {@link KmsAccessDeniedException} (client fault)
+ *  <p>Either your KMS key policy or API caller does not have the required permissions.</p>
+ *
+ * @throws {@link KmsInvalidStateException} (client fault)
+ *  <p>The KMS key is not in valid state, for example: Disabled or Deleted.</p>
+ *
+ * @throws {@link KmsThrottlingException} (client fault)
+ *  <p>Received when KMS returns <code>ThrottlingException</code> for a KMS call that Step Functions makes on behalf of the caller.</p>
+ *
  * @throws {@link SFNServiceException}
  * <p>Base exception class for all service exceptions from SFN service.</p>
  *

package/dist-types/commands/GetExecutionHistoryCommand.d.ts

@@ -259,6 +259,15 @@ declare const GetExecutionHistoryCommand_base: {
  * @throws {@link InvalidToken} (client fault)
  *  <p>The provided token is not valid.</p>
  *
+ * @throws {@link KmsAccessDeniedException} (client fault)
+ *  <p>Either your KMS key policy or API caller does not have the required permissions.</p>
+ *
+ * @throws {@link KmsInvalidStateException} (client fault)
+ *  <p>The KMS key is not in valid state, for example: Disabled or Deleted.</p>
+ *
+ * @throws {@link KmsThrottlingException} (client fault)
+ *  <p>Received when KMS returns <code>ThrottlingException</code> for a KMS call that Step Functions makes on behalf of the caller.</p>
+ *
  * @throws {@link SFNServiceException}
  * <p>Base exception class for all service exceptions from SFN service.</p>
  *

package/dist-types/commands/ListExecutionsCommand.d.ts

@@ -94,7 +94,7 @@ declare const ListExecutionsCommand_base: {
  *  <p>The specified state machine does not exist.</p>
  *
  * @throws {@link StateMachineTypeNotSupported} (client fault)
- *  <p></p>
+ *  <p>State machine type is not supported.</p>
  *
  * @throws {@link ValidationException} (client fault)
  *  <p>The input does not satisfy the constraints specified by an Amazon Web Services service.</p>

package/dist-types/commands/SendTaskFailureCommand.d.ts

@@ -29,6 +29,8 @@ declare const SendTaskFailureCommand_base: {
 /**
  * <p>Used by activity workers, Task states using the <a href="https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html#connect-wait-token">callback</a>
  *       pattern, and optionally Task states using the <a href="https://docs.aws.amazon.com/step-functions/latest/dg/connect-to-resource.html#connect-sync">job run</a> pattern to report that the task identified by the <code>taskToken</code> failed.</p>
+ *          <p>For an execution with encryption enabled, Step Functions will encrypt the error and cause fields using the KMS key for the execution role.</p>
+ *          <p>A caller can mark a task as fail without using any KMS permissions in the execution role if the caller provides a null value for both <code>error</code> and <code>cause</code> fields because no data needs to be encrypted.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -55,6 +57,15 @@ declare const SendTaskFailureCommand_base: {
  * @throws {@link InvalidToken} (client fault)
  *  <p>The provided token is not valid.</p>
  *
+ * @throws {@link KmsAccessDeniedException} (client fault)
+ *  <p>Either your KMS key policy or API caller does not have the required permissions.</p>
+ *
+ * @throws {@link KmsInvalidStateException} (client fault)
+ *  <p>The KMS key is not in valid state, for example: Disabled or Deleted.</p>
+ *
+ * @throws {@link KmsThrottlingException} (client fault)
+ *  <p>Received when KMS returns <code>ThrottlingException</code> for a KMS call that Step Functions makes on behalf of the caller.</p>
+ *
  * @throws {@link TaskDoesNotExist} (client fault)
  *  <p>The activity does not exist.</p>
  *

package/dist-types/commands/SendTaskSuccessCommand.d.ts

@@ -58,6 +58,15 @@ declare const SendTaskSuccessCommand_base: {
  * @throws {@link InvalidToken} (client fault)
  *  <p>The provided token is not valid.</p>
  *
+ * @throws {@link KmsAccessDeniedException} (client fault)
+ *  <p>Either your KMS key policy or API caller does not have the required permissions.</p>
+ *
+ * @throws {@link KmsInvalidStateException} (client fault)
+ *  <p>The KMS key is not in valid state, for example: Disabled or Deleted.</p>
+ *
+ * @throws {@link KmsThrottlingException} (client fault)
+ *  <p>Received when KMS returns <code>ThrottlingException</code> for a KMS call that Step Functions makes on behalf of the caller.</p>
+ *
  * @throws {@link TaskDoesNotExist} (client fault)
  *  <p>The activity does not exist.</p>
  *

package/dist-types/commands/StartExecutionCommand.d.ts

@@ -117,6 +117,15 @@ declare const StartExecutionCommand_base: {
  * @throws {@link InvalidName} (client fault)
  *  <p>The provided name is not valid.</p>
  *
+ * @throws {@link KmsAccessDeniedException} (client fault)
+ *  <p>Either your KMS key policy or API caller does not have the required permissions.</p>
+ *
+ * @throws {@link KmsInvalidStateException} (client fault)
+ *  <p>The KMS key is not in valid state, for example: Disabled or Deleted.</p>
+ *
+ * @throws {@link KmsThrottlingException} (client fault)
+ *  <p>Received when KMS returns <code>ThrottlingException</code> for a KMS call that Step Functions makes on behalf of the caller.</p>
+ *
  * @throws {@link StateMachineDeleting} (client fault)
  *  <p>The specified state machine is being deleted.</p>
  *

package/dist-types/commands/StartSyncExecutionCommand.d.ts

@@ -51,6 +51,7 @@ declare const StartSyncExecutionCommand_base: {
  *   name: "STRING_VALUE",
  *   input: "STRING_VALUE",
  *   traceHeader: "STRING_VALUE",
+ *   includedData: "ALL_DATA" || "METADATA_ONLY",
  * };
  * const command = new StartSyncExecutionCommand(input);
  * const response = await client.send(command);
@@ -95,6 +96,15 @@ declare const StartSyncExecutionCommand_base: {
  * @throws {@link InvalidName} (client fault)
  *  <p>The provided name is not valid.</p>
  *
+ * @throws {@link KmsAccessDeniedException} (client fault)
+ *  <p>Either your KMS key policy or API caller does not have the required permissions.</p>
+ *
+ * @throws {@link KmsInvalidStateException} (client fault)
+ *  <p>The KMS key is not in valid state, for example: Disabled or Deleted.</p>
+ *
+ * @throws {@link KmsThrottlingException} (client fault)
+ *  <p>Received when KMS returns <code>ThrottlingException</code> for a KMS call that Step Functions makes on behalf of the caller.</p>
+ *
  * @throws {@link StateMachineDeleting} (client fault)
  *  <p>The specified state machine is being deleted.</p>
  *
@@ -102,7 +112,7 @@ declare const StartSyncExecutionCommand_base: {
  *  <p>The specified state machine does not exist.</p>
  *
  * @throws {@link StateMachineTypeNotSupported} (client fault)
- *  <p></p>
+ *  <p>State machine type is not supported.</p>
  *
  * @throws {@link SFNServiceException}
  * <p>Base exception class for all service exceptions from SFN service.</p>

package/dist-types/commands/StopExecutionCommand.d.ts

@@ -29,6 +29,8 @@ declare const StopExecutionCommand_base: {
 /**
  * <p>Stops an execution.</p>
  *          <p>This API action is not supported by <code>EXPRESS</code> state machines.</p>
+ *          <p>For an execution with encryption enabled, Step Functions will encrypt the error and cause fields using the KMS key for the execution role.</p>
+ *          <p>A caller can stop an execution without using any KMS permissions in the execution role if the caller provides a null value for both <code>error</code> and <code>cause</code> fields because no data needs to be encrypted.</p>
  * @example
  * Use a bare-bones client and the command you need to make an API call.
  * ```javascript
@@ -60,6 +62,15 @@ declare const StopExecutionCommand_base: {
  * @throws {@link InvalidArn} (client fault)
  *  <p>The provided Amazon Resource Name (ARN) is not valid.</p>
  *
+ * @throws {@link KmsAccessDeniedException} (client fault)
+ *  <p>Either your KMS key policy or API caller does not have the required permissions.</p>
+ *
+ * @throws {@link KmsInvalidStateException} (client fault)
+ *  <p>The KMS key is not in valid state, for example: Disabled or Deleted.</p>
+ *
+ * @throws {@link KmsThrottlingException} (client fault)
+ *  <p>Received when KMS returns <code>ThrottlingException</code> for a KMS call that Step Functions makes on behalf of the caller.</p>
+ *
  * @throws {@link ValidationException} (client fault)
  *  <p>The input does not satisfy the constraints specified by an Amazon Web Services service.</p>
  *

package/dist-types/commands/UpdateStateMachineCommand.d.ts

@@ -28,7 +28,7 @@ declare const UpdateStateMachineCommand_base: {
 };
 /**
  * <p>Updates an existing state machine by modifying its <code>definition</code>,
- *         <code>roleArn</code>, or <code>loggingConfiguration</code>. Running executions will continue
+ *         <code>roleArn</code>, <code>loggingConfiguration</code>, or <code>EncryptionConfiguration</code>. Running executions will continue
  *       to use the previous <code>definition</code> and <code>roleArn</code>. You must include at
  *       least one of <code>definition</code> or <code>roleArn</code> or you will receive a
  *         <code>MissingRequiredParameter</code> error.</p>
@@ -99,6 +99,11 @@ declare const UpdateStateMachineCommand_base: {
  *   },
  *   publish: true || false,
  *   versionDescription: "STRING_VALUE",
+ *   encryptionConfiguration: { // EncryptionConfiguration
+ *     kmsKeyId: "STRING_VALUE",
+ *     kmsDataKeyReusePeriodSeconds: Number("int"),
+ *     type: "AWS_OWNED_KEY" || "CUSTOMER_MANAGED_KMS_KEY", // required
+ *   },
  * };
  * const command = new UpdateStateMachineCommand(input);
  * const response = await client.send(command);
@@ -126,13 +131,22 @@ declare const UpdateStateMachineCommand_base: {
  * @throws {@link InvalidDefinition} (client fault)
  *  <p>The provided Amazon States Language definition is not valid.</p>
  *
+ * @throws {@link InvalidEncryptionConfiguration} (client fault)
+ *  <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>
+ *
  * @throws {@link InvalidLoggingConfiguration} (client fault)
- *  <p></p>
+ *  <p>Configuration is not valid.</p>
  *
  * @throws {@link InvalidTracingConfiguration} (client fault)
  *  <p>Your <code>tracingConfiguration</code> key does not match, or <code>enabled</code> has not
  *       been set to <code>true</code> or <code>false</code>.</p>
  *
+ * @throws {@link KmsAccessDeniedException} (client fault)
+ *  <p>Either your KMS key policy or API caller does not have the required permissions.</p>
+ *
+ * @throws {@link KmsThrottlingException} (client fault)
+ *  <p>Received when KMS returns <code>ThrottlingException</code> for a KMS call that Step Functions makes on behalf of the caller.</p>
+ *
  * @throws {@link MissingRequiredParameter} (client fault)
  *  <p>Request is missing a required parameter. This error occurs if both <code>definition</code>
  *       and <code>roleArn</code> are not specified.</p>

package/dist-types/index.d.ts

@@ -1,6 +1,6 @@
 /**
  * <fullname>Step Functions</fullname>
- *          <p>Step Functions is a service that lets you coordinate the components of distributed applications
+ *          <p>Step Functions coordinates the components of distributed applications
  *       and microservices using visual workflows.</p>
  *          <p>You can use Step Functions to build applications from individual components, each of which performs
  *       a discrete function, or <i>task</i>, allowing you to scale and change