| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::AppSync::ApiKey; | ||
| 3 | use Moose; | ||
| 4 | has Deletes => (is => 'ro', isa => 'Int', request_name => 'deletes', traits => ['NameInRequest']); | ||
| 5 | has Description => (is => 'ro', isa => 'Str', request_name => 'description', traits => ['NameInRequest']); | ||
| 6 | has Expires => (is => 'ro', isa => 'Int', request_name => 'expires', traits => ['NameInRequest']); | ||
| 7 | has Id => (is => 'ro', isa => 'Str', request_name => 'id', traits => ['NameInRequest']); | ||
| 8 | |||
| 9 | 1; | ||
| 10 | |||
| 11 | ### main pod documentation begin ### | ||
| 12 | |||
| 13 | =head1 NAME | ||
| 14 | |||
| 15 | Paws::AppSync::ApiKey | ||
| 16 | |||
| 17 | =head1 USAGE | ||
| 18 | |||
| 19 | This class represents one of two things: | ||
| 20 | |||
| 21 | =head3 Arguments in a call to a service | ||
| 22 | |||
| 23 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 24 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 25 | |||
| 26 | As an example, if Att1 is expected to be a Paws::AppSync::ApiKey object: | ||
| 27 | |||
| 28 | $service_obj->Method(Att1 => { Deletes => $value, ..., Id => $value }); | ||
| 29 | |||
| 30 | =head3 Results returned from an API call | ||
| 31 | |||
| 32 | Use accessors for each attribute. If Att1 is expected to be an Paws::AppSync::ApiKey object: | ||
| 33 | |||
| 34 | $result = $service_obj->Method(...); | ||
| 35 | $result->Att1->Deletes | ||
| 36 | |||
| 37 | =head1 DESCRIPTION | ||
| 38 | |||
| 39 | Describes an API key. | ||
| 40 | |||
| 41 | Customers invoke AWS AppSync GraphQL API operations with API keys as an | ||
| 42 | identity mechanism. There are two key versions: | ||
| 43 | |||
| 44 | B<da1>: This version was introduced at launch in November 2017. These | ||
| 45 | keys always expire after 7 days. Key expiration is managed by Amazon | ||
| 46 | DynamoDB TTL. The keys ceased to be valid after February 21, 2018 and | ||
| 47 | should not be used after that date. | ||
| 48 | |||
| 49 | =over | ||
| 50 | |||
| 51 | =item * | ||
| 52 | |||
| 53 | C<ListApiKeys> returns the expiration time in milliseconds. | ||
| 54 | |||
| 55 | =item * | ||
| 56 | |||
| 57 | C<CreateApiKey> returns the expiration time in milliseconds. | ||
| 58 | |||
| 59 | =item * | ||
| 60 | |||
| 61 | C<UpdateApiKey> is not available for this key version. | ||
| 62 | |||
| 63 | =item * | ||
| 64 | |||
| 65 | C<DeleteApiKey> deletes the item from the table. | ||
| 66 | |||
| 67 | =item * | ||
| 68 | |||
| 69 | Expiration is stored in Amazon DynamoDB as milliseconds. This results | ||
| 70 | in a bug where keys are not automatically deleted because DynamoDB | ||
| 71 | expects the TTL to be stored in seconds. As a one-time action, we will | ||
| 72 | delete these keys from the table after February 21, 2018. | ||
| 73 | |||
| 74 | =back | ||
| 75 | |||
| 76 | B<da2>: This version was introduced in February 2018 when AppSync added | ||
| 77 | support to extend key expiration. | ||
| 78 | |||
| 79 | =over | ||
| 80 | |||
| 81 | =item * | ||
| 82 | |||
| 83 | C<ListApiKeys> returns the expiration time and deletion time in | ||
| 84 | seconds. | ||
| 85 | |||
| 86 | =item * | ||
| 87 | |||
| 88 | C<CreateApiKey> returns the expiration time and deletion time in | ||
| 89 | seconds and accepts a user-provided expiration time in seconds. | ||
| 90 | |||
| 91 | =item * | ||
| 92 | |||
| 93 | C<UpdateApiKey> returns the expiration time and and deletion time in | ||
| 94 | seconds and accepts a user-provided expiration time in seconds. Expired | ||
| 95 | API keys are kept for 60 days after the expiration time. Key expiration | ||
| 96 | time can be updated while the key is not deleted. | ||
| 97 | |||
| 98 | =item * | ||
| 99 | |||
| 100 | C<DeleteApiKey> deletes the item from the table. | ||
| 101 | |||
| 102 | =item * | ||
| 103 | |||
| 104 | Expiration is stored in Amazon DynamoDB as seconds. After the | ||
| 105 | expiration time, using the key to authenticate will fail. But the key | ||
| 106 | can be reinstated before deletion. | ||
| 107 | |||
| 108 | =item * | ||
| 109 | |||
| 110 | Deletion is stored in Amazon DynamoDB as seconds. The key will be | ||
| 111 | deleted after deletion time. | ||
| 112 | |||
| 113 | =back | ||
| 114 | |||
| 115 | |||
| 116 | =head1 ATTRIBUTES | ||
| 117 | |||
| 118 | |||
| 119 | =head2 Deletes => Int | ||
| 120 | |||
| 121 | The time after which the API key is deleted. The date is represented as | ||
| 122 | seconds since the epoch, rounded down to the nearest hour. | ||
| 123 | |||
| 124 | |||
| 125 | =head2 Description => Str | ||
| 126 | |||
| 127 | A description of the purpose of the API key. | ||
| 128 | |||
| 129 | |||
| 130 | =head2 Expires => Int | ||
| 131 | |||
| 132 | The time after which the API key expires. The date is represented as | ||
| 133 | seconds since the epoch, rounded down to the nearest hour. | ||
| 134 | |||
| 135 | |||
| 136 | =head2 Id => Str | ||
| 137 | |||
| 138 | The API key ID. | ||
| 139 | |||
| 140 | |||
| 141 | |||
| 142 | =head1 SEE ALSO | ||
| 143 | |||
| 144 | This class forms part of L<Paws>, describing an object used in L<Paws::AppSync> | ||
| 145 | |||
| 146 | =head1 BUGS and CONTRIBUTIONS | ||
| 147 | |||
| 148 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 149 | |||
| 150 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 151 | |||
| 152 | =cut | ||
| 153 |