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

#include <ListDocumentsRequest.h>

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

Public Member Functions

 ListDocumentsRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::Vector< DocumentFilter > & GetDocumentFilterList () const
 
bool DocumentFilterListHasBeenSet () const
 
void SetDocumentFilterList (const Aws::Vector< DocumentFilter > &value)
 
void SetDocumentFilterList (Aws::Vector< DocumentFilter > &&value)
 
ListDocumentsRequestWithDocumentFilterList (const Aws::Vector< DocumentFilter > &value)
 
ListDocumentsRequestWithDocumentFilterList (Aws::Vector< DocumentFilter > &&value)
 
ListDocumentsRequestAddDocumentFilterList (const DocumentFilter &value)
 
ListDocumentsRequestAddDocumentFilterList (DocumentFilter &&value)
 
const Aws::Vector< DocumentKeyValuesFilter > & GetFilters () const
 
bool FiltersHasBeenSet () const
 
void SetFilters (const Aws::Vector< DocumentKeyValuesFilter > &value)
 
void SetFilters (Aws::Vector< DocumentKeyValuesFilter > &&value)
 
ListDocumentsRequestWithFilters (const Aws::Vector< DocumentKeyValuesFilter > &value)
 
ListDocumentsRequestWithFilters (Aws::Vector< DocumentKeyValuesFilter > &&value)
 
ListDocumentsRequestAddFilters (const DocumentKeyValuesFilter &value)
 
ListDocumentsRequestAddFilters (DocumentKeyValuesFilter &&value)
 
int GetMaxResults () const
 
bool MaxResultsHasBeenSet () const
 
void SetMaxResults (int value)
 
ListDocumentsRequestWithMaxResults (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)
 
ListDocumentsRequestWithNextToken (const Aws::String &value)
 
ListDocumentsRequestWithNextToken (Aws::String &&value)
 
