You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::SSM::Types::DeleteDocumentRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb

Overview

Note:

When making an API call, you may pass DeleteDocumentRequest data as a hash:

{
  name: "DocumentName", # required
  document_version: "DocumentVersion",
  version_name: "DocumentVersionName",
}

Instance Attribute Summary collapse

Instance Attribute Details

#document_versionString

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

Returns:

  • (String)


3288
3289
3290
3291
3292
3293
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 3288

class DeleteDocumentRequest < Struct.new(
  :name,
  :document_version,
  :version_name)
  include Aws::Structure
end

#nameString

The name of the document.

Returns:

  • (String)


3288
3289
3290
3291
3292
3293
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 3288

class DeleteDocumentRequest < Struct.new(
  :name,
  :document_version,
  :version_name)
  include Aws::Structure
end

#version_nameString

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

Returns:

  • (String)


3288
3289
3290
3291
3292
3293
# File 'gems/aws-sdk-ssm/lib/aws-sdk-ssm/types.rb', line 3288

class DeleteDocumentRequest < Struct.new(
  :name,
  :document_version,
  :version_name)
  include Aws::Structure
end