This repository has been archived on 2025-09-14. You can view files and clone it, but cannot push or open issues or pull requests.
Files
pxz-hos-client-cpp-module/support/aws-sdk-cpp-master/aws-cpp-sdk-ssm/include/aws/ssm/model/DescribePatchGroupsRequest.h

236 lines
11 KiB
C++

/**
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* SPDX-License-Identifier: Apache-2.0.
*/
#pragma once
#include <aws/ssm/SSM_EXPORTS.h>
#include <aws/ssm/SSMRequest.h>
#include <aws/core/utils/memory/stl/AWSVector.h>
#include <aws/core/utils/memory/stl/AWSString.h>
#include <aws/ssm/model/PatchOrchestratorFilter.h>
#include <utility>
namespace Aws
{
namespace SSM
{
namespace Model
{
/**
*/
class AWS_SSM_API DescribePatchGroupsRequest : public SSMRequest
{
public:
DescribePatchGroupsRequest();
// 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 "DescribePatchGroups"; }
Aws::String SerializePayload() const override;
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override;
/**
* <p>The maximum number of patch groups to return (per page).</p>
*/
inline int GetMaxResults() const{ return m_maxResults; }
/**
* <p>The maximum number of patch groups to return (per page).</p>
*/
inline bool MaxResultsHasBeenSet() const { return m_maxResultsHasBeenSet; }
/**
* <p>The maximum number of patch groups to return (per page).</p>
*/
inline void SetMaxResults(int value) { m_maxResultsHasBeenSet = true; m_maxResults = value; }
/**
* <p>The maximum number of patch groups to return (per page).</p>
*/
inline DescribePatchGroupsRequest& WithMaxResults(int value) { SetMaxResults(value); return *this;}
/**
* <p>One or more filters. Use a filter to return a more specific list of
* results.</p> <p>For <code>DescribePatchGroups</code>,valid filter keys include
* the following:</p> <ul> <li> <p> <code>NAME_PREFIX</code>: The name of the patch
* group. Wildcards (*) are accepted.</p> </li> <li> <p>
* <code>OPERATING_SYSTEM</code>: The supported operating system type to return
* results for. For valid operating system values, see
* <a>GetDefaultPatchBaselineRequest$OperatingSystem</a> in
* <a>CreatePatchBaseline</a>.</p> <p>Examples:</p> <ul> <li> <p> <code>--filters
* Key=NAME_PREFIX,Values=MyPatchGroup*</code> </p> </li> <li> <p> <code>--filters
* Key=OPERATING_SYSTEM,Values=AMAZON_LINUX_2</code> </p> </li> </ul> </li> </ul>
*/
inline const Aws::Vector<PatchOrchestratorFilter>& GetFilters() const{ return m_filters; }
/**
* <p>One or more filters. Use a filter to return a more specific list of
* results.</p> <p>For <code>DescribePatchGroups</code>,valid filter keys include
* the following:</p> <ul> <li> <p> <code>NAME_PREFIX</code>: The name of the patch
* group. Wildcards (*) are accepted.</p> </li> <li> <p>
* <code>OPERATING_SYSTEM</code>: The supported operating system type to return
* results for. For valid operating system values, see
* <a>GetDefaultPatchBaselineRequest$OperatingSystem</a> in
* <a>CreatePatchBaseline</a>.</p> <p>Examples:</p> <ul> <li> <p> <code>--filters
* Key=NAME_PREFIX,Values=MyPatchGroup*</code> </p> </li> <li> <p> <code>--filters
* Key=OPERATING_SYSTEM,Values=AMAZON_LINUX_2</code> </p> </li> </ul> </li> </ul>
*/
inline bool FiltersHasBeenSet() const { return m_filtersHasBeenSet; }
/**
* <p>One or more filters. Use a filter to return a more specific list of
* results.</p> <p>For <code>DescribePatchGroups</code>,valid filter keys include
* the following:</p> <ul> <li> <p> <code>NAME_PREFIX</code>: The name of the patch
* group. Wildcards (*) are accepted.</p> </li> <li> <p>
* <code>OPERATING_SYSTEM</code>: The supported operating system type to return
* results for. For valid operating system values, see
* <a>GetDefaultPatchBaselineRequest$OperatingSystem</a> in
* <a>CreatePatchBaseline</a>.</p> <p>Examples:</p> <ul> <li> <p> <code>--filters
* Key=NAME_PREFIX,Values=MyPatchGroup*</code> </p> </li> <li> <p> <code>--filters
* Key=OPERATING_SYSTEM,Values=AMAZON_LINUX_2</code> </p> </li> </ul> </li> </ul>
*/
inline void SetFilters(const Aws::Vector<PatchOrchestratorFilter>& value) { m_filtersHasBeenSet = true; m_filters = value; }
/**
* <p>One or more filters. Use a filter to return a more specific list of
* results.</p> <p>For <code>DescribePatchGroups</code>,valid filter keys include
* the following:</p> <ul> <li> <p> <code>NAME_PREFIX</code>: The name of the patch
* group. Wildcards (*) are accepted.</p> </li> <li> <p>
* <code>OPERATING_SYSTEM</code>: The supported operating system type to return
* results for. For valid operating system values, see
* <a>GetDefaultPatchBaselineRequest$OperatingSystem</a> in
* <a>CreatePatchBaseline</a>.</p> <p>Examples:</p> <ul> <li> <p> <code>--filters
* Key=NAME_PREFIX,Values=MyPatchGroup*</code> </p> </li> <li> <p> <code>--filters
* Key=OPERATING_SYSTEM,Values=AMAZON_LINUX_2</code> </p> </li> </ul> </li> </ul>
*/
inline void SetFilters(Aws::Vector<PatchOrchestratorFilter>&& value) { m_filtersHasBeenSet = true; m_filters = std::move(value); }
/**
* <p>One or more filters. Use a filter to return a more specific list of
* results.</p> <p>For <code>DescribePatchGroups</code>,valid filter keys include
* the following:</p> <ul> <li> <p> <code>NAME_PREFIX</code>: The name of the patch
* group. Wildcards (*) are accepted.</p> </li> <li> <p>
* <code>OPERATING_SYSTEM</code>: The supported operating system type to return
* results for. For valid operating system values, see
* <a>GetDefaultPatchBaselineRequest$OperatingSystem</a> in
* <a>CreatePatchBaseline</a>.</p> <p>Examples:</p> <ul> <li> <p> <code>--filters
* Key=NAME_PREFIX,Values=MyPatchGroup*</code> </p> </li> <li> <p> <code>--filters
* Key=OPERATING_SYSTEM,Values=AMAZON_LINUX_2</code> </p> </li> </ul> </li> </ul>
*/
inline DescribePatchGroupsRequest& WithFilters(const Aws::Vector<PatchOrchestratorFilter>& value) { SetFilters(value); return *this;}
/**
* <p>One or more filters. Use a filter to return a more specific list of
* results.</p> <p>For <code>DescribePatchGroups</code>,valid filter keys include
* the following:</p> <ul> <li> <p> <code>NAME_PREFIX</code>: The name of the patch
* group. Wildcards (*) are accepted.</p> </li> <li> <p>
* <code>OPERATING_SYSTEM</code>: The supported operating system type to return
* results for. For valid operating system values, see
* <a>GetDefaultPatchBaselineRequest$OperatingSystem</a> in
* <a>CreatePatchBaseline</a>.</p> <p>Examples:</p> <ul> <li> <p> <code>--filters
* Key=NAME_PREFIX,Values=MyPatchGroup*</code> </p> </li> <li> <p> <code>--filters
* Key=OPERATING_SYSTEM,Values=AMAZON_LINUX_2</code> </p> </li> </ul> </li> </ul>
*/
inline DescribePatchGroupsRequest& WithFilters(Aws::Vector<PatchOrchestratorFilter>&& value) { SetFilters(std::move(value)); return *this;}
/**
* <p>One or more filters. Use a filter to return a more specific list of
* results.</p> <p>For <code>DescribePatchGroups</code>,valid filter keys include
* the following:</p> <ul> <li> <p> <code>NAME_PREFIX</code>: The name of the patch
* group. Wildcards (*) are accepted.</p> </li> <li> <p>
* <code>OPERATING_SYSTEM</code>: The supported operating system type to return
* results for. For valid operating system values, see
* <a>GetDefaultPatchBaselineRequest$OperatingSystem</a> in
* <a>CreatePatchBaseline</a>.</p> <p>Examples:</p> <ul> <li> <p> <code>--filters
* Key=NAME_PREFIX,Values=MyPatchGroup*</code> </p> </li> <li> <p> <code>--filters
* Key=OPERATING_SYSTEM,Values=AMAZON_LINUX_2</code> </p> </li> </ul> </li> </ul>
*/
inline DescribePatchGroupsRequest& AddFilters(const PatchOrchestratorFilter& value) { m_filtersHasBeenSet = true; m_filters.push_back(value); return *this; }
/**
* <p>One or more filters. Use a filter to return a more specific list of
* results.</p> <p>For <code>DescribePatchGroups</code>,valid filter keys include
* the following:</p> <ul> <li> <p> <code>NAME_PREFIX</code>: The name of the patch
* group. Wildcards (*) are accepted.</p> </li> <li> <p>
* <code>OPERATING_SYSTEM</code>: The supported operating system type to return
* results for. For valid operating system values, see
* <a>GetDefaultPatchBaselineRequest$OperatingSystem</a> in
* <a>CreatePatchBaseline</a>.</p> <p>Examples:</p> <ul> <li> <p> <code>--filters
* Key=NAME_PREFIX,Values=MyPatchGroup*</code> </p> </li> <li> <p> <code>--filters
* Key=OPERATING_SYSTEM,Values=AMAZON_LINUX_2</code> </p> </li> </ul> </li> </ul>
*/
inline DescribePatchGroupsRequest& AddFilters(PatchOrchestratorFilter&& value) { m_filtersHasBeenSet = true; m_filters.push_back(std::move(value)); return *this; }
/**
* <p>The token for the next set of items to return. (You received this token from
* a previous call.)</p>
*/
inline const Aws::String& GetNextToken() const{ return m_nextToken; }
/**
* <p>The token for the next set of items to return. (You received this token from
* a previous call.)</p>
*/
inline bool NextTokenHasBeenSet() const { return m_nextTokenHasBeenSet; }
/**
* <p>The token for the next set of items to return. (You received this token from
* a previous call.)</p>
*/
inline void SetNextToken(const Aws::String& value) { m_nextTokenHasBeenSet = true; m_nextToken = value; }
/**
* <p>The token for the next set of items to return. (You received this token from
* a previous call.)</p>
*/
inline void SetNextToken(Aws::String&& value) { m_nextTokenHasBeenSet = true; m_nextToken = std::move(value); }
/**
* <p>The token for the next set of items to return. (You received this token from
* a previous call.)</p>
*/
inline void SetNextToken(const char* value) { m_nextTokenHasBeenSet = true; m_nextToken.assign(value); }
/**
* <p>The token for the next set of items to return. (You received this token from
* a previous call.)</p>
*/
inline DescribePatchGroupsRequest& WithNextToken(const Aws::String& value) { SetNextToken(value); return *this;}
/**
* <p>The token for the next set of items to return. (You received this token from
* a previous call.)</p>
*/
inline DescribePatchGroupsRequest& WithNextToken(Aws::String&& value) { SetNextToken(std::move(value)); return *this;}
/**
* <p>The token for the next set of items to return. (You received this token from
* a previous call.)</p>
*/
inline DescribePatchGroupsRequest& WithNextToken(const char* value) { SetNextToken(value); return *this;}
private:
int m_maxResults;
bool m_maxResultsHasBeenSet;
Aws::Vector<PatchOrchestratorFilter> m_filters;
bool m_filtersHasBeenSet;
Aws::String m_nextToken;
bool m_nextTokenHasBeenSet;
};
} // namespace Model
} // namespace SSM
} // namespace Aws