Module Values_0.DocumentDescriptionSource

Describes an Amazon Web Services Systems Manager document (SSM document).

Sourcetype nonrec t = {
  1. sha1 : DocumentSha1.t option;
    (*

    The SHA1 hash of the document, which you can use for verification.

    *)
  2. hash : DocumentHash.t option;
    (*

    The Sha256 or Sha1 hash created by the system when the document was created. Sha1 hashes have been deprecated.

    *)
  3. hashType : DocumentHashType.t option;
    (*

    The hash type of the document. Valid values include Sha256 or Sha1. Sha1 hashes have been deprecated.

    *)
  4. name : DocumentARN.t option;
    (*

    The name of the SSM document.

    *)
  5. displayName : DocumentDisplayName.t option;
    (*

    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.

    *)
  6. versionName : DocumentVersionName.t option;
    (*

    The version of the artifact associated with the document.

    *)
  7. owner : DocumentOwner.t option;
    (*

    The Amazon Web Services user that created the document.

    *)
  8. createdDate : DateTime.t option;
    (*

    The date when the document was created.

    *)
  9. status : DocumentStatus.t option;
    (*

    The status of the SSM document.

    *)
  10. statusInformation : DocumentStatusInformation.t option;
    (*

    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."

    *)
  11. documentVersion : DocumentVersion.t option;
    (*

    The document version.

    *)
  12. description : DescriptionInDocument.t option;
    (*

    A description of the document.

    *)
  13. parameters : DocumentParameterList.t option;
    (*

    A description of the parameters for a document.

    *)
  14. platformTypes : PlatformTypeList.t option;
    (*

    The list of operating system (OS) platforms compatible with this SSM document.

    *)
  15. documentType : DocumentType.t option;
    (*

    The type of document.

    *)
  16. schemaVersion : DocumentSchemaVersion.t option;
    (*

    The schema version.

    *)
  17. latestVersion : DocumentVersion.t option;
    (*

    The latest version of the document.

    *)
  18. defaultVersion : DocumentVersion.t option;
    (*

    The default version.

    *)
  19. documentFormat : DocumentFormat.t option;
    (*

    The document format, either JSON or YAML.

    *)
  20. targetType : TargetType.t option;
    (*

    The target type which defines the kinds of resources the document can run on. For example, /AWS::EC2::Instance. For a list of valid resource types, see Amazon Web Services resource and property types reference in the CloudFormation User Guide.

    *)
  21. tags : TagList.t option;
    (*

    The tags, or metadata, that have been applied to the document.

    *)
  22. attachmentsInformation : AttachmentInformationList.t option;
    (*

    Details about the document attachments, including names, locations, sizes, and so on.

    *)
  23. requires : DocumentRequiresList.t option;
    (*

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

    *)
  24. author : DocumentAuthor.t option;
    (*

    The user in your organization who created the document.

    *)
  25. reviewInformation : ReviewInformationList.t option;
    (*

    Details about the review of a document.

    *)
  26. approvedVersion : DocumentVersion.t option;
    (*

    The version of the document currently approved for use in the organization.

    *)
  27. pendingReviewVersion : DocumentVersion.t option;
    (*

    The version of the document that is currently under review.

    *)
  28. reviewStatus : ReviewStatus.t option;
    (*

    The current status of the review.

    *)
  29. category : CategoryList.t option;
    (*

    The classification of a document to help you identify and categorize its use.

    *)
  30. categoryEnum : CategoryEnumList.t option;
    (*

    The value that identifies a document's category.

    *)
}
Sourceval make : ?sha1:??? -> ?hash:??? -> ?hashType:??? -> ?name:??? -> ?displayName:??? -> ?versionName:??? -> ?owner:??? -> ?createdDate:??? -> ?status:??? -> ?statusInformation:??? -> ?documentVersion:??? -> ?description:??? -> ?parameters:??? -> ?platformTypes:??? -> ?documentType:??? -> ?schemaVersion:??? -> ?latestVersion:??? -> ?defaultVersion:??? -> ?documentFormat:??? -> ?targetType:??? -> ?tags:??? -> ?attachmentsInformation:??? -> ?requires:??? -> ?author:??? -> ?reviewInformation:??? -> ?approvedVersion:??? -> ?pendingReviewVersion:??? -> ?reviewStatus:??? -> ?category:??? -> ?categoryEnum:??? -> unit -> t
Sourceval to_value : t -> [> `Structure of (string * [> `Enum of string | `List of [> `Enum of string | `String of Category.t | `Structure of (string * [> `Enum of string | `String of DocumentParameterName.t | `Timestamp of DateTime.t ]) list ] list | `String of DocumentSha1.t | `Timestamp of DateTime.t ]) list ]
Sourceval to_query : t -> Awso.Client.Query.t
Sourceval of_xml : Awso.Xml.t -> t
Sourceval of_string : string -> t
Sourceval of_json : Yojson.Safe.t -> t
Sourceval to_json : t -> Yojson.Safe.t