AWS SDK for C++  1.9.104
AWS SDK for C++
Public Member Functions | List of all members
Aws::SecretsManager::Model::ListSecretVersionIdsRequest Class Reference

#include <ListSecretVersionIdsRequest.h>

+ Inheritance diagram for Aws::SecretsManager::Model::ListSecretVersionIdsRequest:

Public Member Functions

 ListSecretVersionIdsRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetSecretId () const
 
bool SecretIdHasBeenSet () const
 
void SetSecretId (const Aws::String &value)
 
void SetSecretId (Aws::String &&value)
 
void SetSecretId (const char *value)
 
ListSecretVersionIdsRequestWithSecretId (const Aws::String &value)
 
ListSecretVersionIdsRequestWithSecretId (Aws::String &&value)
 
ListSecretVersionIdsRequestWithSecretId (const char *value)
 
int GetMaxResults () const
 
bool MaxResultsHasBeenSet () const
 
void SetMaxResults (int value)
 
ListSecretVersionIdsRequestWithMaxResults (int value)
 
const Aws::StringGetNextToken () const
 
bool NextTokenHasBeenSet () const
 
void SetNextToken (const Aws::String &value)
 
void SetNextToken (Aws::String &&value)
 
void SetNextToken (const char *value)
 
ListSecretVersionIdsRequestWithNextToken (const Aws::String &value)
 
ListSecretVersionIdsRequestWithNextToken (Aws::String &&value)
 
ListSecretVersionIdsRequestWithNextToken (const char *value)
 
bool GetIncludeDeprecated () const
 
bool IncludeDeprecatedHasBeenSet () const
 
void SetIncludeDeprecated (bool value)
 
ListSecretVersionIdsRequestWithIncludeDeprecated (bool value)
 
- Public Member Functions inherited from Aws::SecretsManager::SecretsManagerRequest
virtual ~SecretsManagerRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Definition at line 21 of file ListSecretVersionIdsRequest.h.

Constructor & Destructor Documentation

◆ ListSecretVersionIdsRequest()

Aws::SecretsManager::Model::ListSecretVersionIdsRequest::ListSecretVersionIdsRequest ( )

Member Function Documentation

◆ GetIncludeDeprecated()

bool Aws::SecretsManager::Model::ListSecretVersionIdsRequest::GetIncludeDeprecated ( ) const
inline

(Optional) Specifies that you want the results to include versions that do not have any staging labels attached to them. Such versions are considered deprecated and are subject to deletion by Secrets Manager as needed.

Definition at line 345 of file ListSecretVersionIdsRequest.h.

◆ GetMaxResults()

int Aws::SecretsManager::Model::ListSecretVersionIdsRequest::GetMaxResults ( ) const
inline

