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

#include <DeleteDocumentRequest.h>

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

Public Member Functions

 DeleteDocumentRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetName () const
 
bool NameHasBeenSet () const
 
void SetName (const Aws::String &value)
 
void SetName (Aws::String &&value)
 
void SetName (const char *value)
 
DeleteDocumentRequestWithName (const Aws::String &value)
 
DeleteDocumentRequestWithName (Aws::String &&value)
 
DeleteDocumentRequestWithName (const char *value)
 
const Aws::StringGetDocumentVersion () const
 
bool DocumentVersionHasBeenSet () const
 
void SetDocumentVersion (const Aws::String &value)
 
void SetDocumentVersion (Aws::String &&value)
 
void SetDocumentVersion (const char *value)
 
DeleteDocumentRequestWithDocumentVersion (const Aws::String &value)
 
DeleteDocumentRequestWithDocumentVersion (Aws::String &&value)
 
DeleteDocumentRequestWithDocumentVersion (const char *value)
 
const Aws::StringGetVersionName () const
 
bool VersionNameHasBeenSet () const
 
void SetVersionName (const Aws::String &value)
 
void SetVersionName (Aws::String &&value)
 
void SetVersionName (const char *value)
 
DeleteDocumentRequestWithVersionName (const Aws::String &value)
 
DeleteDocumentRequestWithVersionName (Aws::String &&value)
 
DeleteDocumentRequestWithVersionName (const char *value)
 
bool GetForce () const
 
bool ForceHasBeenSet () const
 
void SetForce (bool value)
 