ListDocumentsRequestWithNextToken (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 24 of file ListDocumentsRequest.h.

Constructor & Destructor Documentation

◆ ListDocumentsRequest()

Aws::SSM::Model::ListDocumentsRequest::ListDocumentsRequest ( )

Member Function Documentation

◆ AddDocumentFilterList() [1/2]

ListDocumentsRequest& Aws::SSM::Model::ListDocumentsRequest::AddDocumentFilterList ( const DocumentFilter value)
inline

This data type is deprecated. Instead, use Filters.

Definition at line 73 of file ListDocumentsRequest.h.

◆ AddDocumentFilterList() [2/2]

ListDocumentsRequest& Aws::SSM::Model::ListDocumentsRequest::AddDocumentFilterList ( DocumentFilter &&  value)
inline

This data type is deprecated. Instead, use Filters.

Definition at line 78 of file ListDocumentsRequest.h.

◆ AddFilters() [1/2]

ListDocumentsRequest& Aws::SSM::Model::ListDocumentsRequest::AddFilters ( const DocumentKeyValuesFilter value)
inline

One or more DocumentKeyValuesFilter objects. Use a filter to return a more specific list of results. For keys, you can specify one or more key-value pair tags that have been applied to a document. Other valid keys include Owner, Name, PlatformTypes, DocumentType, and TargetType. For example, to return documents you own use Key=Owner,Values=Self. To specify a custom key-value pair, use the format Key=tag:tagName,Values=valueName.

Definition at line 163 of file ListDocumentsRequest.h.

◆ AddFilters() [2/2]

ListDocumentsRequest& Aws::SSM::Model::ListDocumentsRequest::AddFilters ( DocumentKeyValuesFilter &&  value)
inline

One or more DocumentKeyValuesFilter objects. Use a filter to return a more specific list of results. For keys, you can specify one or more key-value pair tags that have been applied to a document. Other valid keys include Owner, Name, PlatformTypes, DocumentType, and TargetType. For example, to return documents you own use Key=Owner,Values=Self. To specify a custom key-value pair, use the format Key=tag:tagName,Values=valueName.

Definition at line 175 of file ListDocumentsRequest.h.

◆ DocumentFilterListHasBeenSet()

bool Aws::SSM::Model::ListDocumentsRequest::DocumentFilterListHasBeenSet ( ) const
inline

This data type is deprecated. Instead, use Filters.

Definition at line 48 of file ListDocumentsRequest.h.

◆ FiltersHasBeenSet()

bool Aws::SSM::Model::ListDocumentsRequest::FiltersHasBeenSet ( ) const
inline

One or more DocumentKeyValuesFilter objects. Use a filter to return a more specific list of results. For keys, you can specify one or more key-value pair tags that have been applied to a document. Other valid keys include Owner, Name, PlatformTypes, DocumentType, and TargetType. For example, to return documents you own use Key=Owner,Values=Self. To specify a custom key-value pair, use the format Key=tag:tagName,Values=valueName.

Definition at line 103 of file ListDocumentsRequest.h.

◆ GetDocumentFilterList()

const Aws::Vector<DocumentFilter>& Aws::SSM::Model::ListDocumentsRequest::GetDocumentFilterList ( ) const
inline

This data type is deprecated. Instead, use Filters.

Definition at line 43 of file ListDocumentsRequest.h.

◆ GetFilters()

const Aws::Vector<DocumentKeyValuesFilter>& Aws::SSM::Model::ListDocumentsRequest::GetFilters ( ) const
inline

One or more DocumentKeyValuesFilter objects. Use a filter to return a more specific list of results. For keys, you can specify one or more key-value pair tags that have been applied to a document. Other valid keys include Owner, Name, PlatformTypes, DocumentType, and TargetType. For example, to return documents you own use Key=Owner,Values=Self. To specify a custom key-value pair, use the format Key=tag:tagName,Values=valueName.

Definition at line 91 of file ListDocumentsRequest.h.

◆ GetMaxResults()

int Aws::SSM::Model::ListDocumentsRequest::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 183 of file ListDocumentsRequest.h.

◆ GetNextToken()

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

The token for the next set of items to return. (You received this token from a previous call.)

Definition at line 211 of file ListDocumentsRequest.h.

◆ GetRequestSpecificHeaders()

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

Reimplemented from Aws::SSM::SSMRequest.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 33 of file ListDocumentsRequest.h.

◆ MaxResultsHasBeenSet()

bool Aws::SSM::Model::ListDocumentsRequest::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 190 of file ListDocumentsRequest.h.

◆ NextTokenHasBeenSet()

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

The token for the next set of items to return. (You received this token from a previous call.)

Definition at line 217 of file ListDocumentsRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetDocumentFilterList() [1/2]

void Aws::SSM::Model::ListDocumentsRequest::SetDocumentFilterList ( const Aws::Vector< DocumentFilter > &  value)
inline

This data type is deprecated. Instead, use Filters.

Definition at line 53 of file ListDocumentsRequest.h.

◆ SetDocumentFilterList() [2/2]

void Aws::SSM::Model::ListDocumentsRequest::SetDocumentFilterList ( Aws::Vector< DocumentFilter > &&  value)
inline

This data type is deprecated. Instead, use Filters.

Definition at line 58 of file ListDocumentsRequest.h.

◆ SetFilters() [1/2]

void Aws::SSM::Model::ListDocumentsRequest::SetFilters ( const Aws::Vector< DocumentKeyValuesFilter > &  value)
inline

One or more DocumentKeyValuesFilter objects. Use a filter to return a more specific list of results. For keys, you can specify one or more key-value pair tags that have been applied to a document. Other valid keys include Owner, Name, PlatformTypes, DocumentType, and TargetType. For example, to return documents you own use Key=Owner,Values=Self. To specify a custom key-value pair, use the format Key=tag:tagName,Values=valueName.

Definition at line 115 of file ListDocumentsRequest.h.

◆ SetFilters() [2/2]

void Aws::SSM::Model::ListDocumentsRequest::SetFilters ( Aws::Vector< DocumentKeyValuesFilter > &&  value)
inline

One or more DocumentKeyValuesFilter objects. Use a filter to return a more specific list of results. For keys, you can specify one or more key-value pair tags that have been applied to a document. Other valid keys include Owner, Name, PlatformTypes, DocumentType, and TargetType. For example, to return documents you own use Key=Owner,Values=Self. To specify a custom key-value pair, use the format Key=tag:tagName,Values=valueName.

Definition at line 127 of file ListDocumentsRequest.h.

◆ SetMaxResults()

void Aws::SSM::Model::ListDocumentsRequest::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 197 of file ListDocumentsRequest.h.

◆ SetNextToken() [1/3]

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

The token for the next set of items to return. (You received this token from a previous call.)

Definition at line 223 of file ListDocumentsRequest.h.

◆ SetNextToken() [2/3]

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

The token for the next set of items to return. (You received this token from a previous call.)

Definition at line 229 of file ListDocumentsRequest.h.

◆ SetNextToken() [3/3]

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

The token for the next set of items to return. (You received this token from a previous call.)

Definition at line 235 of file ListDocumentsRequest.h.

◆ WithDocumentFilterList() [1/2]

ListDocumentsRequest& Aws::SSM::Model::ListDocumentsRequest::WithDocumentFilterList ( const Aws::Vector< DocumentFilter > &  value)
inline

This data type is deprecated. Instead, use Filters.

Definition at line 63 of file ListDocumentsRequest.h.

◆ WithDocumentFilterList() [2/2]

ListDocumentsRequest& Aws::SSM::Model::ListDocumentsRequest::WithDocumentFilterList ( Aws::Vector< DocumentFilter > &&  value)
inline

This data type is deprecated. Instead, use Filters.

Definition at line 68 of file ListDocumentsRequest.h.

◆ WithFilters() [1/2]

ListDocumentsRequest& Aws::SSM::Model::ListDocumentsRequest::WithFilters ( const Aws::Vector< DocumentKeyValuesFilter > &  value)
inline

One or more DocumentKeyValuesFilter objects. Use a filter to return a more specific list of results. For keys, you can specify one or more key-value pair tags that have been applied to a document. Other valid keys include Owner, Name, PlatformTypes, DocumentType, and TargetType. For example, to return documents you own use Key=Owner,Values=Self. To specify a custom key-value pair, use the format Key=tag:tagName,Values=valueName.

Definition at line 139 of file ListDocumentsRequest.h.

◆ WithFilters() [2/2]

ListDocumentsRequest& Aws::SSM::Model::ListDocumentsRequest::WithFilters ( Aws::Vector< DocumentKeyValuesFilter > &&  value)
inline

One or more DocumentKeyValuesFilter objects. Use a filter to return a more specific list of results. For keys, you can specify one or more key-value pair tags that have been applied to a document. Other valid keys include Owner, Name, PlatformTypes, DocumentType, and TargetType. For example, to return documents you own use Key=Owner,Values=Self. To specify a custom key-value pair, use the format Key=tag:tagName,Values=valueName.

Definition at line 151 of file ListDocumentsRequest.h.

◆ WithMaxResults()

ListDocumentsRequest& Aws::SSM::Model::ListDocumentsRequest::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 204 of file ListDocumentsRequest.h.

◆ WithNextToken() [1/3]

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

The token for the next set of items to return. (You received this token from a previous call.)

Definition at line 241 of file ListDocumentsRequest.h.

◆ WithNextToken() [2/3]

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

The token for the next set of items to return. (You received this token from a previous call.)

Definition at line 247 of file ListDocumentsRequest.h.

◆ WithNextToken() [3/3]

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

The token for the next set of items to return. (You received this token from a previous call.)

Definition at line 253 of file ListDocumentsRequest.h.


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