/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include namespace Aws { namespace SFN { namespace Model { /** */ class GetExecutionHistoryRequest : public SFNRequest { public: AWS_SFN_API GetExecutionHistoryRequest(); // Service request name is the Operation name which will send this request out, // each operation should has unique request name, so that we can get operation's name from this request. // Note: this is not true for response, multiple operations may have the same response name, // so we can not get operation's name from response. inline virtual const char* GetServiceRequestName() const override { return "GetExecutionHistory"; } AWS_SFN_API Aws::String SerializePayload() const override; AWS_SFN_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override; /** *

The Amazon Resource Name (ARN) of the execution.

*/ inline const Aws::String& GetExecutionArn() const{ return m_executionArn; } /** *

The Amazon Resource Name (ARN) of the execution.

*/ inline bool ExecutionArnHasBeenSet() const { return m_executionArnHasBeenSet; } /** *

The Amazon Resource Name (ARN) of the execution.

*/ inline void SetExecutionArn(const Aws::String& value) { m_executionArnHasBeenSet = true; m_executionArn = value; } /** *

The Amazon Resource Name (ARN) of the execution.

*/ inline void SetExecutionArn(Aws::String&& value) { m_executionArnHasBeenSet = true; m_executionArn = std::move(value); } /** *

The Amazon Resource Name (ARN) of the execution.

*/ inline void SetExecutionArn(const char* value) { m_executionArnHasBeenSet = true; m_executionArn.assign(value); } /** *

The Amazon Resource Name (ARN) of the execution.

*/ inline GetExecutionHistoryRequest& WithExecutionArn(const Aws::String& value) { SetExecutionArn(value); return *this;} /** *

The Amazon Resource Name (ARN) of the execution.

*/ inline GetExecutionHistoryRequest& WithExecutionArn(Aws::String&& value) { SetExecutionArn(std::move(value)); return *this;} /** *

The Amazon Resource Name (ARN) of the execution.

*/ inline GetExecutionHistoryRequest& WithExecutionArn(const char* value) { SetExecutionArn(value); return *this;} /** *

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.

*/ inline int GetMaxResults() const{ return m_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.

*/ inline bool MaxResultsHasBeenSet() const { return m_maxResultsHasBeenSet; } /** *

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.

*/ inline void SetMaxResults(int value) { m_maxResultsHasBeenSet = true; m_maxResults = value; } /** *

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.

*/ inline GetExecutionHistoryRequest& WithMaxResults(int value) { SetMaxResults(value); return *this;} /** *

Lists events in descending order of their timeStamp.

*/ inline bool GetReverseOrder() const{ return m_reverseOrder; } /** *

Lists events in descending order of their timeStamp.

*/ inline bool ReverseOrderHasBeenSet() const { return m_reverseOrderHasBeenSet; } /** *

Lists events in descending order of their timeStamp.

*/ inline void SetReverseOrder(bool value) { m_reverseOrderHasBeenSet = true; m_reverseOrder = value; } /** *

Lists events in descending order of their timeStamp.

*/ inline GetExecutionHistoryRequest& WithReverseOrder(bool value) { SetReverseOrder(value); return *this;} /** *

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.

*/ inline const Aws::String& GetNextToken() const{ return m_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.

*/ inline bool NextTokenHasBeenSet() const { return m_nextTokenHasBeenSet; } /** *

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.

*/ inline void SetNextToken(const Aws::String& value) { m_nextTokenHasBeenSet = true; m_nextToken = value; } /** *

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.

*/ inline void SetNextToken(Aws::String&& value) { m_nextTokenHasBeenSet = true; m_nextToken = std::move(value); } /** *

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.

*/ inline void SetNextToken(const char* value) { m_nextTokenHasBeenSet = true; m_nextToken.assign(value); } /** *

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.

*/ inline GetExecutionHistoryRequest& WithNextToken(const Aws::String& value) { SetNextToken(value); return *this;} /** *

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.

*/ inline GetExecutionHistoryRequest& WithNextToken(Aws::String&& value) { SetNextToken(std::move(value)); return *this;} /** *

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.

*/ inline GetExecutionHistoryRequest& WithNextToken(const char* value) { SetNextToken(value); return *this;} /** *

You can select whether execution data (input or output of a history event) is * returned. The default is true.

*/ inline bool GetIncludeExecutionData() const{ return m_includeExecutionData; } /** *

You can select whether execution data (input or output of a history event) is * returned. The default is true.

*/ inline bool IncludeExecutionDataHasBeenSet() const { return m_includeExecutionDataHasBeenSet; } /** *

You can select whether execution data (input or output of a history event) is * returned. The default is true.

*/ inline void SetIncludeExecutionData(bool value) { m_includeExecutionDataHasBeenSet = true; m_includeExecutionData = value; } /** *

You can select whether execution data (input or output of a history event) is * returned. The default is true.

*/ inline GetExecutionHistoryRequest& WithIncludeExecutionData(bool value) { SetIncludeExecutionData(value); return *this;} private: Aws::String m_executionArn; bool m_executionArnHasBeenSet = false; int m_maxResults; bool m_maxResultsHasBeenSet = false; bool m_reverseOrder; bool m_reverseOrderHasBeenSet = false; Aws::String m_nextToken; bool m_nextTokenHasBeenSet = false; bool m_includeExecutionData; bool m_includeExecutionDataHasBeenSet = false; }; } // namespace Model } // namespace SFN } // namespace Aws