AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

This is the response object from the GetDocument operation.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceResponse
    Amazon.SimpleSystemsManagement.Model.GetDocumentResponse

Namespace: Amazon.SimpleSystemsManagement.Model
Assembly: AWSSDK.SimpleSystemsManagement.dll
Version: 3.x.y.z

Syntax

C# 
public class GetDocumentResponse : AmazonWebServiceResponse

The GetDocumentResponse type exposes the following members

Constructors

NameDescription
Public Method GetDocumentResponse()

Properties

NameTypeDescription
Public Property AttachmentsContent System.Collections.Generic.List<Amazon.SimpleSystemsManagement.Model.AttachmentContent>

Gets and sets the property AttachmentsContent.

A description of the document attachments, including names, locations, sizes, and so on.

Public Property Content System.String

Gets and sets the property Content.

The contents of the SSM document.

Public Property ContentLength System.Int64 Inherited from Amazon.Runtime.AmazonWebServiceResponse.
Public Property CreatedDate System.DateTime

Gets and sets the property CreatedDate.

The date the SSM document was created.

Public Property DisplayName System.String

Gets and sets the property DisplayName.

The friendly name of the SSM document. This value can differ for each version of the document. If you want to update this value, see UpdateDocument.

Public Property DocumentFormat Amazon.SimpleSystemsManagement.DocumentFormat

Gets and sets the property DocumentFormat.

The document format, either JSON or YAML.

Public Property DocumentType Amazon.SimpleSystemsManagement.DocumentType

Gets and sets the property DocumentType.

The document type.

Public Property DocumentVersion System.String

Gets and sets the property DocumentVersion.

The document version.

Public Property HttpStatusCode System.Net.HttpStatusCode Inherited from Amazon.Runtime.AmazonWebServiceResponse.
Public Property Name System.String

Gets and sets the property Name.

The name of the SSM document.

Public Property Requires System.Collections.Generic.List<Amazon.SimpleSystemsManagement.Model.DocumentRequires>

Gets and sets the property Requires.

A list of SSM documents required by a document. For example, an ApplicationConfiguration document requires an ApplicationConfigurationSchema document.

Public Property ResponseMetadata Amazon.Runtime.ResponseMetadata Inherited from Amazon.Runtime.AmazonWebServiceResponse.
Public Property ReviewStatus Amazon.SimpleSystemsManagement.ReviewStatus

Gets and sets the property ReviewStatus.

The current review status of a new custom Systems Manager document (SSM document) created by a member of your organization, or of the latest version of an existing SSM document.

Only one version of an SSM document can be in the APPROVED state at a time. When a new version is approved, the status of the previous version changes to REJECTED.

Only one version of an SSM document can be in review, or PENDING, at a time.

Public Property Status Amazon.SimpleSystemsManagement.DocumentStatus

Gets and sets the property Status.

The status of the SSM document, such as Creating, Active, Updating, Failed, and Deleting.

Public Property StatusInformation System.String

Gets and sets the property StatusInformation.

A message returned by Amazon Web Services Systems Manager that explains the Status value. For example, a Failed status might be explained by the StatusInformation message, "The specified S3 bucket doesn't exist. Verify that the URL of the S3 bucket is correct."

Public Property VersionName System.String

Gets and sets the property VersionName.

The version of the artifact associated with the document. For example, 12.6. This value is unique across all versions of a document, and can't be changed.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5