package types

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

Index

Types

type AlreadyExistsException

type AlreadyExistsException struct {
	Message *string

	Code             *string
	Arn              *string
	Context          *string
	CreatorRequestId *string
	Type             *string
}

The required resource already exists.

func (*AlreadyExistsException) Error

func (e *AlreadyExistsException) Error() string

func (*AlreadyExistsException) ErrorCode

func (e *AlreadyExistsException) ErrorCode() string

func (*AlreadyExistsException) ErrorFault

func (e *AlreadyExistsException) ErrorFault() smithy.ErrorFault

func (*AlreadyExistsException) ErrorMessage

func (e *AlreadyExistsException) ErrorMessage() string

func (*AlreadyExistsException) GetArn

func (e *AlreadyExistsException) GetArn() string

func (*AlreadyExistsException) GetCode

func (e *AlreadyExistsException) GetCode() string

func (*AlreadyExistsException) GetContext

func (e *AlreadyExistsException) GetContext() string

func (*AlreadyExistsException) GetCreatorRequestId

func (e *AlreadyExistsException) GetCreatorRequestId() string

func (*AlreadyExistsException) GetMessage

func (e *AlreadyExistsException) GetMessage() string

func (*AlreadyExistsException) GetType

func (e *AlreadyExistsException) GetType() string

func (*AlreadyExistsException) HasArn

func (e *AlreadyExistsException) HasArn() bool

func (*AlreadyExistsException) HasCode

func (e *AlreadyExistsException) HasCode() bool

func (*AlreadyExistsException) HasContext

func (e *AlreadyExistsException) HasContext() bool

func (*AlreadyExistsException) HasCreatorRequestId

func (e *AlreadyExistsException) HasCreatorRequestId() bool

func (*AlreadyExistsException) HasMessage

func (e *AlreadyExistsException) HasMessage() bool

func (*AlreadyExistsException) HasType

func (e *AlreadyExistsException) HasType() bool

type BackupJob

type BackupJob struct {
	// 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.
	CompletionDate *time.Time
	// 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.
	BackupVaultName *string
	// 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.
	StartBy *time.Time
	// Specifies the IAM role ARN used to create the target recovery point; for
	// example, arn:aws:iam::123456789012:role/S3Access.
	IamRoleArn *string
	// The current state of a resource recovery point.
	State BackupJobState
	// 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.
	CreationDate *time.Time
	// 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.
	CreatedBy *RecoveryPointCreator
	// An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for
	// example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
	BackupVaultArn *string
	// A detailed message explaining the status of the job to back up a resource.
	StatusMessage *string
	// The size in bytes transferred to a backup vault at the time that the job status
	// was queried.
	BytesTransferred *int64
	// Uniquely identifies a request to AWS Backup to back up a resource.
	BackupJobId *string
	// 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.
	ExpectedCompletionDate *time.Time
	// Contains an estimated percentage complete of a job at the time the job status
	// was queried.
	PercentDone *string
	// The account ID that owns the backup job.
	AccountId *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.
	ResourceType *string
	// An ARN that uniquely identifies a resource. The format of the ARN depends on the
	// resource type.
	ResourceArn *string
	// The size, in bytes, of a backup.
	BackupSizeInBytes *int64
	// An ARN that uniquely identifies a recovery point; for example,
	// arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
	RecoveryPointArn *string
}

Contains detailed information about a backup job.

type BackupJobState

type BackupJobState string
const (
	BackupJobStateCreated   BackupJobState = "CREATED"
	BackupJobStatePending   BackupJobState = "PENDING"
	BackupJobStateRunning   BackupJobState = "RUNNING"
	BackupJobStateAborting  BackupJobState = "ABORTING"
	BackupJobStateAborted   BackupJobState = "ABORTED"
	BackupJobStateCompleted BackupJobState = "COMPLETED"
	BackupJobStateFailed    BackupJobState = "FAILED"
	BackupJobStateExpired   BackupJobState = "EXPIRED"
)

Enum values for BackupJobState

type BackupPlan

type BackupPlan struct {
	// The display name of a backup plan.
	BackupPlanName *string
	// An array of BackupRule objects, each of which specifies a scheduled task that is
	// used to back up a selection of resources.
	Rules []*BackupRule
}

