/** * 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 ListRetirableGrantsRequest : public KMSRequest { public: AWS_KMS_API ListRetirableGrantsRequest(); // 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 "ListRetirableGrants"; } AWS_KMS_API Aws::String SerializePayload() const override; AWS_KMS_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override; /** *

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.

This value is optional. If you include * a value, it must be between 1 and 100, inclusive. If you do not include a value, * it defaults to 50.

*/ 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.

This value is optional. If you include * a value, it must be between 1 and 100, inclusive. If you do not include a value, * it defaults to 50.

*/ 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.

This value is optional. If you include * a value, it must be between 1 and 100, inclusive. If you do not include a value, * it defaults to 50.

*/ 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.

This value is optional. If you include * a value, it must be between 1 and 100, inclusive. If you do not include a value, * it defaults to 50.

*/ inline ListRetirableGrantsRequest& 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 ListRetirableGrantsRequest& 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 ListRetirableGrantsRequest& 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 ListRetirableGrantsRequest& WithMarker(const char* value) { SetMarker(value); return *this;} /** *

The retiring principal for which to list grants. Enter a principal in your * Amazon Web Services account.

To specify the retiring principal, use the * Amazon * Resource Name (ARN) of an Amazon Web Services principal. Valid principals * include Amazon Web Services accounts, IAM users, IAM roles, federated users, and * assumed role users. For help with the ARN syntax for a principal, see IAM * ARNs in the Identity and Access Management User Guide .

*/ inline const Aws::String& GetRetiringPrincipal() const{ return m_retiringPrincipal; } /** *

The retiring principal for which to list grants. Enter a principal in your * Amazon Web Services account.

To specify the retiring principal, use the * Amazon * Resource Name (ARN) of an Amazon Web Services principal. Valid principals * include Amazon Web Services accounts, IAM users, IAM roles, federated users, and * assumed role users. For help with the ARN syntax for a principal, see IAM * ARNs in the Identity and Access Management User Guide .

*/ inline bool RetiringPrincipalHasBeenSet() const { return m_retiringPrincipalHasBeenSet; } /** *

The retiring principal for which to list grants. Enter a principal in your * Amazon Web Services account.

To specify the retiring principal, use the * Amazon * Resource Name (ARN) of an Amazon Web Services principal. Valid principals * include Amazon Web Services accounts, IAM users, IAM roles, federated users, and * assumed role users. For help with the ARN syntax for a principal, see IAM * ARNs in the Identity and Access Management User Guide .

*/ inline void SetRetiringPrincipal(const Aws::String& value) { m_retiringPrincipalHasBeenSet = true; m_retiringPrincipal = value; } /** *

The retiring principal for which to list grants. Enter a principal in your * Amazon Web Services account.

To specify the retiring principal, use the * Amazon * Resource Name (ARN) of an Amazon Web Services principal. Valid principals * include Amazon Web Services accounts, IAM users, IAM roles, federated users, and * assumed role users. For help with the ARN syntax for a principal, see IAM * ARNs in the Identity and Access Management User Guide .

*/ inline void SetRetiringPrincipal(Aws::String&& value) { m_retiringPrincipalHasBeenSet = true; m_retiringPrincipal = std::move(value); } /** *

The retiring principal for which to list grants. Enter a principal in your * Amazon Web Services account.

To specify the retiring principal, use the * Amazon * Resource Name (ARN) of an Amazon Web Services principal. Valid principals * include Amazon Web Services accounts, IAM users, IAM roles, federated users, and * assumed role users. For help with the ARN syntax for a principal, see IAM * ARNs in the Identity and Access Management User Guide .

*/ inline void SetRetiringPrincipal(const char* value) { m_retiringPrincipalHasBeenSet = true; m_retiringPrincipal.assign(value); } /** *

The retiring principal for which to list grants. Enter a principal in your * Amazon Web Services account.

To specify the retiring principal, use the * Amazon * Resource Name (ARN) of an Amazon Web Services principal. Valid principals * include Amazon Web Services accounts, IAM users, IAM roles, federated users, and * assumed role users. For help with the ARN syntax for a principal, see IAM * ARNs in the Identity and Access Management User Guide .

*/ inline ListRetirableGrantsRequest& WithRetiringPrincipal(const Aws::String& value) { SetRetiringPrincipal(value); return *this;} /** *

The retiring principal for which to list grants. Enter a principal in your * Amazon Web Services account.

To specify the retiring principal, use the * Amazon * Resource Name (ARN) of an Amazon Web Services principal. Valid principals * include Amazon Web Services accounts, IAM users, IAM roles, federated users, and * assumed role users. For help with the ARN syntax for a principal, see IAM * ARNs in the Identity and Access Management User Guide .

*/ inline ListRetirableGrantsRequest& WithRetiringPrincipal(Aws::String&& value) { SetRetiringPrincipal(std::move(value)); return *this;} /** *

The retiring principal for which to list grants. Enter a principal in your * Amazon Web Services account.

To specify the retiring principal, use the * Amazon * Resource Name (ARN) of an Amazon Web Services principal. Valid principals * include Amazon Web Services accounts, IAM users, IAM roles, federated users, and * assumed role users. For help with the ARN syntax for a principal, see IAM * ARNs in the Identity and Access Management User Guide .

*/ inline ListRetirableGrantsRequest& WithRetiringPrincipal(const char* value) { SetRetiringPrincipal(value); return *this;} private: int m_limit; bool m_limitHasBeenSet = false; Aws::String m_marker; bool m_markerHasBeenSet = false; Aws::String m_retiringPrincipal; bool m_retiringPrincipalHasBeenSet = false; }; } // namespace Model } // namespace KMS } // namespace Aws