DocumentDescription

public struct DocumentDescription : AWSShape

Undocumented

  • Declaration

    Swift

    public static var _members: [AWSShapeMember]

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

    Declaration

    Swift

    public let attachmentsInformation: [AttachmentInformation]?

  • The date when the document was created.

    Declaration

    Swift

    public let createdDate: TimeStamp?

  • The default version.

    Declaration

    Swift

    public let defaultVersion: String?

  • A description of the document.

    Declaration

    Swift

    public let description: String?

  • The document format, either JSON or YAML.

    Declaration

    Swift

    public let documentFormat: DocumentFormat?

  • The type of document.

    Declaration

    Swift

    public let documentType: DocumentType?

  • The document version.

    Declaration

    Swift

    public let documentVersion: String?

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

    Declaration

    Swift

    public let hash: String?

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

    Declaration

    Swift

    public let hashType: DocumentHashType?

  • The latest version of the document.

    Declaration

    Swift

    public let latestVersion: String?

  • The name of the Systems Manager document.

    Declaration

    Swift

    public let name: String?

  • The AWS user account that created the document.

    Declaration

    Swift

    public let owner: String?

  • A description of the parameters for a document.

    Declaration

    Swift

    public let parameters: [DocumentParameter]?

  • The list of OS platforms compatible with this Systems Manager document.

    Declaration

    Swift

    public let platformTypes: [PlatformType]?

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

    Declaration

    Swift

    public let requires: [DocumentRequires]?

  • The schema version.

    Declaration

    Swift

    public let schemaVersion: String?

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

    Declaration

    Swift

    public let sha1: String?

  • The status of the Systems Manager document.

    Declaration

    Swift

    public let status: DocumentStatus?

  • A message returned by AWS Systems Manager that explains the Status value. For example, a Failed status might be explained by the StatusInformation message, “The specified S3 bucket does not exist. Verify that the URL of the S3 bucket is correct.”

    Declaration

    Swift

    public let statusInformation: String?

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

    Declaration

    Swift

    public let tags: [Tag]?

  • 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 AWS resource and property types reference in the AWS CloudFormation User Guide.

    Declaration

    Swift

    public let targetType: String?

  • The version of the artifact associated with the document.

    Declaration

    Swift

    public let versionName: String?

  • Undocumented

    Declaration

    Swift

    public init(attachmentsInformation: [AttachmentInformation]? = nil, createdDate: TimeStamp? = nil, defaultVersion: String? = nil, description: String? = nil, documentFormat: DocumentFormat? = nil, documentType: DocumentType? = nil, documentVersion: String? = nil, hash: String? = nil, hashType: DocumentHashType? = nil, latestVersion: String? = nil, name: String? = nil, owner: String? = nil, parameters: [DocumentParameter]? = nil, platformTypes: [PlatformType]? = nil, requires: [DocumentRequires]? = nil, schemaVersion: String? = nil, sha1: String? = nil, status: DocumentStatus? = nil, statusInformation: String? = nil, tags: [Tag]? = nil, targetType: String? = nil, versionName: String? = nil)