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

#include <DeleteInventoryRequest.h>

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

Public Member Functions

 DeleteInventoryRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetTypeName () const
 
bool TypeNameHasBeenSet () const
 
void SetTypeName (const Aws::String &value)
 
void SetTypeName (Aws::String &&value)
 
void SetTypeName (const char *value)
 
DeleteInventoryRequestWithTypeName (const Aws::String &value)
 
DeleteInventoryRequestWithTypeName (Aws::String &&value)
 
DeleteInventoryRequestWithTypeName (const char *value)
 
const InventorySchemaDeleteOptionGetSchemaDeleteOption () const
 
bool SchemaDeleteOptionHasBeenSet () const
 
void SetSchemaDeleteOption (const InventorySchemaDeleteOption &value)
 
void SetSchemaDeleteOption (InventorySchemaDeleteOption &&value)
 
DeleteInventoryRequestWithSchemaDeleteOption (const InventorySchemaDeleteOption &value)
 
DeleteInventoryRequestWithSchemaDeleteOption (InventorySchemaDeleteOption &&value)
 
bool GetDryRun () const
 
bool DryRunHasBeenSet () const
 
void SetDryRun (bool value)
 
DeleteInventoryRequestWithDryRun (bool value)
 
const Aws::StringGetClientToken () const
 
bool ClientTokenHasBeenSet () const
 
void SetClientToken (const Aws::String &value)
 
void SetClientToken (Aws::String &&value)
 
void SetClientToken (const char *value)
 
DeleteInventoryRequestWithClientToken (const Aws::String &value)
 
DeleteInventoryRequestWithClientToken (Aws::String &&value)
 