Contains an optional backup plan display name and an array of BackupRule objects, each of which specifies a backup rule. Each rule in a backup plan is a separate scheduled task and can back up a different selection of AWS resources.

type BackupPlanInput

type BackupPlanInput struct {
	// An array of BackupRule objects, each of which specifies a scheduled task that is
	// used to back up a selection of resources.
	Rules []*BackupRuleInput
	// The optional display name of a backup plan.
	BackupPlanName *string
}

Contains an optional backup plan display name and an array of BackupRule objects, each of which specifies a backup rule. Each rule in a backup plan is a separate scheduled task and can back up a different selection of AWS resources.

type BackupPlanTemplatesListMember

type BackupPlanTemplatesListMember struct {
	// Uniquely identifies a stored backup plan template.
	BackupPlanTemplateId *string
	// The optional display name of a backup plan template.
	BackupPlanTemplateName *string
}

An object specifying metadata associated with a backup plan template.

type BackupPlansListMember

type BackupPlansListMember struct {
	// Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most
	// 1,024 bytes long. Version IDs cannot be edited.
	VersionId *string
	// The date and time a resource backup plan 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.
	CreationDate *time.Time
	// The display name of a saved backup plan.
	BackupPlanName *string
	// An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for
	// example,
	// arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50.
	BackupPlanArn *string
	// The last time a job to back up resources was executed with this rule. A date and
	// time, in Unix format and Coordinated Universal Time (UTC). The value of
	// LastExecutionDate is accurate to milliseconds. For example, the value
	// 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.
	LastExecutionDate *time.Time
	// The date and time a backup plan is deleted, in Unix format and Coordinated
	// Universal Time (UTC). The value of DeletionDate is accurate to milliseconds. For
	// example, the value 1516925490.087 represents Friday, January 26, 2018
	// 12:11:30.087 AM.
	DeletionDate *time.Time
	// Uniquely identifies a backup plan.
	BackupPlanId *string
	// A unique string that identifies the request and allows failed requests to be
	// retried without the risk of executing the operation twice.
	CreatorRequestId *string
}

Contains metadata about a backup plan.

type BackupRule

type BackupRule struct {
	// 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.
	TargetBackupVaultName *string
	// A value in minutes after a backup job is successfully started before it must be
	// completed or it will be canceled by AWS Backup. This value is optional.
	CompletionWindowMinutes *int64
	// A CRON expression specifying when AWS Backup initiates a backup job.
	ScheduleExpression *string
	// The lifecycle defines when a protected resource is transitioned to cold storage
	// and when it expires. AWS Backup transitions and expires backups automatically
	// according to the lifecycle that you define. Backups transitioned to cold storage
	// must be stored in cold storage for a minimum of 90 days. Therefore, the “expire
	// after days” setting must be 90 days greater than the “transition to cold after
	// days” setting. The “transition to cold after days” setting cannot be changed
	// after a backup has been transitioned to cold.
	Lifecycle *Lifecycle
	// Uniquely identifies a rule that is used to schedule the backup of a selection of
	// resources.
	RuleId *string
	// An array of key-value pair strings that are assigned to resources that are
	// associated with this rule when restored from backup.
	RecoveryPointTags map[string]*string
	// A value in minutes after a backup is scheduled before a job will be canceled if
	// it doesn't start successfully. This value is optional.
	StartWindowMinutes *int64
	// An optional display name for a backup rule.
	RuleName *string
	// An array of CopyAction objects, which contains the details of the copy
	// operation.
	CopyActions []*CopyAction
}

Specifies a scheduled task used to back up a selection of resources.

type BackupRuleInput