(Optional) Limits the number of results you want to include in the response. If you don't include this parameter, it defaults to a value that's specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (isn't null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Secrets Manager might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

Definition at line 225 of file ListSecretVersionIdsRequest.h.

◆ GetNextToken()

const Aws::String& Aws::SecretsManager::Model::ListSecretVersionIdsRequest::GetNextToken ( ) const
inline

(Optional) Use this parameter in a request if you receive a NextToken response in a previous request indicating there's more output available. In a subsequent call, set it to the value of the previous call NextToken response to indicate where the output should continue from.

Definition at line 274 of file ListSecretVersionIdsRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::SecretsManager::Model::ListSecretVersionIdsRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

◆ GetSecretId()

const Aws::String& Aws::SecretsManager::Model::ListSecretVersionIdsRequest::GetSecretId ( ) const
inline

The identifier for the secret containing the versions you want to list. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.

If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t create secret names ending with a hyphen followed by six characters.

If you specify an incomplete ARN without the random suffix, and instead provide the 'friendly name', you must not include the random suffix. If you do include the random suffix added by Secrets Manager, you receive either a ResourceNotFoundException or an AccessDeniedException error, depending on your permissions.

Definition at line 57 of file ListSecretVersionIdsRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::SecretsManager::Model::ListSecretVersionIdsRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 30 of file ListSecretVersionIdsRequest.h.

◆ IncludeDeprecatedHasBeenSet()

bool Aws::SecretsManager::Model::ListSecretVersionIdsRequest::IncludeDeprecatedHasBeenSet ( ) const
inline

(Optional) Specifies that you want the results to include versions that do not have any staging labels attached to them. Such versions are considered deprecated and are subject to deletion by Secrets Manager as needed.

Definition at line 352 of file ListSecretVersionIdsRequest.h.

◆ MaxResultsHasBeenSet()

bool Aws::SecretsManager::Model::ListSecretVersionIdsRequest::MaxResultsHasBeenSet ( ) const
inline

(Optional) Limits the number of results you want to include in the response. If you don't include this parameter, it defaults to a value that's specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (isn't null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Secrets Manager might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

Definition at line 238 of file ListSecretVersionIdsRequest.h.

◆ NextTokenHasBeenSet()

bool Aws::SecretsManager::Model::ListSecretVersionIdsRequest::NextTokenHasBeenSet ( ) const
inline

(Optional) Use this parameter in a request if you receive a NextToken response in a previous request indicating there's more output available. In a subsequent call, set it to the value of the previous call NextToken response to indicate where the output should continue from.

Definition at line 283 of file ListSecretVersionIdsRequest.h.

◆ SecretIdHasBeenSet()

bool Aws::SecretsManager::Model::ListSecretVersionIdsRequest::SecretIdHasBeenSet ( ) const
inline

The identifier for the secret containing the versions you want to list. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.

If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t create secret names ending with a hyphen followed by six characters.

If you specify an incomplete ARN without the random suffix, and instead provide the 'friendly name', you must not include the random suffix. If you do include the random suffix added by Secrets Manager, you receive either a ResourceNotFoundException or an AccessDeniedException error, depending on your permissions.

Definition at line 79 of file ListSecretVersionIdsRequest.h.

◆ SerializePayload()

Aws::String Aws::SecretsManager::Model::ListSecretVersionIdsRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetIncludeDeprecated()

void Aws::SecretsManager::Model::ListSecretVersionIdsRequest::SetIncludeDeprecated ( bool  value)
inline

(Optional) Specifies that you want the results to include versions that do not have any staging labels attached to them. Such versions are considered deprecated and are subject to deletion by Secrets Manager as needed.

Definition at line 359 of file ListSecretVersionIdsRequest.h.

◆ SetMaxResults()

void Aws::SecretsManager::Model::ListSecretVersionIdsRequest::SetMaxResults ( int  value)
inline

(Optional) Limits the number of results you want to include in the response. If you don't include this parameter, it defaults to a value that's specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (isn't null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Secrets Manager might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

Definition at line 251 of file ListSecretVersionIdsRequest.h.

◆ SetNextToken() [1/3]

void Aws::SecretsManager::Model::ListSecretVersionIdsRequest::SetNextToken ( Aws::String &&  value)
inline

(Optional) Use this parameter in a request if you receive a NextToken response in a previous request indicating there's more output available. In a subsequent call, set it to the value of the previous call NextToken response to indicate where the output should continue from.

Definition at line 301 of file ListSecretVersionIdsRequest.h.

◆ SetNextToken() [2/3]

void Aws::SecretsManager::Model::ListSecretVersionIdsRequest::SetNextToken ( const Aws::String value)
inline

(Optional) Use this parameter in a request if you receive a NextToken response in a previous request indicating there's more output available. In a subsequent call, set it to the value of the previous call NextToken response to indicate where the output should continue from.

Definition at line 292 of file ListSecretVersionIdsRequest.h.

◆ SetNextToken() [3/3]

void Aws::SecretsManager::Model::ListSecretVersionIdsRequest::SetNextToken ( const char *  value)
inline

(Optional) Use this parameter in a request if you receive a NextToken response in a previous request indicating there's more output available. In a subsequent call, set it to the value of the previous call NextToken response to indicate where the output should continue from.

Definition at line 310 of file ListSecretVersionIdsRequest.h.

◆ SetSecretId() [1/3]

void Aws::SecretsManager::Model::ListSecretVersionIdsRequest::SetSecretId ( Aws::String &&  value)
inline

The identifier for the secret containing the versions you want to list. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.

If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t create secret names ending with a hyphen followed by six characters.

If you specify an incomplete ARN without the random suffix, and instead provide the 'friendly name', you must not include the random suffix. If you do include the random suffix added by Secrets Manager, you receive either a ResourceNotFoundException or an AccessDeniedException error, depending on your permissions.

Definition at line 123 of file ListSecretVersionIdsRequest.h.

◆ SetSecretId() [2/3]

void Aws::SecretsManager::Model::ListSecretVersionIdsRequest::SetSecretId ( const Aws::String value)
inline

The identifier for the secret containing the versions you want to list. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.

If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t create secret names ending with a hyphen followed by six characters.

If you specify an incomplete ARN without the random suffix, and instead provide the 'friendly name', you must not include the random suffix. If you do include the random suffix added by Secrets Manager, you receive either a ResourceNotFoundException or an AccessDeniedException error, depending on your permissions.

Definition at line 101 of file ListSecretVersionIdsRequest.h.

◆ SetSecretId() [3/3]

void Aws::SecretsManager::Model::ListSecretVersionIdsRequest::SetSecretId ( const char *  value)
inline

The identifier for the secret containing the versions you want to list. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.

If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t create secret names ending with a hyphen followed by six characters.

If you specify an incomplete ARN without the random suffix, and instead provide the 'friendly name', you must not include the random suffix. If you do include the random suffix added by Secrets Manager, you receive either a ResourceNotFoundException or an AccessDeniedException error, depending on your permissions.

Definition at line 145 of file ListSecretVersionIdsRequest.h.

◆ WithIncludeDeprecated()

ListSecretVersionIdsRequest& Aws::SecretsManager::Model::ListSecretVersionIdsRequest::WithIncludeDeprecated ( bool  value)
inline

(Optional) Specifies that you want the results to include versions that do not have any staging labels attached to them. Such versions are considered deprecated and are subject to deletion by Secrets Manager as needed.

Definition at line 366 of file ListSecretVersionIdsRequest.h.

◆ WithMaxResults()

ListSecretVersionIdsRequest& Aws::SecretsManager::Model::ListSecretVersionIdsRequest::WithMaxResults ( int  value)
inline

(Optional) Limits the number of results you want to include in the response. If you don't include this parameter, it defaults to a value that's specific to the operation. If additional items exist beyond the maximum you specify, the NextToken response element is present and has a value (isn't null). Include that value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that Secrets Manager might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

Definition at line 264 of file ListSecretVersionIdsRequest.h.

◆ WithNextToken() [1/3]

ListSecretVersionIdsRequest& Aws::SecretsManager::Model::ListSecretVersionIdsRequest::WithNextToken ( Aws::String &&  value)
inline

(Optional) Use this parameter in a request if you receive a NextToken response in a previous request indicating there's more output available. In a subsequent call, set it to the value of the previous call NextToken response to indicate where the output should continue from.

Definition at line 328 of file ListSecretVersionIdsRequest.h.

◆ WithNextToken() [2/3]

ListSecretVersionIdsRequest& Aws::SecretsManager::Model::ListSecretVersionIdsRequest::WithNextToken ( const Aws::String value)
inline

(Optional) Use this parameter in a request if you receive a NextToken response in a previous request indicating there's more output available. In a subsequent call, set it to the value of the previous call NextToken response to indicate where the output should continue from.

Definition at line 319 of file ListSecretVersionIdsRequest.h.

◆ WithNextToken() [3/3]

ListSecretVersionIdsRequest& Aws::SecretsManager::Model::ListSecretVersionIdsRequest::WithNextToken ( const char *  value)
inline

(Optional) Use this parameter in a request if you receive a NextToken response in a previous request indicating there's more output available. In a subsequent call, set it to the value of the previous call NextToken response to indicate where the output should continue from.

Definition at line 337 of file ListSecretVersionIdsRequest.h.

◆ WithSecretId() [1/3]

ListSecretVersionIdsRequest& Aws::SecretsManager::Model::ListSecretVersionIdsRequest::WithSecretId ( Aws::String &&  value)
inline

The identifier for the secret containing the versions you want to list. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.

If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t create secret names ending with a hyphen followed by six characters.

If you specify an incomplete ARN without the random suffix, and instead provide the 'friendly name', you must not include the random suffix. If you do include the random suffix added by Secrets Manager, you receive either a ResourceNotFoundException or an AccessDeniedException error, depending on your permissions.

Definition at line 189 of file ListSecretVersionIdsRequest.h.

◆ WithSecretId() [2/3]

ListSecretVersionIdsRequest& Aws::SecretsManager::Model::ListSecretVersionIdsRequest::WithSecretId ( const Aws::String value)
inline

The identifier for the secret containing the versions you want to list. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.

If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t create secret names ending with a hyphen followed by six characters.

If you specify an incomplete ARN without the random suffix, and instead provide the 'friendly name', you must not include the random suffix. If you do include the random suffix added by Secrets Manager, you receive either a ResourceNotFoundException or an AccessDeniedException error, depending on your permissions.

Definition at line 167 of file ListSecretVersionIdsRequest.h.

◆ WithSecretId() [3/3]

ListSecretVersionIdsRequest& Aws::SecretsManager::Model::ListSecretVersionIdsRequest::WithSecretId ( const char *  value)
inline

The identifier for the secret containing the versions you want to list. You can specify either the Amazon Resource Name (ARN) or the friendly name of the secret.

If you specify an ARN, we generally recommend that you specify a complete ARN. You can specify a partial ARN too—for example, if you don’t include the final hyphen and six random characters that Secrets Manager adds at the end of the ARN when you created the secret. A partial ARN match can work as long as it uniquely matches only one secret. However, if your secret has a name that ends in a hyphen followed by six characters (before Secrets Manager adds the hyphen and six characters to the ARN) and you try to use that as a partial ARN, then those characters cause Secrets Manager to assume that you’re specifying a complete ARN. This confusion can cause unexpected results. To avoid this situation, we recommend that you don’t create secret names ending with a hyphen followed by six characters.

If you specify an incomplete ARN without the random suffix, and instead provide the 'friendly name', you must not include the random suffix. If you do include the random suffix added by Secrets Manager, you receive either a ResourceNotFoundException or an AccessDeniedException error, depending on your permissions.

Definition at line 211 of file ListSecretVersionIdsRequest.h.


The documentation for this class was generated from the following file: