« blib/lib/Paws/SSM/UpdateAssociationStatusResult.pm
↑ Summary
blib/lib/Paws/SSM/UpdateDocumentDefaultVersion.pm »
| 1 | |||
| 2 | package Paws::SSM::UpdateDocument; | ||
| 3 | use Moose; | ||
| 4 | has Attachments => (is => 'ro', isa => 'ArrayRef[Paws::SSM::AttachmentsSource]'); | ||
| 5 | has Content => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | has DisplayName => (is => 'ro', isa => 'Str'); | ||
| 7 | has DocumentFormat => (is => 'ro', isa => 'Str'); | ||
| 8 | has DocumentVersion => (is => 'ro', isa => 'Str'); | ||
| 9 | has Name => (is => 'ro', isa => 'Str', required => 1); | ||
| 10 | has TargetType => (is => 'ro', isa => 'Str'); | ||
| 11 | has VersionName => (is => 'ro', isa => 'Str'); | ||
| 12 | |||
| 13 | use MooseX::ClassAttribute; | ||
| 14 | |||
| 15 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'UpdateDocument'); | ||
| 16 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::SSM::UpdateDocumentResult'); | ||
| 17 | class_has _result_key => (isa => 'Str', is => 'ro'); | ||
| 18 | 1; | ||
| 19 | |||
| 20 | ### main pod documentation begin ### | ||
| 21 | |||
| 22 | =head1 NAME | ||
| 23 | |||
| 24 | Paws::SSM::UpdateDocument - Arguments for method UpdateDocument on L<Paws::SSM> | ||
| 25 | |||
| 26 | =head1 DESCRIPTION | ||
| 27 | |||
| 28 | This class represents the parameters used for calling the method UpdateDocument on the | ||
| 29 | L<Amazon Simple Systems Manager (SSM)|Paws::SSM> service. Use the attributes of this class | ||
| 30 | as arguments to method UpdateDocument. | ||
| 31 | |||
| 32 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to UpdateDocument. | ||
| 33 | |||
| 34 | =head1 SYNOPSIS | ||
| 35 | |||
| 36 | my $ssm = Paws->service('SSM'); | ||
| 37 | my $UpdateDocumentResult = $ssm->UpdateDocument( | ||
| 38 | Content => 'MyDocumentContent', | ||
| 39 | Name => 'MyDocumentName', | ||
| 40 | Attachments => [ | ||
| 41 | { | ||
| 42 | Key => 'SourceUrl' | ||
| 43 | , # values: SourceUrl, S3FileUrl, AttachmentReference; OPTIONAL | ||
| 44 | Name => 'MyAttachmentIdentifier', # OPTIONAL | ||
| 45 | Values => [ | ||
| 46 | 'MyAttachmentsSourceValue', ... # min: 1, max: 1024 | ||
| 47 | ], # min: 1, max: 1; OPTIONAL | ||
| 48 | }, | ||
| 49 | ... | ||
| 50 | ], # OPTIONAL | ||
| 51 | DisplayName => 'MyDocumentDisplayName', # OPTIONAL | ||
| 52 | DocumentFormat => 'YAML', # OPTIONAL | ||
| 53 | DocumentVersion => 'MyDocumentVersion', # OPTIONAL | ||
| 54 | TargetType => 'MyTargetType', # OPTIONAL | ||
| 55 | VersionName => 'MyDocumentVersionName', # OPTIONAL | ||
| 56 | ); | ||
| 57 | |||
| 58 | # Results: | ||
| 59 | my $DocumentDescription = $UpdateDocumentResult->DocumentDescription; | ||
| 60 | |||
| 61 | # Returns a L<Paws::SSM::UpdateDocumentResult> object. | ||
| 62 | |||
| 63 | 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. | ||
| 64 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/ssm/UpdateDocument> | ||
| 65 | |||
| 66 | =head1 ATTRIBUTES | ||
| 67 | |||
| 68 | |||
| 69 | =head2 Attachments => ArrayRef[L<Paws::SSM::AttachmentsSource>] | ||
| 70 | |||
| 71 | A list of key and value pairs that describe attachments to a version of | ||
| 72 | a document. | ||
| 73 | |||
| 74 | |||
| 75 | |||
| 76 | =head2 B<REQUIRED> Content => Str | ||
| 77 | |||
| 78 | A valid JSON or YAML string. | ||
| 79 | |||
| 80 | |||
| 81 | |||
| 82 | =head2 DisplayName => Str | ||
| 83 | |||
| 84 | The friendly name of the Systems Manager document that you want to | ||
| 85 | update. This value can differ for each version of the document. If you | ||
| 86 | do not specify a value for this parameter in your request, the existing | ||
| 87 | value is applied to the new document version. | ||
| 88 | |||
| 89 | |||
| 90 | |||
| 91 | =head2 DocumentFormat => Str | ||
| 92 | |||
| 93 | Specify the document format for the new document version. Systems | ||
| 94 | Manager supports JSON and YAML documents. JSON is the default format. | ||
| 95 | |||
| 96 | Valid values are: C<"YAML">, C<"JSON">, C<"TEXT"> | ||
| 97 | |||
| 98 | =head2 DocumentVersion => Str | ||
| 99 | |||
| 100 | The version of the document that you want to update. Currently, Systems | ||
| 101 | Manager supports updating only the latest version of the document. You | ||
| 102 | can specify the version number of the latest version or use the | ||
| 103 | C<$LATEST> variable. | ||
| 104 | |||
| 105 | |||
| 106 | |||
| 107 | =head2 B<REQUIRED> Name => Str | ||
| 108 | |||
| 109 | The name of the Systems Manager document that you want to update. | ||
| 110 | |||
| 111 | |||
| 112 | |||
| 113 | =head2 TargetType => Str | ||
| 114 | |||
| 115 | Specify a new target type for the document. | ||
| 116 | |||
| 117 | |||
| 118 | |||
| 119 | =head2 VersionName => Str | ||
| 120 | |||
| 121 | An optional field specifying the version of the artifact you are | ||
| 122 | updating with the document. For example, "Release 12, Update 6". This | ||
| 123 | value is unique across all versions of a document, and cannot be | ||
| 124 | changed. | ||
| 125 | |||
| 126 | |||
| 127 | |||
| 128 | |||
| 129 | =head1 SEE ALSO | ||
| 130 | |||
| 131 | This class forms part of L<Paws>, documenting arguments for method UpdateDocument in L<Paws::SSM> | ||
| 132 | |||
| 133 | =head1 BUGS and CONTRIBUTIONS | ||
| 134 | |||
| 135 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 136 | |||
| 137 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 138 | |||
| 139 | =cut | ||
| 140 |