AWS SDK for Go (PILOT)
API Reference

PREVIEW DOCUMENTATION - This is a preview of a new format for the AWS SDK for Go API Reference documentation. For the current AWS SDK for Go API Reference, see https://docs.aws.amazon.com/sdk-for-go/api/.

We welcome your feedback on this new version of the documentation. Send your comments to aws-sdkdocs-feedback@amazon.com.

Job

import "github.com/aws/aws-sdk-go/service/backup"

type Job struct { BackupJobId *string `type:"string"` BackupSizeInBytes *int64 `type:"long"` BackupVaultArn *string `type:"string"` BackupVaultName *string `type:"string"` BytesTransferred *int64 `type:"long"` CompletionDate *time.Time `type:"timestamp"` CreatedBy *RecoveryPointCreator `type:"structure"` CreationDate *time.Time `type:"timestamp"` ExpectedCompletionDate *time.Time `type:"timestamp"` IamRoleArn *string `type:"string"` PercentDone *string `type:"string"` RecoveryPointArn *string `type:"string"` ResourceArn *string `type:"string"` ResourceType *string `type:"string"` StartBy *time.Time `type:"timestamp"` State *string `type:"string" enum:"JobState"` StatusMessage *string `type:"string"` }

Contains detailed information about a backup job.

BackupJobId

Type: *string

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

BackupSizeInBytes

Type: *int64

The size, in bytes, of a backup.

BackupVaultArn

Type: *string

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

BackupVaultName

Type: *string

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

Type: *int64

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

CompletionDate

Type: *time.Time

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

Contains information about the backup plan and rule that AWS Backup used to initiate the recovery point backup.

CreationDate

Type: *time.Time

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

Type: *time.Time

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

Type: *string

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

PercentDone

Type: *string

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

RecoveryPointArn

Type: *string

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

Type: *string

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

ResourceType

Type: *string

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.

StartBy

Type: *time.Time

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

Type: *string

The current state of a resource recovery point.

StatusMessage

Type: *string

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

Method

GoString

func (s Job) GoString() string

GoString returns the string representation

SetBackupJobId

func (s *Job) SetBackupJobId(v string) *Job

SetBackupJobId sets the BackupJobId field's value.

SetBackupSizeInBytes

func (s *Job) SetBackupSizeInBytes(v int64) *Job

SetBackupSizeInBytes sets the BackupSizeInBytes field's value.

SetBackupVaultArn

func (s *Job) SetBackupVaultArn(v string) *Job

SetBackupVaultArn sets the BackupVaultArn field's value.

SetBackupVaultName

func (s *Job) SetBackupVaultName(v string) *Job

SetBackupVaultName sets the BackupVaultName field's value.

SetBytesTransferred

func (s *Job) SetBytesTransferred(v int64) *Job

SetBytesTransferred sets the BytesTransferred field's value.

SetCompletionDate

func (s *Job) SetCompletionDate(v time.Time) *Job

SetCompletionDate sets the CompletionDate field's value.

SetCreatedBy

func (s *Job) SetCreatedBy(v *RecoveryPointCreator) *Job

SetCreatedBy sets the CreatedBy field's value.

SetCreationDate

func (s *Job) SetCreationDate(v time.Time) *Job

SetCreationDate sets the CreationDate field's value.

SetExpectedCompletionDate

func (s *Job) SetExpectedCompletionDate(v time.Time) *Job

SetExpectedCompletionDate sets the ExpectedCompletionDate field's value.

SetIamRoleArn

func (s *Job) SetIamRoleArn(v string) *Job

SetIamRoleArn sets the IamRoleArn field's value.

SetPercentDone

func (s *Job) SetPercentDone(v string) *Job

SetPercentDone sets the PercentDone field's value.

SetRecoveryPointArn

func (s *Job) SetRecoveryPointArn(v string) *Job

SetRecoveryPointArn sets the RecoveryPointArn field's value.

SetResourceArn

func (s *Job) SetResourceArn(v string) *Job

SetResourceArn sets the ResourceArn field's value.

SetResourceType

func (s *Job) SetResourceType(v string) *Job

SetResourceType sets the ResourceType field's value.

SetStartBy

func (s *Job) SetStartBy(v time.Time) *Job

SetStartBy sets the StartBy field's value.

SetState

func (s *Job) SetState(v string) *Job

SetState sets the State field's value.

SetStatusMessage

func (s *Job) SetStatusMessage(v string) *Job

SetStatusMessage sets the StatusMessage field's value.

String

func (s Job) String() string

String returns the string representation

On this page: