« blib/lib/Paws/Backup/DeleteRecoveryPoint.pm
↑ Summary
blib/lib/Paws/Backup/DescribeBackupJobOutput.pm »
| 1 | |||
| 2 | package Paws::Backup::DescribeBackupJob; | ||
| 3 | use Moose; | ||
| 4 | has BackupJobId => (is => 'ro', isa => 'Str', traits => ['ParamInURI'], uri_name => 'backupJobId', required => 1); | ||
| 5 | |||
| 6 | use MooseX::ClassAttribute; | ||
| 7 | |||
| 8 | class_has _api_call => (isa => 'Str', is => 'ro', default => 'DescribeBackupJob'); | ||
| 9 | class_has _api_uri => (isa => 'Str', is => 'ro', default => '/backup-jobs/{backupJobId}'); | ||
| 10 | class_has _api_method => (isa => 'Str', is => 'ro', default => 'GET'); | ||
| 11 | class_has _returns => (isa => 'Str', is => 'ro', default => 'Paws::Backup::DescribeBackupJobOutput'); | ||
| 12 | 1; | ||
| 13 | |||
| 14 | ### main pod documentation begin ### | ||
| 15 | |||
| 16 | =head1 NAME | ||
| 17 | |||
| 18 | Paws::Backup::DescribeBackupJob - Arguments for method DescribeBackupJob on L<Paws::Backup> | ||
| 19 | |||
| 20 | =head1 DESCRIPTION | ||
| 21 | |||
| 22 | This class represents the parameters used for calling the method DescribeBackupJob on the | ||
| 23 | L<AWS Backup|Paws::Backup> service. Use the attributes of this class | ||
| 24 | as arguments to method DescribeBackupJob. | ||
| 25 | |||
| 26 | You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to DescribeBackupJob. | ||
| 27 | |||
| 28 | =head1 SYNOPSIS | ||
| 29 | |||
| 30 | my $backup = Paws->service('Backup'); | ||
| 31 | my $DescribeBackupJobOutput = $backup->DescribeBackupJob( | ||
| 32 | BackupJobId => 'Mystring', | ||
| 33 | |||
| 34 | ); | ||
| 35 | |||
| 36 | # Results: | ||
| 37 | my $AccountId = $DescribeBackupJobOutput->AccountId; | ||
| 38 | my $BackupJobId = $DescribeBackupJobOutput->BackupJobId; | ||
| 39 | my $BackupOptions = $DescribeBackupJobOutput->BackupOptions; | ||
| 40 | my $BackupSizeInBytes = $DescribeBackupJobOutput->BackupSizeInBytes; | ||
| 41 | my $BackupType = $DescribeBackupJobOutput->BackupType; | ||
| 42 | my $BackupVaultArn = $DescribeBackupJobOutput->BackupVaultArn; | ||
| 43 | my $BackupVaultName = $DescribeBackupJobOutput->BackupVaultName; | ||
| 44 | my $BytesTransferred = $DescribeBackupJobOutput->BytesTransferred; | ||
| 45 | my $CompletionDate = $DescribeBackupJobOutput->CompletionDate; | ||
| 46 | my $CreatedBy = $DescribeBackupJobOutput->CreatedBy; | ||
| 47 | my $CreationDate = $DescribeBackupJobOutput->CreationDate; | ||
| 48 | my $ExpectedCompletionDate = | ||
| 49 | $DescribeBackupJobOutput->ExpectedCompletionDate; | ||
| 50 | my $IamRoleArn = $DescribeBackupJobOutput->IamRoleArn; | ||
| 51 | my $PercentDone = $DescribeBackupJobOutput->PercentDone; | ||
| 52 | my $RecoveryPointArn = $DescribeBackupJobOutput->RecoveryPointArn; | ||
| 53 | my $ResourceArn = $DescribeBackupJobOutput->ResourceArn; | ||
| 54 | my $ResourceType = $DescribeBackupJobOutput->ResourceType; | ||
| 55 | my $StartBy = $DescribeBackupJobOutput->StartBy; | ||
| 56 | my $State = $DescribeBackupJobOutput->State; | ||
| 57 | my $StatusMessage = $DescribeBackupJobOutput->StatusMessage; | ||
| 58 | |||
| 59 | # Returns a L<Paws::Backup::DescribeBackupJobOutput> object. | ||
| 60 | |||
| 61 | Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. | ||
| 62 | For the AWS API documentation, see L<https://docs.aws.amazon.com/goto/WebAPI/backup/DescribeBackupJob> | ||
| 63 | |||
| 64 | =head1 ATTRIBUTES | ||
| 65 | |||
| 66 | |||
| 67 | =head2 B<REQUIRED> BackupJobId => Str | ||
| 68 | |||
| 69 | Uniquely identifies a request to AWS Backup to back up a resource. | ||
| 70 | |||
| 71 | |||
| 72 | |||
| 73 | |||
| 74 | =head1 SEE ALSO | ||
| 75 | |||
| 76 | This class forms part of L<Paws>, documenting arguments for method DescribeBackupJob in L<Paws::Backup> | ||
| 77 | |||
| 78 | =head1 BUGS and CONTRIBUTIONS | ||
| 79 | |||
| 80 | The source code is located here: L<https://github.com/pplu/aws-sdk-perl> | ||
| 81 | |||
| 82 | Please report bugs to: L<https://github.com/pplu/aws-sdk-perl/issues> | ||
| 83 | |||
| 84 | =cut | ||
| 85 |