« blib/lib/Paws/PinpointEmail/SnsDestination.pm
↑ Summary
blib/lib/Paws/PinpointEmail/TagResource.pm »
| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::PinpointEmail::Tag; | ||
| 3 | use Moose; | ||
| 4 | has Key => (is => 'ro', isa => 'Str', required => 1); | ||
| 5 | has Value => (is => 'ro', isa => 'Str', required => 1); | ||
| 6 | |||
| 7 | 1; | ||
| 8 | |||
| 9 | ### main pod documentation begin ### | ||
| 10 | |||
| 11 | =head1 NAME | ||
| 12 | |||
| 13 | Paws::PinpointEmail::Tag | ||
| 14 | |||
| 15 | =head1 USAGE | ||
| 16 | |||
| 17 | This class represents one of two things: | ||
| 18 | |||
| 19 | =head3 Arguments in a call to a service | ||
| 20 | |||
| 21 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 22 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 23 | |||
| 24 | As an example, if Att1 is expected to be a Paws::PinpointEmail::Tag object: | ||
| 25 | |||
| 26 | $service_obj->Method(Att1 => { Key => $value, ..., Value => $value }); | ||
| 27 | |||
| 28 | =head3 Results returned from an API call | ||
| 29 | |||
| 30 | Use accessors for each attribute. If Att1 is expected to be an Paws::PinpointEmail::Tag object: | ||
| 31 | |||
| 32 | $result = $service_obj->Method(...); | ||
| 33 | $result->Att1->Key | ||
| 34 | |||
| 35 | =head1 DESCRIPTION | ||
| 36 | |||
| 37 | An object that defines the tags that are associated with a resource. A | ||
| 38 | I<tag> is a label that you optionally define and associate with a | ||
| 39 | resource in Amazon Pinpoint. Tags can help you categorize and manage | ||
| 40 | resources in different ways, such as by purpose, owner, environment, or | ||
| 41 | other criteria. A resource can have as many as 50 tags. | ||
| 42 | |||
| 43 | Each tag consists of a required I<tag key> and an associated I<tag | ||
| 44 | value>, both of which you define. A tag key is a general label that | ||
| 45 | acts as a category for a more specific tag value. A tag value acts as a | ||
| 46 | descriptor within a tag key. A tag key can contain as many as 128 | ||
| 47 | characters. A tag value can contain as many as 256 characters. The | ||
| 48 | characters can be Unicode letters, digits, white space, or one of the | ||
| 49 | following symbols: _ . : / = + -. The following additional restrictions | ||
| 50 | apply to tags: | ||
| 51 | |||
| 52 | =over | ||
| 53 | |||
| 54 | =item * | ||
| 55 | |||
| 56 | Tag keys and values are case sensitive. | ||
| 57 | |||
| 58 | =item * | ||
| 59 | |||
| 60 | For each associated resource, each tag key must be unique and it can | ||
| 61 | have only one value. | ||
| 62 | |||
| 63 | =item * | ||
| 64 | |||
| 65 | The C<aws:> prefix is reserved for use by AWS; you canE<rsquo>t use it | ||
| 66 | in any tag keys or values that you define. In addition, you can't edit | ||
| 67 | or remove tag keys or values that use this prefix. Tags that use this | ||
| 68 | prefix donE<rsquo>t count against the limit of 50 tags per resource. | ||
| 69 | |||
| 70 | =item * | ||
| 71 | |||
| 72 | You can associate tags with public or shared resources, but the tags | ||
| 73 | are available only for your AWS account, not any other accounts that | ||
| 74 | share the resource. In addition, the tags are available only for | ||
| 75 | resources that are located in the specified AWS Region for your AWS | ||
| 76 | account. | ||
| 77 | |||
| 78 | =back | ||
| 79 | |||
| 80 | |||
| 81 | =head1 ATTRIBUTES | ||
| 82 | |||
| 83 | |||
| 84 | =head2 B<REQUIRED> Key => Str | ||
| 85 | |||
| 86 | One part of a key-value pair that defines a tag. The maximum length of | ||
| 87 | a tag key is 128 characters. The minimum length is 1 character. | ||
| 88 | |||
| 89 | |||
| 90 | =head2 B<REQUIRED> Value => Str | ||
| 91 | |||
| 92 | The optional part of a key-value pair that defines a tag. The maximum | ||
| 93 | length of a tag value is 256 characters. The minimum length is 0 | ||
| 94 | characters. If you donE<rsquo>t want a resource to have a specific tag | ||
| 95 | value, donE<rsquo>t specify a value for this parameter. Amazon Pinpoint | ||
| 96 | will set the value to an empty string. | ||
| 97 | |||
| 98 | |||
| 99 | |||
| 100 | =head1 SEE ALSO | ||
| 101 | |||
| 102 | This class forms part of L<Paws>, describing an object used in L<Paws::PinpointEmail> | ||
| 103 | |||
| 104 | =head1 BUGS and CONTRIBUTIONS | ||
| 105 | |||
| 106 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 107 | |||
| 108 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 109 | |||
| 110 | =cut | ||
| 111 |