Struct aws_sdk_ssm::client::fluent_builders::DeleteDocument

pub struct DeleteDocument { /* private fields */ }

Fluent builder constructing a request to DeleteDocument.

Deletes the Amazon Web Services Systems Manager document (SSM document) and all managed node associations to the document.

Before you delete the document, we recommend that you use DeleteAssociation to disassociate all managed nodes that are associated with the document.

Implementations

impl DeleteDocument

pub async fn customize(
    self
) -> Result<CustomizableOperation<DeleteDocument, AwsResponseRetryClassifier>, SdkError<DeleteDocumentError>>

Consume this builder, creating a customizable operation that can be modified before being sent. The operation’s inner http::Request can be modified as well.

pub async fn send(
    self
) -> Result<DeleteDocumentOutput, SdkError<DeleteDocumentError>>

Sends the request and returns the response.

If an error occurs, an SdkError will be returned with additional details that can be matched against.

By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.

pub fn name(self, input: impl Into<String>) -> Self

The name of the document.

pub fn set_name(self, input: Option<String>) -> Self

The name of the document.

pub fn document_version(self, input: impl Into<String>) -> Self

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

pub fn set_document_version(self, input: Option<String>) -> Self

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

pub fn version_name(self, input: impl Into<String>) -> Self

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

pub fn set_version_name(self, input: Option<String>) -> Self

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

pub fn force(self, input: bool) -> Self

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 Identity and Access Management (IAM) policy.

pub fn set_force(self, input: Option<bool>) -> Self

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 Identity and Access Management (IAM) policy.

Trait Implementations

impl Clone for DeleteDocument

fn clone(&self) -> DeleteDocument

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for DeleteDocument

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.