/ 
Paws-0.46
River stage two • 9 direct dependents • 11 total dependents
/ Paws::StepFunctions::StartExecution

NAME

Paws::StepFunctions::StartExecution - Arguments for method StartExecution on Paws::StepFunctions

DESCRIPTION

This class represents the parameters used for calling the method StartExecution on the AWS Step Functions service. Use the attributes of this class as arguments to method StartExecution.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to StartExecution.

SYNOPSIS

my $states = Paws->service('StepFunctions');
my $StartExecutionOutput = $states->StartExecution(
  StateMachineArn => 'MyArn',
  Input           => 'MySensitiveData',    # OPTIONAL
  Name            => 'MyName',             # OPTIONAL
  TraceHeader     => 'MyTraceHeader',      # OPTIONAL
);

# Results:
my $ExecutionArn = $StartExecutionOutput->ExecutionArn;
my $StartDate    = $StartExecutionOutput->StartDate;

# Returns a L<Paws::StepFunctions::StartExecutionOutput> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/states/StartExecution

ATTRIBUTES

Input => Str

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 => Str

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 (https://docs.aws.amazon.com/step-functions/latest/dg/limits.html#service-limits-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 _.

REQUIRED StateMachineArn => Str

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

TraceHeader => Str

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

SEE ALSO

This class forms part of Paws, documenting arguments for method StartExecution in Paws::StepFunctions

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues