.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.29)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{
.    if \nF \{
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "VM::EC2::REST::tag 3pm"
.TH VM::EC2::REST::tag 3pm "2016-06-04" "perl v5.22.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH "NAME VM::EC2::REST::tag \- Create, delete and fetch resource tags"
.IX Header "NAME VM::EC2::REST::tag - Create, delete and fetch resource tags"
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 1
\& use VM::EC2 \*(Aq:standard\*(Aq;
.Ve
.SH "METHODS"
.IX Header "METHODS"
These methods allow you to create, delete and fetch resource tags. You
may find that you rarely need to use these methods directly because
every object produced by \s-1VM::EC2\s0 supports a simple tag interface:
.PP
.Vb 5
\&  $object = $ec2\->describe_volumes(\-volume_id=>\*(Aqvol\-12345\*(Aq); # e.g.
\&  $tags = $object\->tags();
\&  $name = $tags\->{Name};
\&  $object\->add_tags(Role => \*(AqWeb Server\*(Aq, Status=>\*(Aqdevelopment);
\&  $object\->delete_tags(Name=>undef);
.Ve
.PP
See VM::EC2::Generic for a full description of the uniform object
tagging interface.
.PP
These methods are most useful when creating and deleting tags for
multiple resources simultaneously.
.PP
Implemented:
 CreateTags
 DeleteTags
 DescribeTags
.PP
Unimplemented:
 (none)
.ie n .SS "@t = $ec2\->describe_tags(\-filter=>\e%filters);"
.el .SS "\f(CW@t\fP = \f(CW$ec2\fP\->describe_tags(\-filter=>\e%filters);"
.IX Subsection "@t = $ec2->describe_tags(-filter=>%filters);"
Return a series of VM::EC2::Tag objects, each describing an
\&\s-1AMI. A\s0 single optional \-filter argument is allowed.
.PP
Available filters are: key, resource-id, resource-type and value. See
http://docs.amazonwebservices.com/AWSEC2/latest/APIReference/ApiReference\-query\-DescribeTags.html
.ie n .SS "$bool = $ec2\->create_tags(\-resource_id=>\e@ids,\-tag=>{key1=>value1...})"
.el .SS "\f(CW$bool\fP = \f(CW$ec2\fP\->create_tags(\-resource_id=>\e@ids,\-tag=>{key1=>value1...})"
.IX Subsection "$bool = $ec2->create_tags(-resource_id=>@ids,-tag=>{key1=>value1...})"
Tags the resource indicated by \-resource_id with the tag(s) in in the
hashref indicated by \-tag. You may specify a single resource by
passing a scalar resourceId to \-resource_id, or multiple resources
using an anonymous array. Returns a true value if tagging was
successful.
.PP
The method name \*(L"\fIadd_tags()\fR\*(R" is an alias for \fIcreate_tags()\fR.
.PP
You may find it more convenient to tag an object retrieved with any of
the \fIdescribe()\fR methods using the built-in \fIadd_tags()\fR method:
.PP
.Vb 2
\& @snap = $ec2\->describe_snapshots(\-filter=>{status=>\*(Aqcompleted\*(Aq});
\& foreach (@snap) {$_\->add_tags(ReadyToUse => \*(Aqtrue\*(Aq)}
.Ve
.PP
but if there are many snapshots to tag simultaneously, this will be faster:
.PP
.Vb 2
\& @snap = $ec2\->describe_snapshots(\-filter=>{status=>\*(Aqcompleted\*(Aq});
\& $ec2\->add_tags(\-resource_id=>\e@snap,\-tag=>{ReadyToUse=>\*(Aqtrue\*(Aq});
.Ve
.PP
Note that you can tag volumes, snapshots and images owned by other
people. Only you will be able to see these tags.
.ie n .SS "$bool = $ec2\->delete_tags(\-resource_id=>$id1,\-tag=>{key1=>value1...})"
.el .SS "\f(CW$bool\fP = \f(CW$ec2\fP\->delete_tags(\-resource_id=>$id1,\-tag=>{key1=>value1...})"
.IX Subsection "$bool = $ec2->delete_tags(-resource_id=>$id1,-tag=>{key1=>value1...})"
Delete the indicated tags from the indicated resource. Pass an
arrayref to operate on several resources at once. The tag syntax is a
bit tricky. Use a value of undef to delete the tag unconditionally:
.PP
.Vb 1
\& \-tag => { Role => undef }    # deletes any Role tag
.Ve
.PP
Any scalar value will cause the tag to be deleted only if its value
exactly matches the specified value:
.PP
.Vb 2
\& \-tag => { Role => \*(AqServer\*(Aq }  # only delete the Role tag
\&                               # if it currently has the value "Server"
.Ve
.PP
An empty string value ('') will only delete the tag if its value is an
empty string, which is probably not what you want.
.PP
Pass an array reference of tag names to delete each of the tag names
unconditionally (same as passing a value of undef):
.PP
.Vb 1
\& $ec2\->delete_tags([\*(AqName\*(Aq,\*(AqRole\*(Aq,\*(AqDescription\*(Aq]);
.Ve
.PP
You may find it more convenient to delete tags from objects using
their \fIdelete_tags()\fR method:
.PP
.Vb 2
\& @snap = $ec2\->describe_snapshots(\-filter=>{status=>\*(Aqcompleted\*(Aq});
\& foreach (@snap) {$_\->delete_tags(Role => undef)}
.Ve
.ie n .SS "@arguments = $ec2\->tagcreate_parm(\e%args)"
.el .SS "\f(CW@arguments\fP = \f(CW$ec2\fP\->tagcreate_parm(\e%args)"
.IX Subsection "@arguments = $ec2->tagcreate_parm(%args)"
.ie n .SS "@arguments = $ec2\->tagdelete_parm(\e%args)"
.el .SS "\f(CW@arguments\fP = \f(CW$ec2\fP\->tagdelete_parm(\e%args)"
.IX Subsection "@arguments = $ec2->tagdelete_parm(%args)"
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\s-1VM::EC2\s0
.SH "AUTHOR"
.IX Header "AUTHOR"
Lincoln Stein <lincoln.stein@gmail.com>.
.PP
Copyright (c) 2011 Ontario Institute for Cancer Research
.PP
This package and its accompanying libraries is free software; you can
redistribute it and/or modify it under the terms of the \s-1GPL \s0(either
version 1, or at your option, any later version) or the Artistic
License 2.0.  Refer to \s-1LICENSE\s0 for the full license text. In addition,
please see \s-1DISCLAIMER\s0.txt for disclaimers of warranty.