type BackupRuleInput struct {
	// To help organize your resources, you can assign your own metadata to the
	// resources that you create. Each tag is a key-value pair.
	RecoveryPointTags map[string]*string
	// An optional display name for a backup rule.
	RuleName *string
	// A value in minutes after a backup is scheduled before a job will be canceled if
	// it doesn't start successfully. This value is optional.
	StartWindowMinutes *int64
	// A CRON expression specifying when AWS Backup initiates a backup job.
	ScheduleExpression *string
	// An array of CopyAction objects, which contains the details of the copy
	// operation.
	CopyActions []*CopyAction
	// A value in minutes after a backup job is successfully started before it must be
	// completed or it will be canceled by AWS Backup. This value is optional.
	CompletionWindowMinutes *int64
	// The lifecycle defines when a protected resource is transitioned to cold storage
	// and when it expires. AWS Backup will transition and expire backups automatically
	// according to the lifecycle that you define. Backups transitioned to cold storage
	// must be stored in cold storage for a minimum of 90 days. Therefore, the “expire
	// after days” setting must be 90 days greater than the “transition to cold after
	// days” setting. The “transition to cold after days” setting cannot be changed
	// after a backup has been transitioned to cold.
	Lifecycle *Lifecycle
	// 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.
	TargetBackupVaultName *string
}

Specifies a scheduled task used to back up a selection of resources.

type BackupSelection

type BackupSelection struct {
	// An array of conditions used to specify a set of resources to assign to a backup
	// plan; for example, "STRINGEQUALS": {"ec2:ResourceTag/Department": "accounting".
	ListOfTags []*Condition
	// An array of strings that contain Amazon Resource Names (ARNs) of resources to
	// assign to a backup plan.
	Resources []*string
	// The ARN of the IAM role that AWS Backup uses to authenticate when restoring the
	// target resource; for example, arn:aws:iam::123456789012:role/S3Access.
	IamRoleArn *string
	// The display name of a resource selection document.
	SelectionName *string
}

Used to specify a set of resources to a backup plan.

type BackupSelectionsListMember

type BackupSelectionsListMember struct {
	// Uniquely identifies a backup plan.
	BackupPlanId *string
	// A unique string that identifies the request and allows failed requests to be
	// retried without the risk of executing the operation twice.
	CreatorRequestId *string
	// Uniquely identifies a request to assign a set of resources to a backup plan.
	SelectionId *string
	// The display name of a resource selection document.
	SelectionName *string
	// Specifies the IAM role Amazon Resource Name (ARN) to create the target recovery
	// point; for example, arn:aws:iam::123456789012:role/S3Access.
	IamRoleArn *string
	// The date and time a backup plan 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.
	CreationDate *time.Time
}

Contains metadata about a BackupSelection object.

type BackupVaultEvent

type BackupVaultEvent string
const (
	BackupVaultEventBackup_job_started      BackupVaultEvent = "BACKUP_JOB_STARTED"
	BackupVaultEventBackup_job_completed    BackupVaultEvent = "BACKUP_JOB_COMPLETED"
	BackupVaultEventBackup_job_successful   BackupVaultEvent = "BACKUP_JOB_SUCCESSFUL"
	BackupVaultEventBackup_job_failed       BackupVaultEvent = "BACKUP_JOB_FAILED"
	BackupVaultEventBackup_job_expired      BackupVaultEvent = "BACKUP_JOB_EXPIRED"
	BackupVaultEventRestore_job_started     BackupVaultEvent = "RESTORE_JOB_STARTED"
	BackupVaultEventRestore_job_completed   BackupVaultEvent = "RESTORE_JOB_COMPLETED"
	BackupVaultEventRestore_job_successful  BackupVaultEvent = "RESTORE_JOB_SUCCESSFUL"
	BackupVaultEventRestore_job_failed      BackupVaultEvent = "RESTORE_JOB_FAILED"
	BackupVaultEventCopy_job_started        BackupVaultEvent = "COPY_JOB_STARTED"
	BackupVaultEventCopy_job_successful     BackupVaultEvent = "COPY_JOB_SUCCESSFUL"
	BackupVaultEventCopy_job_failed         BackupVaultEvent = "COPY_JOB_FAILED"
	BackupVaultEventRecovery_point_modified BackupVaultEvent = "RECOVERY_POINT_MODIFIED"
	BackupVaultEventBackup_plan_created     BackupVaultEvent = "BACKUP_PLAN_CREATED"
	BackupVaultEventBackup_plan_modified    BackupVaultEvent = "BACKUP_PLAN_MODIFIED"
)

Enum values for BackupVaultEvent

type BackupVaultListMember

type BackupVaultListMember struct {
	// A unique string that identifies the request and allows failed requests to be
	// retried without the risk of executing the operation twice.
	CreatorRequestId *string
	// The server-side encryption key that is used to protect your backups; for
	// example,
	// arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.
	EncryptionKeyArn *string
	// An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for
	// example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
	BackupVaultArn *string
	// The date and time a resource backup 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.
	CreationDate *time.Time
	// The number of recovery points that are stored in a backup vault.
	NumberOfRecoveryPoints *int64
	// 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.
	BackupVaultName *string
}

Contains metadata about a backup vault.

type CalculatedLifecycle

type CalculatedLifecycle struct {
	// A timestamp that specifies when to transition a recovery point to cold storage.
	MoveToColdStorageAt *time.Time
	// A timestamp that specifies when to delete a recovery point.
	DeleteAt *time.Time
}

Contains DeleteAt and MoveToColdStorageAt timestamps, which are used to specify a lifecycle for a recovery point. The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. AWS Backup transitions and expires backups automatically according to the lifecycle that you define. Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “expire after days” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.

type Condition

type Condition struct {
	// An operation, such as STRINGEQUALS, that is applied to a key-value pair used to
	// filter resources in a selection.
	ConditionType ConditionType
	// The value in a key-value pair. For example, in "ec2:ResourceTag/Department":
	// "accounting", "accounting" is the value.
	ConditionValue *string
	// The key in a key-value pair. For example, in "ec2:ResourceTag/Department":
	// "accounting", "ec2:ResourceTag/Department" is the key.
	ConditionKey *string
}

Contains an array of triplets made up of a condition type (such as STRINGEQUALS), a key, and a value. Conditions are used to filter resources in a selection that is assigned to a backup plan.

type ConditionType

type ConditionType string
const (
	ConditionTypeStringequals ConditionType = "STRINGEQUALS"
)

Enum values for ConditionType

type CopyAction

type CopyAction struct {
	// An Amazon Resource Name (ARN) that uniquely identifies the destination backup
	// vault for the copied backup. For example,
	// arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
	DestinationBackupVaultArn *string
	// Contains an array of Transition objects specifying how long in days before a
	// recovery point transitions to cold storage or is deleted. Backups transitioned
	// to cold storage must be stored in cold storage for a minimum of 90 days.
	// Therefore, on the console, the “expire after days” setting must be 90 days
	// greater than the “transition to cold after days” setting. The “transition to
	// cold after days” setting cannot be changed after a backup has been transitioned
	// to cold.
	Lifecycle *Lifecycle
}

The details of the copy operation.

type CopyJob

type CopyJob struct {
	// The date and time a copy 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.
	CompletionDate *time.Time
	// The current state of a copy job.
	State CopyJobState
	// An ARN that uniquely identifies a source recovery point; for example,
	// arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
	SourceRecoveryPointArn *string
	// An Amazon Resource Name (ARN) that uniquely identifies a destination copy vault;
	// for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
	DestinationBackupVaultArn *string
	// An Amazon Resource Name (ARN) that uniquely identifies a source copy vault; for
	// example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
	SourceBackupVaultArn *string
	// The date and time a copy 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.
	CreationDate *time.Time
	// Specifies the IAM role ARN used to copy the target recovery point; for example,
	// arn:aws:iam::123456789012:role/S3Access.
	IamRoleArn *string
	// Contains information about the backup plan and rule that AWS Backup used to
	// initiate the recovery point backup.
	CreatedBy *RecoveryPointCreator
	// An ARN that uniquely identifies a destination recovery point; for example,
	// arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
	DestinationRecoveryPointArn *string
	// The account ID that owns the copy job.
	AccountId *string
	// The size, in bytes, of a copy job.
	BackupSizeInBytes *int64
	// Uniquely identifies a copy job.
	CopyJobId *string
	// A detailed message explaining the status of the job to copy a resource.
	StatusMessage *string
	// The AWS resource to be copied; for example, an Amazon Elastic Block Store
	// (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS)
	// database.
	ResourceArn *string
	// The type of AWS resource to be copied; for example, an Amazon Elastic Block
	// Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon RDS)
	// database.
	ResourceType *string
}

Contains detailed information about a copy job.

type CopyJobState

type CopyJobState string
const (
	CopyJobStateCreated   CopyJobState = "CREATED"
	CopyJobStateRunning   CopyJobState = "RUNNING"
	CopyJobStateCompleted CopyJobState = "COMPLETED"
	CopyJobStateFailed    CopyJobState = "FAILED"
)

