/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License").
* You may not use this file except in compliance with the License.
* A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed
* on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
* express or implied. See the License for the specific language governing
* permissions and limitations under the License.
*/
/*
* Do not modify this file. This file is generated from the states-2016-11-23.normal.json service model.
*/
using System;
using System.Collections.Generic;
using System.Xml.Serialization;
using System.Text;
using System.IO;
using System.Net;
using Amazon.Runtime;
using Amazon.Runtime.Internal;
namespace Amazon.StepFunctions.Model
{
///
/// This is the response object from the DescribeExecution operation.
///
public partial class DescribeExecutionResponse : AmazonWebServiceResponse
{
private string _cause;
private string _error;
private string _executionArn;
private string _input;
private CloudWatchEventsExecutionDataDetails _inputDetails;
private string _mapRunArn;
private string _name;
private string _output;
private CloudWatchEventsExecutionDataDetails _outputDetails;
private DateTime? _startDate;
private string _stateMachineAliasArn;
private string _stateMachineArn;
private string _stateMachineVersionArn;
private ExecutionStatus _status;
private DateTime? _stopDate;
private string _traceHeader;
///
/// Gets and sets the property Cause.
///
/// The cause string if the state machine execution failed.
///
///
[AWSProperty(Sensitive=true, Min=0, Max=32768)]
public string Cause
{
get { return this._cause; }
set { this._cause = value; }
}
// Check to see if Cause property is set
internal bool IsSetCause()
{
return this._cause != null;
}
///
/// Gets and sets the property Error.
///
/// The error string if the state machine execution failed.
///
///
[AWSProperty(Sensitive=true, Min=0, Max=256)]
public string Error
{
get { return this._error; }
set { this._error = value; }
}
// Check to see if Error property is set
internal bool IsSetError()
{
return this._error != null;
}
///
/// Gets and sets the property ExecutionArn.
///
/// The Amazon Resource Name (ARN) that identifies the execution.
///
///
[AWSProperty(Required=true, Min=1, Max=256)]
public string ExecutionArn
{
get { return this._executionArn; }
set { this._executionArn = value; }
}
// Check to see if ExecutionArn property is set
internal bool IsSetExecutionArn()
{
return this._executionArn != null;
}
///
/// Gets and sets the property Input.
///
/// The string that contains the JSON input data of the execution. Length constraints
/// apply to the payload size, and are expressed as bytes in UTF-8 encoding.
///
///
[AWSProperty(Sensitive=true, Max=262144)]
public string Input
{
get { return this._input; }
set { this._input = value; }
}
// Check to see if Input property is set
internal bool IsSetInput()
{
return this._input != null;
}
///
/// Gets and sets the property InputDetails.
///
public CloudWatchEventsExecutionDataDetails InputDetails
{
get { return this._inputDetails; }
set { this._inputDetails = value; }
}
// Check to see if InputDetails property is set
internal bool IsSetInputDetails()
{
return this._inputDetails != null;
}
///
/// Gets and sets the property MapRunArn.
///
/// The Amazon Resource Name (ARN) that identifies a Map Run, which dispatched this execution.
///
///
[AWSProperty(Min=1, Max=2000)]
public string MapRunArn
{
get { return this._mapRunArn; }
set { this._mapRunArn = value; }
}
// Check to see if MapRunArn property is set
internal bool IsSetMapRunArn()
{
return this._mapRunArn != null;
}
///
/// Gets and sets the property Name.
///
/// The name of the execution.
///
///
///
/// 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 _.
///
///
[AWSProperty(Min=1, Max=80)]
public string Name
{
get { return this._name; }
set { this._name = value; }
}
// Check to see if Name property is set
internal bool IsSetName()
{
return this._name != null;
}
///
/// Gets and sets the property Output.
///
/// The JSON output data of the execution. Length constraints apply to the payload size,
/// and are expressed as bytes in UTF-8 encoding.
///
///
///
/// This field is set only if the execution succeeds. If the execution fails, this field
/// is null.
///
///
///
[AWSProperty(Sensitive=true, Max=262144)]
public string Output
{
get { return this._output; }
set { this._output = value; }
}
// Check to see if Output property is set
internal bool IsSetOutput()
{
return this._output != null;
}
///
/// Gets and sets the property OutputDetails.
///
public CloudWatchEventsExecutionDataDetails OutputDetails
{
get { return this._outputDetails; }
set { this._outputDetails = value; }
}
// Check to see if OutputDetails property is set
internal bool IsSetOutputDetails()
{
return this._outputDetails != null;
}
///
/// Gets and sets the property StartDate.
///
/// The date the execution is started.
///
///
[AWSProperty(Required=true)]
public DateTime StartDate
{
get { return this._startDate.GetValueOrDefault(); }
set { this._startDate = value; }
}
// Check to see if StartDate property is set
internal bool IsSetStartDate()
{
return this._startDate.HasValue;
}
///
/// Gets and sets the property StateMachineAliasArn.
///
/// The Amazon Resource Name (ARN) of the state machine alias associated with the execution.
/// The alias ARN is a combination of state machine ARN and the alias name separated by
/// a colon (:). For example, stateMachineARN:PROD
.
///
///
///
/// If you start an execution from a StartExecution
request with a state
/// machine version ARN, this field will be null.
///
///
[AWSProperty(Min=1, Max=256)]
public string StateMachineAliasArn
{
get { return this._stateMachineAliasArn; }
set { this._stateMachineAliasArn = value; }
}
// Check to see if StateMachineAliasArn property is set
internal bool IsSetStateMachineAliasArn()
{
return this._stateMachineAliasArn != null;
}
///
/// Gets and sets the property StateMachineArn.
///
/// The Amazon Resource Name (ARN) of the executed stated machine.
///
///
[AWSProperty(Required=true, Min=1, Max=256)]
public string StateMachineArn
{
get { return this._stateMachineArn; }
set { this._stateMachineArn = value; }
}
// Check to see if StateMachineArn property is set
internal bool IsSetStateMachineArn()
{
return this._stateMachineArn != null;
}
///
/// Gets and sets the property StateMachineVersionArn.
///
/// The Amazon Resource Name (ARN) of the state machine version associated with the execution.
/// The version ARN is a combination of state machine ARN and the version number separated
/// by a colon (:). For example, stateMachineARN:1
.
///
///
///
/// If you start an execution from a StartExecution
request without specifying
/// a state machine version or alias ARN, Step Functions returns a null value.
///
///
[AWSProperty(Min=1, Max=256)]
public string StateMachineVersionArn
{
get { return this._stateMachineVersionArn; }
set { this._stateMachineVersionArn = value; }
}
// Check to see if StateMachineVersionArn property is set
internal bool IsSetStateMachineVersionArn()
{
return this._stateMachineVersionArn != null;
}
///
/// Gets and sets the property Status.
///
/// The current status of the execution.
///
///
[AWSProperty(Required=true)]
public ExecutionStatus Status
{
get { return this._status; }
set { this._status = value; }
}
// Check to see if Status property is set
internal bool IsSetStatus()
{
return this._status != null;
}
///
/// Gets and sets the property StopDate.
///
/// If the execution ended, the date the execution stopped.
///
///
public DateTime StopDate
{
get { return this._stopDate.GetValueOrDefault(); }
set { this._stopDate = value; }
}
// Check to see if StopDate property is set
internal bool IsSetStopDate()
{
return this._stopDate.HasValue;
}
///
/// Gets and sets the property TraceHeader.
///
/// The X-Ray trace header that was passed to the execution.
///
///
[AWSProperty(Min=0, Max=256)]
public string TraceHeader
{
get { return this._traceHeader; }
set { this._traceHeader = value; }
}
// Check to see if TraceHeader property is set
internal bool IsSetTraceHeader()
{
return this._traceHeader != null;
}
}
}