/** * 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 KMS { namespace Model { /** */ class DescribeCustomKeyStoresRequest : public KMSRequest { public: AWS_KMS_API DescribeCustomKeyStoresRequest(); // 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 "DescribeCustomKeyStores"; } AWS_KMS_API Aws::String SerializePayload() const override; AWS_KMS_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override; /** *

Gets only information about the specified custom key store. Enter the key * store ID.

By default, this operation gets information about all custom * key stores in the account and Region. To limit the output to a particular custom * key store, provide either the CustomKeyStoreId or * CustomKeyStoreName parameter, but not both.

*/ inline const Aws::String& GetCustomKeyStoreId() const{ return m_customKeyStoreId; } /** *

Gets only information about the specified custom key store. Enter the key * store ID.

By default, this operation gets information about all custom * key stores in the account and Region. To limit the output to a particular custom * key store, provide either the CustomKeyStoreId or * CustomKeyStoreName parameter, but not both.

*/ inline bool CustomKeyStoreIdHasBeenSet() const { return m_customKeyStoreIdHasBeenSet; } /** *

Gets only information about the specified custom key store. Enter the key * store ID.

By default, this operation gets information about all custom * key stores in the account and Region. To limit the output to a particular custom * key store, provide either the CustomKeyStoreId or * CustomKeyStoreName parameter, but not both.

*/ inline void SetCustomKeyStoreId(const Aws::String& value) { m_customKeyStoreIdHasBeenSet = true; m_customKeyStoreId = value; } /** *

Gets only information about the specified custom key store. Enter the key * store ID.

By default, this operation gets information about all custom * key stores in the account and Region. To limit the output to a particular custom * key store, provide either the CustomKeyStoreId or * CustomKeyStoreName parameter, but not both.

*/ inline void SetCustomKeyStoreId(Aws::String&& value) { m_customKeyStoreIdHasBeenSet = true; m_customKeyStoreId = std::move(value); } /** *

Gets only information about the specified custom key store. Enter the key * store ID.

By default, this operation gets information about all custom * key stores in the account and Region. To limit the output to a particular custom * key store, provide either the CustomKeyStoreId or * CustomKeyStoreName parameter, but not both.

*/ inline void SetCustomKeyStoreId(const char* value) { m_customKeyStoreIdHasBeenSet = true; m_customKeyStoreId.assign(value); } /** *

Gets only information about the specified custom key store. Enter the key * store ID.

By default, this operation gets information about all custom * key stores in the account and Region. To limit the output to a particular custom * key store, provide either the CustomKeyStoreId or * CustomKeyStoreName parameter, but not both.

*/ inline DescribeCustomKeyStoresRequest& WithCustomKeyStoreId(const Aws::String& value) { SetCustomKeyStoreId(value); return *this;} /** *

Gets only information about the specified custom key store. Enter the key * store ID.

By default, this operation gets information about all custom * key stores in the account and Region. To limit the output to a particular custom * key store, provide either the CustomKeyStoreId or * CustomKeyStoreName parameter, but not both.

*/ inline DescribeCustomKeyStoresRequest& WithCustomKeyStoreId(Aws::String&& value) { SetCustomKeyStoreId(std::move(value)); return *this;} /** *

Gets only information about the specified custom key store. Enter the key * store ID.

By default, this operation gets information about all custom * key stores in the account and Region. To limit the output to a particular custom * key store, provide either the CustomKeyStoreId or * CustomKeyStoreName parameter, but not both.

*/ inline DescribeCustomKeyStoresRequest& WithCustomKeyStoreId(const char* value) { SetCustomKeyStoreId(value); return *this;} /** *

Gets only information about the specified custom key store. Enter the * friendly name of the custom key store.

By default, this operation gets * information about all custom key stores in the account and Region. To limit the * output to a particular custom key store, provide either the * CustomKeyStoreId or CustomKeyStoreName parameter, but * not both.

*/ inline const Aws::String& GetCustomKeyStoreName() const{ return m_customKeyStoreName; } /** *

Gets only information about the specified custom key store. Enter the * friendly name of the custom key store.

By default, this operation gets * information about all custom key stores in the account and Region. To limit the * output to a particular custom key store, provide either the * CustomKeyStoreId or CustomKeyStoreName parameter, but * not both.

*/ inline bool CustomKeyStoreNameHasBeenSet() const { return m_customKeyStoreNameHasBeenSet; } /** *

Gets only information about the specified custom key store. Enter the * friendly name of the custom key store.

By default, this operation gets * information about all custom key stores in the account and Region. To limit the * output to a particular custom key store, provide either the * CustomKeyStoreId or CustomKeyStoreName parameter, but * not both.

*/ inline void SetCustomKeyStoreName(const Aws::String& value) { m_customKeyStoreNameHasBeenSet = true; m_customKeyStoreName = value; } /** *

Gets only information about the specified custom key store. Enter the * friendly name of the custom key store.

By default, this operation gets * information about all custom key stores in the account and Region. To limit the * output to a particular custom key store, provide either the * CustomKeyStoreId or CustomKeyStoreName parameter, but * not both.

*/ inline void SetCustomKeyStoreName(Aws::String&& value) { m_customKeyStoreNameHasBeenSet = true; m_customKeyStoreName = std::move(value); } /** *

Gets only information about the specified custom key store. Enter the * friendly name of the custom key store.

By default, this operation gets * information about all custom key stores in the account and Region. To limit the * output to a particular custom key store, provide either the * CustomKeyStoreId or CustomKeyStoreName parameter, but * not both.

*/ inline void SetCustomKeyStoreName(const char* value) { m_customKeyStoreNameHasBeenSet = true; m_customKeyStoreName.assign(value); } /** *

Gets only information about the specified custom key store. Enter the * friendly name of the custom key store.

By default, this operation gets * information about all custom key stores in the account and Region. To limit the * output to a particular custom key store, provide either the * CustomKeyStoreId or CustomKeyStoreName parameter, but * not both.

*/ inline DescribeCustomKeyStoresRequest& WithCustomKeyStoreName(const Aws::String& value) { SetCustomKeyStoreName(value); return *this;} /** *

Gets only information about the specified custom key store. Enter the * friendly name of the custom key store.

By default, this operation gets * information about all custom key stores in the account and Region. To limit the * output to a particular custom key store, provide either the * CustomKeyStoreId or CustomKeyStoreName parameter, but * not both.

*/ inline DescribeCustomKeyStoresRequest& WithCustomKeyStoreName(Aws::String&& value) { SetCustomKeyStoreName(std::move(value)); return *this;} /** *

Gets only information about the specified custom key store. Enter the * friendly name of the custom key store.

By default, this operation gets * information about all custom key stores in the account and Region. To limit the * output to a particular custom key store, provide either the * CustomKeyStoreId or CustomKeyStoreName parameter, but * not both.

*/ inline DescribeCustomKeyStoresRequest& WithCustomKeyStoreName(const char* value) { SetCustomKeyStoreName(value); return *this;} /** *

Use this parameter to specify the maximum number of items to return. When * this value is present, KMS does not return more than the specified number of * items, but it might return fewer.

*/ inline int GetLimit() const{ return m_limit; } /** *

Use this parameter to specify the maximum number of items to return. When * this value is present, KMS does not return more than the specified number of * items, but it might return fewer.

*/ inline bool LimitHasBeenSet() const { return m_limitHasBeenSet; } /** *

Use this parameter to specify the maximum number of items to return. When * this value is present, KMS does not return more than the specified number of * items, but it might return fewer.

*/ inline void SetLimit(int value) { m_limitHasBeenSet = true; m_limit = value; } /** *

Use this parameter to specify the maximum number of items to return. When * this value is present, KMS does not return more than the specified number of * items, but it might return fewer.

*/ inline DescribeCustomKeyStoresRequest& WithLimit(int value) { SetLimit(value); return *this;} /** *

Use this parameter in a subsequent request after you receive a response with * truncated results. Set it to the value of NextMarker from the * truncated response you just received.

*/ inline const Aws::String& GetMarker() const{ return m_marker; } /** *

Use this parameter in a subsequent request after you receive a response with * truncated results. Set it to the value of NextMarker from the * truncated response you just received.

*/ inline bool MarkerHasBeenSet() const { return m_markerHasBeenSet; } /** *

Use this parameter in a subsequent request after you receive a response with * truncated results. Set it to the value of NextMarker from the * truncated response you just received.

*/ inline void SetMarker(const Aws::String& value) { m_markerHasBeenSet = true; m_marker = value; } /** *

Use this parameter in a subsequent request after you receive a response with * truncated results. Set it to the value of NextMarker from the * truncated response you just received.

*/ inline void SetMarker(Aws::String&& value) { m_markerHasBeenSet = true; m_marker = std::move(value); } /** *

Use this parameter in a subsequent request after you receive a response with * truncated results. Set it to the value of NextMarker from the * truncated response you just received.

*/ inline void SetMarker(const char* value) { m_markerHasBeenSet = true; m_marker.assign(value); } /** *

Use this parameter in a subsequent request after you receive a response with * truncated results. Set it to the value of NextMarker from the * truncated response you just received.

*/ inline DescribeCustomKeyStoresRequest& WithMarker(const Aws::String& value) { SetMarker(value); return *this;} /** *

Use this parameter in a subsequent request after you receive a response with * truncated results. Set it to the value of NextMarker from the * truncated response you just received.

*/ inline DescribeCustomKeyStoresRequest& WithMarker(Aws::String&& value) { SetMarker(std::move(value)); return *this;} /** *

Use this parameter in a subsequent request after you receive a response with * truncated results. Set it to the value of NextMarker from the * truncated response you just received.

*/ inline DescribeCustomKeyStoresRequest& WithMarker(const char* value) { SetMarker(value); return *this;} private: Aws::String m_customKeyStoreId; bool m_customKeyStoreIdHasBeenSet = false; Aws::String m_customKeyStoreName; bool m_customKeyStoreNameHasBeenSet = false; int m_limit; bool m_limitHasBeenSet = false; Aws::String m_marker; bool m_markerHasBeenSet = false; }; } // namespace Model } // namespace KMS } // namespace Aws