NAME
Paws::Backup::BackupJob
USAGE
This class represents one of two things:
Arguments in a call to a service
Use the attributes of this class as arguments to methods. You shouldn't make instances of this class. Each attribute should be used as a named argument in the calls that expect this type of object.
As an example, if Att1 is expected to be a Paws::Backup::BackupJob object:
$service_obj->Method(Att1 => { AccountId => $value, ..., StatusMessage => $value });
Results returned from an API call
Use accessors for each attribute. If Att1 is expected to be an Paws::Backup::BackupJob object:
$result = $service_obj->Method(...);
$result->Att1->AccountId
DESCRIPTION
Contains detailed information about a backup job.
ATTRIBUTES
AccountId => Str
The account ID that owns the backup job.
BackupJobId => Str
Uniquely identifies a request to AWS Backup to back up a resource.
BackupOptions => Paws::Backup::BackupOptions
Specifies the backup option for a selected resource. This option is only available for Windows VSS backup jobs.
Valid values: Set to "WindowsVSS”:“enabled"
to enable WindowsVSS backup option and create a VSS Windows backup. Set to “WindowsVSS”:”disabled” to create a regular backup. If you specify an invalid option, you get an InvalidParameterValueException
exception.
BackupSizeInBytes => Int
The size, in bytes, of a backup.
BackupType => Str
Represents the type of backup for a backup job.
BackupVaultArn => Str
An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault
.
BackupVaultName => Str
The name of a logical container where backups are stored. Backup vaults are identified by names that are unique to the account used to create them and the AWS Region where they are created. They consist of lowercase letters, numbers, and hyphens.
BytesTransferred => Int
The size in bytes transferred to a backup vault at the time that the job status was queried.
CompletionDate => Str
The date and time a job to create a backup job is completed, in Unix format and Coordinated Universal Time (UTC). The value of CompletionDate
is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
CreatedBy => Paws::Backup::RecoveryPointCreator
Contains identifying information about the creation of a backup job, including the BackupPlanArn
, BackupPlanId
, BackupPlanVersion
, and BackupRuleId
of the backup plan used to create it.
CreationDate => Str
The date and time a backup job is created, in Unix format and Coordinated Universal Time (UTC). The value of CreationDate
is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
ExpectedCompletionDate => Str
The date and time a job to back up resources is expected to be completed, in Unix format and Coordinated Universal Time (UTC). The value of ExpectedCompletionDate
is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
IamRoleArn => Str
Specifies the IAM role ARN used to create the target recovery point. IAM roles other than the default role must include either AWSBackup
or AwsBackup
in the role name. For example, arn:aws:iam::123456789012:role/AWSBackupRDSAccess
. Role names without those strings lack permissions to perform backup jobs.
PercentDone => Str
Contains an estimated percentage complete of a job at the time the job status was queried.
RecoveryPointArn => Str
An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45
.
ResourceArn => Str
An ARN that uniquely identifies a resource. The format of the ARN depends on the resource type.
ResourceType => Str
The type of AWS resource to be backed up; for example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS) database. For VSS Windows backups, the only supported resource type is Amazon EC2.
StartBy => Str
Specifies the time in Unix format and Coordinated Universal Time (UTC) when a backup job must be started before it is canceled. The value is calculated by adding the start window to the scheduled time. So if the scheduled time were 6:00 PM and the start window is 2 hours, the StartBy
time would be 8:00 PM on the date specified. The value of StartBy
is accurate to milliseconds. For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
State => Str
The current state of a resource recovery point.
StatusMessage => Str
A detailed message explaining the status of the job to back up a resource.
SEE ALSO
This class forms part of Paws, describing an object used in Paws::Backup
BUGS and CONTRIBUTIONS
The source code is located here: https://github.com/pplu/aws-sdk-perl
Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues