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

Gets the names of key policies for the specified KMS key.

Specify the * key ID or key ARN of the KMS key.

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; } /** *

Gets the names of key policies for the specified KMS key.

Specify the * key ID or key ARN of the KMS key.

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; } /** *

Gets the names of key policies for the specified KMS key.

Specify the * key ID or key ARN of the KMS key.

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; } /** *

Gets the names of key policies for the specified KMS key.

Specify the * key ID or key ARN of the KMS key.

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); } /** *

Gets the names of key policies for the specified KMS key.

Specify the * key ID or key ARN of the KMS key.

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); } /** *

Gets the names of key policies for the specified KMS key.

Specify the * key ID or key ARN of the KMS key.

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 ListKeyPoliciesRequest& WithKeyId(const Aws::String& value) { SetKeyId(value); return *this;} /** *

Gets the names of key policies for the specified KMS key.

Specify the * key ID or key ARN of the KMS key.

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 ListKeyPoliciesRequest& WithKeyId(Aws::String&& value) { SetKeyId(std::move(value)); return *this;} /** *

Gets the names of key policies for the specified KMS key.

Specify the * key ID or key ARN of the KMS key.

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 ListKeyPoliciesRequest& WithKeyId(const char* value) { SetKeyId(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.

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

Only one policy can be attached to a key.

*/ 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 1000, inclusive. If you do not include a * value, it defaults to 100.

Only one policy can be attached to a key.

*/ 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 1000, inclusive. If you do not include a * value, it defaults to 100.

Only one policy can be attached to a key.

*/ 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 1000, inclusive. If you do not include a * value, it defaults to 100.

Only one policy can be attached to a key.

*/ inline ListKeyPoliciesRequest& 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 ListKeyPoliciesRequest& 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 ListKeyPoliciesRequest& 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 ListKeyPoliciesRequest& WithMarker(const char* value) { SetMarker(value); return *this;} private: Aws::String m_keyId; bool m_keyIdHasBeenSet = false; int m_limit; bool m_limitHasBeenSet = false; Aws::String m_marker; bool m_markerHasBeenSet = false; }; } // namespace Model } // namespace KMS } // namespace Aws