/** * 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 ListGrantsRequest : public KMSRequest { public: AWS_KMS_API ListGrantsRequest(); // 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 "ListGrants"; } 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 ListGrantsRequest& 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 ListGrantsRequest& 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 ListGrantsRequest& 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 ListGrantsRequest& WithMarker(const char* value) { SetMarker(value); return *this;} /** *

Returns only grants for the specified KMS key. This parameter is * required.

Specify the key ID or key ARN of the KMS key. To specify a KMS * key in a different Amazon Web Services account, you must use the key ARN.

*

For example:

  • Key ID: * 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: * arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab *

To get the key ID and key ARN for a KMS key, use * ListKeys or DescribeKey.

*/ inline const Aws::String& GetKeyId() const{ return m_keyId; } /** *

Returns only grants for the specified KMS key. This parameter is * required.

Specify the key ID or key ARN of the KMS key. To specify a KMS * key in a different Amazon Web Services account, you must use the key ARN.

*

For example:

  • Key ID: * 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: * arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab *

To get the key ID and key ARN for a KMS key, use * ListKeys or DescribeKey.

*/ inline bool KeyIdHasBeenSet() const { return m_keyIdHasBeenSet; } /** *

Returns only grants for the specified KMS key. This parameter is * required.

Specify the key ID or key ARN of the KMS key. To specify a KMS * key in a different Amazon Web Services account, you must use the key ARN.

*

For example:

  • Key ID: * 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: * arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab *

To get the key ID and key ARN for a KMS key, use * ListKeys or DescribeKey.

*/ inline void SetKeyId(const Aws::String& value) { m_keyIdHasBeenSet = true; m_keyId = value; } /** *

Returns only grants for the specified KMS key. This parameter is * required.

Specify the key ID or key ARN of the KMS key. To specify a KMS * key in a different Amazon Web Services account, you must use the key ARN.

*

For example:

  • Key ID: * 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: * arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab *

To get the key ID and key ARN for a KMS key, use * ListKeys or DescribeKey.

*/ inline void SetKeyId(Aws::String&& value) { m_keyIdHasBeenSet = true; m_keyId = std::move(value); } /** *

Returns only grants for the specified KMS key. This parameter is * required.

Specify the key ID or key ARN of the KMS key. To specify a KMS * key in a different Amazon Web Services account, you must use the key ARN.

*

For example:

  • Key ID: * 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: * arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab *

To get the key ID and key ARN for a KMS key, use * ListKeys or DescribeKey.

*/ inline void SetKeyId(const char* value) { m_keyIdHasBeenSet = true; m_keyId.assign(value); } /** *

Returns only grants for the specified KMS key. This parameter is * required.

Specify the key ID or key ARN of the KMS key. To specify a KMS * key in a different Amazon Web Services account, you must use the key ARN.

*

For example:

  • Key ID: * 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: * arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab *

To get the key ID and key ARN for a KMS key, use * ListKeys or DescribeKey.

*/ inline ListGrantsRequest& WithKeyId(const Aws::String& value) { SetKeyId(value); return *this;} /** *

Returns only grants for the specified KMS key. This parameter is * required.

Specify the key ID or key ARN of the KMS key. To specify a KMS * key in a different Amazon Web Services account, you must use the key ARN.

*

For example:

  • Key ID: * 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: * arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab *

To get the key ID and key ARN for a KMS key, use * ListKeys or DescribeKey.

*/ inline ListGrantsRequest& WithKeyId(Aws::String&& value) { SetKeyId(std::move(value)); return *this;} /** *

Returns only grants for the specified KMS key. This parameter is * required.

Specify the key ID or key ARN of the KMS key. To specify a KMS * key in a different Amazon Web Services account, you must use the key ARN.

*

For example:

  • Key ID: * 1234abcd-12ab-34cd-56ef-1234567890ab

  • Key ARN: * arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab *

To get the key ID and key ARN for a KMS key, use * ListKeys or DescribeKey.

*/ inline ListGrantsRequest& WithKeyId(const char* value) { SetKeyId(value); return *this;} /** *

Returns only the grant with the specified grant ID. The grant ID uniquely * identifies the grant.

*/ inline const Aws::String& GetGrantId() const{ return m_grantId; } /** *

Returns only the grant with the specified grant ID. The grant ID uniquely * identifies the grant.

*/ inline bool GrantIdHasBeenSet() const { return m_grantIdHasBeenSet; } /** *

Returns only the grant with the specified grant ID. The grant ID uniquely * identifies the grant.

*/ inline void SetGrantId(const Aws::String& value) { m_grantIdHasBeenSet = true; m_grantId = value; } /** *

Returns only the grant with the specified grant ID. The grant ID uniquely * identifies the grant.

*/ inline void SetGrantId(Aws::String&& value) { m_grantIdHasBeenSet = true; m_grantId = std::move(value); } /** *

Returns only the grant with the specified grant ID. The grant ID uniquely * identifies the grant.

*/ inline void SetGrantId(const char* value) { m_grantIdHasBeenSet = true; m_grantId.assign(value); } /** *

Returns only the grant with the specified grant ID. The grant ID uniquely * identifies the grant.

*/ inline ListGrantsRequest& WithGrantId(const Aws::String& value) { SetGrantId(value); return *this;} /** *

Returns only the grant with the specified grant ID. The grant ID uniquely * identifies the grant.

*/ inline ListGrantsRequest& WithGrantId(Aws::String&& value) { SetGrantId(std::move(value)); return *this;} /** *

Returns only the grant with the specified grant ID. The grant ID uniquely * identifies the grant.

*/ inline ListGrantsRequest& WithGrantId(const char* value) { SetGrantId(value); return *this;} /** *

Returns only grants where the specified principal is the grantee principal * for the grant.

*/ inline const Aws::String& GetGranteePrincipal() const{ return m_granteePrincipal; } /** *

Returns only grants where the specified principal is the grantee principal * for the grant.

*/ inline bool GranteePrincipalHasBeenSet() const { return m_granteePrincipalHasBeenSet; } /** *

Returns only grants where the specified principal is the grantee principal * for the grant.

*/ inline void SetGranteePrincipal(const Aws::String& value) { m_granteePrincipalHasBeenSet = true; m_granteePrincipal = value; } /** *

Returns only grants where the specified principal is the grantee principal * for the grant.

*/ inline void SetGranteePrincipal(Aws::String&& value) { m_granteePrincipalHasBeenSet = true; m_granteePrincipal = std::move(value); } /** *

Returns only grants where the specified principal is the grantee principal * for the grant.

*/ inline void SetGranteePrincipal(const char* value) { m_granteePrincipalHasBeenSet = true; m_granteePrincipal.assign(value); } /** *

Returns only grants where the specified principal is the grantee principal * for the grant.

*/ inline ListGrantsRequest& WithGranteePrincipal(const Aws::String& value) { SetGranteePrincipal(value); return *this;} /** *

Returns only grants where the specified principal is the grantee principal * for the grant.

*/ inline ListGrantsRequest& WithGranteePrincipal(Aws::String&& value) { SetGranteePrincipal(std::move(value)); return *this;} /** *

Returns only grants where the specified principal is the grantee principal * for the grant.

*/ inline ListGrantsRequest& WithGranteePrincipal(const char* value) { SetGranteePrincipal(value); return *this;} private: int m_limit; bool m_limitHasBeenSet = false; Aws::String m_marker; bool m_markerHasBeenSet = false; Aws::String m_keyId; bool m_keyIdHasBeenSet = false; Aws::String m_grantId; bool m_grantIdHasBeenSet = false; Aws::String m_granteePrincipal; bool m_granteePrincipalHasBeenSet = false; }; } // namespace Model } // namespace KMS } // namespace Aws