NAME
Paws::SSM::DocumentDescription
USAGE
This class represents one of two things:
Arguments in a call to a service
Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. Each attribute should be used as a named argument in the calls that expect this type of object.
As an example, if Att1 is expected to be a Paws::SSM::DocumentDescription object:
$service_obj->Method(Att1 => { ApprovedVersion => $value, ..., VersionName => $value });
Results returned from an API call
Use accessors for each attribute. If Att1 is expected to be an Paws::SSM::DocumentDescription object:
$result = $service_obj->Method(...);
$result->Att1->ApprovedVersion
DESCRIPTION
Describes a Systems Manager document.
ATTRIBUTES
ApprovedVersion => Str
The version of the document currently approved for use in the organization.
AttachmentsInformation => ArrayRef[Paws::SSM::AttachmentInformation]
Details about the document attachments, including names, locations, sizes, and so on.
Author => Str
The user in your organization who created the document.
CreatedDate => Str
The date when the document was created.
DefaultVersion => Str
The default version.
Description => Str
A description of the document.
DisplayName => Str
The friendly name of the Systems Manager document. This value can differ for each version of the document. If you want to update this value, see UpdateDocument.
DocumentFormat => Str
The document format, either JSON or YAML.
DocumentType => Str
The type of document.
DocumentVersion => Str
The document version.
Hash => Str
The Sha256 or Sha1 hash created by the system when the document was created.
Sha1 hashes have been deprecated.
HashType => Str
The hash type of the document. Valid values include Sha256
or Sha1
.
Sha1 hashes have been deprecated.
LatestVersion => Str
The latest version of the document.
Name => Str
The name of the Systems Manager document.
Owner => Str
The AWS user account that created the document.
Parameters => ArrayRef[Paws::SSM::DocumentParameter]
A description of the parameters for a document.
PendingReviewVersion => Str
The version of the document that is currently under review.
PlatformTypes => ArrayRef[Str|Undef]
The list of OS platforms compatible with this Systems Manager document.
Requires => ArrayRef[Paws::SSM::DocumentRequires]
A list of SSM documents required by a document. For example, an ApplicationConfiguration
document requires an ApplicationConfigurationSchema
document.
ReviewInformation => ArrayRef[Paws::SSM::ReviewInformation]
Details about the review of a document.
ReviewStatus => Str
The current status of the review.
SchemaVersion => Str
The schema version.
Sha1 => Str
The SHA1 hash of the document, which you can use for verification.
Status => Str
The status of the Systems Manager document.
StatusInformation => Str
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."
Tags => ArrayRef[Paws::SSM::Tag]
The tags, or metadata, that have been applied to the document.
TargetType => Str
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 (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-template-resource-type-ref.html) in the AWS CloudFormation User Guide.
VersionName => Str
The version of the artifact associated with the document.
SEE ALSO
This class forms part of Paws, describing an object used in Paws::SSM
BUGS and CONTRIBUTIONS
The source code is located here: https://github.com/pplu/aws-sdk-perl
Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues