AWS SDK for C++  1.9.18
AWS SDK for C++
Public Member Functions | List of all members
Aws::SSM::Model::GetParametersByPathRequest Class Reference

#include <GetParametersByPathRequest.h>

+ Inheritance diagram for Aws::SSM::Model::GetParametersByPathRequest:

Public Member Functions

 GetParametersByPathRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetPath () const
 
bool PathHasBeenSet () const
 
void SetPath (const Aws::String &value)
 
void SetPath (Aws::String &&value)
 
void SetPath (const char *value)
 
GetParametersByPathRequestWithPath (const Aws::String &value)
 
GetParametersByPathRequestWithPath (Aws::String &&value)
 
GetParametersByPathRequestWithPath (const char *value)
 
bool GetRecursive () const
 
bool RecursiveHasBeenSet () const
 
void SetRecursive (bool value)
 
GetParametersByPathRequestWithRecursive (bool value)
 
const Aws::Vector< ParameterStringFilter > & GetParameterFilters () const
 
bool ParameterFiltersHasBeenSet () const
 
void SetParameterFilters (const Aws::Vector< ParameterStringFilter > &value)
 
void SetParameterFilters (Aws::Vector< ParameterStringFilter > &&value)
 
GetParametersByPathRequestWithParameterFilters (const Aws::Vector< ParameterStringFilter > &value)
 
GetParametersByPathRequestWithParameterFilters (Aws::Vector< ParameterStringFilter > &&value)
 
GetParametersByPathRequestAddParameterFilters (const ParameterStringFilter &value)
 
GetParametersByPathRequestAddParameterFilters (ParameterStringFilter &&value)
 
bool GetWithDecryption () const
 
bool WithDecryptionHasBeenSet () const
 
void SetWithDecryption (bool value)
 
GetParametersByPathRequestWithWithDecryption (bool value)
 
int GetMaxResults () const
 
bool MaxResultsHasBeenSet () const
 
void SetMaxResults (int value)
 
GetParametersByPathRequestWithMaxResults (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)
 
GetParametersByPathRequestWithNextToken (const Aws::String &value)
 
GetParametersByPathRequestWithNextToken (Aws::String &&value)
 
GetParametersByPathRequestWithNextToken (const char *value)
 
- Public Member Functions inherited from Aws::SSM::SSMRequest
virtual ~SSMRequest ()
 
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 23 of file GetParametersByPathRequest.h.

Constructor & Destructor Documentation

◆ GetParametersByPathRequest()

Aws::SSM::Model::GetParametersByPathRequest::GetParametersByPathRequest ( )

Member Function Documentation

◆ AddParameterFilters() [1/2]

GetParametersByPathRequest& Aws::SSM::Model::GetParametersByPathRequest::AddParameterFilters ( const ParameterStringFilter value)
inline

Filters to limit the request results.

For GetParametersByPath, the following filter Key names are supported: Type, KeyId, Label, and DataType.

The following Key values are not supported for GetParametersByPath: tag, Name, Path, and Tier.

Definition at line 233 of file GetParametersByPathRequest.h.

◆ AddParameterFilters() [2/2]

GetParametersByPathRequest& Aws::SSM::Model::GetParametersByPathRequest::AddParameterFilters ( ParameterStringFilter &&  value)
inline

Filters to limit the request results.

For GetParametersByPath, the following filter Key names are supported: Type, KeyId, Label, and DataType.

The following Key values are not supported for GetParametersByPath: tag, Name, Path, and Tier.

Definition at line 243 of file GetParametersByPathRequest.h.

◆ GetMaxResults()

int Aws::SSM::Model::GetParametersByPathRequest::GetMaxResults ( ) const
inline

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

Definition at line 272 of file GetParametersByPathRequest.h.

◆ GetNextToken()

const Aws::String& Aws::SSM::Model::GetParametersByPathRequest::GetNextToken ( ) const
inline

A token to start the list. Use this token to get the next set of results.

Definition at line 300 of file GetParametersByPathRequest.h.

◆ GetParameterFilters()

const Aws::Vector<ParameterStringFilter>& Aws::SSM::Model::GetParametersByPathRequest::GetParameterFilters ( ) const
inline

Filters to limit the request results.

For GetParametersByPath, the following filter Key names are supported: Type, KeyId, Label, and DataType.

The following Key values are not supported for GetParametersByPath: tag, Name, Path, and Tier.

Definition at line 173 of file GetParametersByPathRequest.h.

◆ GetPath()

const Aws::String& Aws::SSM::Model::GetParametersByPathRequest::GetPath ( ) const
inline

The hierarchy for the parameter. Hierarchies start with a forward slash (/). The hierachy is the parameter name except the last part of the parameter. For the API call to succeeed, the last part of the parameter name cannot be in the path. A parameter name hierarchy can have a maximum of 15 levels. Here is an example of a hierarchy: /Finance/Prod/IAD/WinServ2016/license33

Definition at line 47 of file GetParametersByPathRequest.h.

◆ GetRecursive()

bool Aws::SSM::Model::GetParametersByPathRequest::GetRecursive ( ) const
inline

Retrieve all parameters within a hierarchy.

If a user has access to a path, then the user can access all levels of that path. For example, if a user has permission to access path /a, then the user can also access /a/b. Even if a user has explicitly been denied access in IAM for parameter /a/b, they can still call the GetParametersByPath API action recursively for /a and view /a/b.

Definition at line 129 of file GetParametersByPathRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::SSM::Model::GetParametersByPathRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

Reimplemented from Aws::SSM::SSMRequest.

◆ GetServiceRequestName()

virtual const char* Aws::SSM::Model::GetParametersByPathRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 32 of file GetParametersByPathRequest.h.

◆ GetWithDecryption()

bool Aws::SSM::Model::GetParametersByPathRequest::GetWithDecryption ( ) const
inline

Retrieve all parameters in a hierarchy with their value decrypted.

Definition at line 249 of file GetParametersByPathRequest.h.

◆ MaxResultsHasBeenSet()

bool Aws::SSM::Model::GetParametersByPathRequest::MaxResultsHasBeenSet ( ) const
inline

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

Definition at line 279 of file GetParametersByPathRequest.h.

◆ NextTokenHasBeenSet()

bool Aws::SSM::Model::GetParametersByPathRequest::NextTokenHasBeenSet ( ) const
inline

A token to start the list. Use this token to get the next set of results.

Definition at line 306 of file GetParametersByPathRequest.h.

◆ ParameterFiltersHasBeenSet()

bool Aws::SSM::Model::GetParametersByPathRequest::ParameterFiltersHasBeenSet ( ) const
inline

Filters to limit the request results.

For GetParametersByPath, the following filter Key names are supported: Type, KeyId, Label, and DataType.

The following Key values are not supported for GetParametersByPath: tag, Name, Path, and Tier.

Definition at line 183 of file GetParametersByPathRequest.h.

◆ PathHasBeenSet()

bool Aws::SSM::Model::GetParametersByPathRequest::PathHasBeenSet ( ) const
inline

The hierarchy for the parameter. Hierarchies start with a forward slash (/). The hierachy is the parameter name except the last part of the parameter. For the API call to succeeed, the last part of the parameter name cannot be in the path. A parameter name hierarchy can have a maximum of 15 levels. Here is an example of a hierarchy: /Finance/Prod/IAD/WinServ2016/license33

Definition at line 57 of file GetParametersByPathRequest.h.

◆ RecursiveHasBeenSet()

bool Aws::SSM::Model::GetParametersByPathRequest::RecursiveHasBeenSet ( ) const
inline

Retrieve all parameters within a hierarchy.

If a user has access to a path, then the user can access all levels of that path. For example, if a user has permission to access path /a, then the user can also access /a/b. Even if a user has explicitly been denied access in IAM for parameter /a/b, they can still call the GetParametersByPath API action recursively for /a and view /a/b.

Definition at line 140 of file GetParametersByPathRequest.h.

◆ SerializePayload()

Aws::String Aws::SSM::Model::GetParametersByPathRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetMaxResults()

void Aws::SSM::Model::GetParametersByPathRequest::SetMaxResults ( int  value)
inline

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

Definition at line 286 of file GetParametersByPathRequest.h.

◆ SetNextToken() [1/3]

void Aws::SSM::Model::GetParametersByPathRequest::SetNextToken ( Aws::String &&  value)
inline

A token to start the list. Use this token to get the next set of results.

Definition at line 318 of file GetParametersByPathRequest.h.

◆ SetNextToken() [2/3]

void Aws::SSM::Model::GetParametersByPathRequest::SetNextToken ( const Aws::String value)
inline

A token to start the list. Use this token to get the next set of results.

Definition at line 312 of file GetParametersByPathRequest.h.

◆ SetNextToken() [3/3]

void Aws::SSM::Model::GetParametersByPathRequest::SetNextToken ( const char *  value)
inline

A token to start the list. Use this token to get the next set of results.

Definition at line 324 of file GetParametersByPathRequest.h.

◆ SetParameterFilters() [1/2]

void Aws::SSM::Model::GetParametersByPathRequest::SetParameterFilters ( Aws::Vector< ParameterStringFilter > &&  value)
inline

Filters to limit the request results.

For GetParametersByPath, the following filter Key names are supported: Type, KeyId, Label, and DataType.

The following Key values are not supported for GetParametersByPath: tag, Name, Path, and Tier.

Definition at line 203 of file GetParametersByPathRequest.h.

◆ SetParameterFilters() [2/2]

void Aws::SSM::Model::GetParametersByPathRequest::SetParameterFilters ( const Aws::Vector< ParameterStringFilter > &  value)
inline

Filters to limit the request results.

For GetParametersByPath, the following filter Key names are supported: Type, KeyId, Label, and DataType.

The following Key values are not supported for GetParametersByPath: tag, Name, Path, and Tier.

Definition at line 193 of file GetParametersByPathRequest.h.

◆ SetPath() [1/3]

void Aws::SSM::Model::GetParametersByPathRequest::SetPath ( Aws::String &&  value)
inline

The hierarchy for the parameter. Hierarchies start with a forward slash (/). The hierachy is the parameter name except the last part of the parameter. For the API call to succeeed, the last part of the parameter name cannot be in the path. A parameter name hierarchy can have a maximum of 15 levels. Here is an example of a hierarchy: /Finance/Prod/IAD/WinServ2016/license33

Definition at line 77 of file GetParametersByPathRequest.h.

◆ SetPath() [2/3]

void Aws::SSM::Model::GetParametersByPathRequest::SetPath ( const Aws::String value)
inline

The hierarchy for the parameter. Hierarchies start with a forward slash (/). The hierachy is the parameter name except the last part of the parameter. For the API call to succeeed, the last part of the parameter name cannot be in the path. A parameter name hierarchy can have a maximum of 15 levels. Here is an example of a hierarchy: /Finance/Prod/IAD/WinServ2016/license33

Definition at line 67 of file GetParametersByPathRequest.h.

◆ SetPath() [3/3]

void Aws::SSM::Model::GetParametersByPathRequest::SetPath ( const char *  value)
inline

The hierarchy for the parameter. Hierarchies start with a forward slash (/). The hierachy is the parameter name except the last part of the parameter. For the API call to succeeed, the last part of the parameter name cannot be in the path. A parameter name hierarchy can have a maximum of 15 levels. Here is an example of a hierarchy: /Finance/Prod/IAD/WinServ2016/license33

Definition at line 87 of file GetParametersByPathRequest.h.

◆ SetRecursive()

void Aws::SSM::Model::GetParametersByPathRequest::SetRecursive ( bool  value)
inline

Retrieve all parameters within a hierarchy.

If a user has access to a path, then the user can access all levels of that path. For example, if a user has permission to access path /a, then the user can also access /a/b. Even if a user has explicitly been denied access in IAM for parameter /a/b, they can still call the GetParametersByPath API action recursively for /a and view /a/b.

Definition at line 151 of file GetParametersByPathRequest.h.

◆ SetWithDecryption()

void Aws::SSM::Model::GetParametersByPathRequest::SetWithDecryption ( bool  value)
inline

Retrieve all parameters in a hierarchy with their value decrypted.

Definition at line 259 of file GetParametersByPathRequest.h.

◆ WithDecryptionHasBeenSet()

bool Aws::SSM::Model::GetParametersByPathRequest::WithDecryptionHasBeenSet ( ) const
inline

Retrieve all parameters in a hierarchy with their value decrypted.

Definition at line 254 of file GetParametersByPathRequest.h.

◆ WithMaxResults()

GetParametersByPathRequest& Aws::SSM::Model::GetParametersByPathRequest::WithMaxResults ( int  value)
inline

The maximum number of items to return for this call. The call also returns a token that you can specify in a subsequent call to get the next set of results.

Definition at line 293 of file GetParametersByPathRequest.h.

◆ WithNextToken() [1/3]

GetParametersByPathRequest& Aws::SSM::Model::GetParametersByPathRequest::WithNextToken ( Aws::String &&  value)
inline

A token to start the list. Use this token to get the next set of results.

Definition at line 336 of file GetParametersByPathRequest.h.

◆ WithNextToken() [2/3]

GetParametersByPathRequest& Aws::SSM::Model::GetParametersByPathRequest::WithNextToken ( const Aws::String value)
inline

A token to start the list. Use this token to get the next set of results.

Definition at line 330 of file GetParametersByPathRequest.h.

◆ WithNextToken() [3/3]

GetParametersByPathRequest& Aws::SSM::Model::GetParametersByPathRequest::WithNextToken ( const char *  value)
inline

A token to start the list. Use this token to get the next set of results.

Definition at line 342 of file GetParametersByPathRequest.h.

◆ WithParameterFilters() [1/2]

GetParametersByPathRequest& Aws::SSM::Model::GetParametersByPathRequest::WithParameterFilters ( Aws::Vector< ParameterStringFilter > &&  value)
inline

Filters to limit the request results.

For GetParametersByPath, the following filter Key names are supported: Type, KeyId, Label, and DataType.

The following Key values are not supported for GetParametersByPath: tag, Name, Path, and Tier.

Definition at line 223 of file GetParametersByPathRequest.h.

◆ WithParameterFilters() [2/2]

GetParametersByPathRequest& Aws::SSM::Model::GetParametersByPathRequest::WithParameterFilters ( const Aws::Vector< ParameterStringFilter > &  value)
inline

Filters to limit the request results.

For GetParametersByPath, the following filter Key names are supported: Type, KeyId, Label, and DataType.

The following Key values are not supported for GetParametersByPath: tag, Name, Path, and Tier.

Definition at line 213 of file GetParametersByPathRequest.h.

◆ WithPath() [1/3]

GetParametersByPathRequest& Aws::SSM::Model::GetParametersByPathRequest::WithPath ( Aws::String &&  value)
inline

The hierarchy for the parameter. Hierarchies start with a forward slash (/). The hierachy is the parameter name except the last part of the parameter. For the API call to succeeed, the last part of the parameter name cannot be in the path. A parameter name hierarchy can have a maximum of 15 levels. Here is an example of a hierarchy: /Finance/Prod/IAD/WinServ2016/license33

Definition at line 107 of file GetParametersByPathRequest.h.

◆ WithPath() [2/3]

GetParametersByPathRequest& Aws::SSM::Model::GetParametersByPathRequest::WithPath ( const Aws::String value)
inline

The hierarchy for the parameter. Hierarchies start with a forward slash (/). The hierachy is the parameter name except the last part of the parameter. For the API call to succeeed, the last part of the parameter name cannot be in the path. A parameter name hierarchy can have a maximum of 15 levels. Here is an example of a hierarchy: /Finance/Prod/IAD/WinServ2016/license33

Definition at line 97 of file GetParametersByPathRequest.h.

◆ WithPath() [3/3]

GetParametersByPathRequest& Aws::SSM::Model::GetParametersByPathRequest::WithPath ( const char *  value)
inline

The hierarchy for the parameter. Hierarchies start with a forward slash (/). The hierachy is the parameter name except the last part of the parameter. For the API call to succeeed, the last part of the parameter name cannot be in the path. A parameter name hierarchy can have a maximum of 15 levels. Here is an example of a hierarchy: /Finance/Prod/IAD/WinServ2016/license33

Definition at line 117 of file GetParametersByPathRequest.h.

◆ WithRecursive()

GetParametersByPathRequest& Aws::SSM::Model::GetParametersByPathRequest::WithRecursive ( bool  value)
inline

Retrieve all parameters within a hierarchy.

If a user has access to a path, then the user can access all levels of that path. For example, if a user has permission to access path /a, then the user can also access /a/b. Even if a user has explicitly been denied access in IAM for parameter /a/b, they can still call the GetParametersByPath API action recursively for /a and view /a/b.

Definition at line 162 of file GetParametersByPathRequest.h.

◆ WithWithDecryption()

GetParametersByPathRequest& Aws::SSM::Model::GetParametersByPathRequest::WithWithDecryption ( bool  value)
inline

Retrieve all parameters in a hierarchy with their value decrypted.

Definition at line 264 of file GetParametersByPathRequest.h.


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