/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include namespace Aws { namespace Synthetics { namespace Model { /** */ class DescribeCanariesLastRunRequest : public SyntheticsRequest { public: AWS_SYNTHETICS_API DescribeCanariesLastRunRequest(); // 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 "DescribeCanariesLastRun"; } AWS_SYNTHETICS_API Aws::String SerializePayload() const override; /** *

A token that indicates that there is more data available. You can use this * token in a subsequent DescribeCanariesLastRun operation to retrieve * the next set of results.

*/ inline const Aws::String& GetNextToken() const{ return m_nextToken; } /** *

A token that indicates that there is more data available. You can use this * token in a subsequent DescribeCanariesLastRun operation to retrieve * the next set of results.

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

A token that indicates that there is more data available. You can use this * token in a subsequent DescribeCanariesLastRun operation to retrieve * the next set of results.

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

A token that indicates that there is more data available. You can use this * token in a subsequent DescribeCanariesLastRun operation to retrieve * the next set of results.

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

A token that indicates that there is more data available. You can use this * token in a subsequent DescribeCanariesLastRun operation to retrieve * the next set of results.

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

A token that indicates that there is more data available. You can use this * token in a subsequent DescribeCanariesLastRun operation to retrieve * the next set of results.

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

A token that indicates that there is more data available. You can use this * token in a subsequent DescribeCanariesLastRun operation to retrieve * the next set of results.

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

A token that indicates that there is more data available. You can use this * token in a subsequent DescribeCanariesLastRun operation to retrieve * the next set of results.

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

Specify this parameter to limit how many runs are returned each time you use * the DescribeLastRun operation. If you omit this parameter, the * default of 100 is used.

*/ inline int GetMaxResults() const{ return m_maxResults; } /** *

Specify this parameter to limit how many runs are returned each time you use * the DescribeLastRun operation. If you omit this parameter, the * default of 100 is used.

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

Specify this parameter to limit how many runs are returned each time you use * the DescribeLastRun operation. If you omit this parameter, the * default of 100 is used.

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

Specify this parameter to limit how many runs are returned each time you use * the DescribeLastRun operation. If you omit this parameter, the * default of 100 is used.

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

Use this parameter to return only canaries that match the names that you * specify here. You can specify as many as five canary names.

If you * specify this parameter, the operation is successful only if you have * authorization to view all the canaries that you specify in your request. If you * do not have permission to view any of the canaries, the request fails with a 403 * response.

You are required to use the Names parameter if you * are logged on to a user or role that has an IAM policy that restricts which * canaries that you are allowed to view. For more information, see * Limiting a user to viewing specific canaries.

*/ inline const Aws::Vector& GetNames() const{ return m_names; } /** *

Use this parameter to return only canaries that match the names that you * specify here. You can specify as many as five canary names.

If you * specify this parameter, the operation is successful only if you have * authorization to view all the canaries that you specify in your request. If you * do not have permission to view any of the canaries, the request fails with a 403 * response.

You are required to use the Names parameter if you * are logged on to a user or role that has an IAM policy that restricts which * canaries that you are allowed to view. For more information, see * Limiting a user to viewing specific canaries.

*/ inline bool NamesHasBeenSet() const { return m_namesHasBeenSet; } /** *

Use this parameter to return only canaries that match the names that you * specify here. You can specify as many as five canary names.

If you * specify this parameter, the operation is successful only if you have * authorization to view all the canaries that you specify in your request. If you * do not have permission to view any of the canaries, the request fails with a 403 * response.

You are required to use the Names parameter if you * are logged on to a user or role that has an IAM policy that restricts which * canaries that you are allowed to view. For more information, see * Limiting a user to viewing specific canaries.

*/ inline void SetNames(const Aws::Vector& value) { m_namesHasBeenSet = true; m_names = value; } /** *

Use this parameter to return only canaries that match the names that you * specify here. You can specify as many as five canary names.

If you * specify this parameter, the operation is successful only if you have * authorization to view all the canaries that you specify in your request. If you * do not have permission to view any of the canaries, the request fails with a 403 * response.

You are required to use the Names parameter if you * are logged on to a user or role that has an IAM policy that restricts which * canaries that you are allowed to view. For more information, see * Limiting a user to viewing specific canaries.

*/ inline void SetNames(Aws::Vector&& value) { m_namesHasBeenSet = true; m_names = std::move(value); } /** *

Use this parameter to return only canaries that match the names that you * specify here. You can specify as many as five canary names.

If you * specify this parameter, the operation is successful only if you have * authorization to view all the canaries that you specify in your request. If you * do not have permission to view any of the canaries, the request fails with a 403 * response.

You are required to use the Names parameter if you * are logged on to a user or role that has an IAM policy that restricts which * canaries that you are allowed to view. For more information, see * Limiting a user to viewing specific canaries.

*/ inline DescribeCanariesLastRunRequest& WithNames(const Aws::Vector& value) { SetNames(value); return *this;} /** *

Use this parameter to return only canaries that match the names that you * specify here. You can specify as many as five canary names.

If you * specify this parameter, the operation is successful only if you have * authorization to view all the canaries that you specify in your request. If you * do not have permission to view any of the canaries, the request fails with a 403 * response.

You are required to use the Names parameter if you * are logged on to a user or role that has an IAM policy that restricts which * canaries that you are allowed to view. For more information, see * Limiting a user to viewing specific canaries.

*/ inline DescribeCanariesLastRunRequest& WithNames(Aws::Vector&& value) { SetNames(std::move(value)); return *this;} /** *

Use this parameter to return only canaries that match the names that you * specify here. You can specify as many as five canary names.

If you * specify this parameter, the operation is successful only if you have * authorization to view all the canaries that you specify in your request. If you * do not have permission to view any of the canaries, the request fails with a 403 * response.

You are required to use the Names parameter if you * are logged on to a user or role that has an IAM policy that restricts which * canaries that you are allowed to view. For more information, see * Limiting a user to viewing specific canaries.

*/ inline DescribeCanariesLastRunRequest& AddNames(const Aws::String& value) { m_namesHasBeenSet = true; m_names.push_back(value); return *this; } /** *

Use this parameter to return only canaries that match the names that you * specify here. You can specify as many as five canary names.

If you * specify this parameter, the operation is successful only if you have * authorization to view all the canaries that you specify in your request. If you * do not have permission to view any of the canaries, the request fails with a 403 * response.

You are required to use the Names parameter if you * are logged on to a user or role that has an IAM policy that restricts which * canaries that you are allowed to view. For more information, see * Limiting a user to viewing specific canaries.

*/ inline DescribeCanariesLastRunRequest& AddNames(Aws::String&& value) { m_namesHasBeenSet = true; m_names.push_back(std::move(value)); return *this; } /** *

Use this parameter to return only canaries that match the names that you * specify here. You can specify as many as five canary names.

If you * specify this parameter, the operation is successful only if you have * authorization to view all the canaries that you specify in your request. If you * do not have permission to view any of the canaries, the request fails with a 403 * response.

You are required to use the Names parameter if you * are logged on to a user or role that has an IAM policy that restricts which * canaries that you are allowed to view. For more information, see * Limiting a user to viewing specific canaries.

*/ inline DescribeCanariesLastRunRequest& AddNames(const char* value) { m_namesHasBeenSet = true; m_names.push_back(value); return *this; } private: Aws::String m_nextToken; bool m_nextTokenHasBeenSet = false; int m_maxResults; bool m_maxResultsHasBeenSet = false; Aws::Vector m_names; bool m_namesHasBeenSet = false; }; } // namespace Model } // namespace Synthetics } // namespace Aws