Enum values for CopyJobState

type DependencyFailureException

type DependencyFailureException struct {
	Message *string

	Type    *string
	Code    *string
	Context *string
}

A dependent AWS service or resource returned an error to the AWS Backup service, and the action cannot be completed.

func (*DependencyFailureException) Error

func (*DependencyFailureException) ErrorCode

func (e *DependencyFailureException) ErrorCode() string

func (*DependencyFailureException) ErrorFault

func (*DependencyFailureException) ErrorMessage

func (e *DependencyFailureException) ErrorMessage() string

func (*DependencyFailureException) GetCode

func (e *DependencyFailureException) GetCode() string

func (*DependencyFailureException) GetContext

func (e *DependencyFailureException) GetContext() string

func (*DependencyFailureException) GetMessage

func (e *DependencyFailureException) GetMessage() string

func (*DependencyFailureException) GetType

func (e *DependencyFailureException) GetType() string

func (*DependencyFailureException) HasCode

func (e *DependencyFailureException) HasCode() bool

func (*DependencyFailureException) HasContext

func (e *DependencyFailureException) HasContext() bool

func (*DependencyFailureException) HasMessage

func (e *DependencyFailureException) HasMessage() bool

func (*DependencyFailureException) HasType

func (e *DependencyFailureException) HasType() bool

type InvalidParameterValueException

type InvalidParameterValueException struct {
	Message *string

	Type    *string
	Context *string
	Code    *string
}

Indicates that something is wrong with a parameter's value. For example, the value is out of range.

func (*InvalidParameterValueException) Error

func (*InvalidParameterValueException) ErrorCode

func (e *InvalidParameterValueException) ErrorCode() string

func (*InvalidParameterValueException) ErrorFault

func (*InvalidParameterValueException) ErrorMessage

func (e *InvalidParameterValueException) ErrorMessage() string

func (*InvalidParameterValueException) GetCode

func (*InvalidParameterValueException) GetContext

func (e *InvalidParameterValueException) GetContext() string

func (*InvalidParameterValueException) GetMessage

func (e *InvalidParameterValueException) GetMessage() string

func (*InvalidParameterValueException) GetType

func (*InvalidParameterValueException) HasCode

func (e *InvalidParameterValueException) HasCode() bool

func (*InvalidParameterValueException) HasContext

func (e *InvalidParameterValueException) HasContext() bool

func (*InvalidParameterValueException) HasMessage

func (e *InvalidParameterValueException) HasMessage() bool

func (*InvalidParameterValueException) HasType

func (e *InvalidParameterValueException) HasType() bool

type InvalidRequestException

type InvalidRequestException struct {
	Message *string

	Type    *string
	Code    *string
	Context *string
}

Indicates that something is wrong with the input to the request. For example, a parameter is of the wrong type.

func (*InvalidRequestException) Error

func (e *InvalidRequestException) Error() string

func (*InvalidRequestException) ErrorCode

func (e *InvalidRequestException) ErrorCode() string

func (*InvalidRequestException) ErrorFault

func (e *InvalidRequestException) ErrorFault() smithy.ErrorFault

func (*InvalidRequestException) ErrorMessage

func (e *InvalidRequestException) ErrorMessage() string

func (*InvalidRequestException) GetCode

func (e *InvalidRequestException) GetCode() string

func (*InvalidRequestException) GetContext

func (e *InvalidRequestException) GetContext() string

func (*InvalidRequestException) GetMessage

func (e *InvalidRequestException) GetMessage() string

func (*InvalidRequestException) GetType

func (e *InvalidRequestException) GetType() string

func (*InvalidRequestException) HasCode

func (e *InvalidRequestException) HasCode() bool

func (*InvalidRequestException) HasContext

func (e *InvalidRequestException) HasContext() bool

func (*InvalidRequestException) HasMessage

func (e *InvalidRequestException) HasMessage() bool

func (*InvalidRequestException) HasType

func (e *InvalidRequestException) HasType() bool

type Lifecycle

type Lifecycle struct {
	// Specifies the number of days after creation that a recovery point is deleted.
	// Must be greater than 90 days plus MoveToColdStorageAfterDays.
	DeleteAfterDays *int64
	// Specifies the number of days after creation that a recovery point is moved to
	// cold storage.
	MoveToColdStorageAfterDays *int64
}

