/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include #include namespace Aws { namespace EC2 { namespace Model { /** */ class DescribeKeyPairsRequest : public EC2Request { public: AWS_EC2_API DescribeKeyPairsRequest(); // 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 "DescribeKeyPairs"; } AWS_EC2_API Aws::String SerializePayload() const override; protected: AWS_EC2_API void DumpBodyToUrl(Aws::Http::URI& uri ) const override; public: /** *

The filters.

  • key-pair-id - The ID of the key * pair.

  • fingerprint - The fingerprint of the key * pair.

  • key-name - The name of the key pair.

    *
  • tag-key - The key of a tag assigned to the resource. * Use this filter to find all resources assigned a tag with a specific key, * regardless of the tag value.

  • tag:<key> - * The key/value combination of a tag assigned to the resource. Use the tag key in * the filter name and the tag value as the filter value. For example, to find all * resources that have a tag with the key Owner and the value * TeamA, specify tag:Owner for the filter name and * TeamA for the filter value.

*/ inline const Aws::Vector& GetFilters() const{ return m_filters; } /** *

The filters.

  • key-pair-id - The ID of the key * pair.

  • fingerprint - The fingerprint of the key * pair.

  • key-name - The name of the key pair.

    *
  • tag-key - The key of a tag assigned to the resource. * Use this filter to find all resources assigned a tag with a specific key, * regardless of the tag value.

  • tag:<key> - * The key/value combination of a tag assigned to the resource. Use the tag key in * the filter name and the tag value as the filter value. For example, to find all * resources that have a tag with the key Owner and the value * TeamA, specify tag:Owner for the filter name and * TeamA for the filter value.

*/ inline bool FiltersHasBeenSet() const { return m_filtersHasBeenSet; } /** *

The filters.

  • key-pair-id - The ID of the key * pair.

  • fingerprint - The fingerprint of the key * pair.

  • key-name - The name of the key pair.

    *
  • tag-key - The key of a tag assigned to the resource. * Use this filter to find all resources assigned a tag with a specific key, * regardless of the tag value.

  • tag:<key> - * The key/value combination of a tag assigned to the resource. Use the tag key in * the filter name and the tag value as the filter value. For example, to find all * resources that have a tag with the key Owner and the value * TeamA, specify tag:Owner for the filter name and * TeamA for the filter value.

*/ inline void SetFilters(const Aws::Vector& value) { m_filtersHasBeenSet = true; m_filters = value; } /** *

The filters.

  • key-pair-id - The ID of the key * pair.

  • fingerprint - The fingerprint of the key * pair.

  • key-name - The name of the key pair.

    *
  • tag-key - The key of a tag assigned to the resource. * Use this filter to find all resources assigned a tag with a specific key, * regardless of the tag value.

  • tag:<key> - * The key/value combination of a tag assigned to the resource. Use the tag key in * the filter name and the tag value as the filter value. For example, to find all * resources that have a tag with the key Owner and the value * TeamA, specify tag:Owner for the filter name and * TeamA for the filter value.

*/ inline void SetFilters(Aws::Vector&& value) { m_filtersHasBeenSet = true; m_filters = std::move(value); } /** *

The filters.

  • key-pair-id - The ID of the key * pair.

  • fingerprint - The fingerprint of the key * pair.

  • key-name - The name of the key pair.

    *
  • tag-key - The key of a tag assigned to the resource. * Use this filter to find all resources assigned a tag with a specific key, * regardless of the tag value.

  • tag:<key> - * The key/value combination of a tag assigned to the resource. Use the tag key in * the filter name and the tag value as the filter value. For example, to find all * resources that have a tag with the key Owner and the value * TeamA, specify tag:Owner for the filter name and * TeamA for the filter value.

*/ inline DescribeKeyPairsRequest& WithFilters(const Aws::Vector& value) { SetFilters(value); return *this;} /** *

The filters.

  • key-pair-id - The ID of the key * pair.

  • fingerprint - The fingerprint of the key * pair.

  • key-name - The name of the key pair.

    *
  • tag-key - The key of a tag assigned to the resource. * Use this filter to find all resources assigned a tag with a specific key, * regardless of the tag value.

  • tag:<key> - * The key/value combination of a tag assigned to the resource. Use the tag key in * the filter name and the tag value as the filter value. For example, to find all * resources that have a tag with the key Owner and the value * TeamA, specify tag:Owner for the filter name and * TeamA for the filter value.

*/ inline DescribeKeyPairsRequest& WithFilters(Aws::Vector&& value) { SetFilters(std::move(value)); return *this;} /** *

The filters.

  • key-pair-id - The ID of the key * pair.

  • fingerprint - The fingerprint of the key * pair.

  • key-name - The name of the key pair.

    *
  • tag-key - The key of a tag assigned to the resource. * Use this filter to find all resources assigned a tag with a specific key, * regardless of the tag value.

  • tag:<key> - * The key/value combination of a tag assigned to the resource. Use the tag key in * the filter name and the tag value as the filter value. For example, to find all * resources that have a tag with the key Owner and the value * TeamA, specify tag:Owner for the filter name and * TeamA for the filter value.

*/ inline DescribeKeyPairsRequest& AddFilters(const Filter& value) { m_filtersHasBeenSet = true; m_filters.push_back(value); return *this; } /** *

The filters.

  • key-pair-id - The ID of the key * pair.

  • fingerprint - The fingerprint of the key * pair.

  • key-name - The name of the key pair.

    *
  • tag-key - The key of a tag assigned to the resource. * Use this filter to find all resources assigned a tag with a specific key, * regardless of the tag value.

  • tag:<key> - * The key/value combination of a tag assigned to the resource. Use the tag key in * the filter name and the tag value as the filter value. For example, to find all * resources that have a tag with the key Owner and the value * TeamA, specify tag:Owner for the filter name and * TeamA for the filter value.

*/ inline DescribeKeyPairsRequest& AddFilters(Filter&& value) { m_filtersHasBeenSet = true; m_filters.push_back(std::move(value)); return *this; } /** *

The key pair names.

Default: Describes all of your key pairs.

*/ inline const Aws::Vector& GetKeyNames() const{ return m_keyNames; } /** *

The key pair names.

Default: Describes all of your key pairs.

*/ inline bool KeyNamesHasBeenSet() const { return m_keyNamesHasBeenSet; } /** *

The key pair names.

Default: Describes all of your key pairs.

*/ inline void SetKeyNames(const Aws::Vector& value) { m_keyNamesHasBeenSet = true; m_keyNames = value; } /** *

The key pair names.

Default: Describes all of your key pairs.

*/ inline void SetKeyNames(Aws::Vector&& value) { m_keyNamesHasBeenSet = true; m_keyNames = std::move(value); } /** *

The key pair names.

Default: Describes all of your key pairs.

*/ inline DescribeKeyPairsRequest& WithKeyNames(const Aws::Vector& value) { SetKeyNames(value); return *this;} /** *

The key pair names.

Default: Describes all of your key pairs.

*/ inline DescribeKeyPairsRequest& WithKeyNames(Aws::Vector&& value) { SetKeyNames(std::move(value)); return *this;} /** *

The key pair names.

Default: Describes all of your key pairs.

*/ inline DescribeKeyPairsRequest& AddKeyNames(const Aws::String& value) { m_keyNamesHasBeenSet = true; m_keyNames.push_back(value); return *this; } /** *

The key pair names.

Default: Describes all of your key pairs.

*/ inline DescribeKeyPairsRequest& AddKeyNames(Aws::String&& value) { m_keyNamesHasBeenSet = true; m_keyNames.push_back(std::move(value)); return *this; } /** *

The key pair names.

Default: Describes all of your key pairs.

*/ inline DescribeKeyPairsRequest& AddKeyNames(const char* value) { m_keyNamesHasBeenSet = true; m_keyNames.push_back(value); return *this; } /** *

The IDs of the key pairs.

*/ inline const Aws::Vector& GetKeyPairIds() const{ return m_keyPairIds; } /** *

The IDs of the key pairs.

*/ inline bool KeyPairIdsHasBeenSet() const { return m_keyPairIdsHasBeenSet; } /** *

The IDs of the key pairs.

*/ inline void SetKeyPairIds(const Aws::Vector& value) { m_keyPairIdsHasBeenSet = true; m_keyPairIds = value; } /** *

The IDs of the key pairs.

*/ inline void SetKeyPairIds(Aws::Vector&& value) { m_keyPairIdsHasBeenSet = true; m_keyPairIds = std::move(value); } /** *

The IDs of the key pairs.

*/ inline DescribeKeyPairsRequest& WithKeyPairIds(const Aws::Vector& value) { SetKeyPairIds(value); return *this;} /** *

The IDs of the key pairs.

*/ inline DescribeKeyPairsRequest& WithKeyPairIds(Aws::Vector&& value) { SetKeyPairIds(std::move(value)); return *this;} /** *

The IDs of the key pairs.

*/ inline DescribeKeyPairsRequest& AddKeyPairIds(const Aws::String& value) { m_keyPairIdsHasBeenSet = true; m_keyPairIds.push_back(value); return *this; } /** *

The IDs of the key pairs.

*/ inline DescribeKeyPairsRequest& AddKeyPairIds(Aws::String&& value) { m_keyPairIdsHasBeenSet = true; m_keyPairIds.push_back(std::move(value)); return *this; } /** *

The IDs of the key pairs.

*/ inline DescribeKeyPairsRequest& AddKeyPairIds(const char* value) { m_keyPairIdsHasBeenSet = true; m_keyPairIds.push_back(value); return *this; } /** *

Checks whether you have the required permissions for the action, without * actually making the request, and provides an error response. If you have the * required permissions, the error response is DryRunOperation. * Otherwise, it is UnauthorizedOperation.

*/ inline bool GetDryRun() const{ return m_dryRun; } /** *

Checks whether you have the required permissions for the action, without * actually making the request, and provides an error response. If you have the * required permissions, the error response is DryRunOperation. * Otherwise, it is UnauthorizedOperation.

*/ inline bool DryRunHasBeenSet() const { return m_dryRunHasBeenSet; } /** *

Checks whether you have the required permissions for the action, without * actually making the request, and provides an error response. If you have the * required permissions, the error response is DryRunOperation. * Otherwise, it is UnauthorizedOperation.

*/ inline void SetDryRun(bool value) { m_dryRunHasBeenSet = true; m_dryRun = value; } /** *

Checks whether you have the required permissions for the action, without * actually making the request, and provides an error response. If you have the * required permissions, the error response is DryRunOperation. * Otherwise, it is UnauthorizedOperation.

*/ inline DescribeKeyPairsRequest& WithDryRun(bool value) { SetDryRun(value); return *this;} /** *

If true, the public key material is included in the * response.

Default: false

*/ inline bool GetIncludePublicKey() const{ return m_includePublicKey; } /** *

If true, the public key material is included in the * response.

Default: false

*/ inline bool IncludePublicKeyHasBeenSet() const { return m_includePublicKeyHasBeenSet; } /** *

If true, the public key material is included in the * response.

Default: false

*/ inline void SetIncludePublicKey(bool value) { m_includePublicKeyHasBeenSet = true; m_includePublicKey = value; } /** *

If true, the public key material is included in the * response.

Default: false

*/ inline DescribeKeyPairsRequest& WithIncludePublicKey(bool value) { SetIncludePublicKey(value); return *this;} private: Aws::Vector m_filters; bool m_filtersHasBeenSet = false; Aws::Vector m_keyNames; bool m_keyNamesHasBeenSet = false; Aws::Vector m_keyPairIds; bool m_keyPairIdsHasBeenSet = false; bool m_dryRun; bool m_dryRunHasBeenSet = false; bool m_includePublicKey; bool m_includePublicKeyHasBeenSet = false; }; } // namespace Model } // namespace EC2 } // namespace Aws