/*
* 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
{
///
/// Container for the parameters to the GetExecutionHistory operation.
/// Returns the history of the specified execution as a list of events. By default, the
/// results are returned in ascending order of the timeStamp
of the events.
/// Use the reverseOrder
parameter to get the latest events first.
///
///
///
/// If nextToken
is returned, there are more results available. The value
/// of nextToken
is a unique pagination token for each page. Make the call
/// again using the returned token to retrieve the next page. Keep all other arguments
/// unchanged. Each pagination token expires after 24 hours. Using an expired pagination
/// token will return an HTTP 400 InvalidToken error.
///
///
///
/// This API action is not supported by EXPRESS
state machines.
///
///
public partial class GetExecutionHistoryRequest : AmazonStepFunctionsRequest
{
private string _executionArn;
private bool? _includeExecutionData;
private int? _maxResults;
private string _nextToken;
private bool? _reverseOrder;
///
/// Gets and sets the property ExecutionArn.
///
/// The Amazon Resource Name (ARN) of 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 IncludeExecutionData.
///
/// You can select whether execution data (input or output of a history event) is returned.
/// The default is true
.
///
///
public bool IncludeExecutionData
{
get { return this._includeExecutionData.GetValueOrDefault(); }
set { this._includeExecutionData = value; }
}
// Check to see if IncludeExecutionData property is set
internal bool IsSetIncludeExecutionData()
{
return this._includeExecutionData.HasValue;
}
///
/// Gets and sets the property MaxResults.
///
/// The maximum number of results that are returned per call. You can use nextToken
/// to obtain further pages of results. The default is 100 and the maximum allowed page
/// size is 1000. A value of 0 uses the default.
///
///
///
/// This is only an upper limit. The actual number of results returned per call might
/// be fewer than the specified maximum.
///
///
[AWSProperty(Min=0, Max=1000)]
public int MaxResults
{
get { return this._maxResults.GetValueOrDefault(); }
set { this._maxResults = value; }
}
// Check to see if MaxResults property is set
internal bool IsSetMaxResults()
{
return this._maxResults.HasValue;
}
///
/// Gets and sets the property NextToken.
///
/// If nextToken
is returned, there are more results available. The value
/// of nextToken
is a unique pagination token for each page. Make the call
/// again using the returned token to retrieve the next page. Keep all other arguments
/// unchanged. Each pagination token expires after 24 hours. Using an expired pagination
/// token will return an HTTP 400 InvalidToken error.
///
///
[AWSProperty(Min=1, Max=1024)]
public string NextToken
{
get { return this._nextToken; }
set { this._nextToken = value; }
}
// Check to see if NextToken property is set
internal bool IsSetNextToken()
{
return this._nextToken != null;
}
///
/// Gets and sets the property ReverseOrder.
///
/// Lists events in descending order of their timeStamp
.
///
///
public bool ReverseOrder
{
get { return this._reverseOrder.GetValueOrDefault(); }
set { this._reverseOrder = value; }
}
// Check to see if ReverseOrder property is set
internal bool IsSetReverseOrder()
{
return this._reverseOrder.HasValue;
}
}
}