libZSservicesZSamazonka-stepfunctionsZSamazonka-stepfunctions
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.StepFunctions.StartExecution

Description

Starts a state machine execution.

StartExecution is idempotent. If StartExecution is called with the same name and input as a running execution, the call will succeed and return the same response as the original request. If the execution is closed or if the input is different, it will return a 400 ExecutionAlreadyExists error. Names can be reused after 90 days.

Synopsis

Creating a Request

data StartExecution Source #

See: newStartExecution smart constructor.

Constructors

StartExecution' 

Fields

  • input :: Maybe (Sensitive Text)

    The string that contains the JSON input data for the execution, for example:

    "input": "{\"first_name\" : \"test\"}"

    If you don't include any JSON input data, you still must include the two braces, for example: "input": "{}"

    Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.

  • name :: Maybe Text

    The name of the execution. This name must be unique for your AWS account, region, and state machine for 90 days. For more information, see Limits Related to State Machine Executions in the AWS Step Functions Developer Guide.

    A name must not contain:

    • white space
    • brackets < > { } [ ]
    • wildcard characters ? *
    • special characters " # % \ ^ | ~ ` $ & , ; : /
    • control characters (U+0000-001F, U+007F-009F)

    To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.

  • traceHeader :: Maybe Text

    Passes the AWS X-Ray trace header. The trace header can also be passed in the request payload.

  • stateMachineArn :: Text

    The Amazon Resource Name (ARN) of the state machine to execute.

Instances

Instances details
Eq StartExecution Source # 
Instance details

Defined in Amazonka.StepFunctions.StartExecution

Show StartExecution Source # 
Instance details

Defined in Amazonka.StepFunctions.StartExecution

Generic StartExecution Source # 
Instance details

Defined in Amazonka.StepFunctions.StartExecution

Associated Types

type Rep StartExecution :: Type -> Type #

NFData StartExecution Source # 
Instance details

Defined in Amazonka.StepFunctions.StartExecution

Methods

rnf :: StartExecution -> () #

Hashable StartExecution Source # 
Instance details

Defined in Amazonka.StepFunctions.StartExecution

ToJSON StartExecution Source # 
Instance details

Defined in Amazonka.StepFunctions.StartExecution

AWSRequest StartExecution Source # 
Instance details

Defined in Amazonka.StepFunctions.StartExecution

Associated Types

type AWSResponse StartExecution #

ToHeaders StartExecution Source # 
Instance details

Defined in Amazonka.StepFunctions.StartExecution

ToPath StartExecution Source # 
Instance details

Defined in Amazonka.StepFunctions.StartExecution

ToQuery StartExecution Source # 
Instance details

Defined in Amazonka.StepFunctions.StartExecution

type Rep StartExecution Source # 
Instance details

Defined in Amazonka.StepFunctions.StartExecution

type Rep StartExecution = D1 ('MetaData "StartExecution" "Amazonka.StepFunctions.StartExecution" "libZSservicesZSamazonka-stepfunctionsZSamazonka-stepfunctions" 'False) (C1 ('MetaCons "StartExecution'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "input") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :*: S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "traceHeader") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "stateMachineArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))
type AWSResponse StartExecution Source # 
Instance details

Defined in Amazonka.StepFunctions.StartExecution

newStartExecution Source #

Create a value of StartExecution 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:input:StartExecution', startExecution_input - The string that contains the JSON input data for the execution, for example:

"input": "{\"first_name\" : \"test\"}"

If you don't include any JSON input data, you still must include the two braces, for example: "input": "{}"

Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.

$sel:name:StartExecution', startExecution_name - The name of the execution. This name must be unique for your AWS account, region, and state machine for 90 days. For more information, see Limits Related to State Machine Executions in the AWS Step Functions Developer Guide.

A name must not contain:

  • white space
  • brackets < > { } [ ]
  • wildcard characters ? *
  • special characters " # % \ ^ | ~ ` $ & , ; : /
  • control characters (U+0000-001F, U+007F-009F)

To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.

$sel:traceHeader:StartExecution', startExecution_traceHeader - Passes the AWS X-Ray trace header. The trace header can also be passed in the request payload.

$sel:stateMachineArn:StartExecution', startExecution_stateMachineArn - The Amazon Resource Name (ARN) of the state machine to execute.

Request Lenses

startExecution_input :: Lens' StartExecution (Maybe Text) Source #

The string that contains the JSON input data for the execution, for example:

"input": "{\"first_name\" : \"test\"}"

If you don't include any JSON input data, you still must include the two braces, for example: "input": "{}"

Length constraints apply to the payload size, and are expressed as bytes in UTF-8 encoding.

startExecution_name :: Lens' StartExecution (Maybe Text) Source #

The name of the execution. This name must be unique for your AWS account, region, and state machine for 90 days. For more information, see Limits Related to State Machine Executions in the AWS Step Functions Developer Guide.

A name must not contain:

  • white space
  • brackets < > { } [ ]
  • wildcard characters ? *
  • special characters " # % \ ^ | ~ ` $ & , ; : /
  • control characters (U+0000-001F, U+007F-009F)

To enable logging with CloudWatch Logs, the name should only contain 0-9, A-Z, a-z, - and _.

startExecution_traceHeader :: Lens' StartExecution (Maybe Text) Source #

Passes the AWS X-Ray trace header. The trace header can also be passed in the request payload.

startExecution_stateMachineArn :: Lens' StartExecution Text Source #

The Amazon Resource Name (ARN) of the state machine to execute.

Destructuring the Response

data StartExecutionResponse Source #

See: newStartExecutionResponse smart constructor.

Constructors

StartExecutionResponse' 

Fields

Instances

Instances details
Eq StartExecutionResponse Source # 
Instance details

Defined in Amazonka.StepFunctions.StartExecution

Read StartExecutionResponse Source # 
Instance details

Defined in Amazonka.StepFunctions.StartExecution

Show StartExecutionResponse Source # 
Instance details

Defined in Amazonka.StepFunctions.StartExecution

Generic StartExecutionResponse Source # 
Instance details

Defined in Amazonka.StepFunctions.StartExecution

Associated Types

type Rep StartExecutionResponse :: Type -> Type #

NFData StartExecutionResponse Source # 
Instance details

Defined in Amazonka.StepFunctions.StartExecution

Methods

rnf :: StartExecutionResponse -> () #

type Rep StartExecutionResponse Source # 
Instance details

Defined in Amazonka.StepFunctions.StartExecution

type Rep StartExecutionResponse = D1 ('MetaData "StartExecutionResponse" "Amazonka.StepFunctions.StartExecution" "libZSservicesZSamazonka-stepfunctionsZSamazonka-stepfunctions" 'False) (C1 ('MetaCons "StartExecutionResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: (S1 ('MetaSel ('Just "executionArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "startDate") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX))))

newStartExecutionResponse Source #

Create a value of StartExecutionResponse 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:httpStatus:StartExecutionResponse', startExecutionResponse_httpStatus - The response's http status code.

$sel:executionArn:StartExecutionResponse', startExecutionResponse_executionArn - The Amazon Resource Name (ARN) that identifies the execution.

$sel:startDate:StartExecutionResponse', startExecutionResponse_startDate - The date the execution is started.

Response Lenses

startExecutionResponse_executionArn :: Lens' StartExecutionResponse Text Source #

The Amazon Resource Name (ARN) that identifies the execution.