DeleteDocumentRequestWithForce (bool 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 21 of file DeleteDocumentRequest.h.

Constructor & Destructor Documentation

◆ DeleteDocumentRequest()

Aws::SSM::Model::DeleteDocumentRequest::DeleteDocumentRequest ( )

Member Function Documentation

◆ DocumentVersionHasBeenSet()

bool Aws::SSM::Model::DeleteDocumentRequest::DocumentVersionHasBeenSet ( ) const
inline

The version of the document that you want to delete. If not provided, all versions of the document are deleted.

Definition at line 88 of file DeleteDocumentRequest.h.

◆ ForceHasBeenSet()

bool Aws::SSM::Model::DeleteDocumentRequest::ForceHasBeenSet ( ) const
inline

Some SSM document types require that you specify a Force flag before you can delete the document. For example, you must specify a Force flag to delete a document of type ApplicationConfigurationSchema. You can restrict access to the Force flag in an AWS Identity and Access Management (IAM) policy.

Definition at line 194 of file DeleteDocumentRequest.h.

◆ GetDocumentVersion()

const Aws::String& Aws::SSM::Model::DeleteDocumentRequest::GetDocumentVersion ( ) const
inline

The version of the document that you want to delete. If not provided, all versions of the document are deleted.

Definition at line 82 of file DeleteDocumentRequest.h.

◆ GetForce()

bool Aws::SSM::Model::DeleteDocumentRequest::GetForce ( ) const
inline

Some SSM document types require that you specify a Force flag before you can delete the document. For example, you must specify a Force flag to delete a document of type ApplicationConfigurationSchema. You can restrict access to the Force flag in an AWS Identity and Access Management (IAM) policy.

Definition at line 184 of file DeleteDocumentRequest.h.

◆ GetName()

const Aws::String& Aws::SSM::Model::DeleteDocumentRequest::GetName ( ) const
inline

The name of the document.

Definition at line 40 of file DeleteDocumentRequest.h.

◆ GetRequestSpecificHeaders()

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

Reimplemented from Aws::SSM::SSMRequest.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 30 of file DeleteDocumentRequest.h.

◆ GetVersionName()

const Aws::String& Aws::SSM::Model::DeleteDocumentRequest::GetVersionName ( ) const
inline

The version name of the document that you want to delete. If not provided, all versions of the document are deleted.

Definition at line 131 of file DeleteDocumentRequest.h.

◆ NameHasBeenSet()

bool Aws::SSM::Model::DeleteDocumentRequest::NameHasBeenSet ( ) const
inline

The name of the document.

Definition at line 45 of file DeleteDocumentRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetDocumentVersion() [1/3]

void Aws::SSM::Model::DeleteDocumentRequest::SetDocumentVersion ( const Aws::String value)
inline

The version of the document that you want to delete. If not provided, all versions of the document are deleted.

Definition at line 94 of file DeleteDocumentRequest.h.

◆ SetDocumentVersion() [2/3]

void Aws::SSM::Model::DeleteDocumentRequest::SetDocumentVersion ( Aws::String &&  value)
inline

The version of the document that you want to delete. If not provided, all versions of the document are deleted.

Definition at line 100 of file DeleteDocumentRequest.h.

◆ SetDocumentVersion() [3/3]

void Aws::SSM::Model::DeleteDocumentRequest::SetDocumentVersion ( const char *  value)
inline

The version of the document that you want to delete. If not provided, all versions of the document are deleted.

Definition at line 106 of file DeleteDocumentRequest.h.

◆ SetForce()

void Aws::SSM::Model::DeleteDocumentRequest::SetForce ( bool  value)
inline

Some SSM document types require that you specify a Force flag before you can delete the document. For example, you must specify a Force flag to delete a document of type ApplicationConfigurationSchema. You can restrict access to the Force flag in an AWS Identity and Access Management (IAM) policy.

Definition at line 204 of file DeleteDocumentRequest.h.

◆ SetName() [1/3]

void Aws::SSM::Model::DeleteDocumentRequest::SetName ( const Aws::String value)
inline

The name of the document.

Definition at line 50 of file DeleteDocumentRequest.h.

◆ SetName() [2/3]

void Aws::SSM::Model::DeleteDocumentRequest::SetName ( Aws::String &&  value)
inline

The name of the document.

Definition at line 55 of file DeleteDocumentRequest.h.

◆ SetName() [3/3]

void Aws::SSM::Model::DeleteDocumentRequest::SetName ( const char *  value)
inline

The name of the document.

Definition at line 60 of file DeleteDocumentRequest.h.

◆ SetVersionName() [1/3]

void Aws::SSM::Model::DeleteDocumentRequest::SetVersionName ( const Aws::String value)
inline

The version name of the document that you want to delete. If not provided, all versions of the document are deleted.

Definition at line 143 of file DeleteDocumentRequest.h.

◆ SetVersionName() [2/3]

void Aws::SSM::Model::DeleteDocumentRequest::SetVersionName ( Aws::String &&  value)
inline

The version name of the document that you want to delete. If not provided, all versions of the document are deleted.

Definition at line 149 of file DeleteDocumentRequest.h.

◆ SetVersionName() [3/3]

void Aws::SSM::Model::DeleteDocumentRequest::SetVersionName ( const char *  value)
inline

The version name of the document that you want to delete. If not provided, all versions of the document are deleted.

Definition at line 155 of file DeleteDocumentRequest.h.

◆ VersionNameHasBeenSet()

bool Aws::SSM::Model::DeleteDocumentRequest::VersionNameHasBeenSet ( ) const
inline

The version name of the document that you want to delete. If not provided, all versions of the document are deleted.

Definition at line 137 of file DeleteDocumentRequest.h.

◆ WithDocumentVersion() [1/3]

DeleteDocumentRequest& Aws::SSM::Model::DeleteDocumentRequest::WithDocumentVersion ( const Aws::String value)
inline

The version of the document that you want to delete. If not provided, all versions of the document are deleted.

Definition at line 112 of file DeleteDocumentRequest.h.

◆ WithDocumentVersion() [2/3]

DeleteDocumentRequest& Aws::SSM::Model::DeleteDocumentRequest::WithDocumentVersion ( Aws::String &&  value)
inline

The version of the document that you want to delete. If not provided, all versions of the document are deleted.

Definition at line 118 of file DeleteDocumentRequest.h.

◆ WithDocumentVersion() [3/3]

DeleteDocumentRequest& Aws::SSM::Model::DeleteDocumentRequest::WithDocumentVersion ( const char *  value)
inline

The version of the document that you want to delete. If not provided, all versions of the document are deleted.

Definition at line 124 of file DeleteDocumentRequest.h.

◆ WithForce()

DeleteDocumentRequest& Aws::SSM::Model::DeleteDocumentRequest::WithForce ( bool  value)
inline

Some SSM document types require that you specify a Force flag before you can delete the document. For example, you must specify a Force flag to delete a document of type ApplicationConfigurationSchema. You can restrict access to the Force flag in an AWS Identity and Access Management (IAM) policy.

Definition at line 214 of file DeleteDocumentRequest.h.

◆ WithName() [1/3]

DeleteDocumentRequest& Aws::SSM::Model::DeleteDocumentRequest::WithName ( const Aws::String value)
inline

The name of the document.

Definition at line 65 of file DeleteDocumentRequest.h.

◆ WithName() [2/3]

DeleteDocumentRequest& Aws::SSM::Model::DeleteDocumentRequest::WithName ( Aws::String &&  value)
inline

The name of the document.

Definition at line 70 of file DeleteDocumentRequest.h.

◆ WithName() [3/3]

DeleteDocumentRequest& Aws::SSM::Model::DeleteDocumentRequest::WithName ( const char *  value)
inline

The name of the document.

Definition at line 75 of file DeleteDocumentRequest.h.

◆ WithVersionName() [1/3]

DeleteDocumentRequest& Aws::SSM::Model::DeleteDocumentRequest::WithVersionName ( const Aws::String value)
inline

The version name of the document that you want to delete. If not provided, all versions of the document are deleted.

Definition at line 161 of file DeleteDocumentRequest.h.

◆ WithVersionName() [2/3]

DeleteDocumentRequest& Aws::SSM::Model::DeleteDocumentRequest::WithVersionName ( Aws::String &&  value)
inline

The version name of the document that you want to delete. If not provided, all versions of the document are deleted.

Definition at line 167 of file DeleteDocumentRequest.h.

◆ WithVersionName() [3/3]

DeleteDocumentRequest& Aws::SSM::Model::DeleteDocumentRequest::WithVersionName ( const char *  value)
inline

The version name of the document that you want to delete. If not provided, all versions of the document are deleted.

Definition at line 173 of file DeleteDocumentRequest.h.


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