The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.

NAME

Paws::SSM::GetDocument - Arguments for method GetDocument on Paws::SSM

DESCRIPTION

This class represents the parameters used for calling the method GetDocument on the Amazon Simple Systems Manager (SSM) service. Use the attributes of this class as arguments to method GetDocument.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to GetDocument.

SYNOPSIS

    my $ssm = Paws->service('SSM');
    my $GetDocumentResult = $ssm->GetDocument(
      Name            => 'MyDocumentARN',
      DocumentFormat  => 'YAML',                     # OPTIONAL
      DocumentVersion => 'MyDocumentVersion',        # OPTIONAL
      VersionName     => 'MyDocumentVersionName',    # OPTIONAL
    );

    # Results:
    my $AttachmentsContent = $GetDocumentResult->AttachmentsContent;
    my $Content            = $GetDocumentResult->Content;
    my $CreatedDate        = $GetDocumentResult->CreatedDate;
    my $DisplayName        = $GetDocumentResult->DisplayName;
    my $DocumentFormat     = $GetDocumentResult->DocumentFormat;
    my $DocumentType       = $GetDocumentResult->DocumentType;
    my $DocumentVersion    = $GetDocumentResult->DocumentVersion;
    my $Name               = $GetDocumentResult->Name;
    my $Requires           = $GetDocumentResult->Requires;
    my $ReviewStatus       = $GetDocumentResult->ReviewStatus;
    my $Status             = $GetDocumentResult->Status;
    my $StatusInformation  = $GetDocumentResult->StatusInformation;
    my $VersionName        = $GetDocumentResult->VersionName;

    # Returns a L<Paws::SSM::GetDocumentResult> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/ssm/GetDocument

ATTRIBUTES

DocumentFormat => Str

Returns the document in the specified format. The document format can be either JSON or YAML. JSON is the default format.

Valid values are: "YAML", "JSON", "TEXT"

DocumentVersion => Str

The document version for which you want information.

REQUIRED Name => Str

The name of the Systems Manager document.

VersionName => Str

An optional field specifying the version of the artifact associated with the document. For example, "Release 12, Update 6". This value is unique across all versions of a document and can't be changed.

SEE ALSO

This class forms part of Paws, documenting arguments for method GetDocument 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