AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

This is the response object from the DescribeBackupJob operation.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceResponse
    Amazon.Backup.Model.DescribeBackupJobResponse

Namespace: Amazon.Backup.Model
Assembly: AWSSDK.Backup.dll
Version: 3.x.y.z

Syntax

C#
public class DescribeBackupJobResponse : AmazonWebServiceResponse

The DescribeBackupJobResponse type exposes the following members

Constructors

NameDescription
Public Method DescribeBackupJobResponse()

Properties

NameTypeDescription
Public Property BackupJobId System.String

Gets and sets the property BackupJobId.

Uniquely identifies a request to AWS Backup to back up a resource.

Public Property BackupSizeInBytes System.Int64

Gets and sets the property BackupSizeInBytes.

The size, in bytes, of a backup.

Public Property BackupVaultArn System.String

Gets and sets the property BackupVaultArn.

An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.

Public Property BackupVaultName System.String

Gets and sets the property BackupVaultName.

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.

Public Property BytesTransferred System.Int64

Gets and sets the property BytesTransferred.

The size in bytes transferred to a backup vault at the time that the job status was queried.

Public Property CompletionDate System.DateTime

Gets and sets the property CompletionDate.

The date and time that a job to create a backup job is completed, 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.

Public Property ContentLength System.Int64 Inherited from Amazon.Runtime.AmazonWebServiceResponse.
Public Property CreatedBy Amazon.Backup.Model.RecoveryPointCreator

Gets and sets the property CreatedBy.

Contains identifying information about the creation of a backup job, including the BackupPlanArn, BackupPlanId, BackupPlanVersion, and BackupRuleId of the backup plan that is used to create it.

Public Property CreationDate System.DateTime

Gets and sets the property CreationDate.

The date and time that 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.

Public Property ExpectedCompletionDate System.DateTime

Gets and sets the property ExpectedCompletionDate.

The date and time that 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.

Public Property HttpStatusCode System.Net.HttpStatusCode Inherited from Amazon.Runtime.AmazonWebServiceResponse.
Public Property IamRoleArn System.String

Gets and sets the property IamRoleArn.

Specifies the IAM role ARN used to create the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.

Public Property PercentDone System.String

Gets and sets the property PercentDone.

Contains an estimated percentage that is complete of a job at the time the job status was queried.

Public Property RecoveryPointArn System.String

Gets and sets the property RecoveryPointArn.

An ARN that uniquely identifies a recovery point; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.

Public Property ResourceArn System.String

Gets and sets the property ResourceArn.

An ARN that uniquely identifies a saved resource. The format of the ARN depends on the resource type.

Public Property ResourceType System.String

Gets and sets the property ResourceType.

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.

Public Property ResponseMetadata Amazon.Runtime.ResponseMetadata Inherited from Amazon.Runtime.AmazonWebServiceResponse.
Public Property StartBy System.DateTime

Gets and sets the property StartBy.

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.

Public Property State Amazon.Backup.BackupJobState

Gets and sets the property State.

The current state of a resource recovery point.

Public Property StatusMessage System.String

Gets and sets the property StatusMessage.

A detailed message explaining the status of the job to back up a resource.

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms