| 1 | # Generated by default/object.tt | ||
| 2 | package Paws::Backup::BackupJob; | ||
| 3 | use Moose; | ||
| 4 | has AccountId => (is => 'ro', isa => 'Str'); | ||
| 5 | has BackupJobId => (is => 'ro', isa => 'Str'); | ||
| 6 | has BackupOptions => (is => 'ro', isa => 'Paws::Backup::BackupOptions'); | ||
| 7 | has BackupSizeInBytes => (is => 'ro', isa => 'Int'); | ||
| 8 | has BackupType => (is => 'ro', isa => 'Str'); | ||
| 9 | has BackupVaultArn => (is => 'ro', isa => 'Str'); | ||
| 10 | has BackupVaultName => (is => 'ro', isa => 'Str'); | ||
| 11 | has BytesTransferred => (is => 'ro', isa => 'Int'); | ||
| 12 | has CompletionDate => (is => 'ro', isa => 'Str'); | ||
| 13 | has CreatedBy => (is => 'ro', isa => 'Paws::Backup::RecoveryPointCreator'); | ||
| 14 | has CreationDate => (is => 'ro', isa => 'Str'); | ||
| 15 | has ExpectedCompletionDate => (is => 'ro', isa => 'Str'); | ||
| 16 | has IamRoleArn => (is => 'ro', isa => 'Str'); | ||
| 17 | has PercentDone => (is => 'ro', isa => 'Str'); | ||
| 18 | has RecoveryPointArn => (is => 'ro', isa => 'Str'); | ||
| 19 | has ResourceArn => (is => 'ro', isa => 'Str'); | ||
| 20 | has ResourceType => (is => 'ro', isa => 'Str'); | ||
| 21 | has StartBy => (is => 'ro', isa => 'Str'); | ||
| 22 | has State => (is => 'ro', isa => 'Str'); | ||
| 23 | has StatusMessage => (is => 'ro', isa => 'Str'); | ||
| 24 | |||
| 25 | 1; | ||
| 26 | |||
| 27 | ### main pod documentation begin ### | ||
| 28 | |||
| 29 | =head1 NAME | ||
| 30 | |||
| 31 | Paws::Backup::BackupJob | ||
| 32 | |||
| 33 | =head1 USAGE | ||
| 34 | |||
| 35 | This class represents one of two things: | ||
| 36 | |||
| 37 | =head3 Arguments in a call to a service | ||
| 38 | |||
| 39 | Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. | ||
| 40 | Each attribute should be used as a named argument in the calls that expect this type of object. | ||
| 41 | |||
| 42 | As an example, if Att1 is expected to be a Paws::Backup::BackupJob object: | ||
| 43 | |||
| 44 | $service_obj->Method(Att1 => { AccountId => $value, ..., StatusMessage => $value }); | ||
| 45 | |||
| 46 | =head3 Results returned from an API call | ||
| 47 | |||
| 48 | Use accessors for each attribute. If Att1 is expected to be an Paws::Backup::BackupJob object: | ||
| 49 | |||
| 50 | $result = $service_obj->Method(...); | ||
| 51 | $result->Att1->AccountId | ||
| 52 | |||
| 53 | =head1 DESCRIPTION | ||
| 54 | |||
| 55 | Contains detailed information about a backup job. | ||
| 56 | |||
| 57 | =head1 ATTRIBUTES | ||
| 58 | |||
| 59 | |||
| 60 | =head2 AccountId => Str | ||
| 61 | |||
| 62 | The account ID that owns the backup job. | ||
| 63 | |||
| 64 | |||
| 65 | =head2 BackupJobId => Str | ||
| 66 | |||
| 67 | Uniquely identifies a request to AWS Backup to back up a resource. | ||
| 68 | |||
| 69 | |||
| 70 | =head2 BackupOptions => L<Paws::Backup::BackupOptions> | ||
| 71 | |||
| 72 | Specifies the backup option for a selected resource. This option is | ||
| 73 | only available for Windows VSS backup jobs. | ||
| 74 | |||
| 75 | Valid values: Set to C<"WindowsVSSE<rdquo>:E<ldquo>enabled"> to enable | ||
| 76 | WindowsVSS backup option and create a VSS Windows backup. Set to | ||
| 77 | E<ldquo>WindowsVSSE<rdquo>:E<rdquo>disabledE<rdquo> to create a regular | ||
| 78 | backup. If you specify an invalid option, you get an | ||
| 79 | C<InvalidParameterValueException> exception. | ||
| 80 | |||
| 81 | |||
| 82 | =head2 BackupSizeInBytes => Int | ||
| 83 | |||
| 84 | The size, in bytes, of a backup. | ||
| 85 | |||
| 86 | |||
| 87 | =head2 BackupType => Str | ||
| 88 | |||
| 89 | Represents the type of backup for a backup job. | ||
| 90 | |||
| 91 | |||
| 92 | =head2 BackupVaultArn => Str | ||
| 93 | |||
| 94 | An Amazon Resource Name (ARN) that uniquely identifies a backup vault; | ||
| 95 | for example, | ||
| 96 | C<arn:aws:backup:us-east-1:123456789012:vault:aBackupVault>. | ||
| 97 | |||
| 98 | |||
| 99 | =head2 BackupVaultName => Str | ||
| 100 | |||
| 101 | The name of a logical container where backups are stored. Backup vaults | ||
| 102 | are identified by names that are unique to the account used to create | ||
| 103 | them and the AWS Region where they are created. They consist of | ||
| 104 | lowercase letters, numbers, and hyphens. | ||
| 105 | |||
| 106 | |||
| 107 | =head2 BytesTransferred => Int | ||
| 108 | |||
| 109 | The size in bytes transferred to a backup vault at the time that the | ||
| 110 | job status was queried. | ||
| 111 | |||
| 112 | |||
| 113 | =head2 CompletionDate => Str | ||
| 114 | |||
| 115 | The date and time a job to create a backup job is completed, in Unix | ||
| 116 | format and Coordinated Universal Time (UTC). The value of | ||
| 117 | C<CompletionDate> is accurate to milliseconds. For example, the value | ||
| 118 | 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM. | ||
| 119 | |||
| 120 | |||
| 121 | =head2 CreatedBy => L<Paws::Backup::RecoveryPointCreator> | ||
| 122 | |||
| 123 | Contains identifying information about the creation of a backup job, | ||
| 124 | including the C<BackupPlanArn>, C<BackupPlanId>, C<BackupPlanVersion>, | ||
| 125 | and C<BackupRuleId> of the backup plan used to create it. | ||
| 126 | |||
| 127 | |||
| 128 | =head2 CreationDate => Str | ||
| 129 | |||
| 130 | The date and time a backup job is created, in Unix format and | ||
| 131 | Coordinated Universal Time (UTC). The value of C<CreationDate> is | ||
| 132 | accurate to milliseconds. For example, the value 1516925490.087 | ||
| 133 | represents Friday, January 26, 2018 12:11:30.087 AM. | ||
| 134 | |||
| 135 | |||
| 136 | =head2 ExpectedCompletionDate => Str | ||
| 137 | |||
| 138 | The date and time a job to back up resources is expected to be | ||
| 139 | completed, in Unix format and Coordinated Universal Time (UTC). The | ||
| 140 | value of C<ExpectedCompletionDate> is accurate to milliseconds. For | ||
| 141 | example, the value 1516925490.087 represents Friday, January 26, 2018 | ||
| 142 | 12:11:30.087 AM. | ||
| 143 | |||
| 144 | |||
| 145 | =head2 IamRoleArn => Str | ||
| 146 | |||
| 147 | Specifies the IAM role ARN used to create the target recovery point. | ||
| 148 | IAM roles other than the default role must include either C<AWSBackup> | ||
| 149 | or C<AwsBackup> in the role name. For example, | ||
| 150 | C<arn:aws:iam::123456789012:role/AWSBackupRDSAccess>. Role names | ||
| 151 | without those strings lack permissions to perform backup jobs. | ||
| 152 | |||
| 153 | |||
| 154 | =head2 PercentDone => Str | ||
| 155 | |||
| 156 | Contains an estimated percentage complete of a job at the time the job | ||
| 157 | status was queried. | ||
| 158 | |||
| 159 | |||
| 160 | =head2 RecoveryPointArn => Str | ||
| 161 | |||
| 162 | An ARN that uniquely identifies a recovery point; for example, | ||
| 163 | C<arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45>. | ||
| 164 | |||
| 165 | |||
| 166 | =head2 ResourceArn => Str | ||
| 167 | |||
| 168 | An ARN that uniquely identifies a resource. The format of the ARN | ||
| 169 | depends on the resource type. | ||
| 170 | |||
| 171 | |||
| 172 | =head2 ResourceType => Str | ||
| 173 | |||
| 174 | The type of AWS resource to be backed up; for example, an Amazon | ||
| 175 | Elastic Block Store (Amazon EBS) volume or an Amazon Relational | ||
| 176 | Database Service (Amazon RDS) database. For VSS Windows backups, the | ||
| 177 | only supported resource type is Amazon EC2. | ||
| 178 | |||
| 179 | |||
| 180 | =head2 StartBy => Str | ||
| 181 | |||
| 182 | Specifies the time in Unix format and Coordinated Universal Time (UTC) | ||
| 183 | when a backup job must be started before it is canceled. The value is | ||
| 184 | calculated by adding the start window to the scheduled time. So if the | ||
| 185 | scheduled time were 6:00 PM and the start window is 2 hours, the | ||
| 186 | C<StartBy> time would be 8:00 PM on the date specified. The value of | ||
| 187 | C<StartBy> is accurate to milliseconds. For example, the value | ||
| 188 | 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM. | ||
| 189 | |||
| 190 | |||
| 191 | =head2 State => Str | ||
| 192 | |||
| 193 | The current state of a resource recovery point. | ||
| 194 | |||
| 195 | |||
| 196 | =head2 StatusMessage => Str | ||
| 197 | |||
| 198 | A detailed message explaining the status of the job to back up a | ||
| 199 | resource. | ||
| 200 | |||
| 201 | |||
| 202 | |||
| 203 | =head1 SEE ALSO | ||
| 204 | |||
| 205 | This class forms part of L<Paws>, describing an object used in L<Paws::Backup> | ||
| 206 | |||
| 207 | =head1 BUGS and CONTRIBUTIONS | ||
| 208 | |||
| 209 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 210 | |||
| 211 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 212 | |||
| 213 | =cut | ||
| 214 |