DeleteInventoryRequestWithClientToken (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 DeleteInventoryRequest.h.

Constructor & Destructor Documentation

◆ DeleteInventoryRequest()

Aws::SSM::Model::DeleteInventoryRequest::DeleteInventoryRequest ( )

Member Function Documentation

◆ ClientTokenHasBeenSet()

bool Aws::SSM::Model::DeleteInventoryRequest::ClientTokenHasBeenSet ( ) const
inline

User-provided idempotency token.

Definition at line 212 of file DeleteInventoryRequest.h.

◆ DryRunHasBeenSet()

bool Aws::SSM::Model::DeleteInventoryRequest::DryRunHasBeenSet ( ) const
inline

Use this option to view a summary of the deletion request without deleting any data or the data type. This option is useful when you only want to understand what will be deleted. Once you validate that the data to be deleted is what you intend to delete, you can run the same command without specifying the DryRun option.

Definition at line 183 of file DeleteInventoryRequest.h.

◆ GetClientToken()

const Aws::String& Aws::SSM::Model::DeleteInventoryRequest::GetClientToken ( ) const
inline

User-provided idempotency token.

Definition at line 207 of file DeleteInventoryRequest.h.

◆ GetDryRun()

bool Aws::SSM::Model::DeleteInventoryRequest::GetDryRun ( ) const
inline

Use this option to view a summary of the deletion request without deleting any data or the data type. This option is useful when you only want to understand what will be deleted. Once you validate that the data to be deleted is what you intend to delete, you can run the same command without specifying the DryRun option.

Definition at line 174 of file DeleteInventoryRequest.h.

◆ GetRequestSpecificHeaders()

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

Reimplemented from Aws::SSM::SSMRequest.

◆ GetSchemaDeleteOption()

const InventorySchemaDeleteOption& Aws::SSM::Model::DeleteInventoryRequest::GetSchemaDeleteOption ( ) const
inline

Use the SchemaDeleteOption to delete a custom inventory type (schema). If you don't choose this option, the system only deletes existing inventory data associated with the custom inventory type. Choose one of the following options:

DisableSchema: If you choose this option, the system ignores all inventory data for the specified version, and any earlier versions. To enable this schema again, you must call the PutInventory action for a version greater than the disabled version.

DeleteSchema: This option deletes the specified custom type from the Inventory service. You can recreate the schema later, if you want.

Definition at line 99 of file DeleteInventoryRequest.h.

◆ GetServiceRequestName()

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

Implements Aws::AmazonWebServiceRequest.

Definition at line 32 of file DeleteInventoryRequest.h.

◆ GetTypeName()

const Aws::String& Aws::SSM::Model::DeleteInventoryRequest::GetTypeName ( ) const
inline

The name of the custom inventory type for which you want to delete either all previously collected data or the inventory type itself.

Definition at line 43 of file DeleteInventoryRequest.h.

◆ SchemaDeleteOptionHasBeenSet()

bool Aws::SSM::Model::DeleteInventoryRequest::SchemaDeleteOptionHasBeenSet ( ) const
inline

Use the SchemaDeleteOption to delete a custom inventory type (schema). If you don't choose this option, the system only deletes existing inventory data associated with the custom inventory type. Choose one of the following options:

DisableSchema: If you choose this option, the system ignores all inventory data for the specified version, and any earlier versions. To enable this schema again, you must call the PutInventory action for a version greater than the disabled version.

DeleteSchema: This option deletes the specified custom type from the Inventory service. You can recreate the schema later, if you want.

Definition at line 112 of file DeleteInventoryRequest.h.

◆ SerializePayload()

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

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ SetClientToken() [1/3]

void Aws::SSM::Model::DeleteInventoryRequest::SetClientToken ( const Aws::String value)
inline

User-provided idempotency token.

Definition at line 217 of file DeleteInventoryRequest.h.

◆ SetClientToken() [2/3]

void Aws::SSM::Model::DeleteInventoryRequest::SetClientToken ( Aws::String &&  value)
inline

User-provided idempotency token.

Definition at line 222 of file DeleteInventoryRequest.h.

◆ SetClientToken() [3/3]

void Aws::SSM::Model::DeleteInventoryRequest::SetClientToken ( const char *  value)
inline

User-provided idempotency token.

Definition at line 227 of file DeleteInventoryRequest.h.

◆ SetDryRun()

void Aws::SSM::Model::DeleteInventoryRequest::SetDryRun ( bool  value)
inline

Use this option to view a summary of the deletion request without deleting any data or the data type. This option is useful when you only want to understand what will be deleted. Once you validate that the data to be deleted is what you intend to delete, you can run the same command without specifying the DryRun option.

Definition at line 192 of file DeleteInventoryRequest.h.

◆ SetSchemaDeleteOption() [1/2]

void Aws::SSM::Model::DeleteInventoryRequest::SetSchemaDeleteOption ( const InventorySchemaDeleteOption value)
inline

Use the SchemaDeleteOption to delete a custom inventory type (schema). If you don't choose this option, the system only deletes existing inventory data associated with the custom inventory type. Choose one of the following options:

DisableSchema: If you choose this option, the system ignores all inventory data for the specified version, and any earlier versions. To enable this schema again, you must call the PutInventory action for a version greater than the disabled version.

DeleteSchema: This option deletes the specified custom type from the Inventory service. You can recreate the schema later, if you want.

Definition at line 125 of file DeleteInventoryRequest.h.

◆ SetSchemaDeleteOption() [2/2]

void Aws::SSM::Model::DeleteInventoryRequest::SetSchemaDeleteOption ( InventorySchemaDeleteOption &&  value)
inline

Use the SchemaDeleteOption to delete a custom inventory type (schema). If you don't choose this option, the system only deletes existing inventory data associated with the custom inventory type. Choose one of the following options:

DisableSchema: If you choose this option, the system ignores all inventory data for the specified version, and any earlier versions. To enable this schema again, you must call the PutInventory action for a version greater than the disabled version.

DeleteSchema: This option deletes the specified custom type from the Inventory service. You can recreate the schema later, if you want.

Definition at line 138 of file DeleteInventoryRequest.h.

◆ SetTypeName() [1/3]

void Aws::SSM::Model::DeleteInventoryRequest::SetTypeName ( const Aws::String value)
inline

The name of the custom inventory type for which you want to delete either all previously collected data or the inventory type itself.

Definition at line 55 of file DeleteInventoryRequest.h.

◆ SetTypeName() [2/3]

void Aws::SSM::Model::DeleteInventoryRequest::SetTypeName ( Aws::String &&  value)
inline

The name of the custom inventory type for which you want to delete either all previously collected data or the inventory type itself.

Definition at line 61 of file DeleteInventoryRequest.h.

◆ SetTypeName() [3/3]

void Aws::SSM::Model::DeleteInventoryRequest::SetTypeName ( const char *  value)
inline

The name of the custom inventory type for which you want to delete either all previously collected data or the inventory type itself.

Definition at line 67 of file DeleteInventoryRequest.h.

◆ TypeNameHasBeenSet()

bool Aws::SSM::Model::DeleteInventoryRequest::TypeNameHasBeenSet ( ) const
inline

The name of the custom inventory type for which you want to delete either all previously collected data or the inventory type itself.

Definition at line 49 of file DeleteInventoryRequest.h.

◆ WithClientToken() [1/3]

DeleteInventoryRequest& Aws::SSM::Model::DeleteInventoryRequest::WithClientToken ( const Aws::String value)
inline

User-provided idempotency token.

Definition at line 232 of file DeleteInventoryRequest.h.

◆ WithClientToken() [2/3]

DeleteInventoryRequest& Aws::SSM::Model::DeleteInventoryRequest::WithClientToken ( Aws::String &&  value)
inline

User-provided idempotency token.

Definition at line 237 of file DeleteInventoryRequest.h.

◆ WithClientToken() [3/3]

DeleteInventoryRequest& Aws::SSM::Model::DeleteInventoryRequest::WithClientToken ( const char *  value)
inline

User-provided idempotency token.

Definition at line 242 of file DeleteInventoryRequest.h.

◆ WithDryRun()

DeleteInventoryRequest& Aws::SSM::Model::DeleteInventoryRequest::WithDryRun ( bool  value)
inline

Use this option to view a summary of the deletion request without deleting any data or the data type. This option is useful when you only want to understand what will be deleted. Once you validate that the data to be deleted is what you intend to delete, you can run the same command without specifying the DryRun option.

Definition at line 201 of file DeleteInventoryRequest.h.

◆ WithSchemaDeleteOption() [1/2]

DeleteInventoryRequest& Aws::SSM::Model::DeleteInventoryRequest::WithSchemaDeleteOption ( const InventorySchemaDeleteOption value)
inline

Use the SchemaDeleteOption to delete a custom inventory type (schema). If you don't choose this option, the system only deletes existing inventory data associated with the custom inventory type. Choose one of the following options:

DisableSchema: If you choose this option, the system ignores all inventory data for the specified version, and any earlier versions. To enable this schema again, you must call the PutInventory action for a version greater than the disabled version.

DeleteSchema: This option deletes the specified custom type from the Inventory service. You can recreate the schema later, if you want.

Definition at line 151 of file DeleteInventoryRequest.h.

◆ WithSchemaDeleteOption() [2/2]

DeleteInventoryRequest& Aws::SSM::Model::DeleteInventoryRequest::WithSchemaDeleteOption ( InventorySchemaDeleteOption &&  value)
inline

Use the SchemaDeleteOption to delete a custom inventory type (schema). If you don't choose this option, the system only deletes existing inventory data associated with the custom inventory type. Choose one of the following options:

DisableSchema: If you choose this option, the system ignores all inventory data for the specified version, and any earlier versions. To enable this schema again, you must call the PutInventory action for a version greater than the disabled version.

DeleteSchema: This option deletes the specified custom type from the Inventory service. You can recreate the schema later, if you want.

Definition at line 164 of file DeleteInventoryRequest.h.

◆ WithTypeName() [1/3]

DeleteInventoryRequest& Aws::SSM::Model::DeleteInventoryRequest::WithTypeName ( const Aws::String value)
inline

The name of the custom inventory type for which you want to delete either all previously collected data or the inventory type itself.

Definition at line 73 of file DeleteInventoryRequest.h.

◆ WithTypeName() [2/3]

DeleteInventoryRequest& Aws::SSM::Model::DeleteInventoryRequest::WithTypeName ( Aws::String &&  value)
inline

The name of the custom inventory type for which you want to delete either all previously collected data or the inventory type itself.

Definition at line 79 of file DeleteInventoryRequest.h.

◆ WithTypeName() [3/3]

DeleteInventoryRequest& Aws::SSM::Model::DeleteInventoryRequest::WithTypeName ( const char *  value)
inline

The name of the custom inventory type for which you want to delete either all previously collected data or the inventory type itself.

Definition at line 85 of file DeleteInventoryRequest.h.


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