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

#include <UpdateDocumentRequest.h>

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

Public Member Functions

 UpdateDocumentRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetContent () const
 
bool ContentHasBeenSet () const
 
void SetContent (const Aws::String &value)
 
void SetContent (Aws::String &&value)
 
void SetContent (const char *value)
 
UpdateDocumentRequestWithContent (const Aws::String &value)
 
UpdateDocumentRequestWithContent (Aws::String &&value)
 
UpdateDocumentRequestWithContent (const char *value)
 
const Aws::Vector< AttachmentsSource > & GetAttachments () const
 
bool AttachmentsHasBeenSet () const
 
void SetAttachments (const Aws::Vector< AttachmentsSource > &value)
 
void SetAttachments (Aws::Vector< AttachmentsSource > &&value)
 
UpdateDocumentRequestWithAttachments (const Aws::Vector< AttachmentsSource > &value)
 
UpdateDocumentRequestWithAttachments (Aws::Vector< AttachmentsSource > &&value)
 
UpdateDocumentRequestAddAttachments (const AttachmentsSource &value)
 
UpdateDocumentRequestAddAttachments (AttachmentsSource &&value)
 
const Aws::StringGetName () const
 
bool NameHasBeenSet () const
 
void SetName (const Aws::String &value)
 
void SetName (Aws::String &&value)
 
void SetName (const char *value)
 
UpdateDocumentRequestWithName (const Aws::String &value)
 
UpdateDocumentRequestWithName (Aws::String &&value)
 
UpdateDocumentRequestWithName (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)
 
UpdateDocumentRequestWithVersionName (const Aws::String &value)
 
UpdateDocumentRequestWithVersionName (Aws::String &&value)
 
UpdateDocumentRequestWithVersionName (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)
 
UpdateDocumentRequestWithDocumentVersion (const Aws::String &value)
 
UpdateDocumentRequestWithDocumentVersion (Aws::String &&value)
 
UpdateDocumentRequestWithDocumentVersion (const char *value)
 
const DocumentFormatGetDocumentFormat () const
 
bool DocumentFormatHasBeenSet () const
 
void SetDocumentFormat (const DocumentFormat &value)
 
void SetDocumentFormat (DocumentFormat &&value)
 
UpdateDocumentRequestWithDocumentFormat (const DocumentFormat &value)
 
UpdateDocumentRequestWithDocumentFormat (DocumentFormat &&value)
 
const Aws::StringGetTargetType () const
 
bool TargetTypeHasBeenSet () const
 
void SetTargetType (const Aws::String &value)
 
void SetTargetType (Aws::String &&value)
 
void SetTargetType (const char *value)
 
UpdateDocumentRequestWithTargetType (const Aws::String &value)
 
UpdateDocumentRequestWithTargetType (Aws::String &&value)
 
UpdateDocumentRequestWithTargetType (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 UpdateDocumentRequest.h.

Constructor & Destructor Documentation

◆ UpdateDocumentRequest()

Aws::SSM::Model::UpdateDocumentRequest::UpdateDocumentRequest ( )

Member Function Documentation

◆ AddAttachments() [1/2]

UpdateDocumentRequest& Aws::SSM::Model::UpdateDocumentRequest::AddAttachments ( const AttachmentsSource value)
inline

A list of key and value pairs that describe attachments to a version of a document.

Definition at line 121 of file UpdateDocumentRequest.h.

◆ AddAttachments() [2/2]

UpdateDocumentRequest& Aws::SSM::Model::UpdateDocumentRequest::AddAttachments ( AttachmentsSource &&  value)
inline

A list of key and value pairs that describe attachments to a version of a document.

Definition at line 127 of file UpdateDocumentRequest.h.

◆ AttachmentsHasBeenSet()

bool Aws::SSM::Model::UpdateDocumentRequest::AttachmentsHasBeenSet ( ) const
inline

A list of key and value pairs that describe attachments to a version of a document.

Definition at line 91 of file UpdateDocumentRequest.h.

◆ ContentHasBeenSet()

bool Aws::SSM::Model::UpdateDocumentRequest::ContentHasBeenSet ( ) const
inline

A valid JSON or YAML string.

Definition at line 48 of file UpdateDocumentRequest.h.

◆ DocumentFormatHasBeenSet()

bool Aws::SSM::Model::UpdateDocumentRequest::DocumentFormatHasBeenSet ( ) const
inline

Specify the document format for the new document version. Systems Manager supports JSON and YAML documents. JSON is the default format.

Definition at line 295 of file UpdateDocumentRequest.h.

◆ DocumentVersionHasBeenSet()

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

(Required) The latest version of the document that you want to update. The latest document version can be specified using the $LATEST variable or by the version number. Updating a previous version of a document is not supported.

Definition at line 240 of file UpdateDocumentRequest.h.

◆ GetAttachments()

const Aws::Vector<AttachmentsSource>& Aws::SSM::Model::UpdateDocumentRequest::GetAttachments ( ) const
inline

A list of key and value pairs that describe attachments to a version of a document.

Definition at line 85 of file UpdateDocumentRequest.h.

◆ GetContent()

const Aws::String& Aws::SSM::Model::UpdateDocumentRequest::GetContent ( ) const
inline

A valid JSON or YAML string.

Definition at line 43 of file UpdateDocumentRequest.h.

◆ GetDocumentFormat()

const DocumentFormat& Aws::SSM::Model::UpdateDocumentRequest::GetDocumentFormat ( ) const
inline

Specify the document format for the new document version. Systems Manager supports JSON and YAML documents. JSON is the default format.

Definition at line 289 of file UpdateDocumentRequest.h.

◆ GetDocumentVersion()

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

(Required) The latest version of the document that you want to update. The latest document version can be specified using the $LATEST variable or by the version number. Updating a previous version of a document is not supported.

Definition at line 233 of file UpdateDocumentRequest.h.

◆ GetName()

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

The name of the document that you want to update.

Definition at line 133 of file UpdateDocumentRequest.h.

◆ GetRequestSpecificHeaders()

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

Reimplemented from Aws::SSM::SSMRequest.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 33 of file UpdateDocumentRequest.h.

◆ GetTargetType()

const Aws::String& Aws::SSM::Model::UpdateDocumentRequest::GetTargetType ( ) const
inline

Specify a new target type for the document.

Definition at line 325 of file UpdateDocumentRequest.h.

◆ GetVersionName()

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

An optional field specifying the version of the artifact you are updating with the document. For example, "Release 12, Update 6". This value is unique across all versions of a document, and cannot be changed.

Definition at line 176 of file UpdateDocumentRequest.h.

◆ NameHasBeenSet()

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

The name of the document that you want to update.

Definition at line 138 of file UpdateDocumentRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetAttachments() [1/2]

void Aws::SSM::Model::UpdateDocumentRequest::SetAttachments ( const Aws::Vector< AttachmentsSource > &  value)
inline

A list of key and value pairs that describe attachments to a version of a document.

Definition at line 97 of file UpdateDocumentRequest.h.

◆ SetAttachments() [2/2]

void Aws::SSM::Model::UpdateDocumentRequest::SetAttachments ( Aws::Vector< AttachmentsSource > &&  value)
inline

A list of key and value pairs that describe attachments to a version of a document.

Definition at line 103 of file UpdateDocumentRequest.h.

◆ SetContent() [1/3]

void Aws::SSM::Model::UpdateDocumentRequest::SetContent ( const Aws::String value)
inline

A valid JSON or YAML string.

Definition at line 53 of file UpdateDocumentRequest.h.

◆ SetContent() [2/3]

void Aws::SSM::Model::UpdateDocumentRequest::SetContent ( Aws::String &&  value)
inline

A valid JSON or YAML string.

Definition at line 58 of file UpdateDocumentRequest.h.

◆ SetContent() [3/3]

void Aws::SSM::Model::UpdateDocumentRequest::SetContent ( const char *  value)
inline

A valid JSON or YAML string.

Definition at line 63 of file UpdateDocumentRequest.h.

◆ SetDocumentFormat() [1/2]

void Aws::SSM::Model::UpdateDocumentRequest::SetDocumentFormat ( const DocumentFormat value)
inline

Specify the document format for the new document version. Systems Manager supports JSON and YAML documents. JSON is the default format.

Definition at line 301 of file UpdateDocumentRequest.h.

◆ SetDocumentFormat() [2/2]

void Aws::SSM::Model::UpdateDocumentRequest::SetDocumentFormat ( DocumentFormat &&  value)
inline

Specify the document format for the new document version. Systems Manager supports JSON and YAML documents. JSON is the default format.

Definition at line 307 of file UpdateDocumentRequest.h.

◆ SetDocumentVersion() [1/3]

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

(Required) The latest version of the document that you want to update. The latest document version can be specified using the $LATEST variable or by the version number. Updating a previous version of a document is not supported.

Definition at line 247 of file UpdateDocumentRequest.h.

◆ SetDocumentVersion() [2/3]

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

(Required) The latest version of the document that you want to update. The latest document version can be specified using the $LATEST variable or by the version number. Updating a previous version of a document is not supported.

Definition at line 254 of file UpdateDocumentRequest.h.

◆ SetDocumentVersion() [3/3]

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

(Required) The latest version of the document that you want to update. The latest document version can be specified using the $LATEST variable or by the version number. Updating a previous version of a document is not supported.

Definition at line 261 of file UpdateDocumentRequest.h.

◆ SetName() [1/3]

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

The name of the document that you want to update.

Definition at line 143 of file UpdateDocumentRequest.h.

◆ SetName() [2/3]

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

The name of the document that you want to update.

Definition at line 148 of file UpdateDocumentRequest.h.

◆ SetName() [3/3]

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

The name of the document that you want to update.

Definition at line 153 of file UpdateDocumentRequest.h.

◆ SetTargetType() [1/3]

void Aws::SSM::Model::UpdateDocumentRequest::SetTargetType ( const Aws::String value)
inline

Specify a new target type for the document.

Definition at line 335 of file UpdateDocumentRequest.h.

◆ SetTargetType() [2/3]

void Aws::SSM::Model::UpdateDocumentRequest::SetTargetType ( Aws::String &&  value)
inline

Specify a new target type for the document.

Definition at line 340 of file UpdateDocumentRequest.h.

◆ SetTargetType() [3/3]

void Aws::SSM::Model::UpdateDocumentRequest::SetTargetType ( const char *  value)
inline

Specify a new target type for the document.

Definition at line 345 of file UpdateDocumentRequest.h.

◆ SetVersionName() [1/3]

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

An optional field specifying the version of the artifact you are updating with the document. For example, "Release 12, Update 6". This value is unique across all versions of a document, and cannot be changed.

Definition at line 190 of file UpdateDocumentRequest.h.

◆ SetVersionName() [2/3]

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

An optional field specifying the version of the artifact you are updating with the document. For example, "Release 12, Update 6". This value is unique across all versions of a document, and cannot be changed.

Definition at line 197 of file UpdateDocumentRequest.h.

◆ SetVersionName() [3/3]

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

An optional field specifying the version of the artifact you are updating with the document. For example, "Release 12, Update 6". This value is unique across all versions of a document, and cannot be changed.

Definition at line 204 of file UpdateDocumentRequest.h.

◆ TargetTypeHasBeenSet()

bool Aws::SSM::Model::UpdateDocumentRequest::TargetTypeHasBeenSet ( ) const
inline

Specify a new target type for the document.

Definition at line 330 of file UpdateDocumentRequest.h.

◆ VersionNameHasBeenSet()

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

An optional field specifying the version of the artifact you are updating with the document. For example, "Release 12, Update 6". This value is unique across all versions of a document, and cannot be changed.

Definition at line 183 of file UpdateDocumentRequest.h.

◆ WithAttachments() [1/2]

UpdateDocumentRequest& Aws::SSM::Model::UpdateDocumentRequest::WithAttachments ( const Aws::Vector< AttachmentsSource > &  value)
inline

A list of key and value pairs that describe attachments to a version of a document.

Definition at line 109 of file UpdateDocumentRequest.h.

◆ WithAttachments() [2/2]

UpdateDocumentRequest& Aws::SSM::Model::UpdateDocumentRequest::WithAttachments ( Aws::Vector< AttachmentsSource > &&  value)
inline

A list of key and value pairs that describe attachments to a version of a document.

Definition at line 115 of file UpdateDocumentRequest.h.

◆ WithContent() [1/3]

UpdateDocumentRequest& Aws::SSM::Model::UpdateDocumentRequest::WithContent ( const Aws::String value)
inline

A valid JSON or YAML string.

Definition at line 68 of file UpdateDocumentRequest.h.

◆ WithContent() [2/3]

UpdateDocumentRequest& Aws::SSM::Model::UpdateDocumentRequest::WithContent ( Aws::String &&  value)
inline

A valid JSON or YAML string.

Definition at line 73 of file UpdateDocumentRequest.h.

◆ WithContent() [3/3]

UpdateDocumentRequest& Aws::SSM::Model::UpdateDocumentRequest::WithContent ( const char *  value)
inline

A valid JSON or YAML string.

Definition at line 78 of file UpdateDocumentRequest.h.

◆ WithDocumentFormat() [1/2]

UpdateDocumentRequest& Aws::SSM::Model::UpdateDocumentRequest::WithDocumentFormat ( const DocumentFormat value)
inline

Specify the document format for the new document version. Systems Manager supports JSON and YAML documents. JSON is the default format.

Definition at line 313 of file UpdateDocumentRequest.h.

◆ WithDocumentFormat() [2/2]

UpdateDocumentRequest& Aws::SSM::Model::UpdateDocumentRequest::WithDocumentFormat ( DocumentFormat &&  value)
inline

Specify the document format for the new document version. Systems Manager supports JSON and YAML documents. JSON is the default format.

Definition at line 319 of file UpdateDocumentRequest.h.

◆ WithDocumentVersion() [1/3]

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

(Required) The latest version of the document that you want to update. The latest document version can be specified using the $LATEST variable or by the version number. Updating a previous version of a document is not supported.

Definition at line 268 of file UpdateDocumentRequest.h.

◆ WithDocumentVersion() [2/3]

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

(Required) The latest version of the document that you want to update. The latest document version can be specified using the $LATEST variable or by the version number. Updating a previous version of a document is not supported.

Definition at line 275 of file UpdateDocumentRequest.h.

◆ WithDocumentVersion() [3/3]

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

(Required) The latest version of the document that you want to update. The latest document version can be specified using the $LATEST variable or by the version number. Updating a previous version of a document is not supported.

Definition at line 282 of file UpdateDocumentRequest.h.

◆ WithName() [1/3]

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

The name of the document that you want to update.

Definition at line 158 of file UpdateDocumentRequest.h.

◆ WithName() [2/3]

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

The name of the document that you want to update.

Definition at line 163 of file UpdateDocumentRequest.h.

◆ WithName() [3/3]

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

The name of the document that you want to update.

Definition at line 168 of file UpdateDocumentRequest.h.

◆ WithTargetType() [1/3]

UpdateDocumentRequest& Aws::SSM::Model::UpdateDocumentRequest::WithTargetType ( const Aws::String value)
inline

Specify a new target type for the document.

Definition at line 350 of file UpdateDocumentRequest.h.

◆ WithTargetType() [2/3]

UpdateDocumentRequest& Aws::SSM::Model::UpdateDocumentRequest::WithTargetType ( Aws::String &&  value)
inline

Specify a new target type for the document.

Definition at line 355 of file UpdateDocumentRequest.h.

◆ WithTargetType() [3/3]

UpdateDocumentRequest& Aws::SSM::Model::UpdateDocumentRequest::WithTargetType ( const char *  value)
inline

Specify a new target type for the document.

Definition at line 360 of file UpdateDocumentRequest.h.

◆ WithVersionName() [1/3]

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

An optional field specifying the version of the artifact you are updating with the document. For example, "Release 12, Update 6". This value is unique across all versions of a document, and cannot be changed.

Definition at line 211 of file UpdateDocumentRequest.h.

◆ WithVersionName() [2/3]

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

An optional field specifying the version of the artifact you are updating with the document. For example, "Release 12, Update 6". This value is unique across all versions of a document, and cannot be changed.

Definition at line 218 of file UpdateDocumentRequest.h.

◆ WithVersionName() [3/3]

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

An optional field specifying the version of the artifact you are updating with the document. For example, "Release 12, Update 6". This value is unique across all versions of a document, and cannot be changed.

Definition at line 225 of file UpdateDocumentRequest.h.


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