/** * 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 SecretsManager { namespace Model { /** */ class ListSecretVersionIdsRequest : public SecretsManagerRequest { public: AWS_SECRETSMANAGER_API ListSecretVersionIdsRequest(); // 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 "ListSecretVersionIds"; } AWS_SECRETSMANAGER_API Aws::String SerializePayload() const override; AWS_SECRETSMANAGER_API Aws::Http::HeaderValueCollection GetRequestSpecificHeaders() const override; /** *

The ARN or name of the secret whose versions you want to list.

For an * ARN, we recommend that you specify a complete ARN rather than a partial ARN. See * Finding * a secret from a partial ARN.

*/ inline const Aws::String& GetSecretId() const{ return m_secretId; } /** *

The ARN or name of the secret whose versions you want to list.

For an * ARN, we recommend that you specify a complete ARN rather than a partial ARN. See * Finding * a secret from a partial ARN.

*/ inline bool SecretIdHasBeenSet() const { return m_secretIdHasBeenSet; } /** *

The ARN or name of the secret whose versions you want to list.

For an * ARN, we recommend that you specify a complete ARN rather than a partial ARN. See * Finding * a secret from a partial ARN.

*/ inline void SetSecretId(const Aws::String& value) { m_secretIdHasBeenSet = true; m_secretId = value; } /** *

The ARN or name of the secret whose versions you want to list.

For an * ARN, we recommend that you specify a complete ARN rather than a partial ARN. See * Finding * a secret from a partial ARN.

*/ inline void SetSecretId(Aws::String&& value) { m_secretIdHasBeenSet = true; m_secretId = std::move(value); } /** *

The ARN or name of the secret whose versions you want to list.

For an * ARN, we recommend that you specify a complete ARN rather than a partial ARN. See * Finding * a secret from a partial ARN.

*/ inline void SetSecretId(const char* value) { m_secretIdHasBeenSet = true; m_secretId.assign(value); } /** *

The ARN or name of the secret whose versions you want to list.

For an * ARN, we recommend that you specify a complete ARN rather than a partial ARN. See * Finding * a secret from a partial ARN.

*/ inline ListSecretVersionIdsRequest& WithSecretId(const Aws::String& value) { SetSecretId(value); return *this;} /** *

The ARN or name of the secret whose versions you want to list.

For an * ARN, we recommend that you specify a complete ARN rather than a partial ARN. See * Finding * a secret from a partial ARN.

*/ inline ListSecretVersionIdsRequest& WithSecretId(Aws::String&& value) { SetSecretId(std::move(value)); return *this;} /** *

The ARN or name of the secret whose versions you want to list.

For an * ARN, we recommend that you specify a complete ARN rather than a partial ARN. See * Finding * a secret from a partial ARN.

*/ inline ListSecretVersionIdsRequest& WithSecretId(const char* value) { SetSecretId(value); return *this;} /** *

The number of results to include in the response.

If there are more * results available, in the response, Secrets Manager includes * NextToken. To get the next results, call * ListSecretVersionIds again with the value from * NextToken.

*/ inline int GetMaxResults() const{ return m_maxResults; } /** *

The number of results to include in the response.

If there are more * results available, in the response, Secrets Manager includes * NextToken. To get the next results, call * ListSecretVersionIds again with the value from * NextToken.

*/ inline bool MaxResultsHasBeenSet() const { return m_maxResultsHasBeenSet; } /** *

The number of results to include in the response.

If there are more * results available, in the response, Secrets Manager includes * NextToken. To get the next results, call * ListSecretVersionIds again with the value from * NextToken.

*/ inline void SetMaxResults(int value) { m_maxResultsHasBeenSet = true; m_maxResults = value; } /** *

The number of results to include in the response.

If there are more * results available, in the response, Secrets Manager includes * NextToken. To get the next results, call * ListSecretVersionIds again with the value from * NextToken.

*/ inline ListSecretVersionIdsRequest& WithMaxResults(int value) { SetMaxResults(value); return *this;} /** *

A token that indicates where the output should continue from, if a previous * call did not show all results. To get the next results, call * ListSecretVersionIds again with this value.

*/ inline const Aws::String& GetNextToken() const{ return m_nextToken; } /** *

A token that indicates where the output should continue from, if a previous * call did not show all results. To get the next results, call * ListSecretVersionIds again with this value.

*/ inline bool NextTokenHasBeenSet() const { return m_nextTokenHasBeenSet; } /** *

A token that indicates where the output should continue from, if a previous * call did not show all results. To get the next results, call * ListSecretVersionIds again with this value.

*/ inline void SetNextToken(const Aws::String& value) { m_nextTokenHasBeenSet = true; m_nextToken = value; } /** *

A token that indicates where the output should continue from, if a previous * call did not show all results. To get the next results, call * ListSecretVersionIds again with this value.

*/ inline void SetNextToken(Aws::String&& value) { m_nextTokenHasBeenSet = true; m_nextToken = std::move(value); } /** *

A token that indicates where the output should continue from, if a previous * call did not show all results. To get the next results, call * ListSecretVersionIds again with this value.

*/ inline void SetNextToken(const char* value) { m_nextTokenHasBeenSet = true; m_nextToken.assign(value); } /** *

A token that indicates where the output should continue from, if a previous * call did not show all results. To get the next results, call * ListSecretVersionIds again with this value.

*/ inline ListSecretVersionIdsRequest& WithNextToken(const Aws::String& value) { SetNextToken(value); return *this;} /** *

A token that indicates where the output should continue from, if a previous * call did not show all results. To get the next results, call * ListSecretVersionIds again with this value.

*/ inline ListSecretVersionIdsRequest& WithNextToken(Aws::String&& value) { SetNextToken(std::move(value)); return *this;} /** *

A token that indicates where the output should continue from, if a previous * call did not show all results. To get the next results, call * ListSecretVersionIds again with this value.

*/ inline ListSecretVersionIdsRequest& WithNextToken(const char* value) { SetNextToken(value); return *this;} /** *

Specifies whether to include versions of secrets that don't have any staging * labels attached to them. Versions without staging labels are considered * deprecated and are subject to deletion by Secrets Manager. By default, versions * without staging labels aren't included.

*/ inline bool GetIncludeDeprecated() const{ return m_includeDeprecated; } /** *

Specifies whether to include versions of secrets that don't have any staging * labels attached to them. Versions without staging labels are considered * deprecated and are subject to deletion by Secrets Manager. By default, versions * without staging labels aren't included.

*/ inline bool IncludeDeprecatedHasBeenSet() const { return m_includeDeprecatedHasBeenSet; } /** *

Specifies whether to include versions of secrets that don't have any staging * labels attached to them. Versions without staging labels are considered * deprecated and are subject to deletion by Secrets Manager. By default, versions * without staging labels aren't included.

*/ inline void SetIncludeDeprecated(bool value) { m_includeDeprecatedHasBeenSet = true; m_includeDeprecated = value; } /** *

Specifies whether to include versions of secrets that don't have any staging * labels attached to them. Versions without staging labels are considered * deprecated and are subject to deletion by Secrets Manager. By default, versions * without staging labels aren't included.

*/ inline ListSecretVersionIdsRequest& WithIncludeDeprecated(bool value) { SetIncludeDeprecated(value); return *this;} private: Aws::String m_secretId; bool m_secretIdHasBeenSet = false; int m_maxResults; bool m_maxResultsHasBeenSet = false; Aws::String m_nextToken; bool m_nextTokenHasBeenSet = false; bool m_includeDeprecated; bool m_includeDeprecatedHasBeenSet = false; }; } // namespace Model } // namespace SecretsManager } // namespace Aws