Contains an array of Transition objects specifying how long in days before a recovery point transitions to cold storage or is deleted. Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, on the console, the “expire after days” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.

type LimitExceededException

type LimitExceededException struct {
	Message *string

	Code    *string
	Type    *string
	Context *string
}

A limit in the request has been exceeded; for example, a maximum number of items allowed in a request.

func (*LimitExceededException) Error

func (e *LimitExceededException) Error() string

func (*LimitExceededException) ErrorCode

func (e *LimitExceededException) ErrorCode() string

func (*LimitExceededException) ErrorFault

func (e *LimitExceededException) ErrorFault() smithy.ErrorFault

func (*LimitExceededException) ErrorMessage

func (e *LimitExceededException) ErrorMessage() string

func (*LimitExceededException) GetCode

func (e *LimitExceededException) GetCode() string

func (*LimitExceededException) GetContext

func (e *LimitExceededException) GetContext() string

func (*LimitExceededException) GetMessage

func (e *LimitExceededException) GetMessage() string

func (*LimitExceededException) GetType

func (e *LimitExceededException) GetType() string

func (*LimitExceededException) HasCode

func (e *LimitExceededException) HasCode() bool

func (*LimitExceededException) HasContext

func (e *LimitExceededException) HasContext() bool

func (*LimitExceededException) HasMessage

func (e *LimitExceededException) HasMessage() bool

func (*LimitExceededException) HasType

func (e *LimitExceededException) HasType() bool

type MissingParameterValueException

type MissingParameterValueException struct {
	Message *string

	Code    *string
	Type    *string
	Context *string
}

Indicates that a required parameter is missing.

func (*MissingParameterValueException) Error

func (*MissingParameterValueException) ErrorCode

func (e *MissingParameterValueException) ErrorCode() string

func (*MissingParameterValueException) ErrorFault

func (*MissingParameterValueException) ErrorMessage

func (e *MissingParameterValueException) ErrorMessage() string

func (*MissingParameterValueException) GetCode

func (*MissingParameterValueException) GetContext

func (e *MissingParameterValueException) GetContext() string

func (*MissingParameterValueException) GetMessage

func (e *MissingParameterValueException) GetMessage() string

func (*MissingParameterValueException) GetType

func (*MissingParameterValueException) HasCode

func (e *MissingParameterValueException) HasCode() bool

func (*MissingParameterValueException) HasContext

func (e *MissingParameterValueException) HasContext() bool

func (*MissingParameterValueException) HasMessage

func (e *MissingParameterValueException) HasMessage() bool

func (*MissingParameterValueException) HasType

func (e *MissingParameterValueException) HasType() bool

type ProtectedResource

type ProtectedResource struct {
	// The type of AWS resource; for example, an Amazon Elastic Block Store (Amazon
	// EBS) volume or an Amazon Relational Database Service (Amazon RDS) database.
	ResourceType *string
	// The date and time a resource was last backed up, in Unix format and Coordinated
	// Universal Time (UTC). The value of LastBackupTime is accurate to milliseconds.
	// For example, the value 1516925490.087 represents Friday, January 26, 2018
	// 12:11:30.087 AM.
	LastBackupTime *time.Time
	// An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of
	// the ARN depends on the resource type.
	ResourceArn *string
}

A structure that contains information about a backed-up resource.

type RecoveryPointByBackupVault

type RecoveryPointByBackupVault struct {
	// The size, in bytes, of a backup.
	BackupSizeInBytes *int64
	// An ARN that uniquely identifies a backup vault; for example,
	// arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
	BackupVaultArn *string
	// An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for
	// example,
	// arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
	RecoveryPointArn *string
	// The date and time a job to restore a recovery point 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.
	CompletionDate *time.Time
	// The type of AWS resource saved as a recovery point; for example, an Amazon
	// Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service
	// (Amazon RDS) database.
	ResourceType *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.
	BackupVaultName *string
	// A status code specifying the state of the recovery point.
	Status RecoveryPointStatus
	// The server-side encryption key that is used to protect your backups; for
	// example,
	// arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.
	EncryptionKeyArn *string
	// Specifies the IAM role ARN used to create the target recovery point; for
	// example, arn:aws:iam::123456789012:role/S3Access.
	IamRoleArn *string
	// An ARN that uniquely identifies a resource. The format of the ARN depends on the
	// resource type.
	ResourceArn *string
	// A CalculatedLifecycle object containing DeleteAt and MoveToColdStorageAt
	// timestamps.
	CalculatedLifecycle *CalculatedLifecycle
	// The date and time a recovery point was last restored, in Unix format and
	// Coordinated Universal Time (UTC). The value of LastRestoreTime is accurate to
	// milliseconds. For example, the value 1516925490.087 represents Friday, January
	// 26, 2018 12:11:30.087 AM.
	LastRestoreTime *time.Time
	// A Boolean value that is returned as TRUE if the specified recovery point is
	// encrypted, or FALSE if the recovery point is not encrypted.
	IsEncrypted *bool
	// Contains identifying information about the creation of a recovery point,
	// including the BackupPlanArn, BackupPlanId, BackupPlanVersion, and BackupRuleId
	// of the backup plan that is used to create it.
	CreatedBy *RecoveryPointCreator
	// The date and time a recovery point 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.
	CreationDate *time.Time
	// The lifecycle defines when a protected resource is transitioned to cold storage
	// and when it expires. AWS Backup transitions and expires backups automatically
	// according to the lifecycle that you define. Backups transitioned to cold storage
	// must be stored in cold storage for a minimum of 90 days. Therefore, the “expire
	// after days” setting must be 90 days greater than the “transition to cold after
	// days” setting. The “transition to cold after days” setting cannot be changed
	// after a backup has been transitioned to cold.
	Lifecycle *Lifecycle
}

Contains detailed information about the recovery points stored in a backup vault.

type RecoveryPointByResource

type RecoveryPointByResource struct {
	// A status code specifying the state of the recovery point.
	Status RecoveryPointStatus
	// The date and time a recovery point 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.
	CreationDate *time.Time
	// 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.
	BackupVaultName *string
	// The server-side encryption key that is used to protect your backups; for
	// example,
	// arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.
	EncryptionKeyArn *string
	// An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for
	// example,
	// arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
	RecoveryPointArn *string
	// The size, in bytes, of a backup.
	BackupSizeBytes *int64
}

Contains detailed information about a saved recovery point.

type RecoveryPointCreator

type RecoveryPointCreator struct {
	// Uniquely identifies a rule used to schedule the backup of a selection of
	// resources.
	BackupRuleId *string
	// An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for
	// example,
	// arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50.
	BackupPlanArn *string
	// Version IDs are unique, randomly generated, Unicode, UTF-8 encoded strings that
	// are at most 1,024 bytes long. They cannot be edited.
	BackupPlanVersion *string
	// Uniquely identifies a backup plan.
	BackupPlanId *string
}

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

type RecoveryPointStatus

type RecoveryPointStatus string
const (
	RecoveryPointStatusCompleted RecoveryPointStatus = "COMPLETED"
	RecoveryPointStatusPartial   RecoveryPointStatus = "PARTIAL"
	RecoveryPointStatusDeleting  RecoveryPointStatus = "DELETING"
	RecoveryPointStatusExpired   RecoveryPointStatus = "EXPIRED"
)

Enum values for RecoveryPointStatus

type ResourceNotFoundException

type ResourceNotFoundException struct {
	Message *string

	Code    *string
	Type    *string
	Context *string
}

A resource that is required for the action doesn't exist.

func (*ResourceNotFoundException) Error

func (e *ResourceNotFoundException) Error() string

func (*ResourceNotFoundException) ErrorCode

func (e *ResourceNotFoundException) ErrorCode() string

func (*ResourceNotFoundException) ErrorFault

func (*ResourceNotFoundException) ErrorMessage

func (e *ResourceNotFoundException) ErrorMessage() string

func (*ResourceNotFoundException) GetCode

func (e *ResourceNotFoundException) GetCode() string

func (*ResourceNotFoundException) GetContext

func (e *ResourceNotFoundException) GetContext() string

func (*ResourceNotFoundException) GetMessage

func (e *ResourceNotFoundException) GetMessage() string

func (*ResourceNotFoundException) GetType

func (e *ResourceNotFoundException) GetType() string

func (*ResourceNotFoundException) HasCode

func (e *ResourceNotFoundException) HasCode() bool

func (*ResourceNotFoundException) HasContext

func (e *ResourceNotFoundException) HasContext() bool

func (*ResourceNotFoundException) HasMessage

func (e *ResourceNotFoundException) HasMessage() bool

func (*ResourceNotFoundException) HasType

func (e *ResourceNotFoundException) HasType() bool

type RestoreJobStatus

type RestoreJobStatus string
const (
	RestoreJobStatusPending   RestoreJobStatus = "PENDING"
	RestoreJobStatusRunning   RestoreJobStatus = "RUNNING"
	RestoreJobStatusCompleted RestoreJobStatus = "COMPLETED"
	RestoreJobStatusAborted   RestoreJobStatus = "ABORTED"
	RestoreJobStatusFailed    RestoreJobStatus = "FAILED"
)

Enum values for RestoreJobStatus

type RestoreJobsListMember

type RestoreJobsListMember struct {
	// Specifies the IAM role ARN used to create the target recovery point; for
	// example, arn:aws:iam::123456789012:role/S3Access.
	IamRoleArn *string
	// The resource type of the listed restore jobs; for example, an Amazon Elastic
	// Block Store (Amazon EBS) volume or an Amazon Relational Database Service (Amazon
	// RDS) database.
	ResourceType *string
	// The date and time a restore 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.
	CreationDate *time.Time
	// A status code specifying the state of the job initiated by AWS Backup to restore
	// a recovery point.
	Status RestoreJobStatus
	// An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of
	// the ARN depends on the resource type.
	CreatedResourceArn *string
	// The date and time a job to restore a recovery point 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.
	CompletionDate *time.Time
	// An ARN that uniquely identifies a recovery point; for example,
	// arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
	RecoveryPointArn *string
	// The size, in bytes, of the restored resource.
	BackupSizeInBytes *int64
	// The amount of time in minutes that a job restoring a recovery point is expected
	// to take.
	ExpectedCompletionTimeMinutes *int64
	// The account ID that owns the restore job.
	AccountId *string
	// Uniquely identifies the job that restores a recovery point.
	RestoreJobId *string
	// A detailed message explaining the status of the job to restore a recovery point.
	StatusMessage *string
	// Contains an estimated percentage complete of a job at the time the job status
	// was queried.
	PercentDone *string
}

Contains metadata about a restore job.

type ServiceUnavailableException

type ServiceUnavailableException struct {
	Message *string

	Type    *string
	Context *string
	Code    *string
}

The request failed due to a temporary failure of the server.

func (*ServiceUnavailableException) Error

func (*ServiceUnavailableException) ErrorCode

func (e *ServiceUnavailableException) ErrorCode() string

func (*ServiceUnavailableException) ErrorFault

func (*ServiceUnavailableException) ErrorMessage

func (e *ServiceUnavailableException) ErrorMessage() string

func (*ServiceUnavailableException) GetCode

func (e *ServiceUnavailableException) GetCode() string

func (*ServiceUnavailableException) GetContext

func (e *ServiceUnavailableException) GetContext() string

func (*ServiceUnavailableException) GetMessage

func (e *ServiceUnavailableException) GetMessage() string

func (*ServiceUnavailableException) GetType

func (e *ServiceUnavailableException) GetType() string

func (*ServiceUnavailableException) HasCode

func (e *ServiceUnavailableException) HasCode() bool

func (*ServiceUnavailableException) HasContext

func (e *ServiceUnavailableException) HasContext() bool

func (*ServiceUnavailableException) HasMessage

func (e *ServiceUnavailableException) HasMessage() bool

func (*ServiceUnavailableException) HasType

func (e *ServiceUnavailableException) HasType() bool

type StorageClass

type StorageClass string
const (
	StorageClassWarm    StorageClass = "WARM"
	StorageClassCold    StorageClass = "COLD"
	StorageClassDeleted StorageClass = "DELETED"
)

Enum values for StorageClass

Source Files

enums.go errors.go types.go

Version
v0.1.0
Published
Sep 29, 2020
Platform
windows/amd64
Imports
4 packages
Last checked
6 hours ago

Tools for package owners.