backup

package
v1.38.20 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Apr 14, 2021 License: Apache-2.0 Imports: 10 Imported by: 61

Documentation

Overview

Package backup provides the client and types for making API requests to AWS Backup.

AWS Backup is a unified backup service designed to protect AWS services and their associated data. AWS Backup simplifies the creation, migration, restoration, and deletion of backups, while also providing reporting and auditing.

See https://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15 for more information on this service.

See backup package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/backup/

Using the Client

To contact AWS Backup with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the AWS Backup client Backup for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/backup/#New

Index

Constants

View Source
const (
	// CopyJobStateCreated is a CopyJobState enum value
	CopyJobStateCreated = "CREATED"

	// CopyJobStateRunning is a CopyJobState enum value
	CopyJobStateRunning = "RUNNING"

	// CopyJobStateCompleted is a CopyJobState enum value
	CopyJobStateCompleted = "COMPLETED"

	// CopyJobStateFailed is a CopyJobState enum value
	CopyJobStateFailed = "FAILED"
)
View Source
const (
	// JobStateCreated is a JobState enum value
	JobStateCreated = "CREATED"

	// JobStatePending is a JobState enum value
	JobStatePending = "PENDING"

	// JobStateRunning is a JobState enum value
	JobStateRunning = "RUNNING"

	// JobStateAborting is a JobState enum value
	JobStateAborting = "ABORTING"

	// JobStateAborted is a JobState enum value
	JobStateAborted = "ABORTED"

	// JobStateCompleted is a JobState enum value
	JobStateCompleted = "COMPLETED"

	// JobStateFailed is a JobState enum value
	JobStateFailed = "FAILED"

	// JobStateExpired is a JobState enum value
	JobStateExpired = "EXPIRED"
)
View Source
const (
	// RecoveryPointStatusCompleted is a RecoveryPointStatus enum value
	RecoveryPointStatusCompleted = "COMPLETED"

	// RecoveryPointStatusPartial is a RecoveryPointStatus enum value
	RecoveryPointStatusPartial = "PARTIAL"

	// RecoveryPointStatusDeleting is a RecoveryPointStatus enum value
	RecoveryPointStatusDeleting = "DELETING"

	// RecoveryPointStatusExpired is a RecoveryPointStatus enum value
	RecoveryPointStatusExpired = "EXPIRED"
)
View Source
const (
	// RestoreJobStatusPending is a RestoreJobStatus enum value
	RestoreJobStatusPending = "PENDING"

	// RestoreJobStatusRunning is a RestoreJobStatus enum value
	RestoreJobStatusRunning = "RUNNING"

	// RestoreJobStatusCompleted is a RestoreJobStatus enum value
	RestoreJobStatusCompleted = "COMPLETED"

	// RestoreJobStatusAborted is a RestoreJobStatus enum value
	RestoreJobStatusAborted = "ABORTED"

	// RestoreJobStatusFailed is a RestoreJobStatus enum value
	RestoreJobStatusFailed = "FAILED"
)
View Source
const (
	// StorageClassWarm is a StorageClass enum value
	StorageClassWarm = "WARM"

	// StorageClassCold is a StorageClass enum value
	StorageClassCold = "COLD"

	// StorageClassDeleted is a StorageClass enum value
	StorageClassDeleted = "DELETED"
)
View Source
const (
	// VaultEventBackupJobStarted is a VaultEvent enum value
	VaultEventBackupJobStarted = "BACKUP_JOB_STARTED"

	// VaultEventBackupJobCompleted is a VaultEvent enum value
	VaultEventBackupJobCompleted = "BACKUP_JOB_COMPLETED"

	// VaultEventBackupJobSuccessful is a VaultEvent enum value
	VaultEventBackupJobSuccessful = "BACKUP_JOB_SUCCESSFUL"

	// VaultEventBackupJobFailed is a VaultEvent enum value
	VaultEventBackupJobFailed = "BACKUP_JOB_FAILED"

	// VaultEventBackupJobExpired is a VaultEvent enum value
	VaultEventBackupJobExpired = "BACKUP_JOB_EXPIRED"

	// VaultEventRestoreJobStarted is a VaultEvent enum value
	VaultEventRestoreJobStarted = "RESTORE_JOB_STARTED"

	// VaultEventRestoreJobCompleted is a VaultEvent enum value
	VaultEventRestoreJobCompleted = "RESTORE_JOB_COMPLETED"

	// VaultEventRestoreJobSuccessful is a VaultEvent enum value
	VaultEventRestoreJobSuccessful = "RESTORE_JOB_SUCCESSFUL"

	// VaultEventRestoreJobFailed is a VaultEvent enum value
	VaultEventRestoreJobFailed = "RESTORE_JOB_FAILED"

	// VaultEventCopyJobStarted is a VaultEvent enum value
	VaultEventCopyJobStarted = "COPY_JOB_STARTED"

	// VaultEventCopyJobSuccessful is a VaultEvent enum value
	VaultEventCopyJobSuccessful = "COPY_JOB_SUCCESSFUL"

	// VaultEventCopyJobFailed is a VaultEvent enum value
	VaultEventCopyJobFailed = "COPY_JOB_FAILED"

	// VaultEventRecoveryPointModified is a VaultEvent enum value
	VaultEventRecoveryPointModified = "RECOVERY_POINT_MODIFIED"

	// VaultEventBackupPlanCreated is a VaultEvent enum value
	VaultEventBackupPlanCreated = "BACKUP_PLAN_CREATED"

	// VaultEventBackupPlanModified is a VaultEvent enum value
	VaultEventBackupPlanModified = "BACKUP_PLAN_MODIFIED"
)
View Source
const (

	// ErrCodeAlreadyExistsException for service response error code
	// "AlreadyExistsException".
	//
	// The required resource already exists.
	ErrCodeAlreadyExistsException = "AlreadyExistsException"

	// ErrCodeDependencyFailureException for service response error code
	// "DependencyFailureException".
	//
	// A dependent AWS service or resource returned an error to the AWS Backup service,
	// and the action cannot be completed.
	ErrCodeDependencyFailureException = "DependencyFailureException"

	// ErrCodeInvalidParameterValueException for service response error code
	// "InvalidParameterValueException".
	//
	// Indicates that something is wrong with a parameter's value. For example,
	// the value is out of range.
	ErrCodeInvalidParameterValueException = "InvalidParameterValueException"

	// ErrCodeInvalidRequestException for service response error code
	// "InvalidRequestException".
	//
	// Indicates that something is wrong with the input to the request. For example,
	// a parameter is of the wrong type.
	ErrCodeInvalidRequestException = "InvalidRequestException"

	// ErrCodeInvalidResourceStateException for service response error code
	// "InvalidResourceStateException".
	//
	// AWS Backup is already performing an action on this recovery point. It can't
	// perform the action you requested until the first action finishes. Try again
	// later.
	ErrCodeInvalidResourceStateException = "InvalidResourceStateException"

	// ErrCodeLimitExceededException for service response error code
	// "LimitExceededException".
	//
	// A limit in the request has been exceeded; for example, a maximum number of
	// items allowed in a request.
	ErrCodeLimitExceededException = "LimitExceededException"

	// ErrCodeMissingParameterValueException for service response error code
	// "MissingParameterValueException".
	//
	// Indicates that a required parameter is missing.
	ErrCodeMissingParameterValueException = "MissingParameterValueException"

	// ErrCodeResourceNotFoundException for service response error code
	// "ResourceNotFoundException".
	//
	// A resource that is required for the action doesn't exist.
	ErrCodeResourceNotFoundException = "ResourceNotFoundException"

	// ErrCodeServiceUnavailableException for service response error code
	// "ServiceUnavailableException".
	//
	// The request failed due to a temporary failure of the server.
	ErrCodeServiceUnavailableException = "ServiceUnavailableException"
)
View Source
const (
	ServiceName = "Backup" // Name of service.
	EndpointsID = "backup" // ID to lookup a service endpoint with.
	ServiceID   = "Backup" // ServiceID is a unique identifier of a specific service.
)

Service information constants

View Source
const (
	// ConditionTypeStringequals is a ConditionType enum value
	ConditionTypeStringequals = "STRINGEQUALS"
)

Variables

This section is empty.

Functions

func ConditionType_Values added in v1.34.3

func ConditionType_Values() []string

ConditionType_Values returns all elements of the ConditionType enum

func CopyJobState_Values added in v1.34.3

func CopyJobState_Values() []string

CopyJobState_Values returns all elements of the CopyJobState enum

func JobState_Values added in v1.34.3

func JobState_Values() []string

JobState_Values returns all elements of the JobState enum

func RecoveryPointStatus_Values added in v1.34.3

func RecoveryPointStatus_Values() []string

RecoveryPointStatus_Values returns all elements of the RecoveryPointStatus enum

func RestoreJobStatus_Values added in v1.34.3

func RestoreJobStatus_Values() []string

RestoreJobStatus_Values returns all elements of the RestoreJobStatus enum

func StorageClass_Values added in v1.34.3

func StorageClass_Values() []string

StorageClass_Values returns all elements of the StorageClass enum

func VaultEvent_Values added in v1.34.3

func VaultEvent_Values() []string

VaultEvent_Values returns all elements of the VaultEvent enum

Types

type AdvancedBackupSetting added in v1.34.30

type AdvancedBackupSetting struct {

	// 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 the WindowsVSS backup option and
	// create a VSS Windows backup.
	//
	// Set to "WindowsVSS":"disabled" to create a regular backup. The WindowsVSS
	// option is not enabled by default.
	//
	// If you specify an invalid option, you get an InvalidParameterValueException
	// exception.
	//
	// For more information about Windows VSS backups, see Creating a VSS-Enabled
	// Windows Backup (https://docs.aws.amazon.com/aws-backup/latest/devguide/windows-backups.html).
	BackupOptions map[string]*string `type:"map"`

	// Specifies an object containing resource type and backup options. The only
	// supported resource type is Amazon EC2 instances with Windows VSS. For an
	// CloudFormation example, see the sample CloudFormation template to enable
	// Windows VSS (https://docs.aws.amazon.com/aws-backup/latest/devguide/integrate-cloudformation-with-aws-backup.html)
	// in the AWS Backup User Guide.
	//
	// Valid values: EC2.
	ResourceType *string `type:"string"`
	// contains filtered or unexported fields
}

A list of backup options for each resource type.

func (AdvancedBackupSetting) GoString added in v1.34.30

func (s AdvancedBackupSetting) GoString() string

GoString returns the string representation

func (*AdvancedBackupSetting) SetBackupOptions added in v1.34.30

func (s *AdvancedBackupSetting) SetBackupOptions(v map[string]*string) *AdvancedBackupSetting

SetBackupOptions sets the BackupOptions field's value.

func (*AdvancedBackupSetting) SetResourceType added in v1.34.30

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

SetResourceType sets the ResourceType field's value.

func (AdvancedBackupSetting) String added in v1.34.30

func (s AdvancedBackupSetting) String() string

String returns the string representation

type AlreadyExistsException added in v1.28.0

type AlreadyExistsException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Arn *string `type:"string"`

	Code_ *string `locationName:"Code" type:"string"`

	Context *string `type:"string"`

	CreatorRequestId *string `type:"string"`

	Message_ *string `locationName:"Message" type:"string"`

	Type *string `type:"string"`
	// contains filtered or unexported fields
}

The required resource already exists.

func (*AlreadyExistsException) Code added in v1.28.0

func (s *AlreadyExistsException) Code() string

Code returns the exception type name.

func (*AlreadyExistsException) Error added in v1.28.0

func (s *AlreadyExistsException) Error() string

func (AlreadyExistsException) GoString added in v1.28.0

func (s AlreadyExistsException) GoString() string

GoString returns the string representation

func (*AlreadyExistsException) Message added in v1.28.0

func (s *AlreadyExistsException) Message() string

Message returns the exception's message.

func (*AlreadyExistsException) OrigErr added in v1.28.0

func (s *AlreadyExistsException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*AlreadyExistsException) RequestID added in v1.28.0

func (s *AlreadyExistsException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*AlreadyExistsException) StatusCode added in v1.28.0

func (s *AlreadyExistsException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (AlreadyExistsException) String added in v1.28.0

func (s AlreadyExistsException) String() string

String returns the string representation

type Backup

type Backup struct {
	*client.Client
}

Backup provides the API operation methods for making requests to AWS Backup. See this package's package overview docs for details on the service.

Backup methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New

func New(p client.ConfigProvider, cfgs ...*aws.Config) *Backup

New creates a new instance of the Backup client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example:

mySession := session.Must(session.NewSession())

// Create a Backup client from just a session.
svc := backup.New(mySession)

// Create a Backup client with additional configuration
svc := backup.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*Backup) CreateBackupPlan

func (c *Backup) CreateBackupPlan(input *CreateBackupPlanInput) (*CreateBackupPlanOutput, error)

CreateBackupPlan API operation for AWS Backup.

Creates a backup plan using a backup plan name and backup rules. A backup plan is a document that contains information that AWS Backup uses to schedule tasks that create recovery points for resources.

If you call CreateBackupPlan with a plan that already exists, an AlreadyExistsException is returned.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Backup's API operation CreateBackupPlan for usage and error information.

Returned Error Types:

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

  • AlreadyExistsException The required resource already exists.

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

  • MissingParameterValueException Indicates that a required parameter is missing.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/CreateBackupPlan

func (*Backup) CreateBackupPlanRequest

func (c *Backup) CreateBackupPlanRequest(input *CreateBackupPlanInput) (req *request.Request, output *CreateBackupPlanOutput)

CreateBackupPlanRequest generates a "aws/request.Request" representing the client's request for the CreateBackupPlan operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateBackupPlan for more information on using the CreateBackupPlan API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateBackupPlanRequest method.
req, resp := client.CreateBackupPlanRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/CreateBackupPlan

func (*Backup) CreateBackupPlanWithContext

func (c *Backup) CreateBackupPlanWithContext(ctx aws.Context, input *CreateBackupPlanInput, opts ...request.Option) (*CreateBackupPlanOutput, error)

CreateBackupPlanWithContext is the same as CreateBackupPlan with the addition of the ability to pass a context and additional request options.

See CreateBackupPlan for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Backup) CreateBackupSelection

func (c *Backup) CreateBackupSelection(input *CreateBackupSelectionInput) (*CreateBackupSelectionOutput, error)

CreateBackupSelection API operation for AWS Backup.

Creates a JSON document that specifies a set of resources to assign to a backup plan. Resources can be included by specifying patterns for a ListOfTags and selected Resources.

For example, consider the following patterns:

  • Resources: "arn:aws:ec2:region:account-id:volume/volume-id"

  • ConditionKey:"department" ConditionValue:"finance" ConditionType:"StringEquals"

  • ConditionKey:"importance" ConditionValue:"critical" ConditionType:"StringEquals"

Using these patterns would back up all Amazon Elastic Block Store (Amazon EBS) volumes that are tagged as "department=finance", "importance=critical", in addition to an EBS volume with the specified volume ID.

Resources and conditions are additive in that all resources that match the pattern are selected. This shouldn't be confused with a logical AND, where all conditions must match. The matching patterns are logically put together using the OR operator. In other words, all patterns that match are selected for backup.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Backup's API operation CreateBackupSelection for usage and error information.

Returned Error Types:

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

  • AlreadyExistsException The required resource already exists.

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

  • MissingParameterValueException Indicates that a required parameter is missing.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/CreateBackupSelection

func (*Backup) CreateBackupSelectionRequest

func (c *Backup) CreateBackupSelectionRequest(input *CreateBackupSelectionInput) (req *request.Request, output *CreateBackupSelectionOutput)

CreateBackupSelectionRequest generates a "aws/request.Request" representing the client's request for the CreateBackupSelection operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateBackupSelection for more information on using the CreateBackupSelection API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateBackupSelectionRequest method.
req, resp := client.CreateBackupSelectionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/CreateBackupSelection

func (*Backup) CreateBackupSelectionWithContext

func (c *Backup) CreateBackupSelectionWithContext(ctx aws.Context, input *CreateBackupSelectionInput, opts ...request.Option) (*CreateBackupSelectionOutput, error)

CreateBackupSelectionWithContext is the same as CreateBackupSelection with the addition of the ability to pass a context and additional request options.

See CreateBackupSelection for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Backup) CreateBackupVault

func (c *Backup) CreateBackupVault(input *CreateBackupVaultInput) (*CreateBackupVaultOutput, error)

CreateBackupVault API operation for AWS Backup.

Creates a logical container where backups are stored. A CreateBackupVault request includes a name, optionally one or more resource tags, an encryption key, and a request ID.

Sensitive data, such as passport numbers, should not be included the name of a backup vault.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Backup's API operation CreateBackupVault for usage and error information.

Returned Error Types:

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

  • MissingParameterValueException Indicates that a required parameter is missing.

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

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

  • AlreadyExistsException The required resource already exists.

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/CreateBackupVault

func (*Backup) CreateBackupVaultRequest

func (c *Backup) CreateBackupVaultRequest(input *CreateBackupVaultInput) (req *request.Request, output *CreateBackupVaultOutput)

CreateBackupVaultRequest generates a "aws/request.Request" representing the client's request for the CreateBackupVault operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateBackupVault for more information on using the CreateBackupVault API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateBackupVaultRequest method.
req, resp := client.CreateBackupVaultRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/CreateBackupVault

func (*Backup) CreateBackupVaultWithContext

func (c *Backup) CreateBackupVaultWithContext(ctx aws.Context, input *CreateBackupVaultInput, opts ...request.Option) (*CreateBackupVaultOutput, error)

CreateBackupVaultWithContext is the same as CreateBackupVault with the addition of the ability to pass a context and additional request options.

See CreateBackupVault for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Backup) DeleteBackupPlan

func (c *Backup) DeleteBackupPlan(input *DeleteBackupPlanInput) (*DeleteBackupPlanOutput, error)

DeleteBackupPlan API operation for AWS Backup.

Deletes a backup plan. A backup plan can only be deleted after all associated selections of resources have been deleted. Deleting a backup plan deletes the current version of a backup plan. Previous versions, if any, will still exist.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Backup's API operation DeleteBackupPlan for usage and error information.

Returned Error Types:

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

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

  • MissingParameterValueException Indicates that a required parameter is missing.

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/DeleteBackupPlan

func (*Backup) DeleteBackupPlanRequest

func (c *Backup) DeleteBackupPlanRequest(input *DeleteBackupPlanInput) (req *request.Request, output *DeleteBackupPlanOutput)

DeleteBackupPlanRequest generates a "aws/request.Request" representing the client's request for the DeleteBackupPlan operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteBackupPlan for more information on using the DeleteBackupPlan API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteBackupPlanRequest method.
req, resp := client.DeleteBackupPlanRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/DeleteBackupPlan

func (*Backup) DeleteBackupPlanWithContext

func (c *Backup) DeleteBackupPlanWithContext(ctx aws.Context, input *DeleteBackupPlanInput, opts ...request.Option) (*DeleteBackupPlanOutput, error)

DeleteBackupPlanWithContext is the same as DeleteBackupPlan with the addition of the ability to pass a context and additional request options.

See DeleteBackupPlan for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Backup) DeleteBackupSelection

func (c *Backup) DeleteBackupSelection(input *DeleteBackupSelectionInput) (*DeleteBackupSelectionOutput, error)

DeleteBackupSelection API operation for AWS Backup.

Deletes the resource selection associated with a backup plan that is specified by the SelectionId.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Backup's API operation DeleteBackupSelection for usage and error information.

Returned Error Types:

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

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

  • MissingParameterValueException Indicates that a required parameter is missing.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/DeleteBackupSelection

func (*Backup) DeleteBackupSelectionRequest

func (c *Backup) DeleteBackupSelectionRequest(input *DeleteBackupSelectionInput) (req *request.Request, output *DeleteBackupSelectionOutput)

DeleteBackupSelectionRequest generates a "aws/request.Request" representing the client's request for the DeleteBackupSelection operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteBackupSelection for more information on using the DeleteBackupSelection API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteBackupSelectionRequest method.
req, resp := client.DeleteBackupSelectionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/DeleteBackupSelection

func (*Backup) DeleteBackupSelectionWithContext

func (c *Backup) DeleteBackupSelectionWithContext(ctx aws.Context, input *DeleteBackupSelectionInput, opts ...request.Option) (*DeleteBackupSelectionOutput, error)

DeleteBackupSelectionWithContext is the same as DeleteBackupSelection with the addition of the ability to pass a context and additional request options.

See DeleteBackupSelection for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Backup) DeleteBackupVault

func (c *Backup) DeleteBackupVault(input *DeleteBackupVaultInput) (*DeleteBackupVaultOutput, error)

DeleteBackupVault API operation for AWS Backup.

Deletes the backup vault identified by its name. A vault can be deleted only if it is empty.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Backup's API operation DeleteBackupVault for usage and error information.

Returned Error Types:

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

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

  • MissingParameterValueException Indicates that a required parameter is missing.

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/DeleteBackupVault

func (*Backup) DeleteBackupVaultAccessPolicy

func (c *Backup) DeleteBackupVaultAccessPolicy(input *DeleteBackupVaultAccessPolicyInput) (*DeleteBackupVaultAccessPolicyOutput, error)

DeleteBackupVaultAccessPolicy API operation for AWS Backup.

Deletes the policy document that manages permissions on a backup vault.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Backup's API operation DeleteBackupVaultAccessPolicy for usage and error information.

Returned Error Types:

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

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

  • MissingParameterValueException Indicates that a required parameter is missing.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/DeleteBackupVaultAccessPolicy

func (*Backup) DeleteBackupVaultAccessPolicyRequest

func (c *Backup) DeleteBackupVaultAccessPolicyRequest(input *DeleteBackupVaultAccessPolicyInput) (req *request.Request, output *DeleteBackupVaultAccessPolicyOutput)

DeleteBackupVaultAccessPolicyRequest generates a "aws/request.Request" representing the client's request for the DeleteBackupVaultAccessPolicy operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteBackupVaultAccessPolicy for more information on using the DeleteBackupVaultAccessPolicy API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteBackupVaultAccessPolicyRequest method.
req, resp := client.DeleteBackupVaultAccessPolicyRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/DeleteBackupVaultAccessPolicy

func (*Backup) DeleteBackupVaultAccessPolicyWithContext

func (c *Backup) DeleteBackupVaultAccessPolicyWithContext(ctx aws.Context, input *DeleteBackupVaultAccessPolicyInput, opts ...request.Option) (*DeleteBackupVaultAccessPolicyOutput, error)

DeleteBackupVaultAccessPolicyWithContext is the same as DeleteBackupVaultAccessPolicy with the addition of the ability to pass a context and additional request options.

See DeleteBackupVaultAccessPolicy for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Backup) DeleteBackupVaultNotifications

func (c *Backup) DeleteBackupVaultNotifications(input *DeleteBackupVaultNotificationsInput) (*DeleteBackupVaultNotificationsOutput, error)

DeleteBackupVaultNotifications API operation for AWS Backup.

Deletes event notifications for the specified backup vault.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Backup's API operation DeleteBackupVaultNotifications for usage and error information.

Returned Error Types:

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

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

  • MissingParameterValueException Indicates that a required parameter is missing.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/DeleteBackupVaultNotifications

func (*Backup) DeleteBackupVaultNotificationsRequest

func (c *Backup) DeleteBackupVaultNotificationsRequest(input *DeleteBackupVaultNotificationsInput) (req *request.Request, output *DeleteBackupVaultNotificationsOutput)

DeleteBackupVaultNotificationsRequest generates a "aws/request.Request" representing the client's request for the DeleteBackupVaultNotifications operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteBackupVaultNotifications for more information on using the DeleteBackupVaultNotifications API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteBackupVaultNotificationsRequest method.
req, resp := client.DeleteBackupVaultNotificationsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/DeleteBackupVaultNotifications

func (*Backup) DeleteBackupVaultNotificationsWithContext

func (c *Backup) DeleteBackupVaultNotificationsWithContext(ctx aws.Context, input *DeleteBackupVaultNotificationsInput, opts ...request.Option) (*DeleteBackupVaultNotificationsOutput, error)

DeleteBackupVaultNotificationsWithContext is the same as DeleteBackupVaultNotifications with the addition of the ability to pass a context and additional request options.

See DeleteBackupVaultNotifications for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Backup) DeleteBackupVaultRequest

func (c *Backup) DeleteBackupVaultRequest(input *DeleteBackupVaultInput) (req *request.Request, output *DeleteBackupVaultOutput)

DeleteBackupVaultRequest generates a "aws/request.Request" representing the client's request for the DeleteBackupVault operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteBackupVault for more information on using the DeleteBackupVault API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteBackupVaultRequest method.
req, resp := client.DeleteBackupVaultRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/DeleteBackupVault

func (*Backup) DeleteBackupVaultWithContext

func (c *Backup) DeleteBackupVaultWithContext(ctx aws.Context, input *DeleteBackupVaultInput, opts ...request.Option) (*DeleteBackupVaultOutput, error)

DeleteBackupVaultWithContext is the same as DeleteBackupVault with the addition of the ability to pass a context and additional request options.

See DeleteBackupVault for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Backup) DeleteRecoveryPoint

func (c *Backup) DeleteRecoveryPoint(input *DeleteRecoveryPointInput) (*DeleteRecoveryPointOutput, error)

DeleteRecoveryPoint API operation for AWS Backup.

Deletes the recovery point specified by a recovery point ID.

If the recovery point ID belongs to a continuous backup, calling this endpoint deletes the existing continuous backup and stops future continuous backup.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Backup's API operation DeleteRecoveryPoint for usage and error information.

Returned Error Types:

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

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

  • MissingParameterValueException Indicates that a required parameter is missing.

  • InvalidResourceStateException AWS Backup is already performing an action on this recovery point. It can't perform the action you requested until the first action finishes. Try again later.

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/DeleteRecoveryPoint

func (*Backup) DeleteRecoveryPointRequest

func (c *Backup) DeleteRecoveryPointRequest(input *DeleteRecoveryPointInput) (req *request.Request, output *DeleteRecoveryPointOutput)

DeleteRecoveryPointRequest generates a "aws/request.Request" representing the client's request for the DeleteRecoveryPoint operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteRecoveryPoint for more information on using the DeleteRecoveryPoint API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteRecoveryPointRequest method.
req, resp := client.DeleteRecoveryPointRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/DeleteRecoveryPoint

func (*Backup) DeleteRecoveryPointWithContext

func (c *Backup) DeleteRecoveryPointWithContext(ctx aws.Context, input *DeleteRecoveryPointInput, opts ...request.Option) (*DeleteRecoveryPointOutput, error)

DeleteRecoveryPointWithContext is the same as DeleteRecoveryPoint with the addition of the ability to pass a context and additional request options.

See DeleteRecoveryPoint for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Backup) DescribeBackupJob

func (c *Backup) DescribeBackupJob(input *DescribeBackupJobInput) (*DescribeBackupJobOutput, error)

DescribeBackupJob API operation for AWS Backup.

Returns backup job details for the specified BackupJobId.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Backup's API operation DescribeBackupJob for usage and error information.

Returned Error Types:

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

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

  • MissingParameterValueException Indicates that a required parameter is missing.

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/DescribeBackupJob

func (*Backup) DescribeBackupJobRequest

func (c *Backup) DescribeBackupJobRequest(input *DescribeBackupJobInput) (req *request.Request, output *DescribeBackupJobOutput)

DescribeBackupJobRequest generates a "aws/request.Request" representing the client's request for the DescribeBackupJob operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeBackupJob for more information on using the DescribeBackupJob API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeBackupJobRequest method.
req, resp := client.DescribeBackupJobRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/DescribeBackupJob

func (*Backup) DescribeBackupJobWithContext

func (c *Backup) DescribeBackupJobWithContext(ctx aws.Context, input *DescribeBackupJobInput, opts ...request.Option) (*DescribeBackupJobOutput, error)

DescribeBackupJobWithContext is the same as DescribeBackupJob with the addition of the ability to pass a context and additional request options.

See DescribeBackupJob for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Backup) DescribeBackupVault

func (c *Backup) DescribeBackupVault(input *DescribeBackupVaultInput) (*DescribeBackupVaultOutput, error)

DescribeBackupVault API operation for AWS Backup.

Returns metadata about a backup vault specified by its name.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Backup's API operation DescribeBackupVault for usage and error information.

Returned Error Types:

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

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

  • MissingParameterValueException Indicates that a required parameter is missing.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/DescribeBackupVault

func (*Backup) DescribeBackupVaultRequest

func (c *Backup) DescribeBackupVaultRequest(input *DescribeBackupVaultInput) (req *request.Request, output *DescribeBackupVaultOutput)

DescribeBackupVaultRequest generates a "aws/request.Request" representing the client's request for the DescribeBackupVault operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeBackupVault for more information on using the DescribeBackupVault API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeBackupVaultRequest method.
req, resp := client.DescribeBackupVaultRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/DescribeBackupVault

func (*Backup) DescribeBackupVaultWithContext

func (c *Backup) DescribeBackupVaultWithContext(ctx aws.Context, input *DescribeBackupVaultInput, opts ...request.Option) (*DescribeBackupVaultOutput, error)

DescribeBackupVaultWithContext is the same as DescribeBackupVault with the addition of the ability to pass a context and additional request options.

See DescribeBackupVault for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Backup) DescribeCopyJob added in v1.28.1

func (c *Backup) DescribeCopyJob(input *DescribeCopyJobInput) (*DescribeCopyJobOutput, error)

DescribeCopyJob API operation for AWS Backup.

Returns metadata associated with creating a copy of a resource.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Backup's API operation DescribeCopyJob for usage and error information.

Returned Error Types:

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

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

  • MissingParameterValueException Indicates that a required parameter is missing.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/DescribeCopyJob

func (*Backup) DescribeCopyJobRequest added in v1.28.1

func (c *Backup) DescribeCopyJobRequest(input *DescribeCopyJobInput) (req *request.Request, output *DescribeCopyJobOutput)

DescribeCopyJobRequest generates a "aws/request.Request" representing the client's request for the DescribeCopyJob operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeCopyJob for more information on using the DescribeCopyJob API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeCopyJobRequest method.
req, resp := client.DescribeCopyJobRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/DescribeCopyJob

func (*Backup) DescribeCopyJobWithContext added in v1.28.1

func (c *Backup) DescribeCopyJobWithContext(ctx aws.Context, input *DescribeCopyJobInput, opts ...request.Option) (*DescribeCopyJobOutput, error)

DescribeCopyJobWithContext is the same as DescribeCopyJob with the addition of the ability to pass a context and additional request options.

See DescribeCopyJob for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Backup) DescribeGlobalSettings added in v1.35.31

func (c *Backup) DescribeGlobalSettings(input *DescribeGlobalSettingsInput) (*DescribeGlobalSettingsOutput, error)

DescribeGlobalSettings API operation for AWS Backup.

Describes the global settings of the AWS account, including whether it is opted in to cross-account backup.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Backup's API operation DescribeGlobalSettings for usage and error information.

Returned Error Types:

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/DescribeGlobalSettings

func (*Backup) DescribeGlobalSettingsRequest added in v1.35.31

func (c *Backup) DescribeGlobalSettingsRequest(input *DescribeGlobalSettingsInput) (req *request.Request, output *DescribeGlobalSettingsOutput)

DescribeGlobalSettingsRequest generates a "aws/request.Request" representing the client's request for the DescribeGlobalSettings operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeGlobalSettings for more information on using the DescribeGlobalSettings API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeGlobalSettingsRequest method.
req, resp := client.DescribeGlobalSettingsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/DescribeGlobalSettings

func (*Backup) DescribeGlobalSettingsWithContext added in v1.35.31

func (c *Backup) DescribeGlobalSettingsWithContext(ctx aws.Context, input *DescribeGlobalSettingsInput, opts ...request.Option) (*DescribeGlobalSettingsOutput, error)

DescribeGlobalSettingsWithContext is the same as DescribeGlobalSettings with the addition of the ability to pass a context and additional request options.

See DescribeGlobalSettings for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Backup) DescribeProtectedResource

func (c *Backup) DescribeProtectedResource(input *DescribeProtectedResourceInput) (*DescribeProtectedResourceOutput, error)

DescribeProtectedResource API operation for AWS Backup.

Returns information about a saved resource, including the last time it was backed up, its Amazon Resource Name (ARN), and the AWS service type of the saved resource.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Backup's API operation DescribeProtectedResource for usage and error information.

Returned Error Types:

  • MissingParameterValueException Indicates that a required parameter is missing.

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/DescribeProtectedResource

func (*Backup) DescribeProtectedResourceRequest

func (c *Backup) DescribeProtectedResourceRequest(input *DescribeProtectedResourceInput) (req *request.Request, output *DescribeProtectedResourceOutput)

DescribeProtectedResourceRequest generates a "aws/request.Request" representing the client's request for the DescribeProtectedResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeProtectedResource for more information on using the DescribeProtectedResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeProtectedResourceRequest method.
req, resp := client.DescribeProtectedResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/DescribeProtectedResource

func (*Backup) DescribeProtectedResourceWithContext

func (c *Backup) DescribeProtectedResourceWithContext(ctx aws.Context, input *DescribeProtectedResourceInput, opts ...request.Option) (*DescribeProtectedResourceOutput, error)

DescribeProtectedResourceWithContext is the same as DescribeProtectedResource with the addition of the ability to pass a context and additional request options.

See DescribeProtectedResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Backup) DescribeRecoveryPoint

func (c *Backup) DescribeRecoveryPoint(input *DescribeRecoveryPointInput) (*DescribeRecoveryPointOutput, error)

DescribeRecoveryPoint API operation for AWS Backup.

Returns metadata associated with a recovery point, including ID, status, encryption, and lifecycle.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Backup's API operation DescribeRecoveryPoint for usage and error information.

Returned Error Types:

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

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

  • MissingParameterValueException Indicates that a required parameter is missing.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/DescribeRecoveryPoint

func (*Backup) DescribeRecoveryPointRequest

func (c *Backup) DescribeRecoveryPointRequest(input *DescribeRecoveryPointInput) (req *request.Request, output *DescribeRecoveryPointOutput)

DescribeRecoveryPointRequest generates a "aws/request.Request" representing the client's request for the DescribeRecoveryPoint operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeRecoveryPoint for more information on using the DescribeRecoveryPoint API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeRecoveryPointRequest method.
req, resp := client.DescribeRecoveryPointRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/DescribeRecoveryPoint

func (*Backup) DescribeRecoveryPointWithContext

func (c *Backup) DescribeRecoveryPointWithContext(ctx aws.Context, input *DescribeRecoveryPointInput, opts ...request.Option) (*DescribeRecoveryPointOutput, error)

DescribeRecoveryPointWithContext is the same as DescribeRecoveryPoint with the addition of the ability to pass a context and additional request options.

See DescribeRecoveryPoint for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Backup) DescribeRegionSettings added in v1.31.2

func (c *Backup) DescribeRegionSettings(input *DescribeRegionSettingsInput) (*DescribeRegionSettingsOutput, error)

DescribeRegionSettings API operation for AWS Backup.

Returns the current service opt-in settings for the Region. If service-opt-in is enabled for a service, AWS Backup tries to protect that service's resources in this Region, when the resource is included in an on-demand backup or scheduled backup plan. Otherwise, AWS Backup does not try to protect that service's resources in this Region, AWS Backup does not try to protect that service's resources in this Region.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Backup's API operation DescribeRegionSettings for usage and error information.

Returned Error Types:

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

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/DescribeRegionSettings

func (*Backup) DescribeRegionSettingsRequest added in v1.31.2

func (c *Backup) DescribeRegionSettingsRequest(input *DescribeRegionSettingsInput) (req *request.Request, output *DescribeRegionSettingsOutput)

DescribeRegionSettingsRequest generates a "aws/request.Request" representing the client's request for the DescribeRegionSettings operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeRegionSettings for more information on using the DescribeRegionSettings API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeRegionSettingsRequest method.
req, resp := client.DescribeRegionSettingsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/DescribeRegionSettings

func (*Backup) DescribeRegionSettingsWithContext added in v1.31.2

func (c *Backup) DescribeRegionSettingsWithContext(ctx aws.Context, input *DescribeRegionSettingsInput, opts ...request.Option) (*DescribeRegionSettingsOutput, error)

DescribeRegionSettingsWithContext is the same as DescribeRegionSettings with the addition of the ability to pass a context and additional request options.

See DescribeRegionSettings for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Backup) DescribeRestoreJob

func (c *Backup) DescribeRestoreJob(input *DescribeRestoreJobInput) (*DescribeRestoreJobOutput, error)

DescribeRestoreJob API operation for AWS Backup.

Returns metadata associated with a restore job that is specified by a job ID.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Backup's API operation DescribeRestoreJob for usage and error information.

Returned Error Types:

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

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

  • MissingParameterValueException Indicates that a required parameter is missing.

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/DescribeRestoreJob

func (*Backup) DescribeRestoreJobRequest

func (c *Backup) DescribeRestoreJobRequest(input *DescribeRestoreJobInput) (req *request.Request, output *DescribeRestoreJobOutput)

DescribeRestoreJobRequest generates a "aws/request.Request" representing the client's request for the DescribeRestoreJob operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeRestoreJob for more information on using the DescribeRestoreJob API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeRestoreJobRequest method.
req, resp := client.DescribeRestoreJobRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/DescribeRestoreJob

func (*Backup) DescribeRestoreJobWithContext

func (c *Backup) DescribeRestoreJobWithContext(ctx aws.Context, input *DescribeRestoreJobInput, opts ...request.Option) (*DescribeRestoreJobOutput, error)

DescribeRestoreJobWithContext is the same as DescribeRestoreJob with the addition of the ability to pass a context and additional request options.

See DescribeRestoreJob for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Backup) DisassociateRecoveryPoint added in v1.37.28

func (c *Backup) DisassociateRecoveryPoint(input *DisassociateRecoveryPointInput) (*DisassociateRecoveryPointOutput, error)

DisassociateRecoveryPoint API operation for AWS Backup.

Deletes the specified continuous backup recovery point from AWS Backup and releases control of that continuous backup to the source service, such as Amazon RDS. The source service will continue to create and retain continuous backups using the lifecycle that you specified in your original backup plan.

Does not support snapshot backup recovery points.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Backup's API operation DisassociateRecoveryPoint for usage and error information.

Returned Error Types:

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

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

  • MissingParameterValueException Indicates that a required parameter is missing.

  • InvalidResourceStateException AWS Backup is already performing an action on this recovery point. It can't perform the action you requested until the first action finishes. Try again later.

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/DisassociateRecoveryPoint

func (*Backup) DisassociateRecoveryPointRequest added in v1.37.28

func (c *Backup) DisassociateRecoveryPointRequest(input *DisassociateRecoveryPointInput) (req *request.Request, output *DisassociateRecoveryPointOutput)

DisassociateRecoveryPointRequest generates a "aws/request.Request" representing the client's request for the DisassociateRecoveryPoint operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DisassociateRecoveryPoint for more information on using the DisassociateRecoveryPoint API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DisassociateRecoveryPointRequest method.
req, resp := client.DisassociateRecoveryPointRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/DisassociateRecoveryPoint

func (*Backup) DisassociateRecoveryPointWithContext added in v1.37.28

func (c *Backup) DisassociateRecoveryPointWithContext(ctx aws.Context, input *DisassociateRecoveryPointInput, opts ...request.Option) (*DisassociateRecoveryPointOutput, error)

DisassociateRecoveryPointWithContext is the same as DisassociateRecoveryPoint with the addition of the ability to pass a context and additional request options.

See DisassociateRecoveryPoint for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Backup) ExportBackupPlanTemplate

func (c *Backup) ExportBackupPlanTemplate(input *ExportBackupPlanTemplateInput) (*ExportBackupPlanTemplateOutput, error)

ExportBackupPlanTemplate API operation for AWS Backup.

Returns the backup plan that is specified by the plan ID as a backup template.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Backup's API operation ExportBackupPlanTemplate for usage and error information.

Returned Error Types:

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

  • MissingParameterValueException Indicates that a required parameter is missing.

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ExportBackupPlanTemplate

func (*Backup) ExportBackupPlanTemplateRequest

func (c *Backup) ExportBackupPlanTemplateRequest(input *ExportBackupPlanTemplateInput) (req *request.Request, output *ExportBackupPlanTemplateOutput)

ExportBackupPlanTemplateRequest generates a "aws/request.Request" representing the client's request for the ExportBackupPlanTemplate operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ExportBackupPlanTemplate for more information on using the ExportBackupPlanTemplate API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ExportBackupPlanTemplateRequest method.
req, resp := client.ExportBackupPlanTemplateRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ExportBackupPlanTemplate

func (*Backup) ExportBackupPlanTemplateWithContext

func (c *Backup) ExportBackupPlanTemplateWithContext(ctx aws.Context, input *ExportBackupPlanTemplateInput, opts ...request.Option) (*ExportBackupPlanTemplateOutput, error)

ExportBackupPlanTemplateWithContext is the same as ExportBackupPlanTemplate with the addition of the ability to pass a context and additional request options.

See ExportBackupPlanTemplate for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Backup) GetBackupPlan

func (c *Backup) GetBackupPlan(input *GetBackupPlanInput) (*GetBackupPlanOutput, error)

GetBackupPlan API operation for AWS Backup.

Returns BackupPlan details for the specified BackupPlanId. The details are the body of a backup plan in JSON format, in addition to plan metadata.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Backup's API operation GetBackupPlan for usage and error information.

Returned Error Types:

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

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

  • MissingParameterValueException Indicates that a required parameter is missing.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/GetBackupPlan

func (*Backup) GetBackupPlanFromJSON

func (c *Backup) GetBackupPlanFromJSON(input *GetBackupPlanFromJSONInput) (*GetBackupPlanFromJSONOutput, error)

GetBackupPlanFromJSON API operation for AWS Backup.

Returns a valid JSON document specifying a backup plan or an error.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Backup's API operation GetBackupPlanFromJSON for usage and error information.

Returned Error Types:

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

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

  • MissingParameterValueException Indicates that a required parameter is missing.

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/GetBackupPlanFromJSON

func (*Backup) GetBackupPlanFromJSONRequest

func (c *Backup) GetBackupPlanFromJSONRequest(input *GetBackupPlanFromJSONInput) (req *request.Request, output *GetBackupPlanFromJSONOutput)

GetBackupPlanFromJSONRequest generates a "aws/request.Request" representing the client's request for the GetBackupPlanFromJSON operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetBackupPlanFromJSON for more information on using the GetBackupPlanFromJSON API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetBackupPlanFromJSONRequest method.
req, resp := client.GetBackupPlanFromJSONRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/GetBackupPlanFromJSON

func (*Backup) GetBackupPlanFromJSONWithContext

func (c *Backup) GetBackupPlanFromJSONWithContext(ctx aws.Context, input *GetBackupPlanFromJSONInput, opts ...request.Option) (*GetBackupPlanFromJSONOutput, error)

GetBackupPlanFromJSONWithContext is the same as GetBackupPlanFromJSON with the addition of the ability to pass a context and additional request options.

See GetBackupPlanFromJSON for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Backup) GetBackupPlanFromTemplate

func (c *Backup) GetBackupPlanFromTemplate(input *GetBackupPlanFromTemplateInput) (*GetBackupPlanFromTemplateOutput, error)

GetBackupPlanFromTemplate API operation for AWS Backup.

Returns the template specified by its templateId as a backup plan.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Backup's API operation GetBackupPlanFromTemplate for usage and error information.

Returned Error Types:

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

  • MissingParameterValueException Indicates that a required parameter is missing.

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/GetBackupPlanFromTemplate

func (*Backup) GetBackupPlanFromTemplateRequest

func (c *Backup) GetBackupPlanFromTemplateRequest(input *GetBackupPlanFromTemplateInput) (req *request.Request, output *GetBackupPlanFromTemplateOutput)

GetBackupPlanFromTemplateRequest generates a "aws/request.Request" representing the client's request for the GetBackupPlanFromTemplate operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetBackupPlanFromTemplate for more information on using the GetBackupPlanFromTemplate API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetBackupPlanFromTemplateRequest method.
req, resp := client.GetBackupPlanFromTemplateRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/GetBackupPlanFromTemplate

func (*Backup) GetBackupPlanFromTemplateWithContext

func (c *Backup) GetBackupPlanFromTemplateWithContext(ctx aws.Context, input *GetBackupPlanFromTemplateInput, opts ...request.Option) (*GetBackupPlanFromTemplateOutput, error)

GetBackupPlanFromTemplateWithContext is the same as GetBackupPlanFromTemplate with the addition of the ability to pass a context and additional request options.

See GetBackupPlanFromTemplate for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Backup) GetBackupPlanRequest

func (c *Backup) GetBackupPlanRequest(input *GetBackupPlanInput) (req *request.Request, output *GetBackupPlanOutput)

GetBackupPlanRequest generates a "aws/request.Request" representing the client's request for the GetBackupPlan operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetBackupPlan for more information on using the GetBackupPlan API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetBackupPlanRequest method.
req, resp := client.GetBackupPlanRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/GetBackupPlan

func (*Backup) GetBackupPlanWithContext

func (c *Backup) GetBackupPlanWithContext(ctx aws.Context, input *GetBackupPlanInput, opts ...request.Option) (*GetBackupPlanOutput, error)

GetBackupPlanWithContext is the same as GetBackupPlan with the addition of the ability to pass a context and additional request options.

See GetBackupPlan for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Backup) GetBackupSelection

func (c *Backup) GetBackupSelection(input *GetBackupSelectionInput) (*GetBackupSelectionOutput, error)

GetBackupSelection API operation for AWS Backup.

Returns selection metadata and a document in JSON format that specifies a list of resources that are associated with a backup plan.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Backup's API operation GetBackupSelection for usage and error information.

Returned Error Types:

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

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

  • MissingParameterValueException Indicates that a required parameter is missing.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/GetBackupSelection

func (*Backup) GetBackupSelectionRequest

func (c *Backup) GetBackupSelectionRequest(input *GetBackupSelectionInput) (req *request.Request, output *GetBackupSelectionOutput)

GetBackupSelectionRequest generates a "aws/request.Request" representing the client's request for the GetBackupSelection operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetBackupSelection for more information on using the GetBackupSelection API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetBackupSelectionRequest method.
req, resp := client.GetBackupSelectionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/GetBackupSelection

func (*Backup) GetBackupSelectionWithContext

func (c *Backup) GetBackupSelectionWithContext(ctx aws.Context, input *GetBackupSelectionInput, opts ...request.Option) (*GetBackupSelectionOutput, error)

GetBackupSelectionWithContext is the same as GetBackupSelection with the addition of the ability to pass a context and additional request options.

See GetBackupSelection for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Backup) GetBackupVaultAccessPolicy

func (c *Backup) GetBackupVaultAccessPolicy(input *GetBackupVaultAccessPolicyInput) (*GetBackupVaultAccessPolicyOutput, error)

GetBackupVaultAccessPolicy API operation for AWS Backup.

Returns the access policy document that is associated with the named backup vault.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Backup's API operation GetBackupVaultAccessPolicy for usage and error information.

Returned Error Types:

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

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

  • MissingParameterValueException Indicates that a required parameter is missing.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/GetBackupVaultAccessPolicy

func (*Backup) GetBackupVaultAccessPolicyRequest

func (c *Backup) GetBackupVaultAccessPolicyRequest(input *GetBackupVaultAccessPolicyInput) (req *request.Request, output *GetBackupVaultAccessPolicyOutput)

GetBackupVaultAccessPolicyRequest generates a "aws/request.Request" representing the client's request for the GetBackupVaultAccessPolicy operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetBackupVaultAccessPolicy for more information on using the GetBackupVaultAccessPolicy API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetBackupVaultAccessPolicyRequest method.
req, resp := client.GetBackupVaultAccessPolicyRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/GetBackupVaultAccessPolicy

func (*Backup) GetBackupVaultAccessPolicyWithContext

func (c *Backup) GetBackupVaultAccessPolicyWithContext(ctx aws.Context, input *GetBackupVaultAccessPolicyInput, opts ...request.Option) (*GetBackupVaultAccessPolicyOutput, error)

GetBackupVaultAccessPolicyWithContext is the same as GetBackupVaultAccessPolicy with the addition of the ability to pass a context and additional request options.

See GetBackupVaultAccessPolicy for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Backup) GetBackupVaultNotifications

func (c *Backup) GetBackupVaultNotifications(input *GetBackupVaultNotificationsInput) (*GetBackupVaultNotificationsOutput, error)

GetBackupVaultNotifications API operation for AWS Backup.

Returns event notifications for the specified backup vault.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Backup's API operation GetBackupVaultNotifications for usage and error information.

Returned Error Types:

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

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

  • MissingParameterValueException Indicates that a required parameter is missing.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/GetBackupVaultNotifications

func (*Backup) GetBackupVaultNotificationsRequest

func (c *Backup) GetBackupVaultNotificationsRequest(input *GetBackupVaultNotificationsInput) (req *request.Request, output *GetBackupVaultNotificationsOutput)

GetBackupVaultNotificationsRequest generates a "aws/request.Request" representing the client's request for the GetBackupVaultNotifications operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetBackupVaultNotifications for more information on using the GetBackupVaultNotifications API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetBackupVaultNotificationsRequest method.
req, resp := client.GetBackupVaultNotificationsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/GetBackupVaultNotifications

func (*Backup) GetBackupVaultNotificationsWithContext

func (c *Backup) GetBackupVaultNotificationsWithContext(ctx aws.Context, input *GetBackupVaultNotificationsInput, opts ...request.Option) (*GetBackupVaultNotificationsOutput, error)

GetBackupVaultNotificationsWithContext is the same as GetBackupVaultNotifications with the addition of the ability to pass a context and additional request options.

See GetBackupVaultNotifications for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Backup) GetRecoveryPointRestoreMetadata

func (c *Backup) GetRecoveryPointRestoreMetadata(input *GetRecoveryPointRestoreMetadataInput) (*GetRecoveryPointRestoreMetadataOutput, error)

GetRecoveryPointRestoreMetadata API operation for AWS Backup.

Returns a set of metadata key-value pairs that were used to create the backup.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Backup's API operation GetRecoveryPointRestoreMetadata for usage and error information.

Returned Error Types:

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

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

  • MissingParameterValueException Indicates that a required parameter is missing.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/GetRecoveryPointRestoreMetadata

func (*Backup) GetRecoveryPointRestoreMetadataRequest

func (c *Backup) GetRecoveryPointRestoreMetadataRequest(input *GetRecoveryPointRestoreMetadataInput) (req *request.Request, output *GetRecoveryPointRestoreMetadataOutput)

GetRecoveryPointRestoreMetadataRequest generates a "aws/request.Request" representing the client's request for the GetRecoveryPointRestoreMetadata operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetRecoveryPointRestoreMetadata for more information on using the GetRecoveryPointRestoreMetadata API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetRecoveryPointRestoreMetadataRequest method.
req, resp := client.GetRecoveryPointRestoreMetadataRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/GetRecoveryPointRestoreMetadata

func (*Backup) GetRecoveryPointRestoreMetadataWithContext

func (c *Backup) GetRecoveryPointRestoreMetadataWithContext(ctx aws.Context, input *GetRecoveryPointRestoreMetadataInput, opts ...request.Option) (*GetRecoveryPointRestoreMetadataOutput, error)

GetRecoveryPointRestoreMetadataWithContext is the same as GetRecoveryPointRestoreMetadata with the addition of the ability to pass a context and additional request options.

See GetRecoveryPointRestoreMetadata for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Backup) GetSupportedResourceTypes

func (c *Backup) GetSupportedResourceTypes(input *GetSupportedResourceTypesInput) (*GetSupportedResourceTypesOutput, error)

GetSupportedResourceTypes API operation for AWS Backup.

Returns the AWS resource types supported by AWS Backup.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Backup's API operation GetSupportedResourceTypes for usage and error information.

Returned Error Types:

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

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/GetSupportedResourceTypes

func (*Backup) GetSupportedResourceTypesRequest

func (c *Backup) GetSupportedResourceTypesRequest(input *GetSupportedResourceTypesInput) (req *request.Request, output *GetSupportedResourceTypesOutput)

GetSupportedResourceTypesRequest generates a "aws/request.Request" representing the client's request for the GetSupportedResourceTypes operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetSupportedResourceTypes for more information on using the GetSupportedResourceTypes API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetSupportedResourceTypesRequest method.
req, resp := client.GetSupportedResourceTypesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/GetSupportedResourceTypes

func (*Backup) GetSupportedResourceTypesWithContext

func (c *Backup) GetSupportedResourceTypesWithContext(ctx aws.Context, input *GetSupportedResourceTypesInput, opts ...request.Option) (*GetSupportedResourceTypesOutput, error)

GetSupportedResourceTypesWithContext is the same as GetSupportedResourceTypes with the addition of the ability to pass a context and additional request options.

See GetSupportedResourceTypes for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Backup) ListBackupJobs

func (c *Backup) ListBackupJobs(input *ListBackupJobsInput) (*ListBackupJobsOutput, error)

ListBackupJobs API operation for AWS Backup.

Returns a list of existing backup jobs for an authenticated account for the last 30 days. For a longer period of time, consider using these monitoring tools (https://docs.aws.amazon.com/aws-backup/latest/devguide/monitoring.html).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Backup's API operation ListBackupJobs for usage and error information.

Returned Error Types:

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ListBackupJobs

func (*Backup) ListBackupJobsPages

func (c *Backup) ListBackupJobsPages(input *ListBackupJobsInput, fn func(*ListBackupJobsOutput, bool) bool) error

ListBackupJobsPages iterates over the pages of a ListBackupJobs operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListBackupJobs method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListBackupJobs operation.
pageNum := 0
err := client.ListBackupJobsPages(params,
    func(page *backup.ListBackupJobsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Backup) ListBackupJobsPagesWithContext

func (c *Backup) ListBackupJobsPagesWithContext(ctx aws.Context, input *ListBackupJobsInput, fn func(*ListBackupJobsOutput, bool) bool, opts ...request.Option) error

ListBackupJobsPagesWithContext same as ListBackupJobsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Backup) ListBackupJobsRequest

func (c *Backup) ListBackupJobsRequest(input *ListBackupJobsInput) (req *request.Request, output *ListBackupJobsOutput)

ListBackupJobsRequest generates a "aws/request.Request" representing the client's request for the ListBackupJobs operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListBackupJobs for more information on using the ListBackupJobs API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListBackupJobsRequest method.
req, resp := client.ListBackupJobsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ListBackupJobs

func (*Backup) ListBackupJobsWithContext

func (c *Backup) ListBackupJobsWithContext(ctx aws.Context, input *ListBackupJobsInput, opts ...request.Option) (*ListBackupJobsOutput, error)

ListBackupJobsWithContext is the same as ListBackupJobs with the addition of the ability to pass a context and additional request options.

See ListBackupJobs for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Backup) ListBackupPlanTemplates

func (c *Backup) ListBackupPlanTemplates(input *ListBackupPlanTemplatesInput) (*ListBackupPlanTemplatesOutput, error)

ListBackupPlanTemplates API operation for AWS Backup.

Returns metadata of your saved backup plan templates, including the template ID, name, and the creation and deletion dates.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Backup's API operation ListBackupPlanTemplates for usage and error information.

Returned Error Types:

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

  • MissingParameterValueException Indicates that a required parameter is missing.

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ListBackupPlanTemplates

func (*Backup) ListBackupPlanTemplatesPages

func (c *Backup) ListBackupPlanTemplatesPages(input *ListBackupPlanTemplatesInput, fn func(*ListBackupPlanTemplatesOutput, bool) bool) error

ListBackupPlanTemplatesPages iterates over the pages of a ListBackupPlanTemplates operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListBackupPlanTemplates method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListBackupPlanTemplates operation.
pageNum := 0
err := client.ListBackupPlanTemplatesPages(params,
    func(page *backup.ListBackupPlanTemplatesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Backup) ListBackupPlanTemplatesPagesWithContext

func (c *Backup) ListBackupPlanTemplatesPagesWithContext(ctx aws.Context, input *ListBackupPlanTemplatesInput, fn func(*ListBackupPlanTemplatesOutput, bool) bool, opts ...request.Option) error

ListBackupPlanTemplatesPagesWithContext same as ListBackupPlanTemplatesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Backup) ListBackupPlanTemplatesRequest

func (c *Backup) ListBackupPlanTemplatesRequest(input *ListBackupPlanTemplatesInput) (req *request.Request, output *ListBackupPlanTemplatesOutput)

ListBackupPlanTemplatesRequest generates a "aws/request.Request" representing the client's request for the ListBackupPlanTemplates operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListBackupPlanTemplates for more information on using the ListBackupPlanTemplates API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListBackupPlanTemplatesRequest method.
req, resp := client.ListBackupPlanTemplatesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ListBackupPlanTemplates

func (*Backup) ListBackupPlanTemplatesWithContext

func (c *Backup) ListBackupPlanTemplatesWithContext(ctx aws.Context, input *ListBackupPlanTemplatesInput, opts ...request.Option) (*ListBackupPlanTemplatesOutput, error)

ListBackupPlanTemplatesWithContext is the same as ListBackupPlanTemplates with the addition of the ability to pass a context and additional request options.

See ListBackupPlanTemplates for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Backup) ListBackupPlanVersions

func (c *Backup) ListBackupPlanVersions(input *ListBackupPlanVersionsInput) (*ListBackupPlanVersionsOutput, error)

ListBackupPlanVersions API operation for AWS Backup.

Returns version metadata of your backup plans, including Amazon Resource Names (ARNs), backup plan IDs, creation and deletion dates, plan names, and version IDs.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Backup's API operation ListBackupPlanVersions for usage and error information.

Returned Error Types:

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

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

  • MissingParameterValueException Indicates that a required parameter is missing.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ListBackupPlanVersions

func (*Backup) ListBackupPlanVersionsPages

func (c *Backup) ListBackupPlanVersionsPages(input *ListBackupPlanVersionsInput, fn func(*ListBackupPlanVersionsOutput, bool) bool) error

ListBackupPlanVersionsPages iterates over the pages of a ListBackupPlanVersions operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListBackupPlanVersions method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListBackupPlanVersions operation.
pageNum := 0
err := client.ListBackupPlanVersionsPages(params,
    func(page *backup.ListBackupPlanVersionsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Backup) ListBackupPlanVersionsPagesWithContext

func (c *Backup) ListBackupPlanVersionsPagesWithContext(ctx aws.Context, input *ListBackupPlanVersionsInput, fn func(*ListBackupPlanVersionsOutput, bool) bool, opts ...request.Option) error

ListBackupPlanVersionsPagesWithContext same as ListBackupPlanVersionsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Backup) ListBackupPlanVersionsRequest

func (c *Backup) ListBackupPlanVersionsRequest(input *ListBackupPlanVersionsInput) (req *request.Request, output *ListBackupPlanVersionsOutput)

ListBackupPlanVersionsRequest generates a "aws/request.Request" representing the client's request for the ListBackupPlanVersions operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListBackupPlanVersions for more information on using the ListBackupPlanVersions API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListBackupPlanVersionsRequest method.
req, resp := client.ListBackupPlanVersionsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ListBackupPlanVersions

func (*Backup) ListBackupPlanVersionsWithContext

func (c *Backup) ListBackupPlanVersionsWithContext(ctx aws.Context, input *ListBackupPlanVersionsInput, opts ...request.Option) (*ListBackupPlanVersionsOutput, error)

ListBackupPlanVersionsWithContext is the same as ListBackupPlanVersions with the addition of the ability to pass a context and additional request options.

See ListBackupPlanVersions for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Backup) ListBackupPlans

func (c *Backup) ListBackupPlans(input *ListBackupPlansInput) (*ListBackupPlansOutput, error)

ListBackupPlans API operation for AWS Backup.

Returns a list of existing backup plans for an authenticated account. The list is populated only if the advanced option is set for the backup plan. The list contains information such as Amazon Resource Names (ARNs), plan IDs, creation and deletion dates, version IDs, plan names, and creator request IDs.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Backup's API operation ListBackupPlans for usage and error information.

Returned Error Types:

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

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

  • MissingParameterValueException Indicates that a required parameter is missing.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ListBackupPlans

func (*Backup) ListBackupPlansPages

func (c *Backup) ListBackupPlansPages(input *ListBackupPlansInput, fn func(*ListBackupPlansOutput, bool) bool) error

ListBackupPlansPages iterates over the pages of a ListBackupPlans operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListBackupPlans method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListBackupPlans operation.
pageNum := 0
err := client.ListBackupPlansPages(params,
    func(page *backup.ListBackupPlansOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Backup) ListBackupPlansPagesWithContext

func (c *Backup) ListBackupPlansPagesWithContext(ctx aws.Context, input *ListBackupPlansInput, fn func(*ListBackupPlansOutput, bool) bool, opts ...request.Option) error

ListBackupPlansPagesWithContext same as ListBackupPlansPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Backup) ListBackupPlansRequest

func (c *Backup) ListBackupPlansRequest(input *ListBackupPlansInput) (req *request.Request, output *ListBackupPlansOutput)

ListBackupPlansRequest generates a "aws/request.Request" representing the client's request for the ListBackupPlans operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListBackupPlans for more information on using the ListBackupPlans API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListBackupPlansRequest method.
req, resp := client.ListBackupPlansRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ListBackupPlans

func (*Backup) ListBackupPlansWithContext

func (c *Backup) ListBackupPlansWithContext(ctx aws.Context, input *ListBackupPlansInput, opts ...request.Option) (*ListBackupPlansOutput, error)

ListBackupPlansWithContext is the same as ListBackupPlans with the addition of the ability to pass a context and additional request options.

See ListBackupPlans for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Backup) ListBackupSelections

func (c *Backup) ListBackupSelections(input *ListBackupSelectionsInput) (*ListBackupSelectionsOutput, error)

ListBackupSelections API operation for AWS Backup.

Returns an array containing metadata of the resources associated with the target backup plan.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Backup's API operation ListBackupSelections for usage and error information.

Returned Error Types:

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

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

  • MissingParameterValueException Indicates that a required parameter is missing.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ListBackupSelections

func (*Backup) ListBackupSelectionsPages

func (c *Backup) ListBackupSelectionsPages(input *ListBackupSelectionsInput, fn func(*ListBackupSelectionsOutput, bool) bool) error

ListBackupSelectionsPages iterates over the pages of a ListBackupSelections operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListBackupSelections method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListBackupSelections operation.
pageNum := 0
err := client.ListBackupSelectionsPages(params,
    func(page *backup.ListBackupSelectionsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Backup) ListBackupSelectionsPagesWithContext

func (c *Backup) ListBackupSelectionsPagesWithContext(ctx aws.Context, input *ListBackupSelectionsInput, fn func(*ListBackupSelectionsOutput, bool) bool, opts ...request.Option) error

ListBackupSelectionsPagesWithContext same as ListBackupSelectionsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Backup) ListBackupSelectionsRequest

func (c *Backup) ListBackupSelectionsRequest(input *ListBackupSelectionsInput) (req *request.Request, output *ListBackupSelectionsOutput)

ListBackupSelectionsRequest generates a "aws/request.Request" representing the client's request for the ListBackupSelections operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListBackupSelections for more information on using the ListBackupSelections API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListBackupSelectionsRequest method.
req, resp := client.ListBackupSelectionsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ListBackupSelections

func (*Backup) ListBackupSelectionsWithContext

func (c *Backup) ListBackupSelectionsWithContext(ctx aws.Context, input *ListBackupSelectionsInput, opts ...request.Option) (*ListBackupSelectionsOutput, error)

ListBackupSelectionsWithContext is the same as ListBackupSelections with the addition of the ability to pass a context and additional request options.

See ListBackupSelections for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Backup) ListBackupVaults

func (c *Backup) ListBackupVaults(input *ListBackupVaultsInput) (*ListBackupVaultsOutput, error)

ListBackupVaults API operation for AWS Backup.

Returns a list of recovery point storage containers along with information about them.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Backup's API operation ListBackupVaults for usage and error information.

Returned Error Types:

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

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

  • MissingParameterValueException Indicates that a required parameter is missing.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ListBackupVaults

func (*Backup) ListBackupVaultsPages

func (c *Backup) ListBackupVaultsPages(input *ListBackupVaultsInput, fn func(*ListBackupVaultsOutput, bool) bool) error

ListBackupVaultsPages iterates over the pages of a ListBackupVaults operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListBackupVaults method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListBackupVaults operation.
pageNum := 0
err := client.ListBackupVaultsPages(params,
    func(page *backup.ListBackupVaultsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Backup) ListBackupVaultsPagesWithContext

func (c *Backup) ListBackupVaultsPagesWithContext(ctx aws.Context, input *ListBackupVaultsInput, fn func(*ListBackupVaultsOutput, bool) bool, opts ...request.Option) error

ListBackupVaultsPagesWithContext same as ListBackupVaultsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Backup) ListBackupVaultsRequest

func (c *Backup) ListBackupVaultsRequest(input *ListBackupVaultsInput) (req *request.Request, output *ListBackupVaultsOutput)

ListBackupVaultsRequest generates a "aws/request.Request" representing the client's request for the ListBackupVaults operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListBackupVaults for more information on using the ListBackupVaults API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListBackupVaultsRequest method.
req, resp := client.ListBackupVaultsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ListBackupVaults

func (*Backup) ListBackupVaultsWithContext

func (c *Backup) ListBackupVaultsWithContext(ctx aws.Context, input *ListBackupVaultsInput, opts ...request.Option) (*ListBackupVaultsOutput, error)

ListBackupVaultsWithContext is the same as ListBackupVaults with the addition of the ability to pass a context and additional request options.

See ListBackupVaults for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Backup) ListCopyJobs added in v1.28.1

func (c *Backup) ListCopyJobs(input *ListCopyJobsInput) (*ListCopyJobsOutput, error)

ListCopyJobs API operation for AWS Backup.

Returns metadata about your copy jobs.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Backup's API operation ListCopyJobs for usage and error information.

Returned Error Types:

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ListCopyJobs

func (*Backup) ListCopyJobsPages added in v1.28.1

func (c *Backup) ListCopyJobsPages(input *ListCopyJobsInput, fn func(*ListCopyJobsOutput, bool) bool) error

ListCopyJobsPages iterates over the pages of a ListCopyJobs operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListCopyJobs method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListCopyJobs operation.
pageNum := 0
err := client.ListCopyJobsPages(params,
    func(page *backup.ListCopyJobsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Backup) ListCopyJobsPagesWithContext added in v1.28.1

func (c *Backup) ListCopyJobsPagesWithContext(ctx aws.Context, input *ListCopyJobsInput, fn func(*ListCopyJobsOutput, bool) bool, opts ...request.Option) error

ListCopyJobsPagesWithContext same as ListCopyJobsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Backup) ListCopyJobsRequest added in v1.28.1

func (c *Backup) ListCopyJobsRequest(input *ListCopyJobsInput) (req *request.Request, output *ListCopyJobsOutput)

ListCopyJobsRequest generates a "aws/request.Request" representing the client's request for the ListCopyJobs operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListCopyJobs for more information on using the ListCopyJobs API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListCopyJobsRequest method.
req, resp := client.ListCopyJobsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ListCopyJobs

func (*Backup) ListCopyJobsWithContext added in v1.28.1

func (c *Backup) ListCopyJobsWithContext(ctx aws.Context, input *ListCopyJobsInput, opts ...request.Option) (*ListCopyJobsOutput, error)

ListCopyJobsWithContext is the same as ListCopyJobs with the addition of the ability to pass a context and additional request options.

See ListCopyJobs for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Backup) ListProtectedResources

func (c *Backup) ListProtectedResources(input *ListProtectedResourcesInput) (*ListProtectedResourcesOutput, error)

ListProtectedResources API operation for AWS Backup.

Returns an array of resources successfully backed up by AWS Backup, including the time the resource was saved, an Amazon Resource Name (ARN) of the resource, and a resource type.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Backup's API operation ListProtectedResources for usage and error information.

Returned Error Types:

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ListProtectedResources

func (*Backup) ListProtectedResourcesPages

func (c *Backup) ListProtectedResourcesPages(input *ListProtectedResourcesInput, fn func(*ListProtectedResourcesOutput, bool) bool) error

ListProtectedResourcesPages iterates over the pages of a ListProtectedResources operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListProtectedResources method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListProtectedResources operation.
pageNum := 0
err := client.ListProtectedResourcesPages(params,
    func(page *backup.ListProtectedResourcesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Backup) ListProtectedResourcesPagesWithContext

func (c *Backup) ListProtectedResourcesPagesWithContext(ctx aws.Context, input *ListProtectedResourcesInput, fn func(*ListProtectedResourcesOutput, bool) bool, opts ...request.Option) error

ListProtectedResourcesPagesWithContext same as ListProtectedResourcesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Backup) ListProtectedResourcesRequest

func (c *Backup) ListProtectedResourcesRequest(input *ListProtectedResourcesInput) (req *request.Request, output *ListProtectedResourcesOutput)

ListProtectedResourcesRequest generates a "aws/request.Request" representing the client's request for the ListProtectedResources operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListProtectedResources for more information on using the ListProtectedResources API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListProtectedResourcesRequest method.
req, resp := client.ListProtectedResourcesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ListProtectedResources

func (*Backup) ListProtectedResourcesWithContext

func (c *Backup) ListProtectedResourcesWithContext(ctx aws.Context, input *ListProtectedResourcesInput, opts ...request.Option) (*ListProtectedResourcesOutput, error)

ListProtectedResourcesWithContext is the same as ListProtectedResources with the addition of the ability to pass a context and additional request options.

See ListProtectedResources for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Backup) ListRecoveryPointsByBackupVault

func (c *Backup) ListRecoveryPointsByBackupVault(input *ListRecoveryPointsByBackupVaultInput) (*ListRecoveryPointsByBackupVaultOutput, error)

ListRecoveryPointsByBackupVault API operation for AWS Backup.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Backup's API operation ListRecoveryPointsByBackupVault for usage and error information.

Returned Error Types:

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

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

  • MissingParameterValueException Indicates that a required parameter is missing.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ListRecoveryPointsByBackupVault

func (*Backup) ListRecoveryPointsByBackupVaultPages

func (c *Backup) ListRecoveryPointsByBackupVaultPages(input *ListRecoveryPointsByBackupVaultInput, fn func(*ListRecoveryPointsByBackupVaultOutput, bool) bool) error

ListRecoveryPointsByBackupVaultPages iterates over the pages of a ListRecoveryPointsByBackupVault operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListRecoveryPointsByBackupVault method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListRecoveryPointsByBackupVault operation.
pageNum := 0
err := client.ListRecoveryPointsByBackupVaultPages(params,
    func(page *backup.ListRecoveryPointsByBackupVaultOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Backup) ListRecoveryPointsByBackupVaultPagesWithContext

func (c *Backup) ListRecoveryPointsByBackupVaultPagesWithContext(ctx aws.Context, input *ListRecoveryPointsByBackupVaultInput, fn func(*ListRecoveryPointsByBackupVaultOutput, bool) bool, opts ...request.Option) error

ListRecoveryPointsByBackupVaultPagesWithContext same as ListRecoveryPointsByBackupVaultPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Backup) ListRecoveryPointsByBackupVaultRequest

func (c *Backup) ListRecoveryPointsByBackupVaultRequest(input *ListRecoveryPointsByBackupVaultInput) (req *request.Request, output *ListRecoveryPointsByBackupVaultOutput)

ListRecoveryPointsByBackupVaultRequest generates a "aws/request.Request" representing the client's request for the ListRecoveryPointsByBackupVault operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListRecoveryPointsByBackupVault for more information on using the ListRecoveryPointsByBackupVault API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListRecoveryPointsByBackupVaultRequest method.
req, resp := client.ListRecoveryPointsByBackupVaultRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ListRecoveryPointsByBackupVault

func (*Backup) ListRecoveryPointsByBackupVaultWithContext

func (c *Backup) ListRecoveryPointsByBackupVaultWithContext(ctx aws.Context, input *ListRecoveryPointsByBackupVaultInput, opts ...request.Option) (*ListRecoveryPointsByBackupVaultOutput, error)

ListRecoveryPointsByBackupVaultWithContext is the same as ListRecoveryPointsByBackupVault with the addition of the ability to pass a context and additional request options.

See ListRecoveryPointsByBackupVault for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Backup) ListRecoveryPointsByResource

func (c *Backup) ListRecoveryPointsByResource(input *ListRecoveryPointsByResourceInput) (*ListRecoveryPointsByResourceOutput, error)

ListRecoveryPointsByResource API operation for AWS Backup.

Returns detailed information about recovery points of the type specified by a resource Amazon Resource Name (ARN).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Backup's API operation ListRecoveryPointsByResource for usage and error information.

Returned Error Types:

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

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

  • MissingParameterValueException Indicates that a required parameter is missing.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ListRecoveryPointsByResource

func (*Backup) ListRecoveryPointsByResourcePages

func (c *Backup) ListRecoveryPointsByResourcePages(input *ListRecoveryPointsByResourceInput, fn func(*ListRecoveryPointsByResourceOutput, bool) bool) error

ListRecoveryPointsByResourcePages iterates over the pages of a ListRecoveryPointsByResource operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListRecoveryPointsByResource method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListRecoveryPointsByResource operation.
pageNum := 0
err := client.ListRecoveryPointsByResourcePages(params,
    func(page *backup.ListRecoveryPointsByResourceOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Backup) ListRecoveryPointsByResourcePagesWithContext

func (c *Backup) ListRecoveryPointsByResourcePagesWithContext(ctx aws.Context, input *ListRecoveryPointsByResourceInput, fn func(*ListRecoveryPointsByResourceOutput, bool) bool, opts ...request.Option) error

ListRecoveryPointsByResourcePagesWithContext same as ListRecoveryPointsByResourcePages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Backup) ListRecoveryPointsByResourceRequest

func (c *Backup) ListRecoveryPointsByResourceRequest(input *ListRecoveryPointsByResourceInput) (req *request.Request, output *ListRecoveryPointsByResourceOutput)

ListRecoveryPointsByResourceRequest generates a "aws/request.Request" representing the client's request for the ListRecoveryPointsByResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListRecoveryPointsByResource for more information on using the ListRecoveryPointsByResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListRecoveryPointsByResourceRequest method.
req, resp := client.ListRecoveryPointsByResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ListRecoveryPointsByResource

func (*Backup) ListRecoveryPointsByResourceWithContext

func (c *Backup) ListRecoveryPointsByResourceWithContext(ctx aws.Context, input *ListRecoveryPointsByResourceInput, opts ...request.Option) (*ListRecoveryPointsByResourceOutput, error)

ListRecoveryPointsByResourceWithContext is the same as ListRecoveryPointsByResource with the addition of the ability to pass a context and additional request options.

See ListRecoveryPointsByResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Backup) ListRestoreJobs

func (c *Backup) ListRestoreJobs(input *ListRestoreJobsInput) (*ListRestoreJobsOutput, error)

ListRestoreJobs API operation for AWS Backup.

Returns a list of jobs that AWS Backup initiated to restore a saved resource, including metadata about the recovery process.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Backup's API operation ListRestoreJobs for usage and error information.

Returned Error Types:

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

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

  • MissingParameterValueException Indicates that a required parameter is missing.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ListRestoreJobs

func (*Backup) ListRestoreJobsPages

func (c *Backup) ListRestoreJobsPages(input *ListRestoreJobsInput, fn func(*ListRestoreJobsOutput, bool) bool) error

ListRestoreJobsPages iterates over the pages of a ListRestoreJobs operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListRestoreJobs method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListRestoreJobs operation.
pageNum := 0
err := client.ListRestoreJobsPages(params,
    func(page *backup.ListRestoreJobsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Backup) ListRestoreJobsPagesWithContext

func (c *Backup) ListRestoreJobsPagesWithContext(ctx aws.Context, input *ListRestoreJobsInput, fn func(*ListRestoreJobsOutput, bool) bool, opts ...request.Option) error

ListRestoreJobsPagesWithContext same as ListRestoreJobsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Backup) ListRestoreJobsRequest

func (c *Backup) ListRestoreJobsRequest(input *ListRestoreJobsInput) (req *request.Request, output *ListRestoreJobsOutput)

ListRestoreJobsRequest generates a "aws/request.Request" representing the client's request for the ListRestoreJobs operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListRestoreJobs for more information on using the ListRestoreJobs API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListRestoreJobsRequest method.
req, resp := client.ListRestoreJobsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ListRestoreJobs

func (*Backup) ListRestoreJobsWithContext

func (c *Backup) ListRestoreJobsWithContext(ctx aws.Context, input *ListRestoreJobsInput, opts ...request.Option) (*ListRestoreJobsOutput, error)

ListRestoreJobsWithContext is the same as ListRestoreJobs with the addition of the ability to pass a context and additional request options.

See ListRestoreJobs for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Backup) ListTags

func (c *Backup) ListTags(input *ListTagsInput) (*ListTagsOutput, error)

ListTags API operation for AWS Backup.

Returns a list of key-value pairs assigned to a target recovery point, backup plan, or backup vault.

ListTags are currently only supported with Amazon EFS backups.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Backup's API operation ListTags for usage and error information.

Returned Error Types:

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

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

  • MissingParameterValueException Indicates that a required parameter is missing.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ListTags

func (*Backup) ListTagsPages

func (c *Backup) ListTagsPages(input *ListTagsInput, fn func(*ListTagsOutput, bool) bool) error

ListTagsPages iterates over the pages of a ListTags operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListTags method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListTags operation.
pageNum := 0
err := client.ListTagsPages(params,
    func(page *backup.ListTagsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Backup) ListTagsPagesWithContext

func (c *Backup) ListTagsPagesWithContext(ctx aws.Context, input *ListTagsInput, fn func(*ListTagsOutput, bool) bool, opts ...request.Option) error

ListTagsPagesWithContext same as ListTagsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Backup) ListTagsRequest

func (c *Backup) ListTagsRequest(input *ListTagsInput) (req *request.Request, output *ListTagsOutput)

ListTagsRequest generates a "aws/request.Request" representing the client's request for the ListTags operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListTags for more information on using the ListTags API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListTagsRequest method.
req, resp := client.ListTagsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/ListTags

func (*Backup) ListTagsWithContext

func (c *Backup) ListTagsWithContext(ctx aws.Context, input *ListTagsInput, opts ...request.Option) (*ListTagsOutput, error)

ListTagsWithContext is the same as ListTags with the addition of the ability to pass a context and additional request options.

See ListTags for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Backup) PutBackupVaultAccessPolicy

func (c *Backup) PutBackupVaultAccessPolicy(input *PutBackupVaultAccessPolicyInput) (*PutBackupVaultAccessPolicyOutput, error)

PutBackupVaultAccessPolicy API operation for AWS Backup.

Sets a resource-based policy that is used to manage access permissions on the target backup vault. Requires a backup vault name and an access policy document in JSON format.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Backup's API operation PutBackupVaultAccessPolicy for usage and error information.

Returned Error Types:

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

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

  • MissingParameterValueException Indicates that a required parameter is missing.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/PutBackupVaultAccessPolicy

func (*Backup) PutBackupVaultAccessPolicyRequest

func (c *Backup) PutBackupVaultAccessPolicyRequest(input *PutBackupVaultAccessPolicyInput) (req *request.Request, output *PutBackupVaultAccessPolicyOutput)

PutBackupVaultAccessPolicyRequest generates a "aws/request.Request" representing the client's request for the PutBackupVaultAccessPolicy operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See PutBackupVaultAccessPolicy for more information on using the PutBackupVaultAccessPolicy API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the PutBackupVaultAccessPolicyRequest method.
req, resp := client.PutBackupVaultAccessPolicyRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/PutBackupVaultAccessPolicy

func (*Backup) PutBackupVaultAccessPolicyWithContext

func (c *Backup) PutBackupVaultAccessPolicyWithContext(ctx aws.Context, input *PutBackupVaultAccessPolicyInput, opts ...request.Option) (*PutBackupVaultAccessPolicyOutput, error)

PutBackupVaultAccessPolicyWithContext is the same as PutBackupVaultAccessPolicy with the addition of the ability to pass a context and additional request options.

See PutBackupVaultAccessPolicy for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Backup) PutBackupVaultNotifications

func (c *Backup) PutBackupVaultNotifications(input *PutBackupVaultNotificationsInput) (*PutBackupVaultNotificationsOutput, error)

PutBackupVaultNotifications API operation for AWS Backup.

Turns on notifications on a backup vault for the specified topic and events.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Backup's API operation PutBackupVaultNotifications for usage and error information.

Returned Error Types:

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

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

  • MissingParameterValueException Indicates that a required parameter is missing.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/PutBackupVaultNotifications

func (*Backup) PutBackupVaultNotificationsRequest

func (c *Backup) PutBackupVaultNotificationsRequest(input *PutBackupVaultNotificationsInput) (req *request.Request, output *PutBackupVaultNotificationsOutput)

PutBackupVaultNotificationsRequest generates a "aws/request.Request" representing the client's request for the PutBackupVaultNotifications operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See PutBackupVaultNotifications for more information on using the PutBackupVaultNotifications API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the PutBackupVaultNotificationsRequest method.
req, resp := client.PutBackupVaultNotificationsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/PutBackupVaultNotifications

func (*Backup) PutBackupVaultNotificationsWithContext

func (c *Backup) PutBackupVaultNotificationsWithContext(ctx aws.Context, input *PutBackupVaultNotificationsInput, opts ...request.Option) (*PutBackupVaultNotificationsOutput, error)

PutBackupVaultNotificationsWithContext is the same as PutBackupVaultNotifications with the addition of the ability to pass a context and additional request options.

See PutBackupVaultNotifications for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Backup) StartBackupJob

func (c *Backup) StartBackupJob(input *StartBackupJobInput) (*StartBackupJobOutput, error)

StartBackupJob API operation for AWS Backup.

Starts an on-demand backup job for the specified resource.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Backup's API operation StartBackupJob for usage and error information.

Returned Error Types:

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

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

  • MissingParameterValueException Indicates that a required parameter is missing.

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/StartBackupJob

func (*Backup) StartBackupJobRequest

func (c *Backup) StartBackupJobRequest(input *StartBackupJobInput) (req *request.Request, output *StartBackupJobOutput)

StartBackupJobRequest generates a "aws/request.Request" representing the client's request for the StartBackupJob operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StartBackupJob for more information on using the StartBackupJob API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the StartBackupJobRequest method.
req, resp := client.StartBackupJobRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/StartBackupJob

func (*Backup) StartBackupJobWithContext

func (c *Backup) StartBackupJobWithContext(ctx aws.Context, input *StartBackupJobInput, opts ...request.Option) (*StartBackupJobOutput, error)

StartBackupJobWithContext is the same as StartBackupJob with the addition of the ability to pass a context and additional request options.

See StartBackupJob for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Backup) StartCopyJob added in v1.28.1

func (c *Backup) StartCopyJob(input *StartCopyJobInput) (*StartCopyJobOutput, error)

StartCopyJob API operation for AWS Backup.

Starts a job to create a one-time copy of the specified resource.

Does not support continuous backups.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Backup's API operation StartCopyJob for usage and error information.

Returned Error Types:

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

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

  • MissingParameterValueException Indicates that a required parameter is missing.

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/StartCopyJob

func (*Backup) StartCopyJobRequest added in v1.28.1

func (c *Backup) StartCopyJobRequest(input *StartCopyJobInput) (req *request.Request, output *StartCopyJobOutput)

StartCopyJobRequest generates a "aws/request.Request" representing the client's request for the StartCopyJob operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StartCopyJob for more information on using the StartCopyJob API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the StartCopyJobRequest method.
req, resp := client.StartCopyJobRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/StartCopyJob

func (*Backup) StartCopyJobWithContext added in v1.28.1

func (c *Backup) StartCopyJobWithContext(ctx aws.Context, input *StartCopyJobInput, opts ...request.Option) (*StartCopyJobOutput, error)

StartCopyJobWithContext is the same as StartCopyJob with the addition of the ability to pass a context and additional request options.

See StartCopyJob for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Backup) StartRestoreJob

func (c *Backup) StartRestoreJob(input *StartRestoreJobInput) (*StartRestoreJobOutput, error)

StartRestoreJob API operation for AWS Backup.

Recovers the saved resource identified by an Amazon Resource Name (ARN).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Backup's API operation StartRestoreJob for usage and error information.

Returned Error Types:

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

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

  • MissingParameterValueException Indicates that a required parameter is missing.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/StartRestoreJob

func (*Backup) StartRestoreJobRequest

func (c *Backup) StartRestoreJobRequest(input *StartRestoreJobInput) (req *request.Request, output *StartRestoreJobOutput)

StartRestoreJobRequest generates a "aws/request.Request" representing the client's request for the StartRestoreJob operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StartRestoreJob for more information on using the StartRestoreJob API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the StartRestoreJobRequest method.
req, resp := client.StartRestoreJobRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/StartRestoreJob

func (*Backup) StartRestoreJobWithContext

func (c *Backup) StartRestoreJobWithContext(ctx aws.Context, input *StartRestoreJobInput, opts ...request.Option) (*StartRestoreJobOutput, error)

StartRestoreJobWithContext is the same as StartRestoreJob with the addition of the ability to pass a context and additional request options.

See StartRestoreJob for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Backup) StopBackupJob

func (c *Backup) StopBackupJob(input *StopBackupJobInput) (*StopBackupJobOutput, error)

StopBackupJob API operation for AWS Backup.

Attempts to cancel a job to create a one-time backup of a resource.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Backup's API operation StopBackupJob for usage and error information.

Returned Error Types:

  • MissingParameterValueException Indicates that a required parameter is missing.

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

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

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/StopBackupJob

func (*Backup) StopBackupJobRequest

func (c *Backup) StopBackupJobRequest(input *StopBackupJobInput) (req *request.Request, output *StopBackupJobOutput)

StopBackupJobRequest generates a "aws/request.Request" representing the client's request for the StopBackupJob operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See StopBackupJob for more information on using the StopBackupJob API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the StopBackupJobRequest method.
req, resp := client.StopBackupJobRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/StopBackupJob

func (*Backup) StopBackupJobWithContext

func (c *Backup) StopBackupJobWithContext(ctx aws.Context, input *StopBackupJobInput, opts ...request.Option) (*StopBackupJobOutput, error)

StopBackupJobWithContext is the same as StopBackupJob with the addition of the ability to pass a context and additional request options.

See StopBackupJob for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Backup) TagResource

func (c *Backup) TagResource(input *TagResourceInput) (*TagResourceOutput, error)

TagResource API operation for AWS Backup.

Assigns a set of key-value pairs to a recovery point, backup plan, or backup vault identified by an Amazon Resource Name (ARN).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Backup's API operation TagResource for usage and error information.

Returned Error Types:

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

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

  • MissingParameterValueException Indicates that a required parameter is missing.

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/TagResource

func (*Backup) TagResourceRequest

func (c *Backup) TagResourceRequest(input *TagResourceInput) (req *request.Request, output *TagResourceOutput)

TagResourceRequest generates a "aws/request.Request" representing the client's request for the TagResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See TagResource for more information on using the TagResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the TagResourceRequest method.
req, resp := client.TagResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/TagResource

func (*Backup) TagResourceWithContext

func (c *Backup) TagResourceWithContext(ctx aws.Context, input *TagResourceInput, opts ...request.Option) (*TagResourceOutput, error)

TagResourceWithContext is the same as TagResource with the addition of the ability to pass a context and additional request options.

See TagResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Backup) UntagResource

func (c *Backup) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error)

UntagResource API operation for AWS Backup.

Removes a set of key-value pairs from a recovery point, backup plan, or backup vault identified by an Amazon Resource Name (ARN)

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Backup's API operation UntagResource for usage and error information.

Returned Error Types:

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

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

  • MissingParameterValueException Indicates that a required parameter is missing.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/UntagResource

func (*Backup) UntagResourceRequest

func (c *Backup) UntagResourceRequest(input *UntagResourceInput) (req *request.Request, output *UntagResourceOutput)

UntagResourceRequest generates a "aws/request.Request" representing the client's request for the UntagResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UntagResource for more information on using the UntagResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UntagResourceRequest method.
req, resp := client.UntagResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/UntagResource

func (*Backup) UntagResourceWithContext

func (c *Backup) UntagResourceWithContext(ctx aws.Context, input *UntagResourceInput, opts ...request.Option) (*UntagResourceOutput, error)

UntagResourceWithContext is the same as UntagResource with the addition of the ability to pass a context and additional request options.

See UntagResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Backup) UpdateBackupPlan

func (c *Backup) UpdateBackupPlan(input *UpdateBackupPlanInput) (*UpdateBackupPlanOutput, error)

UpdateBackupPlan API operation for AWS Backup.

Updates an existing backup plan identified by its backupPlanId with the input document in JSON format. The new version is uniquely identified by a VersionId.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Backup's API operation UpdateBackupPlan for usage and error information.

Returned Error Types:

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

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

  • MissingParameterValueException Indicates that a required parameter is missing.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/UpdateBackupPlan

func (*Backup) UpdateBackupPlanRequest

func (c *Backup) UpdateBackupPlanRequest(input *UpdateBackupPlanInput) (req *request.Request, output *UpdateBackupPlanOutput)

UpdateBackupPlanRequest generates a "aws/request.Request" representing the client's request for the UpdateBackupPlan operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateBackupPlan for more information on using the UpdateBackupPlan API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdateBackupPlanRequest method.
req, resp := client.UpdateBackupPlanRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/UpdateBackupPlan

func (*Backup) UpdateBackupPlanWithContext

func (c *Backup) UpdateBackupPlanWithContext(ctx aws.Context, input *UpdateBackupPlanInput, opts ...request.Option) (*UpdateBackupPlanOutput, error)

UpdateBackupPlanWithContext is the same as UpdateBackupPlan with the addition of the ability to pass a context and additional request options.

See UpdateBackupPlan for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Backup) UpdateGlobalSettings added in v1.35.31

func (c *Backup) UpdateGlobalSettings(input *UpdateGlobalSettingsInput) (*UpdateGlobalSettingsOutput, error)

UpdateGlobalSettings API operation for AWS Backup.

Updates the current global settings for the AWS account. Use the DescribeGlobalSettings API to determine the current settings.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Backup's API operation UpdateGlobalSettings for usage and error information.

Returned Error Types:

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

  • MissingParameterValueException Indicates that a required parameter is missing.

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

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

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/UpdateGlobalSettings

func (*Backup) UpdateGlobalSettingsRequest added in v1.35.31

func (c *Backup) UpdateGlobalSettingsRequest(input *UpdateGlobalSettingsInput) (req *request.Request, output *UpdateGlobalSettingsOutput)

UpdateGlobalSettingsRequest generates a "aws/request.Request" representing the client's request for the UpdateGlobalSettings operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateGlobalSettings for more information on using the UpdateGlobalSettings API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdateGlobalSettingsRequest method.
req, resp := client.UpdateGlobalSettingsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/UpdateGlobalSettings

func (*Backup) UpdateGlobalSettingsWithContext added in v1.35.31

func (c *Backup) UpdateGlobalSettingsWithContext(ctx aws.Context, input *UpdateGlobalSettingsInput, opts ...request.Option) (*UpdateGlobalSettingsOutput, error)

UpdateGlobalSettingsWithContext is the same as UpdateGlobalSettings with the addition of the ability to pass a context and additional request options.

See UpdateGlobalSettings for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Backup) UpdateRecoveryPointLifecycle

func (c *Backup) UpdateRecoveryPointLifecycle(input *UpdateRecoveryPointLifecycleInput) (*UpdateRecoveryPointLifecycleOutput, error)

UpdateRecoveryPointLifecycle API operation for AWS Backup.

Sets the transition lifecycle of 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.

Only Amazon EFS file system backups can be transitioned to cold storage.

Does not support continuous backups.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Backup's API operation UpdateRecoveryPointLifecycle for usage and error information.

Returned Error Types:

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

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

  • MissingParameterValueException Indicates that a required parameter is missing.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/UpdateRecoveryPointLifecycle

func (*Backup) UpdateRecoveryPointLifecycleRequest

func (c *Backup) UpdateRecoveryPointLifecycleRequest(input *UpdateRecoveryPointLifecycleInput) (req *request.Request, output *UpdateRecoveryPointLifecycleOutput)

UpdateRecoveryPointLifecycleRequest generates a "aws/request.Request" representing the client's request for the UpdateRecoveryPointLifecycle operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateRecoveryPointLifecycle for more information on using the UpdateRecoveryPointLifecycle API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdateRecoveryPointLifecycleRequest method.
req, resp := client.UpdateRecoveryPointLifecycleRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/UpdateRecoveryPointLifecycle

func (*Backup) UpdateRecoveryPointLifecycleWithContext

func (c *Backup) UpdateRecoveryPointLifecycleWithContext(ctx aws.Context, input *UpdateRecoveryPointLifecycleInput, opts ...request.Option) (*UpdateRecoveryPointLifecycleOutput, error)

UpdateRecoveryPointLifecycleWithContext is the same as UpdateRecoveryPointLifecycle with the addition of the ability to pass a context and additional request options.

See UpdateRecoveryPointLifecycle for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*Backup) UpdateRegionSettings added in v1.31.2

func (c *Backup) UpdateRegionSettings(input *UpdateRegionSettingsInput) (*UpdateRegionSettingsOutput, error)

UpdateRegionSettings API operation for AWS Backup.

Updates the current service opt-in settings for the Region. If service-opt-in is enabled for a service, AWS Backup tries to protect that service's resources in this Region, when the resource is included in an on-demand backup or scheduled backup plan. Otherwise, AWS Backup does not try to protect that service's resources in this Region. Use the DescribeRegionSettings API to determine the resource types that are supported.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Backup's API operation UpdateRegionSettings for usage and error information.

Returned Error Types:

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

  • MissingParameterValueException Indicates that a required parameter is missing.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/UpdateRegionSettings

func (*Backup) UpdateRegionSettingsRequest added in v1.31.2

func (c *Backup) UpdateRegionSettingsRequest(input *UpdateRegionSettingsInput) (req *request.Request, output *UpdateRegionSettingsOutput)

UpdateRegionSettingsRequest generates a "aws/request.Request" representing the client's request for the UpdateRegionSettings operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateRegionSettings for more information on using the UpdateRegionSettings API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdateRegionSettingsRequest method.
req, resp := client.UpdateRegionSettingsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/UpdateRegionSettings

func (*Backup) UpdateRegionSettingsWithContext added in v1.31.2

func (c *Backup) UpdateRegionSettingsWithContext(ctx aws.Context, input *UpdateRegionSettingsInput, opts ...request.Option) (*UpdateRegionSettingsOutput, error)

UpdateRegionSettingsWithContext is the same as UpdateRegionSettings with the addition of the ability to pass a context and additional request options.

See UpdateRegionSettings for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

type CalculatedLifecycle

type CalculatedLifecycle struct {

	// A timestamp that specifies when to delete a recovery point.
	DeleteAt *time.Time `type:"timestamp"`

	// A timestamp that specifies when to transition a recovery point to cold storage.
	MoveToColdStorageAt *time.Time `type:"timestamp"`
	// contains filtered or unexported fields
}

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.

Only Amazon EFS file system backups can be transitioned to cold storage.

func (CalculatedLifecycle) GoString

func (s CalculatedLifecycle) GoString() string

GoString returns the string representation

func (*CalculatedLifecycle) SetDeleteAt

func (s *CalculatedLifecycle) SetDeleteAt(v time.Time) *CalculatedLifecycle

SetDeleteAt sets the DeleteAt field's value.

func (*CalculatedLifecycle) SetMoveToColdStorageAt

func (s *CalculatedLifecycle) SetMoveToColdStorageAt(v time.Time) *CalculatedLifecycle

SetMoveToColdStorageAt sets the MoveToColdStorageAt field's value.

func (CalculatedLifecycle) String

func (s CalculatedLifecycle) String() string

String returns the string representation

type Condition

type Condition struct {

	// The key in a key-value pair. For example, in "ec2:ResourceTag/Department":
	// "accounting", "ec2:ResourceTag/Department" is the key.
	//
	// ConditionKey is a required field
	ConditionKey *string `type:"string" required:"true"`

	// An operation, such as StringEquals, that is applied to a key-value pair used
	// to filter resources in a selection.
	//
	// ConditionType is a required field
	ConditionType *string `type:"string" required:"true" enum:"ConditionType"`

	// The value in a key-value pair. For example, in "ec2:ResourceTag/Department":
	// "accounting", "accounting" is the value.
	//
	// ConditionValue is a required field
	ConditionValue *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

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.

func (Condition) GoString

func (s Condition) GoString() string

GoString returns the string representation

func (*Condition) SetConditionKey

func (s *Condition) SetConditionKey(v string) *Condition

SetConditionKey sets the ConditionKey field's value.

func (*Condition) SetConditionType

func (s *Condition) SetConditionType(v string) *Condition

SetConditionType sets the ConditionType field's value.

func (*Condition) SetConditionValue

func (s *Condition) SetConditionValue(v string) *Condition

SetConditionValue sets the ConditionValue field's value.

func (Condition) String

func (s Condition) String() string

String returns the string representation

func (*Condition) Validate

func (s *Condition) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CopyAction added in v1.28.1

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 is a required field
	DestinationBackupVaultArn *string `type:"string" required:"true"`

	// 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.
	//
	// Only Amazon EFS file system backups can be transitioned to cold storage.
	Lifecycle *Lifecycle `type:"structure"`
	// contains filtered or unexported fields
}

The details of the copy operation.

func (CopyAction) GoString added in v1.28.1

func (s CopyAction) GoString() string

GoString returns the string representation

func (*CopyAction) SetDestinationBackupVaultArn added in v1.28.1

func (s *CopyAction) SetDestinationBackupVaultArn(v string) *CopyAction

SetDestinationBackupVaultArn sets the DestinationBackupVaultArn field's value.

func (*CopyAction) SetLifecycle added in v1.28.1

func (s *CopyAction) SetLifecycle(v *Lifecycle) *CopyAction

SetLifecycle sets the Lifecycle field's value.

func (CopyAction) String added in v1.28.1

func (s CopyAction) String() string

String returns the string representation

func (*CopyAction) Validate added in v1.28.1

func (s *CopyAction) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CopyJob added in v1.28.1

type CopyJob struct {

	// The account ID that owns the copy job.
	AccountId *string `type:"string"`

	// The size, in bytes, of a copy job.
	BackupSizeInBytes *int64 `type:"long"`

	// 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 `type:"timestamp"`

	// Uniquely identifies a copy job.
	CopyJobId *string `type:"string"`

	// Contains information about the backup plan and rule that AWS Backup used
	// to initiate the recovery point backup.
	CreatedBy *RecoveryPointCreator `type:"structure"`

	// 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 `type:"timestamp"`

	// 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 `type:"string"`

	// 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 `type:"string"`

	// Specifies the IAM role ARN used to copy the target recovery point; for example,
	// arn:aws:iam::123456789012:role/S3Access.
	IamRoleArn *string `type:"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 `type:"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 `type:"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 `type:"string"`

	// 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 `type:"string"`

	// The current state of a copy job.
	State *string `type:"string" enum:"CopyJobState"`

	// A detailed message explaining the status of the job to copy a resource.
	StatusMessage *string `type:"string"`
	// contains filtered or unexported fields
}

Contains detailed information about a copy job.

func (CopyJob) GoString added in v1.28.1

func (s CopyJob) GoString() string

GoString returns the string representation

func (*CopyJob) SetAccountId added in v1.32.9

func (s *CopyJob) SetAccountId(v string) *CopyJob

SetAccountId sets the AccountId field's value.

func (*CopyJob) SetBackupSizeInBytes added in v1.28.1

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

SetBackupSizeInBytes sets the BackupSizeInBytes field's value.

func (*CopyJob) SetCompletionDate added in v1.28.1

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

SetCompletionDate sets the CompletionDate field's value.

func (*CopyJob) SetCopyJobId added in v1.28.1

func (s *CopyJob) SetCopyJobId(v string) *CopyJob

SetCopyJobId sets the CopyJobId field's value.

func (*CopyJob) SetCreatedBy added in v1.28.1

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

SetCreatedBy sets the CreatedBy field's value.

func (*CopyJob) SetCreationDate added in v1.28.1

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

SetCreationDate sets the CreationDate field's value.

func (*CopyJob) SetDestinationBackupVaultArn added in v1.28.1

func (s *CopyJob) SetDestinationBackupVaultArn(v string) *CopyJob

SetDestinationBackupVaultArn sets the DestinationBackupVaultArn field's value.

func (*CopyJob) SetDestinationRecoveryPointArn added in v1.28.1

func (s *CopyJob) SetDestinationRecoveryPointArn(v string) *CopyJob

SetDestinationRecoveryPointArn sets the DestinationRecoveryPointArn field's value.

func (*CopyJob) SetIamRoleArn added in v1.28.1

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

SetIamRoleArn sets the IamRoleArn field's value.

func (*CopyJob) SetResourceArn added in v1.28.1

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

SetResourceArn sets the ResourceArn field's value.

func (*CopyJob) SetResourceType added in v1.28.1

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

SetResourceType sets the ResourceType field's value.

func (*CopyJob) SetSourceBackupVaultArn added in v1.28.1

func (s *CopyJob) SetSourceBackupVaultArn(v string) *CopyJob

SetSourceBackupVaultArn sets the SourceBackupVaultArn field's value.

func (*CopyJob) SetSourceRecoveryPointArn added in v1.28.1

func (s *CopyJob) SetSourceRecoveryPointArn(v string) *CopyJob

SetSourceRecoveryPointArn sets the SourceRecoveryPointArn field's value.

func (*CopyJob) SetState added in v1.28.1

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

SetState sets the State field's value.

func (*CopyJob) SetStatusMessage added in v1.28.1

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

SetStatusMessage sets the StatusMessage field's value.

func (CopyJob) String added in v1.28.1

func (s CopyJob) String() string

String returns the string representation

type CreateBackupPlanInput

type CreateBackupPlanInput struct {

	// Specifies the body of a backup plan. Includes a BackupPlanName and one or
	// more sets of Rules.
	//
	// BackupPlan is a required field
	BackupPlan *PlanInput `type:"structure" required:"true"`

	// To help organize your resources, you can assign your own metadata to the
	// resources that you create. Each tag is a key-value pair. The specified tags
	// are assigned to all backups created with this plan.
	BackupPlanTags map[string]*string `type:"map" sensitive:"true"`

	// Identifies the request and allows failed requests to be retried without the
	// risk of running the operation twice. If the request includes a CreatorRequestId
	// that matches an existing backup plan, that plan is returned. This parameter
	// is optional.
	CreatorRequestId *string `type:"string"`
	// contains filtered or unexported fields
}

func (CreateBackupPlanInput) GoString

func (s CreateBackupPlanInput) GoString() string

GoString returns the string representation

func (*CreateBackupPlanInput) SetBackupPlan

SetBackupPlan sets the BackupPlan field's value.

func (*CreateBackupPlanInput) SetBackupPlanTags

func (s *CreateBackupPlanInput) SetBackupPlanTags(v map[string]*string) *CreateBackupPlanInput

SetBackupPlanTags sets the BackupPlanTags field's value.

func (*CreateBackupPlanInput) SetCreatorRequestId

func (s *CreateBackupPlanInput) SetCreatorRequestId(v string) *CreateBackupPlanInput

SetCreatorRequestId sets the CreatorRequestId field's value.

func (CreateBackupPlanInput) String

func (s CreateBackupPlanInput) String() string

String returns the string representation

func (*CreateBackupPlanInput) Validate

func (s *CreateBackupPlanInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateBackupPlanOutput

type CreateBackupPlanOutput struct {

	// A list of BackupOptions settings for a resource type. This option is only
	// available for Windows VSS backup jobs.
	AdvancedBackupSettings []*AdvancedBackupSetting `type:"list"`

	// 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 `type:"string"`

	// Uniquely identifies a backup plan.
	BackupPlanId *string `type:"string"`

	// The date and time that 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 `type:"timestamp"`

	// Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most
	// 1,024 bytes long. They cannot be edited.
	VersionId *string `type:"string"`
	// contains filtered or unexported fields
}

func (CreateBackupPlanOutput) GoString

func (s CreateBackupPlanOutput) GoString() string

GoString returns the string representation

func (*CreateBackupPlanOutput) SetAdvancedBackupSettings added in v1.34.30

func (s *CreateBackupPlanOutput) SetAdvancedBackupSettings(v []*AdvancedBackupSetting) *CreateBackupPlanOutput

SetAdvancedBackupSettings sets the AdvancedBackupSettings field's value.

func (*CreateBackupPlanOutput) SetBackupPlanArn

func (s *CreateBackupPlanOutput) SetBackupPlanArn(v string) *CreateBackupPlanOutput

SetBackupPlanArn sets the BackupPlanArn field's value.

func (*CreateBackupPlanOutput) SetBackupPlanId

func (s *CreateBackupPlanOutput) SetBackupPlanId(v string) *CreateBackupPlanOutput

SetBackupPlanId sets the BackupPlanId field's value.

func (*CreateBackupPlanOutput) SetCreationDate

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

SetCreationDate sets the CreationDate field's value.

func (*CreateBackupPlanOutput) SetVersionId

SetVersionId sets the VersionId field's value.

func (CreateBackupPlanOutput) String

func (s CreateBackupPlanOutput) String() string

String returns the string representation

type CreateBackupSelectionInput

type CreateBackupSelectionInput struct {

	// Uniquely identifies the backup plan to be associated with the selection of
	// resources.
	//
	// BackupPlanId is a required field
	BackupPlanId *string `location:"uri" locationName:"backupPlanId" type:"string" required:"true"`

	// Specifies the body of a request to assign a set of resources to a backup
	// plan.
	//
	// BackupSelection is a required field
	BackupSelection *Selection `type:"structure" required:"true"`

	// A unique string that identifies the request and allows failed requests to
	// be retried without the risk of running the operation twice.
	CreatorRequestId *string `type:"string"`
	// contains filtered or unexported fields
}

func (CreateBackupSelectionInput) GoString

func (s CreateBackupSelectionInput) GoString() string

GoString returns the string representation

func (*CreateBackupSelectionInput) SetBackupPlanId

SetBackupPlanId sets the BackupPlanId field's value.

func (*CreateBackupSelectionInput) SetBackupSelection

SetBackupSelection sets the BackupSelection field's value.

func (*CreateBackupSelectionInput) SetCreatorRequestId

SetCreatorRequestId sets the CreatorRequestId field's value.

func (CreateBackupSelectionInput) String

String returns the string representation

func (*CreateBackupSelectionInput) Validate

func (s *CreateBackupSelectionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateBackupSelectionOutput

type CreateBackupSelectionOutput struct {

	// Uniquely identifies a backup plan.
	BackupPlanId *string `type:"string"`

	// The date and time a backup selection 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 `type:"timestamp"`

	// Uniquely identifies the body of a request to assign a set of resources to
	// a backup plan.
	SelectionId *string `type:"string"`
	// contains filtered or unexported fields
}

func (CreateBackupSelectionOutput) GoString

func (s CreateBackupSelectionOutput) GoString() string

GoString returns the string representation

func (*CreateBackupSelectionOutput) SetBackupPlanId

SetBackupPlanId sets the BackupPlanId field's value.

func (*CreateBackupSelectionOutput) SetCreationDate

SetCreationDate sets the CreationDate field's value.

func (*CreateBackupSelectionOutput) SetSelectionId

SetSelectionId sets the SelectionId field's value.

func (CreateBackupSelectionOutput) String

String returns the string representation

type CreateBackupVaultInput

type CreateBackupVaultInput 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 letters, numbers,
	// and hyphens.
	//
	// BackupVaultName is a required field
	BackupVaultName *string `location:"uri" locationName:"backupVaultName" type:"string" required:"true"`

	// Metadata that you can assign to help organize the resources that you create.
	// Each tag is a key-value pair.
	BackupVaultTags map[string]*string `type:"map" sensitive:"true"`

	// A unique string that identifies the request and allows failed requests to
	// be retried without the risk of running the operation twice.
	CreatorRequestId *string `type:"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 `type:"string"`
	// contains filtered or unexported fields
}

func (CreateBackupVaultInput) GoString

func (s CreateBackupVaultInput) GoString() string

GoString returns the string representation

func (*CreateBackupVaultInput) SetBackupVaultName

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

SetBackupVaultName sets the BackupVaultName field's value.

func (*CreateBackupVaultInput) SetBackupVaultTags

func (s *CreateBackupVaultInput) SetBackupVaultTags(v map[string]*string) *CreateBackupVaultInput

SetBackupVaultTags sets the BackupVaultTags field's value.

func (*CreateBackupVaultInput) SetCreatorRequestId

func (s *CreateBackupVaultInput) SetCreatorRequestId(v string) *CreateBackupVaultInput

SetCreatorRequestId sets the CreatorRequestId field's value.

func (*CreateBackupVaultInput) SetEncryptionKeyArn

func (s *CreateBackupVaultInput) SetEncryptionKeyArn(v string) *CreateBackupVaultInput

SetEncryptionKeyArn sets the EncryptionKeyArn field's value.

func (CreateBackupVaultInput) String

func (s CreateBackupVaultInput) String() string

String returns the string representation

func (*CreateBackupVaultInput) Validate

func (s *CreateBackupVaultInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateBackupVaultOutput

type CreateBackupVaultOutput struct {

	// An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for
	// example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
	BackupVaultArn *string `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 Region where they are created. They consist of lowercase letters, numbers,
	// and hyphens.
	BackupVaultName *string `type:"string"`

	// The date and time a backup vault 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 `type:"timestamp"`
	// contains filtered or unexported fields
}

func (CreateBackupVaultOutput) GoString

func (s CreateBackupVaultOutput) GoString() string

GoString returns the string representation

func (*CreateBackupVaultOutput) SetBackupVaultArn

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

SetBackupVaultArn sets the BackupVaultArn field's value.

func (*CreateBackupVaultOutput) SetBackupVaultName

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

SetBackupVaultName sets the BackupVaultName field's value.

func (*CreateBackupVaultOutput) SetCreationDate

SetCreationDate sets the CreationDate field's value.

func (CreateBackupVaultOutput) String

func (s CreateBackupVaultOutput) String() string

String returns the string representation

type DeleteBackupPlanInput

type DeleteBackupPlanInput struct {

	// Uniquely identifies a backup plan.
	//
	// BackupPlanId is a required field
	BackupPlanId *string `location:"uri" locationName:"backupPlanId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteBackupPlanInput) GoString

func (s DeleteBackupPlanInput) GoString() string

GoString returns the string representation

func (*DeleteBackupPlanInput) SetBackupPlanId

func (s *DeleteBackupPlanInput) SetBackupPlanId(v string) *DeleteBackupPlanInput

SetBackupPlanId sets the BackupPlanId field's value.

func (DeleteBackupPlanInput) String

func (s DeleteBackupPlanInput) String() string

String returns the string representation

func (*DeleteBackupPlanInput) Validate

func (s *DeleteBackupPlanInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteBackupPlanOutput

type DeleteBackupPlanOutput struct {

	// 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 `type:"string"`

	// Uniquely identifies a backup plan.
	BackupPlanId *string `type:"string"`

	// 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 `type:"timestamp"`

	// Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most
	// 1,024 bytes long. Version IDs cannot be edited.
	VersionId *string `type:"string"`
	// contains filtered or unexported fields
}

func (DeleteBackupPlanOutput) GoString

func (s DeleteBackupPlanOutput) GoString() string

GoString returns the string representation

func (*DeleteBackupPlanOutput) SetBackupPlanArn

func (s *DeleteBackupPlanOutput) SetBackupPlanArn(v string) *DeleteBackupPlanOutput

SetBackupPlanArn sets the BackupPlanArn field's value.

func (*DeleteBackupPlanOutput) SetBackupPlanId

func (s *DeleteBackupPlanOutput) SetBackupPlanId(v string) *DeleteBackupPlanOutput

SetBackupPlanId sets the BackupPlanId field's value.

func (*DeleteBackupPlanOutput) SetDeletionDate

func (s *DeleteBackupPlanOutput) SetDeletionDate(v time.Time) *DeleteBackupPlanOutput

SetDeletionDate sets the DeletionDate field's value.

func (*DeleteBackupPlanOutput) SetVersionId

SetVersionId sets the VersionId field's value.

func (DeleteBackupPlanOutput) String

func (s DeleteBackupPlanOutput) String() string

String returns the string representation

type DeleteBackupSelectionInput

type DeleteBackupSelectionInput struct {

	// Uniquely identifies a backup plan.
	//
	// BackupPlanId is a required field
	BackupPlanId *string `location:"uri" locationName:"backupPlanId" type:"string" required:"true"`

	// Uniquely identifies the body of a request to assign a set of resources to
	// a backup plan.
	//
	// SelectionId is a required field
	SelectionId *string `location:"uri" locationName:"selectionId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteBackupSelectionInput) GoString

func (s DeleteBackupSelectionInput) GoString() string

GoString returns the string representation

func (*DeleteBackupSelectionInput) SetBackupPlanId

SetBackupPlanId sets the BackupPlanId field's value.

func (*DeleteBackupSelectionInput) SetSelectionId

SetSelectionId sets the SelectionId field's value.

func (DeleteBackupSelectionInput) String

String returns the string representation

func (*DeleteBackupSelectionInput) Validate

func (s *DeleteBackupSelectionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteBackupSelectionOutput

type DeleteBackupSelectionOutput struct {
	// contains filtered or unexported fields
}

func (DeleteBackupSelectionOutput) GoString

func (s DeleteBackupSelectionOutput) GoString() string

GoString returns the string representation

func (DeleteBackupSelectionOutput) String

String returns the string representation

type DeleteBackupVaultAccessPolicyInput

type DeleteBackupVaultAccessPolicyInput 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.
	//
	// BackupVaultName is a required field
	BackupVaultName *string `location:"uri" locationName:"backupVaultName" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteBackupVaultAccessPolicyInput) GoString

GoString returns the string representation

func (*DeleteBackupVaultAccessPolicyInput) SetBackupVaultName

SetBackupVaultName sets the BackupVaultName field's value.

func (DeleteBackupVaultAccessPolicyInput) String

String returns the string representation

func (*DeleteBackupVaultAccessPolicyInput) Validate

Validate inspects the fields of the type to determine if they are valid.

type DeleteBackupVaultAccessPolicyOutput

type DeleteBackupVaultAccessPolicyOutput struct {
	// contains filtered or unexported fields
}

func (DeleteBackupVaultAccessPolicyOutput) GoString

GoString returns the string representation

func (DeleteBackupVaultAccessPolicyOutput) String

String returns the string representation

type DeleteBackupVaultInput

type DeleteBackupVaultInput 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.
	//
	// BackupVaultName is a required field
	BackupVaultName *string `location:"uri" locationName:"backupVaultName" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteBackupVaultInput) GoString

func (s DeleteBackupVaultInput) GoString() string

GoString returns the string representation

func (*DeleteBackupVaultInput) SetBackupVaultName

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

SetBackupVaultName sets the BackupVaultName field's value.

func (DeleteBackupVaultInput) String

func (s DeleteBackupVaultInput) String() string

String returns the string representation

func (*DeleteBackupVaultInput) Validate

func (s *DeleteBackupVaultInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteBackupVaultNotificationsInput

type DeleteBackupVaultNotificationsInput 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 Region where they are created. They consist of lowercase letters, numbers,
	// and hyphens.
	//
	// BackupVaultName is a required field
	BackupVaultName *string `location:"uri" locationName:"backupVaultName" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteBackupVaultNotificationsInput) GoString

GoString returns the string representation

func (*DeleteBackupVaultNotificationsInput) SetBackupVaultName

SetBackupVaultName sets the BackupVaultName field's value.

func (DeleteBackupVaultNotificationsInput) String

String returns the string representation

func (*DeleteBackupVaultNotificationsInput) Validate

Validate inspects the fields of the type to determine if they are valid.

type DeleteBackupVaultNotificationsOutput

type DeleteBackupVaultNotificationsOutput struct {
	// contains filtered or unexported fields
}

func (DeleteBackupVaultNotificationsOutput) GoString

GoString returns the string representation

func (DeleteBackupVaultNotificationsOutput) String

String returns the string representation

type DeleteBackupVaultOutput

type DeleteBackupVaultOutput struct {
	// contains filtered or unexported fields
}

func (DeleteBackupVaultOutput) GoString

func (s DeleteBackupVaultOutput) GoString() string

GoString returns the string representation

func (DeleteBackupVaultOutput) String

func (s DeleteBackupVaultOutput) String() string

String returns the string representation

type DeleteRecoveryPointInput

type DeleteRecoveryPointInput 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.
	//
	// BackupVaultName is a required field
	BackupVaultName *string `location:"uri" locationName:"backupVaultName" type:"string" required:"true"`

	// 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 is a required field
	RecoveryPointArn *string `location:"uri" locationName:"recoveryPointArn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteRecoveryPointInput) GoString

func (s DeleteRecoveryPointInput) GoString() string

GoString returns the string representation

func (*DeleteRecoveryPointInput) SetBackupVaultName

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

SetBackupVaultName sets the BackupVaultName field's value.

func (*DeleteRecoveryPointInput) SetRecoveryPointArn

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

SetRecoveryPointArn sets the RecoveryPointArn field's value.

func (DeleteRecoveryPointInput) String

func (s DeleteRecoveryPointInput) String() string

String returns the string representation

func (*DeleteRecoveryPointInput) Validate

func (s *DeleteRecoveryPointInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteRecoveryPointOutput

type DeleteRecoveryPointOutput struct {
	// contains filtered or unexported fields
}

func (DeleteRecoveryPointOutput) GoString

func (s DeleteRecoveryPointOutput) GoString() string

GoString returns the string representation

func (DeleteRecoveryPointOutput) String

func (s DeleteRecoveryPointOutput) String() string

String returns the string representation

type DependencyFailureException added in v1.28.0

type DependencyFailureException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Code_ *string `locationName:"Code" type:"string"`

	Context *string `type:"string"`

	Message_ *string `locationName:"Message" type:"string"`

	Type *string `type:"string"`
	// contains filtered or unexported fields
}

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

func (*DependencyFailureException) Code added in v1.28.0

Code returns the exception type name.

func (*DependencyFailureException) Error added in v1.28.0

func (DependencyFailureException) GoString added in v1.28.0

func (s DependencyFailureException) GoString() string

GoString returns the string representation

func (*DependencyFailureException) Message added in v1.28.0

func (s *DependencyFailureException) Message() string

Message returns the exception's message.

func (*DependencyFailureException) OrigErr added in v1.28.0

func (s *DependencyFailureException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*DependencyFailureException) RequestID added in v1.28.0

func (s *DependencyFailureException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*DependencyFailureException) StatusCode added in v1.28.0

func (s *DependencyFailureException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (DependencyFailureException) String added in v1.28.0

String returns the string representation

type DescribeBackupJobInput

type DescribeBackupJobInput struct {

	// Uniquely identifies a request to AWS Backup to back up a resource.
	//
	// BackupJobId is a required field
	BackupJobId *string `location:"uri" locationName:"backupJobId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeBackupJobInput) GoString

func (s DescribeBackupJobInput) GoString() string

GoString returns the string representation

func (*DescribeBackupJobInput) SetBackupJobId

SetBackupJobId sets the BackupJobId field's value.

func (DescribeBackupJobInput) String

func (s DescribeBackupJobInput) String() string

String returns the string representation

func (*DescribeBackupJobInput) Validate

func (s *DescribeBackupJobInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeBackupJobOutput

type DescribeBackupJobOutput struct {

	// Returns the account ID that owns the backup job.
	AccountId *string `type:"string"`

	// Uniquely identifies a request to AWS Backup to back up a resource.
	BackupJobId *string `type:"string"`

	// Represents the options specified as part of backup plan or on-demand backup
	// job.
	BackupOptions map[string]*string `type:"map"`

	// The size, in bytes, of a backup.
	BackupSizeInBytes *int64 `type:"long"`

	// Represents the actual backup type selected for a backup job. For example,
	// if a successful WindowsVSS backup was taken, BackupType returns "WindowsVSS".
	// If BackupType is empty, then the backup type that was is a regular backup.
	BackupType *string `type:"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 `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.
	BackupVaultName *string `type:"string"`

	// The size in bytes transferred to a backup vault at the time that the job
	// status was queried.
	BytesTransferred *int64 `type:"long"`

	// 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 CompletionDate
	// is accurate to milliseconds. For example, the value 1516925490.087 represents
	// Friday, January 26, 2018 12:11:30.087 AM.
	CompletionDate *time.Time `type:"timestamp"`

	// 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.
	CreatedBy *RecoveryPointCreator `type:"structure"`

	// 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.
	CreationDate *time.Time `type:"timestamp"`

	// 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.
	ExpectedCompletionDate *time.Time `type:"timestamp"`

	// Specifies the IAM role ARN used to create the target recovery point; for
	// example, arn:aws:iam::123456789012:role/S3Access.
	IamRoleArn *string `type:"string"`

	// Contains an estimated percentage that is complete of a job at the time the
	// job status was queried.
	PercentDone *string `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.
	RecoveryPointArn *string `type:"string"`

	// An ARN that uniquely identifies a saved resource. The format of the ARN depends
	// on the resource type.
	ResourceArn *string `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.
	ResourceType *string `type:"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 `type:"timestamp"`

	// The current state of a resource recovery point.
	State *string `type:"string" enum:"JobState"`

	// A detailed message explaining the status of the job to back up a resource.
	StatusMessage *string `type:"string"`
	// contains filtered or unexported fields
}

func (DescribeBackupJobOutput) GoString

func (s DescribeBackupJobOutput) GoString() string

GoString returns the string representation

func (*DescribeBackupJobOutput) SetAccountId added in v1.32.9

SetAccountId sets the AccountId field's value.

func (*DescribeBackupJobOutput) SetBackupJobId

SetBackupJobId sets the BackupJobId field's value.

func (*DescribeBackupJobOutput) SetBackupOptions added in v1.34.30

func (s *DescribeBackupJobOutput) SetBackupOptions(v map[string]*string) *DescribeBackupJobOutput

SetBackupOptions sets the BackupOptions field's value.

func (*DescribeBackupJobOutput) SetBackupSizeInBytes

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

SetBackupSizeInBytes sets the BackupSizeInBytes field's value.

func (*DescribeBackupJobOutput) SetBackupType added in v1.34.30

SetBackupType sets the BackupType field's value.

func (*DescribeBackupJobOutput) SetBackupVaultArn

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

SetBackupVaultArn sets the BackupVaultArn field's value.

func (*DescribeBackupJobOutput) SetBackupVaultName

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

SetBackupVaultName sets the BackupVaultName field's value.

func (*DescribeBackupJobOutput) SetBytesTransferred

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

SetBytesTransferred sets the BytesTransferred field's value.

func (*DescribeBackupJobOutput) SetCompletionDate

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

SetCompletionDate sets the CompletionDate field's value.

func (*DescribeBackupJobOutput) SetCreatedBy

SetCreatedBy sets the CreatedBy field's value.

func (*DescribeBackupJobOutput) SetCreationDate

SetCreationDate sets the CreationDate field's value.

func (*DescribeBackupJobOutput) SetExpectedCompletionDate

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

SetExpectedCompletionDate sets the ExpectedCompletionDate field's value.

func (*DescribeBackupJobOutput) SetIamRoleArn

SetIamRoleArn sets the IamRoleArn field's value.

func (*DescribeBackupJobOutput) SetPercentDone

SetPercentDone sets the PercentDone field's value.

func (*DescribeBackupJobOutput) SetRecoveryPointArn

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

SetRecoveryPointArn sets the RecoveryPointArn field's value.

func (*DescribeBackupJobOutput) SetResourceArn

SetResourceArn sets the ResourceArn field's value.

func (*DescribeBackupJobOutput) SetResourceType

SetResourceType sets the ResourceType field's value.

func (*DescribeBackupJobOutput) SetStartBy

SetStartBy sets the StartBy field's value.

func (*DescribeBackupJobOutput) SetState

SetState sets the State field's value.

func (*DescribeBackupJobOutput) SetStatusMessage

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

SetStatusMessage sets the StatusMessage field's value.

func (DescribeBackupJobOutput) String

func (s DescribeBackupJobOutput) String() string

String returns the string representation

type DescribeBackupVaultInput

type DescribeBackupVaultInput 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.
	//
	// BackupVaultName is a required field
	BackupVaultName *string `location:"uri" locationName:"backupVaultName" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeBackupVaultInput) GoString

func (s DescribeBackupVaultInput) GoString() string

GoString returns the string representation

func (*DescribeBackupVaultInput) SetBackupVaultName

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

SetBackupVaultName sets the BackupVaultName field's value.

func (DescribeBackupVaultInput) String

func (s DescribeBackupVaultInput) String() string

String returns the string representation

func (*DescribeBackupVaultInput) Validate

func (s *DescribeBackupVaultInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeBackupVaultOutput

type DescribeBackupVaultOutput struct {

	// An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for
	// example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
	BackupVaultArn *string `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 Region where they are created. They consist of lowercase letters, numbers,
	// and hyphens.
	BackupVaultName *string `type:"string"`

	// The date and time that a backup vault 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 `type:"timestamp"`

	// A unique string that identifies the request and allows failed requests to
	// be retried without the risk of running the operation twice.
	CreatorRequestId *string `type:"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 `type:"string"`

	// The number of recovery points that are stored in a backup vault.
	NumberOfRecoveryPoints *int64 `type:"long"`
	// contains filtered or unexported fields
}

func (DescribeBackupVaultOutput) GoString

func (s DescribeBackupVaultOutput) GoString() string

GoString returns the string representation

func (*DescribeBackupVaultOutput) SetBackupVaultArn

SetBackupVaultArn sets the BackupVaultArn field's value.

func (*DescribeBackupVaultOutput) SetBackupVaultName

SetBackupVaultName sets the BackupVaultName field's value.

func (*DescribeBackupVaultOutput) SetCreationDate

SetCreationDate sets the CreationDate field's value.

func (*DescribeBackupVaultOutput) SetCreatorRequestId

func (s *DescribeBackupVaultOutput) SetCreatorRequestId(v string) *DescribeBackupVaultOutput

SetCreatorRequestId sets the CreatorRequestId field's value.

func (*DescribeBackupVaultOutput) SetEncryptionKeyArn

func (s *DescribeBackupVaultOutput) SetEncryptionKeyArn(v string) *DescribeBackupVaultOutput

SetEncryptionKeyArn sets the EncryptionKeyArn field's value.

func (*DescribeBackupVaultOutput) SetNumberOfRecoveryPoints

func (s *DescribeBackupVaultOutput) SetNumberOfRecoveryPoints(v int64) *DescribeBackupVaultOutput

SetNumberOfRecoveryPoints sets the NumberOfRecoveryPoints field's value.

func (DescribeBackupVaultOutput) String

func (s DescribeBackupVaultOutput) String() string

String returns the string representation

type DescribeCopyJobInput added in v1.28.1

type DescribeCopyJobInput struct {

	// Uniquely identifies a copy job.
	//
	// CopyJobId is a required field
	CopyJobId *string `location:"uri" locationName:"copyJobId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeCopyJobInput) GoString added in v1.28.1

func (s DescribeCopyJobInput) GoString() string

GoString returns the string representation

func (*DescribeCopyJobInput) SetCopyJobId added in v1.28.1

func (s *DescribeCopyJobInput) SetCopyJobId(v string) *DescribeCopyJobInput

SetCopyJobId sets the CopyJobId field's value.

func (DescribeCopyJobInput) String added in v1.28.1

func (s DescribeCopyJobInput) String() string

String returns the string representation

func (*DescribeCopyJobInput) Validate added in v1.28.1

func (s *DescribeCopyJobInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeCopyJobOutput added in v1.28.1

type DescribeCopyJobOutput struct {

	// Contains detailed information about a copy job.
	CopyJob *CopyJob `type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeCopyJobOutput) GoString added in v1.28.1

func (s DescribeCopyJobOutput) GoString() string

GoString returns the string representation

func (*DescribeCopyJobOutput) SetCopyJob added in v1.28.1

SetCopyJob sets the CopyJob field's value.

func (DescribeCopyJobOutput) String added in v1.28.1

func (s DescribeCopyJobOutput) String() string

String returns the string representation

type DescribeGlobalSettingsInput added in v1.35.31

type DescribeGlobalSettingsInput struct {
	// contains filtered or unexported fields
}

func (DescribeGlobalSettingsInput) GoString added in v1.35.31

func (s DescribeGlobalSettingsInput) GoString() string

GoString returns the string representation

func (DescribeGlobalSettingsInput) String added in v1.35.31

String returns the string representation

type DescribeGlobalSettingsOutput added in v1.35.31

type DescribeGlobalSettingsOutput struct {

	// A list of resources along with the opt-in preferences for the account.
	GlobalSettings map[string]*string `type:"map"`

	// The date and time that the global settings were last updated. This update
	// is in Unix format and Coordinated Universal Time (UTC). The value of LastUpdateTime
	// is accurate to milliseconds. For example, the value 1516925490.087 represents
	// Friday, January 26, 2018 12:11:30.087 AM.
	LastUpdateTime *time.Time `type:"timestamp"`
	// contains filtered or unexported fields
}

func (DescribeGlobalSettingsOutput) GoString added in v1.35.31

func (s DescribeGlobalSettingsOutput) GoString() string

GoString returns the string representation

func (*DescribeGlobalSettingsOutput) SetGlobalSettings added in v1.35.31

SetGlobalSettings sets the GlobalSettings field's value.

func (*DescribeGlobalSettingsOutput) SetLastUpdateTime added in v1.35.31

SetLastUpdateTime sets the LastUpdateTime field's value.

func (DescribeGlobalSettingsOutput) String added in v1.35.31

String returns the string representation

type DescribeProtectedResourceInput

type DescribeProtectedResourceInput struct {

	// An Amazon Resource Name (ARN) that uniquely identifies a resource. The format
	// of the ARN depends on the resource type.
	//
	// ResourceArn is a required field
	ResourceArn *string `location:"uri" locationName:"resourceArn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeProtectedResourceInput) GoString

GoString returns the string representation

func (*DescribeProtectedResourceInput) SetResourceArn

SetResourceArn sets the ResourceArn field's value.

func (DescribeProtectedResourceInput) String

String returns the string representation

func (*DescribeProtectedResourceInput) Validate

func (s *DescribeProtectedResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeProtectedResourceOutput

type DescribeProtectedResourceOutput struct {

	// The date and time that 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 `type:"timestamp"`

	// An ARN that uniquely identifies a resource. The format of the ARN depends
	// on the resource type.
	ResourceArn *string `type:"string"`

	// The type of AWS resource saved as a recovery point; for example, an EBS volume
	// or an Amazon RDS database.
	ResourceType *string `type:"string"`
	// contains filtered or unexported fields
}

func (DescribeProtectedResourceOutput) GoString

GoString returns the string representation

func (*DescribeProtectedResourceOutput) SetLastBackupTime

SetLastBackupTime sets the LastBackupTime field's value.

func (*DescribeProtectedResourceOutput) SetResourceArn

SetResourceArn sets the ResourceArn field's value.

func (*DescribeProtectedResourceOutput) SetResourceType

SetResourceType sets the ResourceType field's value.

func (DescribeProtectedResourceOutput) String

String returns the string representation

type DescribeRecoveryPointInput

type DescribeRecoveryPointInput 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.
	//
	// BackupVaultName is a required field
	BackupVaultName *string `location:"uri" locationName:"backupVaultName" type:"string" required:"true"`

	// 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 is a required field
	RecoveryPointArn *string `location:"uri" locationName:"recoveryPointArn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeRecoveryPointInput) GoString

func (s DescribeRecoveryPointInput) GoString() string

GoString returns the string representation

func (*DescribeRecoveryPointInput) SetBackupVaultName

SetBackupVaultName sets the BackupVaultName field's value.

func (*DescribeRecoveryPointInput) SetRecoveryPointArn

SetRecoveryPointArn sets the RecoveryPointArn field's value.

func (DescribeRecoveryPointInput) String

String returns the string representation

func (*DescribeRecoveryPointInput) Validate

func (s *DescribeRecoveryPointInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeRecoveryPointOutput

type DescribeRecoveryPointOutput struct {

	// The size, in bytes, of a backup.
	BackupSizeInBytes *int64 `type:"long"`

	// An ARN that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
	BackupVaultArn *string `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 Region where they are created. They consist of lowercase letters, numbers,
	// and hyphens.
	BackupVaultName *string `type:"string"`

	// A CalculatedLifecycle object containing DeleteAt and MoveToColdStorageAt
	// timestamps.
	CalculatedLifecycle *CalculatedLifecycle `type:"structure"`

	// The date and time that a job to create 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 `type:"timestamp"`

	// Contains identifying information about the creation of a recovery point,
	// including the BackupPlanArn, BackupPlanId, BackupPlanVersion, and BackupRuleId
	// of the backup plan used to create it.
	CreatedBy *RecoveryPointCreator `type:"structure"`

	// The date and time that 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 `type:"timestamp"`

	// The server-side encryption key used to protect your backups; for example,
	// arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.
	EncryptionKeyArn *string `type:"string"`

	// Specifies the IAM role ARN used to create the target recovery point; for
	// example, arn:aws:iam::123456789012:role/S3Access.
	IamRoleArn *string `type:"string"`

	// 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 `type:"boolean"`

	// The date and time that 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 `type:"timestamp"`

	// 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 that are 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.
	//
	// Only Amazon EFS file system backups can be transitioned to cold storage.
	Lifecycle *Lifecycle `type:"structure"`

	// 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 `type:"string"`

	// An ARN that uniquely identifies a saved resource. The format of the ARN depends
	// on the resource type.
	ResourceArn *string `type:"string"`

	// The type of AWS resource to save 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 `type:"string"`

	// An Amazon Resource Name (ARN) that uniquely identifies the source vault where
	// the resource was originally backed up in; for example, arn:aws:backup:us-east-1:123456789012:vault:BackupVault.
	// If the recovery is restored to the same AWS account or Region, this value
	// will be null.
	SourceBackupVaultArn *string `type:"string"`

	// A status code specifying the state of the recovery point.
	//
	// A partial status indicates that the recovery point was not successfully re-created
	// and must be retried.
	Status *string `type:"string" enum:"RecoveryPointStatus"`

	// Specifies the storage class of the recovery point. Valid values are WARM
	// or COLD.
	StorageClass *string `type:"string" enum:"StorageClass"`
	// contains filtered or unexported fields
}

func (DescribeRecoveryPointOutput) GoString

func (s DescribeRecoveryPointOutput) GoString() string

GoString returns the string representation

func (*DescribeRecoveryPointOutput) SetBackupSizeInBytes

SetBackupSizeInBytes sets the BackupSizeInBytes field's value.

func (*DescribeRecoveryPointOutput) SetBackupVaultArn

SetBackupVaultArn sets the BackupVaultArn field's value.

func (*DescribeRecoveryPointOutput) SetBackupVaultName

SetBackupVaultName sets the BackupVaultName field's value.

func (*DescribeRecoveryPointOutput) SetCalculatedLifecycle

SetCalculatedLifecycle sets the CalculatedLifecycle field's value.

func (*DescribeRecoveryPointOutput) SetCompletionDate

SetCompletionDate sets the CompletionDate field's value.

func (*DescribeRecoveryPointOutput) SetCreatedBy

SetCreatedBy sets the CreatedBy field's value.

func (*DescribeRecoveryPointOutput) SetCreationDate

SetCreationDate sets the CreationDate field's value.

func (*DescribeRecoveryPointOutput) SetEncryptionKeyArn

SetEncryptionKeyArn sets the EncryptionKeyArn field's value.

func (*DescribeRecoveryPointOutput) SetIamRoleArn

SetIamRoleArn sets the IamRoleArn field's value.

func (*DescribeRecoveryPointOutput) SetIsEncrypted

SetIsEncrypted sets the IsEncrypted field's value.

func (*DescribeRecoveryPointOutput) SetLastRestoreTime

SetLastRestoreTime sets the LastRestoreTime field's value.

func (*DescribeRecoveryPointOutput) SetLifecycle

SetLifecycle sets the Lifecycle field's value.

func (*DescribeRecoveryPointOutput) SetRecoveryPointArn

SetRecoveryPointArn sets the RecoveryPointArn field's value.

func (*DescribeRecoveryPointOutput) SetResourceArn

SetResourceArn sets the ResourceArn field's value.

func (*DescribeRecoveryPointOutput) SetResourceType

SetResourceType sets the ResourceType field's value.

func (*DescribeRecoveryPointOutput) SetSourceBackupVaultArn added in v1.35.31

func (s *DescribeRecoveryPointOutput) SetSourceBackupVaultArn(v string) *DescribeRecoveryPointOutput

SetSourceBackupVaultArn sets the SourceBackupVaultArn field's value.

func (*DescribeRecoveryPointOutput) SetStatus

SetStatus sets the Status field's value.

func (*DescribeRecoveryPointOutput) SetStorageClass

SetStorageClass sets the StorageClass field's value.

func (DescribeRecoveryPointOutput) String

String returns the string representation

type DescribeRegionSettingsInput added in v1.31.2

type DescribeRegionSettingsInput struct {
	// contains filtered or unexported fields
}

func (DescribeRegionSettingsInput) GoString added in v1.31.2

func (s DescribeRegionSettingsInput) GoString() string

GoString returns the string representation

func (DescribeRegionSettingsInput) String added in v1.31.2

String returns the string representation

type DescribeRegionSettingsOutput added in v1.31.2

type DescribeRegionSettingsOutput struct {

	// Returns a list of all services along with the opt-in preferences in the Region.
	ResourceTypeOptInPreference map[string]*bool `type:"map"`
	// contains filtered or unexported fields
}

func (DescribeRegionSettingsOutput) GoString added in v1.31.2

func (s DescribeRegionSettingsOutput) GoString() string

GoString returns the string representation

func (*DescribeRegionSettingsOutput) SetResourceTypeOptInPreference added in v1.31.2

func (s *DescribeRegionSettingsOutput) SetResourceTypeOptInPreference(v map[string]*bool) *DescribeRegionSettingsOutput

SetResourceTypeOptInPreference sets the ResourceTypeOptInPreference field's value.

func (DescribeRegionSettingsOutput) String added in v1.31.2

String returns the string representation

type DescribeRestoreJobInput

type DescribeRestoreJobInput struct {

	// Uniquely identifies the job that restores a recovery point.
	//
	// RestoreJobId is a required field
	RestoreJobId *string `location:"uri" locationName:"restoreJobId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeRestoreJobInput) GoString

func (s DescribeRestoreJobInput) GoString() string

GoString returns the string representation

func (*DescribeRestoreJobInput) SetRestoreJobId

SetRestoreJobId sets the RestoreJobId field's value.

func (DescribeRestoreJobInput) String

func (s DescribeRestoreJobInput) String() string

String returns the string representation

func (*DescribeRestoreJobInput) Validate

func (s *DescribeRestoreJobInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeRestoreJobOutput

type DescribeRestoreJobOutput struct {

	// Returns the account ID that owns the restore job.
	AccountId *string `type:"string"`

	// The size, in bytes, of the restored resource.
	BackupSizeInBytes *int64 `type:"long"`

	// The date and time that 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 `type:"timestamp"`

	// An Amazon Resource Name (ARN) that uniquely identifies a resource whose recovery
	// point is being restored. The format of the ARN depends on the resource type
	// of the backed-up resource.
	CreatedResourceArn *string `type:"string"`

	// The date and time that 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 `type:"timestamp"`

	// The amount of time in minutes that a job restoring a recovery point is expected
	// to take.
	ExpectedCompletionTimeMinutes *int64 `type:"long"`

	// Specifies the IAM role ARN used to create the target recovery point; for
	// example, arn:aws:iam::123456789012:role/S3Access.
	IamRoleArn *string `type:"string"`

	// Contains an estimated percentage that is complete of a job at the time the
	// job status was queried.
	PercentDone *string `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.
	RecoveryPointArn *string `type:"string"`

	// Returns metadata associated with a restore job listed by resource type.
	ResourceType *string `type:"string"`

	// Uniquely identifies the job that restores a recovery point.
	RestoreJobId *string `type:"string"`

	// Status code specifying the state of the job that is initiated by AWS Backup
	// to restore a recovery point.
	Status *string `type:"string" enum:"RestoreJobStatus"`

	// A message showing the status of a job to restore a recovery point.
	StatusMessage *string `type:"string"`
	// contains filtered or unexported fields
}

func (DescribeRestoreJobOutput) GoString

func (s DescribeRestoreJobOutput) GoString() string

GoString returns the string representation

func (*DescribeRestoreJobOutput) SetAccountId added in v1.32.9

SetAccountId sets the AccountId field's value.

func (*DescribeRestoreJobOutput) SetBackupSizeInBytes

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

SetBackupSizeInBytes sets the BackupSizeInBytes field's value.

func (*DescribeRestoreJobOutput) SetCompletionDate

SetCompletionDate sets the CompletionDate field's value.

func (*DescribeRestoreJobOutput) SetCreatedResourceArn

func (s *DescribeRestoreJobOutput) SetCreatedResourceArn(v string) *DescribeRestoreJobOutput

SetCreatedResourceArn sets the CreatedResourceArn field's value.

func (*DescribeRestoreJobOutput) SetCreationDate

SetCreationDate sets the CreationDate field's value.

func (*DescribeRestoreJobOutput) SetExpectedCompletionTimeMinutes

func (s *DescribeRestoreJobOutput) SetExpectedCompletionTimeMinutes(v int64) *DescribeRestoreJobOutput

SetExpectedCompletionTimeMinutes sets the ExpectedCompletionTimeMinutes field's value.

func (*DescribeRestoreJobOutput) SetIamRoleArn

SetIamRoleArn sets the IamRoleArn field's value.

func (*DescribeRestoreJobOutput) SetPercentDone

SetPercentDone sets the PercentDone field's value.

func (*DescribeRestoreJobOutput) SetRecoveryPointArn

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

SetRecoveryPointArn sets the RecoveryPointArn field's value.

func (*DescribeRestoreJobOutput) SetResourceType added in v1.32.9

SetResourceType sets the ResourceType field's value.

func (*DescribeRestoreJobOutput) SetRestoreJobId

SetRestoreJobId sets the RestoreJobId field's value.

func (*DescribeRestoreJobOutput) SetStatus

SetStatus sets the Status field's value.

func (*DescribeRestoreJobOutput) SetStatusMessage

SetStatusMessage sets the StatusMessage field's value.

func (DescribeRestoreJobOutput) String

func (s DescribeRestoreJobOutput) String() string

String returns the string representation

type DisassociateRecoveryPointInput added in v1.37.28

type DisassociateRecoveryPointInput struct {

	// The unique name of an AWS Backup vault. Required.
	//
	// BackupVaultName is a required field
	BackupVaultName *string `location:"uri" locationName:"backupVaultName" type:"string" required:"true"`

	// An Amazon Resource Name (ARN) that uniquely identifies an AWS Backup recovery
	// point. Required.
	//
	// RecoveryPointArn is a required field
	RecoveryPointArn *string `location:"uri" locationName:"recoveryPointArn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DisassociateRecoveryPointInput) GoString added in v1.37.28

GoString returns the string representation

func (*DisassociateRecoveryPointInput) SetBackupVaultName added in v1.37.28

SetBackupVaultName sets the BackupVaultName field's value.

func (*DisassociateRecoveryPointInput) SetRecoveryPointArn added in v1.37.28

SetRecoveryPointArn sets the RecoveryPointArn field's value.

func (DisassociateRecoveryPointInput) String added in v1.37.28

String returns the string representation

func (*DisassociateRecoveryPointInput) Validate added in v1.37.28

func (s *DisassociateRecoveryPointInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DisassociateRecoveryPointOutput added in v1.37.28

type DisassociateRecoveryPointOutput struct {
	// contains filtered or unexported fields
}

func (DisassociateRecoveryPointOutput) GoString added in v1.37.28

GoString returns the string representation

func (DisassociateRecoveryPointOutput) String added in v1.37.28

String returns the string representation

type ExportBackupPlanTemplateInput

type ExportBackupPlanTemplateInput struct {

	// Uniquely identifies a backup plan.
	//
	// BackupPlanId is a required field
	BackupPlanId *string `location:"uri" locationName:"backupPlanId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ExportBackupPlanTemplateInput) GoString

GoString returns the string representation

func (*ExportBackupPlanTemplateInput) SetBackupPlanId

SetBackupPlanId sets the BackupPlanId field's value.

func (ExportBackupPlanTemplateInput) String

String returns the string representation

func (*ExportBackupPlanTemplateInput) Validate

func (s *ExportBackupPlanTemplateInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ExportBackupPlanTemplateOutput

type ExportBackupPlanTemplateOutput struct {

	// The body of a backup plan template in JSON format.
	//
	// This is a signed JSON document that cannot be modified before being passed
	// to GetBackupPlanFromJSON.
	BackupPlanTemplateJson *string `type:"string"`
	// contains filtered or unexported fields
}

func (ExportBackupPlanTemplateOutput) GoString

GoString returns the string representation

func (*ExportBackupPlanTemplateOutput) SetBackupPlanTemplateJson

func (s *ExportBackupPlanTemplateOutput) SetBackupPlanTemplateJson(v string) *ExportBackupPlanTemplateOutput

SetBackupPlanTemplateJson sets the BackupPlanTemplateJson field's value.

func (ExportBackupPlanTemplateOutput) String

String returns the string representation

type GetBackupPlanFromJSONInput

type GetBackupPlanFromJSONInput struct {

	// A customer-supplied backup plan document in JSON format.
	//
	// BackupPlanTemplateJson is a required field
	BackupPlanTemplateJson *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetBackupPlanFromJSONInput) GoString

func (s GetBackupPlanFromJSONInput) GoString() string

GoString returns the string representation

func (*GetBackupPlanFromJSONInput) SetBackupPlanTemplateJson

func (s *GetBackupPlanFromJSONInput) SetBackupPlanTemplateJson(v string) *GetBackupPlanFromJSONInput

SetBackupPlanTemplateJson sets the BackupPlanTemplateJson field's value.

func (GetBackupPlanFromJSONInput) String

String returns the string representation

func (*GetBackupPlanFromJSONInput) Validate

func (s *GetBackupPlanFromJSONInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetBackupPlanFromJSONOutput

type GetBackupPlanFromJSONOutput struct {

	// Specifies the body of a backup plan. Includes a BackupPlanName and one or
	// more sets of Rules.
	BackupPlan *Plan `type:"structure"`
	// contains filtered or unexported fields
}

func (GetBackupPlanFromJSONOutput) GoString

func (s GetBackupPlanFromJSONOutput) GoString() string

GoString returns the string representation

func (*GetBackupPlanFromJSONOutput) SetBackupPlan

SetBackupPlan sets the BackupPlan field's value.

func (GetBackupPlanFromJSONOutput) String

String returns the string representation

type GetBackupPlanFromTemplateInput

type GetBackupPlanFromTemplateInput struct {

	// Uniquely identifies a stored backup plan template.
	//
	// BackupPlanTemplateId is a required field
	BackupPlanTemplateId *string `location:"uri" locationName:"templateId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetBackupPlanFromTemplateInput) GoString

GoString returns the string representation

func (*GetBackupPlanFromTemplateInput) SetBackupPlanTemplateId

SetBackupPlanTemplateId sets the BackupPlanTemplateId field's value.

func (GetBackupPlanFromTemplateInput) String

String returns the string representation

func (*GetBackupPlanFromTemplateInput) Validate

func (s *GetBackupPlanFromTemplateInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetBackupPlanFromTemplateOutput

type GetBackupPlanFromTemplateOutput struct {

	// Returns the body of a backup plan based on the target template, including
	// the name, rules, and backup vault of the plan.
	BackupPlanDocument *Plan `type:"structure"`
	// contains filtered or unexported fields
}

func (GetBackupPlanFromTemplateOutput) GoString

GoString returns the string representation

func (*GetBackupPlanFromTemplateOutput) SetBackupPlanDocument

SetBackupPlanDocument sets the BackupPlanDocument field's value.

func (GetBackupPlanFromTemplateOutput) String

String returns the string representation

type GetBackupPlanInput

type GetBackupPlanInput struct {

	// Uniquely identifies a backup plan.
	//
	// BackupPlanId is a required field
	BackupPlanId *string `location:"uri" locationName:"backupPlanId" type:"string" required:"true"`

	// Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most
	// 1,024 bytes long. Version IDs cannot be edited.
	VersionId *string `location:"querystring" locationName:"versionId" type:"string"`
	// contains filtered or unexported fields
}

func (GetBackupPlanInput) GoString

func (s GetBackupPlanInput) GoString() string

GoString returns the string representation

func (*GetBackupPlanInput) SetBackupPlanId

func (s *GetBackupPlanInput) SetBackupPlanId(v string) *GetBackupPlanInput

SetBackupPlanId sets the BackupPlanId field's value.

func (*GetBackupPlanInput) SetVersionId

func (s *GetBackupPlanInput) SetVersionId(v string) *GetBackupPlanInput

SetVersionId sets the VersionId field's value.

func (GetBackupPlanInput) String

func (s GetBackupPlanInput) String() string

String returns the string representation

func (*GetBackupPlanInput) Validate

func (s *GetBackupPlanInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetBackupPlanOutput

type GetBackupPlanOutput struct {

	// Contains a list of BackupOptions for each resource type. The list is populated
	// only if the advanced option is set for the backup plan.
	AdvancedBackupSettings []*AdvancedBackupSetting `type:"list"`

	// Specifies the body of a backup plan. Includes a BackupPlanName and one or
	// more sets of Rules.
	BackupPlan *Plan `type:"structure"`

	// 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 `type:"string"`

	// Uniquely identifies a backup plan.
	BackupPlanId *string `type:"string"`

	// The date and time that 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 `type:"timestamp"`

	// A unique string that identifies the request and allows failed requests to
	// be retried without the risk of running the operation twice.
	CreatorRequestId *string `type:"string"`

	// The date and time that 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 `type:"timestamp"`

	// The last time a job to back up resources was run with this backup plan. 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 `type:"timestamp"`

	// Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most
	// 1,024 bytes long. Version IDs cannot be edited.
	VersionId *string `type:"string"`
	// contains filtered or unexported fields
}

func (GetBackupPlanOutput) GoString

func (s GetBackupPlanOutput) GoString() string

GoString returns the string representation

func (*GetBackupPlanOutput) SetAdvancedBackupSettings added in v1.34.30

func (s *GetBackupPlanOutput) SetAdvancedBackupSettings(v []*AdvancedBackupSetting) *GetBackupPlanOutput

SetAdvancedBackupSettings sets the AdvancedBackupSettings field's value.

func (*GetBackupPlanOutput) SetBackupPlan

func (s *GetBackupPlanOutput) SetBackupPlan(v *Plan) *GetBackupPlanOutput

SetBackupPlan sets the BackupPlan field's value.

func (*GetBackupPlanOutput) SetBackupPlanArn

func (s *GetBackupPlanOutput) SetBackupPlanArn(v string) *GetBackupPlanOutput

SetBackupPlanArn sets the BackupPlanArn field's value.

func (*GetBackupPlanOutput) SetBackupPlanId

func (s *GetBackupPlanOutput) SetBackupPlanId(v string) *GetBackupPlanOutput

SetBackupPlanId sets the BackupPlanId field's value.

func (*GetBackupPlanOutput) SetCreationDate

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

SetCreationDate sets the CreationDate field's value.

func (*GetBackupPlanOutput) SetCreatorRequestId

func (s *GetBackupPlanOutput) SetCreatorRequestId(v string) *GetBackupPlanOutput

SetCreatorRequestId sets the CreatorRequestId field's value.

func (*GetBackupPlanOutput) SetDeletionDate

func (s *GetBackupPlanOutput) SetDeletionDate(v time.Time) *GetBackupPlanOutput

SetDeletionDate sets the DeletionDate field's value.

func (*GetBackupPlanOutput) SetLastExecutionDate

func (s *GetBackupPlanOutput) SetLastExecutionDate(v time.Time) *GetBackupPlanOutput

SetLastExecutionDate sets the LastExecutionDate field's value.

func (*GetBackupPlanOutput) SetVersionId

func (s *GetBackupPlanOutput) SetVersionId(v string) *GetBackupPlanOutput

SetVersionId sets the VersionId field's value.

func (GetBackupPlanOutput) String

func (s GetBackupPlanOutput) String() string

String returns the string representation

type GetBackupSelectionInput

type GetBackupSelectionInput struct {

	// Uniquely identifies a backup plan.
	//
	// BackupPlanId is a required field
	BackupPlanId *string `location:"uri" locationName:"backupPlanId" type:"string" required:"true"`

	// Uniquely identifies the body of a request to assign a set of resources to
	// a backup plan.
	//
	// SelectionId is a required field
	SelectionId *string `location:"uri" locationName:"selectionId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetBackupSelectionInput) GoString

func (s GetBackupSelectionInput) GoString() string

GoString returns the string representation

func (*GetBackupSelectionInput) SetBackupPlanId

SetBackupPlanId sets the BackupPlanId field's value.

func (*GetBackupSelectionInput) SetSelectionId

SetSelectionId sets the SelectionId field's value.

func (GetBackupSelectionInput) String

func (s GetBackupSelectionInput) String() string

String returns the string representation

func (*GetBackupSelectionInput) Validate

func (s *GetBackupSelectionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetBackupSelectionOutput

type GetBackupSelectionOutput struct {

	// Uniquely identifies a backup plan.
	BackupPlanId *string `type:"string"`

	// Specifies the body of a request to assign a set of resources to a backup
	// plan.
	BackupSelection *Selection `type:"structure"`

	// The date and time a backup selection 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 `type:"timestamp"`

	// A unique string that identifies the request and allows failed requests to
	// be retried without the risk of running the operation twice.
	CreatorRequestId *string `type:"string"`

	// Uniquely identifies the body of a request to assign a set of resources to
	// a backup plan.
	SelectionId *string `type:"string"`
	// contains filtered or unexported fields
}

func (GetBackupSelectionOutput) GoString

func (s GetBackupSelectionOutput) GoString() string

GoString returns the string representation

func (*GetBackupSelectionOutput) SetBackupPlanId

SetBackupPlanId sets the BackupPlanId field's value.

func (*GetBackupSelectionOutput) SetBackupSelection

func (s *GetBackupSelectionOutput) SetBackupSelection(v *Selection) *GetBackupSelectionOutput

SetBackupSelection sets the BackupSelection field's value.

func (*GetBackupSelectionOutput) SetCreationDate

SetCreationDate sets the CreationDate field's value.

func (*GetBackupSelectionOutput) SetCreatorRequestId

func (s *GetBackupSelectionOutput) SetCreatorRequestId(v string) *GetBackupSelectionOutput

SetCreatorRequestId sets the CreatorRequestId field's value.

func (*GetBackupSelectionOutput) SetSelectionId

SetSelectionId sets the SelectionId field's value.

func (GetBackupSelectionOutput) String

func (s GetBackupSelectionOutput) String() string

String returns the string representation

type GetBackupVaultAccessPolicyInput

type GetBackupVaultAccessPolicyInput 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.
	//
	// BackupVaultName is a required field
	BackupVaultName *string `location:"uri" locationName:"backupVaultName" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetBackupVaultAccessPolicyInput) GoString

GoString returns the string representation

func (*GetBackupVaultAccessPolicyInput) SetBackupVaultName

SetBackupVaultName sets the BackupVaultName field's value.

func (GetBackupVaultAccessPolicyInput) String

String returns the string representation

func (*GetBackupVaultAccessPolicyInput) Validate

func (s *GetBackupVaultAccessPolicyInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetBackupVaultAccessPolicyOutput

type GetBackupVaultAccessPolicyOutput struct {

	// An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for
	// example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
	BackupVaultArn *string `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 Region where they are created. They consist of lowercase letters, numbers,
	// and hyphens.
	BackupVaultName *string `type:"string"`

	// The backup vault access policy document in JSON format.
	Policy *string `type:"string"`
	// contains filtered or unexported fields
}

func (GetBackupVaultAccessPolicyOutput) GoString

GoString returns the string representation

func (*GetBackupVaultAccessPolicyOutput) SetBackupVaultArn

SetBackupVaultArn sets the BackupVaultArn field's value.

func (*GetBackupVaultAccessPolicyOutput) SetBackupVaultName

SetBackupVaultName sets the BackupVaultName field's value.

func (*GetBackupVaultAccessPolicyOutput) SetPolicy

SetPolicy sets the Policy field's value.

func (GetBackupVaultAccessPolicyOutput) String

String returns the string representation

type GetBackupVaultNotificationsInput

type GetBackupVaultNotificationsInput 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.
	//
	// BackupVaultName is a required field
	BackupVaultName *string `location:"uri" locationName:"backupVaultName" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetBackupVaultNotificationsInput) GoString

GoString returns the string representation

func (*GetBackupVaultNotificationsInput) SetBackupVaultName

SetBackupVaultName sets the BackupVaultName field's value.

func (GetBackupVaultNotificationsInput) String

String returns the string representation

func (*GetBackupVaultNotificationsInput) Validate

Validate inspects the fields of the type to determine if they are valid.

type GetBackupVaultNotificationsOutput

type GetBackupVaultNotificationsOutput struct {

	// An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for
	// example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
	BackupVaultArn *string `type:"string"`

	// An array of events that indicate the status of jobs to back up resources
	// to the backup vault.
	BackupVaultEvents []*string `type:"list"`

	// 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 Region where they are created. They consist of lowercase letters, numbers,
	// and hyphens.
	BackupVaultName *string `type:"string"`

	// An ARN that uniquely identifies an Amazon Simple Notification Service (Amazon
	// SNS) topic; for example, arn:aws:sns:us-west-2:111122223333:MyTopic.
	SNSTopicArn *string `type:"string"`
	// contains filtered or unexported fields
}

func (GetBackupVaultNotificationsOutput) GoString

GoString returns the string representation

func (*GetBackupVaultNotificationsOutput) SetBackupVaultArn

SetBackupVaultArn sets the BackupVaultArn field's value.

func (*GetBackupVaultNotificationsOutput) SetBackupVaultEvents

SetBackupVaultEvents sets the BackupVaultEvents field's value.

func (*GetBackupVaultNotificationsOutput) SetBackupVaultName

SetBackupVaultName sets the BackupVaultName field's value.

func (*GetBackupVaultNotificationsOutput) SetSNSTopicArn

SetSNSTopicArn sets the SNSTopicArn field's value.

func (GetBackupVaultNotificationsOutput) String

String returns the string representation

type GetRecoveryPointRestoreMetadataInput

type GetRecoveryPointRestoreMetadataInput 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.
	//
	// BackupVaultName is a required field
	BackupVaultName *string `location:"uri" locationName:"backupVaultName" type:"string" required:"true"`

	// 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 is a required field
	RecoveryPointArn *string `location:"uri" locationName:"recoveryPointArn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetRecoveryPointRestoreMetadataInput) GoString

GoString returns the string representation

func (*GetRecoveryPointRestoreMetadataInput) SetBackupVaultName

SetBackupVaultName sets the BackupVaultName field's value.

func (*GetRecoveryPointRestoreMetadataInput) SetRecoveryPointArn

SetRecoveryPointArn sets the RecoveryPointArn field's value.

func (GetRecoveryPointRestoreMetadataInput) String

String returns the string representation

func (*GetRecoveryPointRestoreMetadataInput) Validate

Validate inspects the fields of the type to determine if they are valid.

type GetRecoveryPointRestoreMetadataOutput

type GetRecoveryPointRestoreMetadataOutput struct {

	// An ARN that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
	BackupVaultArn *string `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.
	RecoveryPointArn *string `type:"string"`

	// The set of metadata key-value pairs that describe the original configuration
	// of the backed-up resource. These values vary depending on the service that
	// is being restored.
	RestoreMetadata map[string]*string `type:"map" sensitive:"true"`
	// contains filtered or unexported fields
}

func (GetRecoveryPointRestoreMetadataOutput) GoString

GoString returns the string representation

func (*GetRecoveryPointRestoreMetadataOutput) SetBackupVaultArn

SetBackupVaultArn sets the BackupVaultArn field's value.

func (*GetRecoveryPointRestoreMetadataOutput) SetRecoveryPointArn

SetRecoveryPointArn sets the RecoveryPointArn field's value.

func (*GetRecoveryPointRestoreMetadataOutput) SetRestoreMetadata

SetRestoreMetadata sets the RestoreMetadata field's value.

func (GetRecoveryPointRestoreMetadataOutput) String

String returns the string representation

type GetSupportedResourceTypesInput

type GetSupportedResourceTypesInput struct {
	// contains filtered or unexported fields
}

func (GetSupportedResourceTypesInput) GoString

GoString returns the string representation

func (GetSupportedResourceTypesInput) String

String returns the string representation

type GetSupportedResourceTypesOutput

type GetSupportedResourceTypesOutput struct {

	// Contains a string with the supported AWS resource types:
	//
	//    * DynamoDB for Amazon DynamoDB
	//
	//    * EBS for Amazon Elastic Block Store
	//
	//    * EC2 for Amazon Elastic Compute Cloud
	//
	//    * EFS for Amazon Elastic File System
	//
	//    * RDS for Amazon Relational Database Service
	//
	//    * Aurora for Amazon Aurora
	//
	//    * Storage Gateway for AWS Storage Gateway
	ResourceTypes []*string `type:"list"`
	// contains filtered or unexported fields
}

func (GetSupportedResourceTypesOutput) GoString

GoString returns the string representation

func (*GetSupportedResourceTypesOutput) SetResourceTypes

SetResourceTypes sets the ResourceTypes field's value.

func (GetSupportedResourceTypesOutput) String

String returns the string representation

type InvalidParameterValueException added in v1.28.0

type InvalidParameterValueException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Code_ *string `locationName:"Code" type:"string"`

	Context *string `type:"string"`

	Message_ *string `locationName:"Message" type:"string"`

	Type *string `type:"string"`
	// contains filtered or unexported fields
}

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

func (*InvalidParameterValueException) Code added in v1.28.0

Code returns the exception type name.

func (*InvalidParameterValueException) Error added in v1.28.0

func (InvalidParameterValueException) GoString added in v1.28.0

GoString returns the string representation

func (*InvalidParameterValueException) Message added in v1.28.0

Message returns the exception's message.

func (*InvalidParameterValueException) OrigErr added in v1.28.0

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidParameterValueException) RequestID added in v1.28.0

func (s *InvalidParameterValueException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidParameterValueException) StatusCode added in v1.28.0

func (s *InvalidParameterValueException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InvalidParameterValueException) String added in v1.28.0

String returns the string representation

type InvalidRequestException added in v1.28.0

type InvalidRequestException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Code_ *string `locationName:"Code" type:"string"`

	Context *string `type:"string"`

	Message_ *string `locationName:"Message" type:"string"`

	Type *string `type:"string"`
	// contains filtered or unexported fields
}

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

func (*InvalidRequestException) Code added in v1.28.0

func (s *InvalidRequestException) Code() string

Code returns the exception type name.

func (*InvalidRequestException) Error added in v1.28.0

func (s *InvalidRequestException) Error() string

func (InvalidRequestException) GoString added in v1.28.0

func (s InvalidRequestException) GoString() string

GoString returns the string representation

func (*InvalidRequestException) Message added in v1.28.0

func (s *InvalidRequestException) Message() string

Message returns the exception's message.

func (*InvalidRequestException) OrigErr added in v1.28.0

func (s *InvalidRequestException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidRequestException) RequestID added in v1.28.0

func (s *InvalidRequestException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidRequestException) StatusCode added in v1.28.0

func (s *InvalidRequestException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InvalidRequestException) String added in v1.28.0

func (s InvalidRequestException) String() string

String returns the string representation

type InvalidResourceStateException added in v1.37.28

type InvalidResourceStateException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Code_ *string `locationName:"Code" type:"string"`

	Context *string `type:"string"`

	Message_ *string `locationName:"Message" type:"string"`

	Type *string `type:"string"`
	// contains filtered or unexported fields
}

AWS Backup is already performing an action on this recovery point. It can't perform the action you requested until the first action finishes. Try again later.

func (*InvalidResourceStateException) Code added in v1.37.28

Code returns the exception type name.

func (*InvalidResourceStateException) Error added in v1.37.28

func (InvalidResourceStateException) GoString added in v1.37.28

GoString returns the string representation

func (*InvalidResourceStateException) Message added in v1.37.28

Message returns the exception's message.

func (*InvalidResourceStateException) OrigErr added in v1.37.28

func (s *InvalidResourceStateException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidResourceStateException) RequestID added in v1.37.28

func (s *InvalidResourceStateException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidResourceStateException) StatusCode added in v1.37.28

func (s *InvalidResourceStateException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InvalidResourceStateException) String added in v1.37.28

String returns the string representation

type Job

type Job struct {

	// The account ID that owns the backup job.
	AccountId *string `type:"string"`

	// Uniquely identifies a request to AWS Backup to back up a resource.
	BackupJobId *string `type:"string"`

	// 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.
	BackupOptions map[string]*string `type:"map"`

	// The size, in bytes, of a backup.
	BackupSizeInBytes *int64 `type:"long"`

	// Represents the type of backup for a backup job.
	BackupType *string `type:"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 `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.
	BackupVaultName *string `type:"string"`

	// The size in bytes transferred to a backup vault at the time that the job
	// status was queried.
	BytesTransferred *int64 `type:"long"`

	// 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 `type:"timestamp"`

	// 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 `type:"structure"`

	// 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 `type:"timestamp"`

	// 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 `type:"timestamp"`

	// 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.
	IamRoleArn *string `type:"string"`

	// Contains an estimated percentage complete of a job at the time the job status
	// was queried.
	PercentDone *string `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.
	RecoveryPointArn *string `type:"string"`

	// An ARN that uniquely identifies a resource. The format of the ARN depends
	// on the resource type.
	ResourceArn *string `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. For VSS Windows backups, the only supported resource
	// type is Amazon EC2.
	ResourceType *string `type:"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 `type:"timestamp"`

	// The current state of a resource recovery point.
	State *string `type:"string" enum:"JobState"`

	// A detailed message explaining the status of the job to back up a resource.
	StatusMessage *string `type:"string"`
	// contains filtered or unexported fields
}

Contains detailed information about a backup job.

func (Job) GoString

func (s Job) GoString() string

GoString returns the string representation

func (*Job) SetAccountId added in v1.32.9

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

SetAccountId sets the AccountId field's value.

func (*Job) SetBackupJobId

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

SetBackupJobId sets the BackupJobId field's value.

func (*Job) SetBackupOptions added in v1.34.30

func (s *Job) SetBackupOptions(v map[string]*string) *Job

SetBackupOptions sets the BackupOptions field's value.

func (*Job) SetBackupSizeInBytes

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

SetBackupSizeInBytes sets the BackupSizeInBytes field's value.

func (*Job) SetBackupType added in v1.34.30

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

SetBackupType sets the BackupType field's value.

func (*Job) SetBackupVaultArn

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

SetBackupVaultArn sets the BackupVaultArn field's value.

func (*Job) SetBackupVaultName

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

SetBackupVaultName sets the BackupVaultName field's value.

func (*Job) SetBytesTransferred

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

SetBytesTransferred sets the BytesTransferred field's value.

func (*Job) SetCompletionDate

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

SetCompletionDate sets the CompletionDate field's value.

func (*Job) SetCreatedBy

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

SetCreatedBy sets the CreatedBy field's value.

func (*Job) SetCreationDate

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

SetCreationDate sets the CreationDate field's value.

func (*Job) SetExpectedCompletionDate

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

SetExpectedCompletionDate sets the ExpectedCompletionDate field's value.

func (*Job) SetIamRoleArn

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

SetIamRoleArn sets the IamRoleArn field's value.

func (*Job) SetPercentDone

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

SetPercentDone sets the PercentDone field's value.

func (*Job) SetRecoveryPointArn

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

SetRecoveryPointArn sets the RecoveryPointArn field's value.

func (*Job) SetResourceArn

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

SetResourceArn sets the ResourceArn field's value.

func (*Job) SetResourceType

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

SetResourceType sets the ResourceType field's value.

func (*Job) SetStartBy

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

SetStartBy sets the StartBy field's value.

func (*Job) SetState

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

SetState sets the State field's value.

func (*Job) SetStatusMessage

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

SetStatusMessage sets the StatusMessage field's value.

func (Job) String

func (s Job) String() string

String returns the string representation

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 `type:"long"`

	// Specifies the number of days after creation that a recovery point is moved
	// to cold storage.
	MoveToColdStorageAfterDays *int64 `type:"long"`
	// contains filtered or unexported fields
}

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.

Only Amazon EFS file system backups can be transitioned to cold storage.

func (Lifecycle) GoString

func (s Lifecycle) GoString() string

GoString returns the string representation

func (*Lifecycle) SetDeleteAfterDays

func (s *Lifecycle) SetDeleteAfterDays(v int64) *Lifecycle

SetDeleteAfterDays sets the DeleteAfterDays field's value.

func (*Lifecycle) SetMoveToColdStorageAfterDays

func (s *Lifecycle) SetMoveToColdStorageAfterDays(v int64) *Lifecycle

SetMoveToColdStorageAfterDays sets the MoveToColdStorageAfterDays field's value.

func (Lifecycle) String

func (s Lifecycle) String() string

String returns the string representation

type LimitExceededException added in v1.28.0

type LimitExceededException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Code_ *string `locationName:"Code" type:"string"`

	Context *string `type:"string"`

	Message_ *string `locationName:"Message" type:"string"`

	Type *string `type:"string"`
	// contains filtered or unexported fields
}

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

func (*LimitExceededException) Code added in v1.28.0

func (s *LimitExceededException) Code() string

Code returns the exception type name.

func (*LimitExceededException) Error added in v1.28.0

func (s *LimitExceededException) Error() string

func (LimitExceededException) GoString added in v1.28.0

func (s LimitExceededException) GoString() string

GoString returns the string representation

func (*LimitExceededException) Message added in v1.28.0

func (s *LimitExceededException) Message() string

Message returns the exception's message.

func (*LimitExceededException) OrigErr added in v1.28.0

func (s *LimitExceededException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*LimitExceededException) RequestID added in v1.28.0

func (s *LimitExceededException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*LimitExceededException) StatusCode added in v1.28.0

func (s *LimitExceededException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (LimitExceededException) String added in v1.28.0

func (s LimitExceededException) String() string

String returns the string representation

type ListBackupJobsInput

type ListBackupJobsInput struct {

	// The account ID to list the jobs from. Returns only backup jobs associated
	// with the specified account ID.
	//
	// If used from an AWS Organizations management account, passing * returns all
	// jobs across the organization.
	ByAccountId *string `location:"querystring" locationName:"accountId" type:"string"`

	// Returns only backup jobs that will be stored in the specified backup vault.
	// 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.
	ByBackupVaultName *string `location:"querystring" locationName:"backupVaultName" type:"string"`

	// Returns only backup jobs that were created after the specified date.
	ByCreatedAfter *time.Time `location:"querystring" locationName:"createdAfter" type:"timestamp"`

	// Returns only backup jobs that were created before the specified date.
	ByCreatedBefore *time.Time `location:"querystring" locationName:"createdBefore" type:"timestamp"`

	// Returns only backup jobs that match the specified resource Amazon Resource
	// Name (ARN).
	ByResourceArn *string `location:"querystring" locationName:"resourceArn" type:"string"`

	// Returns only backup jobs for the specified resources:
	//
	//    * DynamoDB for Amazon DynamoDB
	//
	//    * EBS for Amazon Elastic Block Store
	//
	//    * EC2 for Amazon Elastic Compute Cloud
	//
	//    * EFS for Amazon Elastic File System
	//
	//    * RDS for Amazon Relational Database Service
	//
	//    * Aurora for Amazon Aurora
	//
	//    * Storage Gateway for AWS Storage Gateway
	ByResourceType *string `location:"querystring" locationName:"resourceType" type:"string"`

	// Returns only backup jobs that are in the specified state.
	ByState *string `location:"querystring" locationName:"state" type:"string" enum:"JobState"`

	// The maximum number of items to be returned.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	// The next item following a partial list of returned items. For example, if
	// a request is made to return maxResults number of items, NextToken allows
	// you to return more items in your list starting at the location pointed to
	// by the next token.
	NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListBackupJobsInput) GoString

func (s ListBackupJobsInput) GoString() string

GoString returns the string representation

func (*ListBackupJobsInput) SetByAccountId added in v1.32.9

func (s *ListBackupJobsInput) SetByAccountId(v string) *ListBackupJobsInput

SetByAccountId sets the ByAccountId field's value.

func (*ListBackupJobsInput) SetByBackupVaultName

func (s *ListBackupJobsInput) SetByBackupVaultName(v string) *ListBackupJobsInput

SetByBackupVaultName sets the ByBackupVaultName field's value.

func (*ListBackupJobsInput) SetByCreatedAfter

func (s *ListBackupJobsInput) SetByCreatedAfter(v time.Time) *ListBackupJobsInput

SetByCreatedAfter sets the ByCreatedAfter field's value.

func (*ListBackupJobsInput) SetByCreatedBefore

func (s *ListBackupJobsInput) SetByCreatedBefore(v time.Time) *ListBackupJobsInput

SetByCreatedBefore sets the ByCreatedBefore field's value.

func (*ListBackupJobsInput) SetByResourceArn

func (s *ListBackupJobsInput) SetByResourceArn(v string) *ListBackupJobsInput

SetByResourceArn sets the ByResourceArn field's value.

func (*ListBackupJobsInput) SetByResourceType

func (s *ListBackupJobsInput) SetByResourceType(v string) *ListBackupJobsInput

SetByResourceType sets the ByResourceType field's value.

func (*ListBackupJobsInput) SetByState

SetByState sets the ByState field's value.

func (*ListBackupJobsInput) SetMaxResults

func (s *ListBackupJobsInput) SetMaxResults(v int64) *ListBackupJobsInput

SetMaxResults sets the MaxResults field's value.

func (*ListBackupJobsInput) SetNextToken

func (s *ListBackupJobsInput) SetNextToken(v string) *ListBackupJobsInput

SetNextToken sets the NextToken field's value.

func (ListBackupJobsInput) String

func (s ListBackupJobsInput) String() string

String returns the string representation

func (*ListBackupJobsInput) Validate

func (s *ListBackupJobsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListBackupJobsOutput

type ListBackupJobsOutput struct {

	// An array of structures containing metadata about your backup jobs returned
	// in JSON format.
	BackupJobs []*Job `type:"list"`

	// The next item following a partial list of returned items. For example, if
	// a request is made to return maxResults number of items, NextToken allows
	// you to return more items in your list starting at the location pointed to
	// by the next token.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListBackupJobsOutput) GoString

func (s ListBackupJobsOutput) GoString() string

GoString returns the string representation

func (*ListBackupJobsOutput) SetBackupJobs

func (s *ListBackupJobsOutput) SetBackupJobs(v []*Job) *ListBackupJobsOutput

SetBackupJobs sets the BackupJobs field's value.

func (*ListBackupJobsOutput) SetNextToken

func (s *ListBackupJobsOutput) SetNextToken(v string) *ListBackupJobsOutput

SetNextToken sets the NextToken field's value.

func (ListBackupJobsOutput) String

func (s ListBackupJobsOutput) String() string

String returns the string representation

type ListBackupPlanTemplatesInput

type ListBackupPlanTemplatesInput struct {

	// The maximum number of items to be returned.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	// The next item following a partial list of returned items. For example, if
	// a request is made to return maxResults number of items, NextToken allows
	// you to return more items in your list starting at the location pointed to
	// by the next token.
	NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListBackupPlanTemplatesInput) GoString

func (s ListBackupPlanTemplatesInput) GoString() string

GoString returns the string representation

func (*ListBackupPlanTemplatesInput) SetMaxResults

SetMaxResults sets the MaxResults field's value.

func (*ListBackupPlanTemplatesInput) SetNextToken

SetNextToken sets the NextToken field's value.

func (ListBackupPlanTemplatesInput) String

String returns the string representation

func (*ListBackupPlanTemplatesInput) Validate

func (s *ListBackupPlanTemplatesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListBackupPlanTemplatesOutput

type ListBackupPlanTemplatesOutput struct {

	// An array of template list items containing metadata about your saved templates.
	BackupPlanTemplatesList []*PlanTemplatesListMember `type:"list"`

	// The next item following a partial list of returned items. For example, if
	// a request is made to return maxResults number of items, NextToken allows
	// you to return more items in your list starting at the location pointed to
	// by the next token.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListBackupPlanTemplatesOutput) GoString

GoString returns the string representation

func (*ListBackupPlanTemplatesOutput) SetBackupPlanTemplatesList

SetBackupPlanTemplatesList sets the BackupPlanTemplatesList field's value.

func (*ListBackupPlanTemplatesOutput) SetNextToken

SetNextToken sets the NextToken field's value.

func (ListBackupPlanTemplatesOutput) String

String returns the string representation

type ListBackupPlanVersionsInput

type ListBackupPlanVersionsInput struct {

	// Uniquely identifies a backup plan.
	//
	// BackupPlanId is a required field
	BackupPlanId *string `location:"uri" locationName:"backupPlanId" type:"string" required:"true"`

	// The maximum number of items to be returned.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	// The next item following a partial list of returned items. For example, if
	// a request is made to return maxResults number of items, NextToken allows
	// you to return more items in your list starting at the location pointed to
	// by the next token.
	NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListBackupPlanVersionsInput) GoString

func (s ListBackupPlanVersionsInput) GoString() string

GoString returns the string representation

func (*ListBackupPlanVersionsInput) SetBackupPlanId

SetBackupPlanId sets the BackupPlanId field's value.

func (*ListBackupPlanVersionsInput) SetMaxResults

SetMaxResults sets the MaxResults field's value.

func (*ListBackupPlanVersionsInput) SetNextToken

SetNextToken sets the NextToken field's value.

func (ListBackupPlanVersionsInput) String

String returns the string representation

func (*ListBackupPlanVersionsInput) Validate

func (s *ListBackupPlanVersionsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListBackupPlanVersionsOutput

type ListBackupPlanVersionsOutput struct {

	// An array of version list items containing metadata about your backup plans.
	BackupPlanVersionsList []*PlansListMember `type:"list"`

	// The next item following a partial list of returned items. For example, if
	// a request is made to return maxResults number of items, NextToken allows
	// you to return more items in your list starting at the location pointed to
	// by the next token.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListBackupPlanVersionsOutput) GoString

func (s ListBackupPlanVersionsOutput) GoString() string

GoString returns the string representation

func (*ListBackupPlanVersionsOutput) SetBackupPlanVersionsList

SetBackupPlanVersionsList sets the BackupPlanVersionsList field's value.

func (*ListBackupPlanVersionsOutput) SetNextToken

SetNextToken sets the NextToken field's value.

func (ListBackupPlanVersionsOutput) String

String returns the string representation

type ListBackupPlansInput

type ListBackupPlansInput struct {

	// A Boolean value with a default value of FALSE that returns deleted backup
	// plans when set to TRUE.
	IncludeDeleted *bool `location:"querystring" locationName:"includeDeleted" type:"boolean"`

	// The maximum number of items to be returned.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	// The next item following a partial list of returned items. For example, if
	// a request is made to return maxResults number of items, NextToken allows
	// you to return more items in your list starting at the location pointed to
	// by the next token.
	NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListBackupPlansInput) GoString

func (s ListBackupPlansInput) GoString() string

GoString returns the string representation

func (*ListBackupPlansInput) SetIncludeDeleted

func (s *ListBackupPlansInput) SetIncludeDeleted(v bool) *ListBackupPlansInput

SetIncludeDeleted sets the IncludeDeleted field's value.

func (*ListBackupPlansInput) SetMaxResults

func (s *ListBackupPlansInput) SetMaxResults(v int64) *ListBackupPlansInput

SetMaxResults sets the MaxResults field's value.

func (*ListBackupPlansInput) SetNextToken

func (s *ListBackupPlansInput) SetNextToken(v string) *ListBackupPlansInput

SetNextToken sets the NextToken field's value.

func (ListBackupPlansInput) String

func (s ListBackupPlansInput) String() string

String returns the string representation

func (*ListBackupPlansInput) Validate

func (s *ListBackupPlansInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListBackupPlansOutput

type ListBackupPlansOutput struct {

	// An array of backup plan list items containing metadata about your saved backup
	// plans.
	BackupPlansList []*PlansListMember `type:"list"`

	// The next item following a partial list of returned items. For example, if
	// a request is made to return maxResults number of items, NextToken allows
	// you to return more items in your list starting at the location pointed to
	// by the next token.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListBackupPlansOutput) GoString

func (s ListBackupPlansOutput) GoString() string

GoString returns the string representation

func (*ListBackupPlansOutput) SetBackupPlansList

func (s *ListBackupPlansOutput) SetBackupPlansList(v []*PlansListMember) *ListBackupPlansOutput

SetBackupPlansList sets the BackupPlansList field's value.

func (*ListBackupPlansOutput) SetNextToken

SetNextToken sets the NextToken field's value.

func (ListBackupPlansOutput) String

func (s ListBackupPlansOutput) String() string

String returns the string representation

type ListBackupSelectionsInput

type ListBackupSelectionsInput struct {

	// Uniquely identifies a backup plan.
	//
	// BackupPlanId is a required field
	BackupPlanId *string `location:"uri" locationName:"backupPlanId" type:"string" required:"true"`

	// The maximum number of items to be returned.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	// The next item following a partial list of returned items. For example, if
	// a request is made to return maxResults number of items, NextToken allows
	// you to return more items in your list starting at the location pointed to
	// by the next token.
	NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListBackupSelectionsInput) GoString

func (s ListBackupSelectionsInput) GoString() string

GoString returns the string representation

func (*ListBackupSelectionsInput) SetBackupPlanId

SetBackupPlanId sets the BackupPlanId field's value.

func (*ListBackupSelectionsInput) SetMaxResults

SetMaxResults sets the MaxResults field's value.

func (*ListBackupSelectionsInput) SetNextToken

SetNextToken sets the NextToken field's value.

func (ListBackupSelectionsInput) String

func (s ListBackupSelectionsInput) String() string

String returns the string representation

func (*ListBackupSelectionsInput) Validate

func (s *ListBackupSelectionsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListBackupSelectionsOutput

type ListBackupSelectionsOutput struct {

	// An array of backup selection list items containing metadata about each resource
	// in the list.
	BackupSelectionsList []*SelectionsListMember `type:"list"`

	// The next item following a partial list of returned items. For example, if
	// a request is made to return maxResults number of items, NextToken allows
	// you to return more items in your list starting at the location pointed to
	// by the next token.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListBackupSelectionsOutput) GoString

func (s ListBackupSelectionsOutput) GoString() string

GoString returns the string representation

func (*ListBackupSelectionsOutput) SetBackupSelectionsList

SetBackupSelectionsList sets the BackupSelectionsList field's value.

func (*ListBackupSelectionsOutput) SetNextToken

SetNextToken sets the NextToken field's value.

func (ListBackupSelectionsOutput) String

String returns the string representation

type ListBackupVaultsInput

type ListBackupVaultsInput struct {

	// The maximum number of items to be returned.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	// The next item following a partial list of returned items. For example, if
	// a request is made to return maxResults number of items, NextToken allows
	// you to return more items in your list starting at the location pointed to
	// by the next token.
	NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListBackupVaultsInput) GoString

func (s ListBackupVaultsInput) GoString() string

GoString returns the string representation

func (*ListBackupVaultsInput) SetMaxResults

func (s *ListBackupVaultsInput) SetMaxResults(v int64) *ListBackupVaultsInput

SetMaxResults sets the MaxResults field's value.

func (*ListBackupVaultsInput) SetNextToken

SetNextToken sets the NextToken field's value.

func (ListBackupVaultsInput) String

func (s ListBackupVaultsInput) String() string

String returns the string representation

func (*ListBackupVaultsInput) Validate

func (s *ListBackupVaultsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListBackupVaultsOutput

type ListBackupVaultsOutput struct {

	// An array of backup vault list members containing vault metadata, including
	// Amazon Resource Name (ARN), display name, creation date, number of saved
	// recovery points, and encryption information if the resources saved in the
	// backup vault are encrypted.
	BackupVaultList []*VaultListMember `type:"list"`

	// The next item following a partial list of returned items. For example, if
	// a request is made to return maxResults number of items, NextToken allows
	// you to return more items in your list starting at the location pointed to
	// by the next token.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListBackupVaultsOutput) GoString

func (s ListBackupVaultsOutput) GoString() string

GoString returns the string representation

func (*ListBackupVaultsOutput) SetBackupVaultList

func (s *ListBackupVaultsOutput) SetBackupVaultList(v []*VaultListMember) *ListBackupVaultsOutput

SetBackupVaultList sets the BackupVaultList field's value.

func (*ListBackupVaultsOutput) SetNextToken

SetNextToken sets the NextToken field's value.

func (ListBackupVaultsOutput) String

func (s ListBackupVaultsOutput) String() string

String returns the string representation

type ListCopyJobsInput added in v1.28.1

type ListCopyJobsInput struct {

	// The account ID to list the jobs from. Returns only copy jobs associated with
	// the specified account ID.
	ByAccountId *string `location:"querystring" locationName:"accountId" type:"string"`

	// Returns only copy jobs that were created after the specified date.
	ByCreatedAfter *time.Time `location:"querystring" locationName:"createdAfter" type:"timestamp"`

	// Returns only copy jobs that were created before the specified date.
	ByCreatedBefore *time.Time `location:"querystring" locationName:"createdBefore" type:"timestamp"`

	// An Amazon Resource Name (ARN) that uniquely identifies a source backup vault
	// to copy from; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
	ByDestinationVaultArn *string `location:"querystring" locationName:"destinationVaultArn" type:"string"`

	// Returns only copy jobs that match the specified resource Amazon Resource
	// Name (ARN).
	ByResourceArn *string `location:"querystring" locationName:"resourceArn" type:"string"`

	// Returns only backup jobs for the specified resources:
	//
	//    * DynamoDB for Amazon DynamoDB
	//
	//    * EBS for Amazon Elastic Block Store
	//
	//    * EC2 for Amazon Elastic Compute Cloud
	//
	//    * EFS for Amazon Elastic File System
	//
	//    * RDS for Amazon Relational Database Service
	//
	//    * Aurora for Amazon Aurora
	//
	//    * Storage Gateway for AWS Storage Gateway
	ByResourceType *string `location:"querystring" locationName:"resourceType" type:"string"`

	// Returns only copy jobs that are in the specified state.
	ByState *string `location:"querystring" locationName:"state" type:"string" enum:"CopyJobState"`

	// The maximum number of items to be returned.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	// The next item following a partial list of returned items. For example, if
	// a request is made to return maxResults number of items, NextToken allows
	// you to return more items in your list starting at the location pointed to
	// by the next token.
	NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListCopyJobsInput) GoString added in v1.28.1

func (s ListCopyJobsInput) GoString() string

GoString returns the string representation

func (*ListCopyJobsInput) SetByAccountId added in v1.32.9

func (s *ListCopyJobsInput) SetByAccountId(v string) *ListCopyJobsInput

SetByAccountId sets the ByAccountId field's value.

func (*ListCopyJobsInput) SetByCreatedAfter added in v1.28.1

func (s *ListCopyJobsInput) SetByCreatedAfter(v time.Time) *ListCopyJobsInput

SetByCreatedAfter sets the ByCreatedAfter field's value.

func (*ListCopyJobsInput) SetByCreatedBefore added in v1.28.1

func (s *ListCopyJobsInput) SetByCreatedBefore(v time.Time) *ListCopyJobsInput

SetByCreatedBefore sets the ByCreatedBefore field's value.

func (*ListCopyJobsInput) SetByDestinationVaultArn added in v1.28.1

func (s *ListCopyJobsInput) SetByDestinationVaultArn(v string) *ListCopyJobsInput

SetByDestinationVaultArn sets the ByDestinationVaultArn field's value.

func (*ListCopyJobsInput) SetByResourceArn added in v1.28.1

func (s *ListCopyJobsInput) SetByResourceArn(v string) *ListCopyJobsInput

SetByResourceArn sets the ByResourceArn field's value.

func (*ListCopyJobsInput) SetByResourceType added in v1.28.1

func (s *ListCopyJobsInput) SetByResourceType(v string) *ListCopyJobsInput

SetByResourceType sets the ByResourceType field's value.

func (*ListCopyJobsInput) SetByState added in v1.28.1

func (s *ListCopyJobsInput) SetByState(v string) *ListCopyJobsInput

SetByState sets the ByState field's value.

func (*ListCopyJobsInput) SetMaxResults added in v1.28.1

func (s *ListCopyJobsInput) SetMaxResults(v int64) *ListCopyJobsInput

SetMaxResults sets the MaxResults field's value.

func (*ListCopyJobsInput) SetNextToken added in v1.28.1

func (s *ListCopyJobsInput) SetNextToken(v string) *ListCopyJobsInput

SetNextToken sets the NextToken field's value.

func (ListCopyJobsInput) String added in v1.28.1

func (s ListCopyJobsInput) String() string

String returns the string representation

func (*ListCopyJobsInput) Validate added in v1.28.1

func (s *ListCopyJobsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListCopyJobsOutput added in v1.28.1

type ListCopyJobsOutput struct {

	// An array of structures containing metadata about your copy jobs returned
	// in JSON format.
	CopyJobs []*CopyJob `type:"list"`

	// The next item following a partial list of returned items. For example, if
	// a request is made to return maxResults number of items, NextToken allows
	// you to return more items in your list starting at the location pointed to
	// by the next token.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListCopyJobsOutput) GoString added in v1.28.1

func (s ListCopyJobsOutput) GoString() string

GoString returns the string representation

func (*ListCopyJobsOutput) SetCopyJobs added in v1.28.1

func (s *ListCopyJobsOutput) SetCopyJobs(v []*CopyJob) *ListCopyJobsOutput

SetCopyJobs sets the CopyJobs field's value.

func (*ListCopyJobsOutput) SetNextToken added in v1.28.1

func (s *ListCopyJobsOutput) SetNextToken(v string) *ListCopyJobsOutput

SetNextToken sets the NextToken field's value.

func (ListCopyJobsOutput) String added in v1.28.1

func (s ListCopyJobsOutput) String() string

String returns the string representation

type ListProtectedResourcesInput

type ListProtectedResourcesInput struct {

	// The maximum number of items to be returned.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	// The next item following a partial list of returned items. For example, if
	// a request is made to return maxResults number of items, NextToken allows
	// you to return more items in your list starting at the location pointed to
	// by the next token.
	NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListProtectedResourcesInput) GoString

func (s ListProtectedResourcesInput) GoString() string

GoString returns the string representation

func (*ListProtectedResourcesInput) SetMaxResults

SetMaxResults sets the MaxResults field's value.

func (*ListProtectedResourcesInput) SetNextToken

SetNextToken sets the NextToken field's value.

func (ListProtectedResourcesInput) String

String returns the string representation

func (*ListProtectedResourcesInput) Validate

func (s *ListProtectedResourcesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListProtectedResourcesOutput

type ListProtectedResourcesOutput struct {

	// The next item following a partial list of returned items. For example, if
	// a request is made to return maxResults number of items, NextToken allows
	// you to return more items in your list starting at the location pointed to
	// by the next token.
	NextToken *string `type:"string"`

	// An array of resources successfully backed up by AWS Backup including the
	// time the resource was saved, an Amazon Resource Name (ARN) of the resource,
	// and a resource type.
	Results []*ProtectedResource `type:"list"`
	// contains filtered or unexported fields
}

func (ListProtectedResourcesOutput) GoString

func (s ListProtectedResourcesOutput) GoString() string

GoString returns the string representation

func (*ListProtectedResourcesOutput) SetNextToken

SetNextToken sets the NextToken field's value.

func (*ListProtectedResourcesOutput) SetResults

SetResults sets the Results field's value.

func (ListProtectedResourcesOutput) String

String returns the string representation

type ListRecoveryPointsByBackupVaultInput

type ListRecoveryPointsByBackupVaultInput 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.
	//
	// BackupVaultName is a required field
	BackupVaultName *string `location:"uri" locationName:"backupVaultName" type:"string" required:"true"`

	// Returns only recovery points that match the specified backup plan ID.
	ByBackupPlanId *string `location:"querystring" locationName:"backupPlanId" type:"string"`

	// Returns only recovery points that were created after the specified timestamp.
	ByCreatedAfter *time.Time `location:"querystring" locationName:"createdAfter" type:"timestamp"`

	// Returns only recovery points that were created before the specified timestamp.
	ByCreatedBefore *time.Time `location:"querystring" locationName:"createdBefore" type:"timestamp"`

	// Returns only recovery points that match the specified resource Amazon Resource
	// Name (ARN).
	ByResourceArn *string `location:"querystring" locationName:"resourceArn" type:"string"`

	// Returns only recovery points that match the specified resource type.
	ByResourceType *string `location:"querystring" locationName:"resourceType" type:"string"`

	// The maximum number of items to be returned.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	// The next item following a partial list of returned items. For example, if
	// a request is made to return maxResults number of items, NextToken allows
	// you to return more items in your list starting at the location pointed to
	// by the next token.
	NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListRecoveryPointsByBackupVaultInput) GoString

GoString returns the string representation

func (*ListRecoveryPointsByBackupVaultInput) SetBackupVaultName

SetBackupVaultName sets the BackupVaultName field's value.

func (*ListRecoveryPointsByBackupVaultInput) SetByBackupPlanId

SetByBackupPlanId sets the ByBackupPlanId field's value.

func (*ListRecoveryPointsByBackupVaultInput) SetByCreatedAfter

SetByCreatedAfter sets the ByCreatedAfter field's value.

func (*ListRecoveryPointsByBackupVaultInput) SetByCreatedBefore

SetByCreatedBefore sets the ByCreatedBefore field's value.

func (*ListRecoveryPointsByBackupVaultInput) SetByResourceArn

SetByResourceArn sets the ByResourceArn field's value.

func (*ListRecoveryPointsByBackupVaultInput) SetByResourceType

SetByResourceType sets the ByResourceType field's value.

func (*ListRecoveryPointsByBackupVaultInput) SetMaxResults

SetMaxResults sets the MaxResults field's value.

func (*ListRecoveryPointsByBackupVaultInput) SetNextToken

SetNextToken sets the NextToken field's value.

func (ListRecoveryPointsByBackupVaultInput) String

String returns the string representation

func (*ListRecoveryPointsByBackupVaultInput) Validate

Validate inspects the fields of the type to determine if they are valid.

type ListRecoveryPointsByBackupVaultOutput

type ListRecoveryPointsByBackupVaultOutput struct {

	// The next item following a partial list of returned items. For example, if
	// a request is made to return maxResults number of items, NextToken allows
	// you to return more items in your list starting at the location pointed to
	// by the next token.
	NextToken *string `type:"string"`

	// An array of objects that contain detailed information about recovery points
	// saved in a backup vault.
	RecoveryPoints []*RecoveryPointByBackupVault `type:"list"`
	// contains filtered or unexported fields
}

func (ListRecoveryPointsByBackupVaultOutput) GoString

GoString returns the string representation

func (*ListRecoveryPointsByBackupVaultOutput) SetNextToken

SetNextToken sets the NextToken field's value.

func (*ListRecoveryPointsByBackupVaultOutput) SetRecoveryPoints

SetRecoveryPoints sets the RecoveryPoints field's value.

func (ListRecoveryPointsByBackupVaultOutput) String

String returns the string representation

type ListRecoveryPointsByResourceInput

type ListRecoveryPointsByResourceInput struct {

	// The maximum number of items to be returned.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	// The next item following a partial list of returned items. For example, if
	// a request is made to return maxResults number of items, NextToken allows
	// you to return more items in your list starting at the location pointed to
	// by the next token.
	NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`

	// An ARN that uniquely identifies a resource. The format of the ARN depends
	// on the resource type.
	//
	// ResourceArn is a required field
	ResourceArn *string `location:"uri" locationName:"resourceArn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListRecoveryPointsByResourceInput) GoString

GoString returns the string representation

func (*ListRecoveryPointsByResourceInput) SetMaxResults

SetMaxResults sets the MaxResults field's value.

func (*ListRecoveryPointsByResourceInput) SetNextToken

SetNextToken sets the NextToken field's value.

func (*ListRecoveryPointsByResourceInput) SetResourceArn

SetResourceArn sets the ResourceArn field's value.

func (ListRecoveryPointsByResourceInput) String

String returns the string representation

func (*ListRecoveryPointsByResourceInput) Validate

Validate inspects the fields of the type to determine if they are valid.

type ListRecoveryPointsByResourceOutput

type ListRecoveryPointsByResourceOutput struct {

	// The next item following a partial list of returned items. For example, if
	// a request is made to return maxResults number of items, NextToken allows
	// you to return more items in your list starting at the location pointed to
	// by the next token.
	NextToken *string `type:"string"`

	// An array of objects that contain detailed information about recovery points
	// of the specified resource type.
	RecoveryPoints []*RecoveryPointByResource `type:"list"`
	// contains filtered or unexported fields
}

func (ListRecoveryPointsByResourceOutput) GoString

GoString returns the string representation

func (*ListRecoveryPointsByResourceOutput) SetNextToken

SetNextToken sets the NextToken field's value.

func (*ListRecoveryPointsByResourceOutput) SetRecoveryPoints

SetRecoveryPoints sets the RecoveryPoints field's value.

func (ListRecoveryPointsByResourceOutput) String

String returns the string representation

type ListRestoreJobsInput

type ListRestoreJobsInput struct {

	// The account ID to list the jobs from. Returns only restore jobs associated
	// with the specified account ID.
	ByAccountId *string `location:"querystring" locationName:"accountId" type:"string"`

	// Returns only restore jobs that were created after the specified date.
	ByCreatedAfter *time.Time `location:"querystring" locationName:"createdAfter" type:"timestamp"`

	// Returns only restore jobs that were created before the specified date.
	ByCreatedBefore *time.Time `location:"querystring" locationName:"createdBefore" type:"timestamp"`

	// Returns only restore jobs associated with the specified job status.
	ByStatus *string `location:"querystring" locationName:"status" type:"string" enum:"RestoreJobStatus"`

	// The maximum number of items to be returned.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	// The next item following a partial list of returned items. For example, if
	// a request is made to return maxResults number of items, NextToken allows
	// you to return more items in your list starting at the location pointed to
	// by the next token.
	NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListRestoreJobsInput) GoString

func (s ListRestoreJobsInput) GoString() string

GoString returns the string representation

func (*ListRestoreJobsInput) SetByAccountId added in v1.32.9

func (s *ListRestoreJobsInput) SetByAccountId(v string) *ListRestoreJobsInput

SetByAccountId sets the ByAccountId field's value.

func (*ListRestoreJobsInput) SetByCreatedAfter added in v1.32.9

func (s *ListRestoreJobsInput) SetByCreatedAfter(v time.Time) *ListRestoreJobsInput

SetByCreatedAfter sets the ByCreatedAfter field's value.

func (*ListRestoreJobsInput) SetByCreatedBefore added in v1.32.9

func (s *ListRestoreJobsInput) SetByCreatedBefore(v time.Time) *ListRestoreJobsInput

SetByCreatedBefore sets the ByCreatedBefore field's value.

func (*ListRestoreJobsInput) SetByStatus added in v1.32.9

SetByStatus sets the ByStatus field's value.

func (*ListRestoreJobsInput) SetMaxResults

func (s *ListRestoreJobsInput) SetMaxResults(v int64) *ListRestoreJobsInput

SetMaxResults sets the MaxResults field's value.

func (*ListRestoreJobsInput) SetNextToken

func (s *ListRestoreJobsInput) SetNextToken(v string) *ListRestoreJobsInput

SetNextToken sets the NextToken field's value.

func (ListRestoreJobsInput) String

func (s ListRestoreJobsInput) String() string

String returns the string representation

func (*ListRestoreJobsInput) Validate

func (s *ListRestoreJobsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListRestoreJobsOutput

type ListRestoreJobsOutput struct {

	// The next item following a partial list of returned items. For example, if
	// a request is made to return maxResults number of items, NextToken allows
	// you to return more items in your list starting at the location pointed to
	// by the next token.
	NextToken *string `type:"string"`

	// An array of objects that contain detailed information about jobs to restore
	// saved resources.
	RestoreJobs []*RestoreJobsListMember `type:"list"`
	// contains filtered or unexported fields
}

func (ListRestoreJobsOutput) GoString

func (s ListRestoreJobsOutput) GoString() string

GoString returns the string representation

func (*ListRestoreJobsOutput) SetNextToken

SetNextToken sets the NextToken field's value.

func (*ListRestoreJobsOutput) SetRestoreJobs

SetRestoreJobs sets the RestoreJobs field's value.

func (ListRestoreJobsOutput) String

func (s ListRestoreJobsOutput) String() string

String returns the string representation

type ListTagsInput

type ListTagsInput struct {

	// The maximum number of items to be returned.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	// The next item following a partial list of returned items. For example, if
	// a request is made to return maxResults number of items, NextToken allows
	// you to return more items in your list starting at the location pointed to
	// by the next token.
	NextToken *string `location:"querystring" locationName:"nextToken" type:"string"`

	// An Amazon Resource Name (ARN) that uniquely identifies a resource. The format
	// of the ARN depends on the type of resource. Valid targets for ListTags are
	// recovery points, backup plans, and backup vaults.
	//
	// ResourceArn is a required field
	ResourceArn *string `location:"uri" locationName:"resourceArn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListTagsInput) GoString

func (s ListTagsInput) GoString() string

GoString returns the string representation

func (*ListTagsInput) SetMaxResults

func (s *ListTagsInput) SetMaxResults(v int64) *ListTagsInput

SetMaxResults sets the MaxResults field's value.

func (*ListTagsInput) SetNextToken

func (s *ListTagsInput) SetNextToken(v string) *ListTagsInput

SetNextToken sets the NextToken field's value.

func (*ListTagsInput) SetResourceArn

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

SetResourceArn sets the ResourceArn field's value.

func (ListTagsInput) String

func (s ListTagsInput) String() string

String returns the string representation

func (*ListTagsInput) Validate

func (s *ListTagsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListTagsOutput

type ListTagsOutput struct {

	// The next item following a partial list of returned items. For example, if
	// a request is made to return maxResults number of items, NextToken allows
	// you to return more items in your list starting at the location pointed to
	// by the next token.
	NextToken *string `type:"string"`

	// To help organize your resources, you can assign your own metadata to the
	// resources you create. Each tag is a key-value pair.
	Tags map[string]*string `type:"map" sensitive:"true"`
	// contains filtered or unexported fields
}

func (ListTagsOutput) GoString

func (s ListTagsOutput) GoString() string

GoString returns the string representation

func (*ListTagsOutput) SetNextToken

func (s *ListTagsOutput) SetNextToken(v string) *ListTagsOutput

SetNextToken sets the NextToken field's value.

func (*ListTagsOutput) SetTags

func (s *ListTagsOutput) SetTags(v map[string]*string) *ListTagsOutput

SetTags sets the Tags field's value.

func (ListTagsOutput) String

func (s ListTagsOutput) String() string

String returns the string representation

type MissingParameterValueException added in v1.28.0

type MissingParameterValueException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Code_ *string `locationName:"Code" type:"string"`

	Context *string `type:"string"`

	Message_ *string `locationName:"Message" type:"string"`

	Type *string `type:"string"`
	// contains filtered or unexported fields
}

Indicates that a required parameter is missing.

func (*MissingParameterValueException) Code added in v1.28.0

Code returns the exception type name.

func (*MissingParameterValueException) Error added in v1.28.0

func (MissingParameterValueException) GoString added in v1.28.0

GoString returns the string representation

func (*MissingParameterValueException) Message added in v1.28.0

Message returns the exception's message.

func (*MissingParameterValueException) OrigErr added in v1.28.0

OrigErr always returns nil, satisfies awserr.Error interface.

func (*MissingParameterValueException) RequestID added in v1.28.0

func (s *MissingParameterValueException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*MissingParameterValueException) StatusCode added in v1.28.0

func (s *MissingParameterValueException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (MissingParameterValueException) String added in v1.28.0

String returns the string representation

type Plan

type Plan struct {

	// Contains a list of BackupOptions for each resource type.
	AdvancedBackupSettings []*AdvancedBackupSetting `type:"list"`

	// The display name of a backup plan.
	//
	// BackupPlanName is a required field
	BackupPlanName *string `type:"string" required:"true"`

	// An array of BackupRule objects, each of which specifies a scheduled task
	// that is used to back up a selection of resources.
	//
	// Rules is a required field
	Rules []*Rule `type:"list" required:"true"`
	// contains filtered or unexported fields
}

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.

func (Plan) GoString

func (s Plan) GoString() string

GoString returns the string representation

func (*Plan) SetAdvancedBackupSettings added in v1.34.30

func (s *Plan) SetAdvancedBackupSettings(v []*AdvancedBackupSetting) *Plan

SetAdvancedBackupSettings sets the AdvancedBackupSettings field's value.

func (*Plan) SetBackupPlanName

func (s *Plan) SetBackupPlanName(v string) *Plan

SetBackupPlanName sets the BackupPlanName field's value.

func (*Plan) SetRules

func (s *Plan) SetRules(v []*Rule) *Plan

SetRules sets the Rules field's value.

func (Plan) String

func (s Plan) String() string

String returns the string representation

type PlanInput

type PlanInput struct {

	// Specifies a list of BackupOptions for each resource type. These settings
	// are only available for Windows VSS backup jobs.
	AdvancedBackupSettings []*AdvancedBackupSetting `type:"list"`

	// The optional display name of a backup plan.
	//
	// BackupPlanName is a required field
	BackupPlanName *string `type:"string" required:"true"`

	// An array of BackupRule objects, each of which specifies a scheduled task
	// that is used to back up a selection of resources.
	//
	// Rules is a required field
	Rules []*RuleInput `type:"list" required:"true"`
	// contains filtered or unexported fields
}

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.

func (PlanInput) GoString

func (s PlanInput) GoString() string

GoString returns the string representation

func (*PlanInput) SetAdvancedBackupSettings added in v1.34.30

func (s *PlanInput) SetAdvancedBackupSettings(v []*AdvancedBackupSetting) *PlanInput

SetAdvancedBackupSettings sets the AdvancedBackupSettings field's value.

func (*PlanInput) SetBackupPlanName

func (s *PlanInput) SetBackupPlanName(v string) *PlanInput

SetBackupPlanName sets the BackupPlanName field's value.

func (*PlanInput) SetRules

func (s *PlanInput) SetRules(v []*RuleInput) *PlanInput

SetRules sets the Rules field's value.

func (PlanInput) String

func (s PlanInput) String() string

String returns the string representation

func (*PlanInput) Validate

func (s *PlanInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PlanTemplatesListMember

type PlanTemplatesListMember struct {

	// Uniquely identifies a stored backup plan template.
	BackupPlanTemplateId *string `type:"string"`

	// The optional display name of a backup plan template.
	BackupPlanTemplateName *string `type:"string"`
	// contains filtered or unexported fields
}

An object specifying metadata associated with a backup plan template.

func (PlanTemplatesListMember) GoString

func (s PlanTemplatesListMember) GoString() string

GoString returns the string representation

func (*PlanTemplatesListMember) SetBackupPlanTemplateId

func (s *PlanTemplatesListMember) SetBackupPlanTemplateId(v string) *PlanTemplatesListMember

SetBackupPlanTemplateId sets the BackupPlanTemplateId field's value.

func (*PlanTemplatesListMember) SetBackupPlanTemplateName

func (s *PlanTemplatesListMember) SetBackupPlanTemplateName(v string) *PlanTemplatesListMember

SetBackupPlanTemplateName sets the BackupPlanTemplateName field's value.

func (PlanTemplatesListMember) String

func (s PlanTemplatesListMember) String() string

String returns the string representation

type PlansListMember

type PlansListMember struct {

	// Contains a list of BackupOptions for a resource type.
	AdvancedBackupSettings []*AdvancedBackupSetting `type:"list"`

	// 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 `type:"string"`

	// Uniquely identifies a backup plan.
	BackupPlanId *string `type:"string"`

	// The display name of a saved backup plan.
	BackupPlanName *string `type:"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 `type:"timestamp"`

	// A unique string that identifies the request and allows failed requests to
	// be retried without the risk of running the operation twice.
	CreatorRequestId *string `type:"string"`

	// 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 `type:"timestamp"`

	// The last time a job to back up resources was run 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 `type:"timestamp"`

	// Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most
	// 1,024 bytes long. Version IDs cannot be edited.
	VersionId *string `type:"string"`
	// contains filtered or unexported fields
}

Contains metadata about a backup plan.

func (PlansListMember) GoString

func (s PlansListMember) GoString() string

GoString returns the string representation

func (*PlansListMember) SetAdvancedBackupSettings added in v1.34.30

func (s *PlansListMember) SetAdvancedBackupSettings(v []*AdvancedBackupSetting) *PlansListMember

SetAdvancedBackupSettings sets the AdvancedBackupSettings field's value.

func (*PlansListMember) SetBackupPlanArn

func (s *PlansListMember) SetBackupPlanArn(v string) *PlansListMember

SetBackupPlanArn sets the BackupPlanArn field's value.

func (*PlansListMember) SetBackupPlanId

func (s *PlansListMember) SetBackupPlanId(v string) *PlansListMember

SetBackupPlanId sets the BackupPlanId field's value.

func (*PlansListMember) SetBackupPlanName

func (s *PlansListMember) SetBackupPlanName(v string) *PlansListMember

SetBackupPlanName sets the BackupPlanName field's value.

func (*PlansListMember) SetCreationDate

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

SetCreationDate sets the CreationDate field's value.

func (*PlansListMember) SetCreatorRequestId

func (s *PlansListMember) SetCreatorRequestId(v string) *PlansListMember

SetCreatorRequestId sets the CreatorRequestId field's value.

func (*PlansListMember) SetDeletionDate

func (s *PlansListMember) SetDeletionDate(v time.Time) *PlansListMember

SetDeletionDate sets the DeletionDate field's value.

func (*PlansListMember) SetLastExecutionDate

func (s *PlansListMember) SetLastExecutionDate(v time.Time) *PlansListMember

SetLastExecutionDate sets the LastExecutionDate field's value.

func (*PlansListMember) SetVersionId

func (s *PlansListMember) SetVersionId(v string) *PlansListMember

SetVersionId sets the VersionId field's value.

func (PlansListMember) String

func (s PlansListMember) String() string

String returns the string representation

type ProtectedResource

type ProtectedResource struct {

	// 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 `type:"timestamp"`

	// An Amazon Resource Name (ARN) that uniquely identifies a resource. The format
	// of the ARN depends on the resource type.
	ResourceArn *string `type:"string"`

	// The type of AWS resource; 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.
	ResourceType *string `type:"string"`
	// contains filtered or unexported fields
}

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

func (ProtectedResource) GoString

func (s ProtectedResource) GoString() string

GoString returns the string representation

func (*ProtectedResource) SetLastBackupTime

func (s *ProtectedResource) SetLastBackupTime(v time.Time) *ProtectedResource

SetLastBackupTime sets the LastBackupTime field's value.

func (*ProtectedResource) SetResourceArn

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

SetResourceArn sets the ResourceArn field's value.

func (*ProtectedResource) SetResourceType

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

SetResourceType sets the ResourceType field's value.

func (ProtectedResource) String

func (s ProtectedResource) String() string

String returns the string representation

type PutBackupVaultAccessPolicyInput

type PutBackupVaultAccessPolicyInput 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.
	//
	// BackupVaultName is a required field
	BackupVaultName *string `location:"uri" locationName:"backupVaultName" type:"string" required:"true"`

	// The backup vault access policy document in JSON format.
	Policy *string `type:"string"`
	// contains filtered or unexported fields
}

func (PutBackupVaultAccessPolicyInput) GoString

GoString returns the string representation

func (*PutBackupVaultAccessPolicyInput) SetBackupVaultName

SetBackupVaultName sets the BackupVaultName field's value.

func (*PutBackupVaultAccessPolicyInput) SetPolicy

SetPolicy sets the Policy field's value.

func (PutBackupVaultAccessPolicyInput) String

String returns the string representation

func (*PutBackupVaultAccessPolicyInput) Validate

func (s *PutBackupVaultAccessPolicyInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PutBackupVaultAccessPolicyOutput

type PutBackupVaultAccessPolicyOutput struct {
	// contains filtered or unexported fields
}

func (PutBackupVaultAccessPolicyOutput) GoString

GoString returns the string representation

func (PutBackupVaultAccessPolicyOutput) String

String returns the string representation

type PutBackupVaultNotificationsInput

type PutBackupVaultNotificationsInput struct {

	// An array of events that indicate the status of jobs to back up resources
	// to the backup vault.
	//
	// BackupVaultEvents is a required field
	BackupVaultEvents []*string `type:"list" required:"true"`

	// 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 is a required field
	BackupVaultName *string `location:"uri" locationName:"backupVaultName" type:"string" required:"true"`

	// The Amazon Resource Name (ARN) that specifies the topic for a backup vault’s
	// events; for example, arn:aws:sns:us-west-2:111122223333:MyVaultTopic.
	//
	// SNSTopicArn is a required field
	SNSTopicArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (PutBackupVaultNotificationsInput) GoString

GoString returns the string representation

func (*PutBackupVaultNotificationsInput) SetBackupVaultEvents

SetBackupVaultEvents sets the BackupVaultEvents field's value.

func (*PutBackupVaultNotificationsInput) SetBackupVaultName

SetBackupVaultName sets the BackupVaultName field's value.

func (*PutBackupVaultNotificationsInput) SetSNSTopicArn

SetSNSTopicArn sets the SNSTopicArn field's value.

func (PutBackupVaultNotificationsInput) String

String returns the string representation

func (*PutBackupVaultNotificationsInput) Validate

Validate inspects the fields of the type to determine if they are valid.

type PutBackupVaultNotificationsOutput

type PutBackupVaultNotificationsOutput struct {
	// contains filtered or unexported fields
}

func (PutBackupVaultNotificationsOutput) GoString

GoString returns the string representation

func (PutBackupVaultNotificationsOutput) String

String returns the string representation

type RecoveryPointByBackupVault

type RecoveryPointByBackupVault struct {

	// The size, in bytes, of a backup.
	BackupSizeInBytes *int64 `type:"long"`

	// An ARN that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
	BackupVaultArn *string `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.
	BackupVaultName *string `type:"string"`

	// A CalculatedLifecycle object containing DeleteAt and MoveToColdStorageAt
	// timestamps.
	CalculatedLifecycle *CalculatedLifecycle `type:"structure"`

	// 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 `type:"timestamp"`

	// 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 `type:"structure"`

	// 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 `type:"timestamp"`

	// 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 `type:"string"`

	// Specifies the IAM role ARN used to create the target recovery point; for
	// example, arn:aws:iam::123456789012:role/S3Access.
	IamRoleArn *string `type:"string"`

	// 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 `type:"boolean"`

	// 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 `type:"timestamp"`

	// 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.
	//
	// Only Amazon EFS file system backups can be transitioned to cold storage.
	Lifecycle *Lifecycle `type:"structure"`

	// 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 `type:"string"`

	// An ARN that uniquely identifies a resource. The format of the ARN depends
	// on the resource type.
	ResourceArn *string `type:"string"`

	// 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. For VSS Windows backups, the only supported
	// resource type is Amazon EC2.
	ResourceType *string `type:"string"`

	// The backup vault where the recovery point was originally copied from. If
	// the recovery point is restored to the same account this value will be null.
	SourceBackupVaultArn *string `type:"string"`

	// A status code specifying the state of the recovery point.
	Status *string `type:"string" enum:"RecoveryPointStatus"`
	// contains filtered or unexported fields
}

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

func (RecoveryPointByBackupVault) GoString

func (s RecoveryPointByBackupVault) GoString() string

GoString returns the string representation

func (*RecoveryPointByBackupVault) SetBackupSizeInBytes

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

SetBackupSizeInBytes sets the BackupSizeInBytes field's value.

func (*RecoveryPointByBackupVault) SetBackupVaultArn

SetBackupVaultArn sets the BackupVaultArn field's value.

func (*RecoveryPointByBackupVault) SetBackupVaultName

SetBackupVaultName sets the BackupVaultName field's value.

func (*RecoveryPointByBackupVault) SetCalculatedLifecycle

SetCalculatedLifecycle sets the CalculatedLifecycle field's value.

func (*RecoveryPointByBackupVault) SetCompletionDate

SetCompletionDate sets the CompletionDate field's value.

func (*RecoveryPointByBackupVault) SetCreatedBy

SetCreatedBy sets the CreatedBy field's value.

func (*RecoveryPointByBackupVault) SetCreationDate

SetCreationDate sets the CreationDate field's value.

func (*RecoveryPointByBackupVault) SetEncryptionKeyArn

SetEncryptionKeyArn sets the EncryptionKeyArn field's value.

func (*RecoveryPointByBackupVault) SetIamRoleArn

SetIamRoleArn sets the IamRoleArn field's value.

func (*RecoveryPointByBackupVault) SetIsEncrypted

SetIsEncrypted sets the IsEncrypted field's value.

func (*RecoveryPointByBackupVault) SetLastRestoreTime

SetLastRestoreTime sets the LastRestoreTime field's value.

func (*RecoveryPointByBackupVault) SetLifecycle

SetLifecycle sets the Lifecycle field's value.

func (*RecoveryPointByBackupVault) SetRecoveryPointArn

SetRecoveryPointArn sets the RecoveryPointArn field's value.

func (*RecoveryPointByBackupVault) SetResourceArn

SetResourceArn sets the ResourceArn field's value.

func (*RecoveryPointByBackupVault) SetResourceType

SetResourceType sets the ResourceType field's value.

func (*RecoveryPointByBackupVault) SetSourceBackupVaultArn added in v1.35.31

func (s *RecoveryPointByBackupVault) SetSourceBackupVaultArn(v string) *RecoveryPointByBackupVault

SetSourceBackupVaultArn sets the SourceBackupVaultArn field's value.

func (*RecoveryPointByBackupVault) SetStatus

SetStatus sets the Status field's value.

func (RecoveryPointByBackupVault) String

String returns the string representation

type RecoveryPointByResource

type RecoveryPointByResource struct {

	// The size, in bytes, of a backup.
	BackupSizeBytes *int64 `type:"long"`

	// 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 `type:"string"`

	// 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 `type:"timestamp"`

	// 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 `type:"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 `type:"string"`

	// A status code specifying the state of the recovery point.
	Status *string `type:"string" enum:"RecoveryPointStatus"`
	// contains filtered or unexported fields
}

Contains detailed information about a saved recovery point.

func (RecoveryPointByResource) GoString

func (s RecoveryPointByResource) GoString() string

GoString returns the string representation

func (*RecoveryPointByResource) SetBackupSizeBytes

func (s *RecoveryPointByResource) SetBackupSizeBytes(v int64) *RecoveryPointByResource

SetBackupSizeBytes sets the BackupSizeBytes field's value.

func (*RecoveryPointByResource) SetBackupVaultName

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

SetBackupVaultName sets the BackupVaultName field's value.

func (*RecoveryPointByResource) SetCreationDate

SetCreationDate sets the CreationDate field's value.

func (*RecoveryPointByResource) SetEncryptionKeyArn

func (s *RecoveryPointByResource) SetEncryptionKeyArn(v string) *RecoveryPointByResource

SetEncryptionKeyArn sets the EncryptionKeyArn field's value.

func (*RecoveryPointByResource) SetRecoveryPointArn

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

SetRecoveryPointArn sets the RecoveryPointArn field's value.

func (*RecoveryPointByResource) SetStatus

SetStatus sets the Status field's value.

func (RecoveryPointByResource) String

func (s RecoveryPointByResource) String() string

String returns the string representation

type RecoveryPointCreator

type RecoveryPointCreator struct {

	// 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 `type:"string"`

	// Uniquely identifies a backup plan.
	BackupPlanId *string `type:"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 `type:"string"`

	// Uniquely identifies a rule used to schedule the backup of a selection of
	// resources.
	BackupRuleId *string `type:"string"`
	// contains filtered or unexported fields
}

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

func (RecoveryPointCreator) GoString

func (s RecoveryPointCreator) GoString() string

GoString returns the string representation

func (*RecoveryPointCreator) SetBackupPlanArn

func (s *RecoveryPointCreator) SetBackupPlanArn(v string) *RecoveryPointCreator

SetBackupPlanArn sets the BackupPlanArn field's value.

func (*RecoveryPointCreator) SetBackupPlanId

func (s *RecoveryPointCreator) SetBackupPlanId(v string) *RecoveryPointCreator

SetBackupPlanId sets the BackupPlanId field's value.

func (*RecoveryPointCreator) SetBackupPlanVersion

func (s *RecoveryPointCreator) SetBackupPlanVersion(v string) *RecoveryPointCreator

SetBackupPlanVersion sets the BackupPlanVersion field's value.

func (*RecoveryPointCreator) SetBackupRuleId

func (s *RecoveryPointCreator) SetBackupRuleId(v string) *RecoveryPointCreator

SetBackupRuleId sets the BackupRuleId field's value.

func (RecoveryPointCreator) String

func (s RecoveryPointCreator) String() string

String returns the string representation

type ResourceNotFoundException added in v1.28.0

type ResourceNotFoundException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Code_ *string `locationName:"Code" type:"string"`

	Context *string `type:"string"`

	Message_ *string `locationName:"Message" type:"string"`

	Type *string `type:"string"`
	// contains filtered or unexported fields
}

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

func (*ResourceNotFoundException) Code added in v1.28.0

Code returns the exception type name.

func (*ResourceNotFoundException) Error added in v1.28.0

func (s *ResourceNotFoundException) Error() string

func (ResourceNotFoundException) GoString added in v1.28.0

func (s ResourceNotFoundException) GoString() string

GoString returns the string representation

func (*ResourceNotFoundException) Message added in v1.28.0

func (s *ResourceNotFoundException) Message() string

Message returns the exception's message.

func (*ResourceNotFoundException) OrigErr added in v1.28.0

func (s *ResourceNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceNotFoundException) RequestID added in v1.28.0

func (s *ResourceNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceNotFoundException) StatusCode added in v1.28.0

func (s *ResourceNotFoundException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ResourceNotFoundException) String added in v1.28.0

func (s ResourceNotFoundException) String() string

String returns the string representation

type RestoreJobsListMember

type RestoreJobsListMember struct {

	// The account ID that owns the restore job.
	AccountId *string `type:"string"`

	// The size, in bytes, of the restored resource.
	BackupSizeInBytes *int64 `type:"long"`

	// 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 `type:"timestamp"`

	// An Amazon Resource Name (ARN) that uniquely identifies a resource. The format
	// of the ARN depends on the resource type.
	CreatedResourceArn *string `type:"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 `type:"timestamp"`

	// The amount of time in minutes that a job restoring a recovery point is expected
	// to take.
	ExpectedCompletionTimeMinutes *int64 `type:"long"`

	// Specifies the IAM role ARN used to create the target recovery point; for
	// example, arn:aws:iam::123456789012:role/S3Access.
	IamRoleArn *string `type:"string"`

	// Contains an estimated percentage complete of a job at the time the job status
	// was queried.
	PercentDone *string `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.
	RecoveryPointArn *string `type:"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. For VSS Windows backups, the only supported resource
	// type is Amazon EC2.
	ResourceType *string `type:"string"`

	// Uniquely identifies the job that restores a recovery point.
	RestoreJobId *string `type:"string"`

	// A status code specifying the state of the job initiated by AWS Backup to
	// restore a recovery point.
	Status *string `type:"string" enum:"RestoreJobStatus"`

	// A detailed message explaining the status of the job to restore a recovery
	// point.
	StatusMessage *string `type:"string"`
	// contains filtered or unexported fields
}

Contains metadata about a restore job.

func (RestoreJobsListMember) GoString

func (s RestoreJobsListMember) GoString() string

GoString returns the string representation

func (*RestoreJobsListMember) SetAccountId added in v1.32.9

SetAccountId sets the AccountId field's value.

func (*RestoreJobsListMember) SetBackupSizeInBytes

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

SetBackupSizeInBytes sets the BackupSizeInBytes field's value.

func (*RestoreJobsListMember) SetCompletionDate

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

SetCompletionDate sets the CompletionDate field's value.

func (*RestoreJobsListMember) SetCreatedResourceArn

func (s *RestoreJobsListMember) SetCreatedResourceArn(v string) *RestoreJobsListMember

SetCreatedResourceArn sets the CreatedResourceArn field's value.

func (*RestoreJobsListMember) SetCreationDate

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

SetCreationDate sets the CreationDate field's value.

func (*RestoreJobsListMember) SetExpectedCompletionTimeMinutes

func (s *RestoreJobsListMember) SetExpectedCompletionTimeMinutes(v int64) *RestoreJobsListMember

SetExpectedCompletionTimeMinutes sets the ExpectedCompletionTimeMinutes field's value.

func (*RestoreJobsListMember) SetIamRoleArn

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

SetIamRoleArn sets the IamRoleArn field's value.

func (*RestoreJobsListMember) SetPercentDone

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

SetPercentDone sets the PercentDone field's value.

func (*RestoreJobsListMember) SetRecoveryPointArn

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

SetRecoveryPointArn sets the RecoveryPointArn field's value.

func (*RestoreJobsListMember) SetResourceType added in v1.32.9

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

SetResourceType sets the ResourceType field's value.

func (*RestoreJobsListMember) SetRestoreJobId

func (s *RestoreJobsListMember) SetRestoreJobId(v string) *RestoreJobsListMember

SetRestoreJobId sets the RestoreJobId field's value.

func (*RestoreJobsListMember) SetStatus

SetStatus sets the Status field's value.

func (*RestoreJobsListMember) SetStatusMessage

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

SetStatusMessage sets the StatusMessage field's value.

func (RestoreJobsListMember) String

func (s RestoreJobsListMember) String() string

String returns the string representation

type Rule

type Rule struct {

	// 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 `type:"long"`

	// An array of CopyAction objects, which contains the details of the copy operation.
	CopyActions []*CopyAction `type:"list"`

	// Specifies whether AWS Backup creates continuous backups. True causes AWS
	// Backup to create continuous backups capable of point-in-time restore (PITR).
	// False (or not specified) causes AWS Backup to create snapshot backups.
	EnableContinuousBackup *bool `type:"boolean"`

	// 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.
	//
	// Only Amazon EFS file system backups can be transitioned to cold storage.
	Lifecycle *Lifecycle `type:"structure"`

	// 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 `type:"map" sensitive:"true"`

	// Uniquely identifies a rule that is used to schedule the backup of a selection
	// of resources.
	RuleId *string `type:"string"`

	// An optional display name for a backup rule.
	//
	// RuleName is a required field
	RuleName *string `type:"string" required:"true"`

	// A CRON expression specifying when AWS Backup initiates a backup job. For
	// more information about cron expressions, see Schedule Expressions for Rules
	// (https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/ScheduledEvents.html)
	// in the Amazon CloudWatch Events User Guide.. Prior to specifying a value
	// for this parameter, we recommend testing your cron expression using one of
	// the many available cron generator and testing tools.
	ScheduleExpression *string `type:"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 `type:"long"`

	// 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 is a required field
	TargetBackupVaultName *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

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

func (Rule) GoString

func (s Rule) GoString() string

GoString returns the string representation

func (*Rule) SetCompletionWindowMinutes

func (s *Rule) SetCompletionWindowMinutes(v int64) *Rule

SetCompletionWindowMinutes sets the CompletionWindowMinutes field's value.

func (*Rule) SetCopyActions added in v1.28.1

func (s *Rule) SetCopyActions(v []*CopyAction) *Rule

SetCopyActions sets the CopyActions field's value.

func (*Rule) SetEnableContinuousBackup added in v1.37.28

func (s *Rule) SetEnableContinuousBackup(v bool) *Rule

SetEnableContinuousBackup sets the EnableContinuousBackup field's value.

func (*Rule) SetLifecycle

func (s *Rule) SetLifecycle(v *Lifecycle) *Rule

SetLifecycle sets the Lifecycle field's value.

func (*Rule) SetRecoveryPointTags

func (s *Rule) SetRecoveryPointTags(v map[string]*string) *Rule

SetRecoveryPointTags sets the RecoveryPointTags field's value.

func (*Rule) SetRuleId

func (s *Rule) SetRuleId(v string) *Rule

SetRuleId sets the RuleId field's value.

func (*Rule) SetRuleName

func (s *Rule) SetRuleName(v string) *Rule

SetRuleName sets the RuleName field's value.

func (*Rule) SetScheduleExpression

func (s *Rule) SetScheduleExpression(v string) *Rule

SetScheduleExpression sets the ScheduleExpression field's value.

func (*Rule) SetStartWindowMinutes

func (s *Rule) SetStartWindowMinutes(v int64) *Rule

SetStartWindowMinutes sets the StartWindowMinutes field's value.

func (*Rule) SetTargetBackupVaultName

func (s *Rule) SetTargetBackupVaultName(v string) *Rule

SetTargetBackupVaultName sets the TargetBackupVaultName field's value.

func (Rule) String

func (s Rule) String() string

String returns the string representation

type RuleInput

type RuleInput struct {

	// 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 `type:"long"`

	// An array of CopyAction objects, which contains the details of the copy operation.
	CopyActions []*CopyAction `type:"list"`

	// Specifies whether AWS Backup creates continuous backups. True causes AWS
	// Backup to create continuous backups capable of point-in-time restore (PITR).
	// False (or not specified) causes AWS Backup to create snapshot backups.
	EnableContinuousBackup *bool `type:"boolean"`

	// 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.
	//
	// Only Amazon EFS file system backups can be transitioned to cold storage.
	Lifecycle *Lifecycle `type:"structure"`

	// 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 `type:"map" sensitive:"true"`

	// An optional display name for a backup rule.
	//
	// RuleName is a required field
	RuleName *string `type:"string" required:"true"`

	// A CRON expression specifying when AWS Backup initiates a backup job.
	ScheduleExpression *string `type:"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 `type:"long"`

	// 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 is a required field
	TargetBackupVaultName *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

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

func (RuleInput) GoString

func (s RuleInput) GoString() string

GoString returns the string representation

func (*RuleInput) SetCompletionWindowMinutes

func (s *RuleInput) SetCompletionWindowMinutes(v int64) *RuleInput

SetCompletionWindowMinutes sets the CompletionWindowMinutes field's value.

func (*RuleInput) SetCopyActions added in v1.28.1

func (s *RuleInput) SetCopyActions(v []*CopyAction) *RuleInput

SetCopyActions sets the CopyActions field's value.

func (*RuleInput) SetEnableContinuousBackup added in v1.37.28

func (s *RuleInput) SetEnableContinuousBackup(v bool) *RuleInput

SetEnableContinuousBackup sets the EnableContinuousBackup field's value.

func (*RuleInput) SetLifecycle

func (s *RuleInput) SetLifecycle(v *Lifecycle) *RuleInput

SetLifecycle sets the Lifecycle field's value.

func (*RuleInput) SetRecoveryPointTags

func (s *RuleInput) SetRecoveryPointTags(v map[string]*string) *RuleInput

SetRecoveryPointTags sets the RecoveryPointTags field's value.

func (*RuleInput) SetRuleName

func (s *RuleInput) SetRuleName(v string) *RuleInput

SetRuleName sets the RuleName field's value.

func (*RuleInput) SetScheduleExpression

func (s *RuleInput) SetScheduleExpression(v string) *RuleInput

SetScheduleExpression sets the ScheduleExpression field's value.

func (*RuleInput) SetStartWindowMinutes

func (s *RuleInput) SetStartWindowMinutes(v int64) *RuleInput

SetStartWindowMinutes sets the StartWindowMinutes field's value.

func (*RuleInput) SetTargetBackupVaultName

func (s *RuleInput) SetTargetBackupVaultName(v string) *RuleInput

SetTargetBackupVaultName sets the TargetBackupVaultName field's value.

func (RuleInput) String

func (s RuleInput) String() string

String returns the string representation

func (*RuleInput) Validate

func (s *RuleInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type Selection

type Selection struct {

	// The ARN of the IAM role that AWS Backup uses to authenticate when backing
	// up the target resource; for example, arn:aws:iam::123456789012:role/S3Access.
	//
	// IamRoleArn is a required field
	IamRoleArn *string `type:"string" required:"true"`

	// An array of conditions used to specify a set of resources to assign to a
	// backup plan; for example, "StringEquals": {"ec2:ResourceTag/Department":
	// "accounting". Assigns the backup plan to every resource with at least one
	// matching tag.
	ListOfTags []*Condition `type:"list"`

	// An array of strings that contain Amazon Resource Names (ARNs) of resources
	// to assign to a backup plan.
	Resources []*string `type:"list"`

	// The display name of a resource selection document.
	//
	// SelectionName is a required field
	SelectionName *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

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

func (Selection) GoString

func (s Selection) GoString() string

GoString returns the string representation

func (*Selection) SetIamRoleArn

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

SetIamRoleArn sets the IamRoleArn field's value.

func (*Selection) SetListOfTags

func (s *Selection) SetListOfTags(v []*Condition) *Selection

SetListOfTags sets the ListOfTags field's value.

func (*Selection) SetResources

func (s *Selection) SetResources(v []*string) *Selection

SetResources sets the Resources field's value.

func (*Selection) SetSelectionName

func (s *Selection) SetSelectionName(v string) *Selection

SetSelectionName sets the SelectionName field's value.

func (Selection) String

func (s Selection) String() string

String returns the string representation

func (*Selection) Validate

func (s *Selection) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type SelectionsListMember

type SelectionsListMember struct {

	// Uniquely identifies a backup plan.
	BackupPlanId *string `type:"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 `type:"timestamp"`

	// A unique string that identifies the request and allows failed requests to
	// be retried without the risk of running the operation twice.
	CreatorRequestId *string `type:"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 `type:"string"`

	// Uniquely identifies a request to assign a set of resources to a backup plan.
	SelectionId *string `type:"string"`

	// The display name of a resource selection document.
	SelectionName *string `type:"string"`
	// contains filtered or unexported fields
}

Contains metadata about a BackupSelection object.

func (SelectionsListMember) GoString

func (s SelectionsListMember) GoString() string

GoString returns the string representation

func (*SelectionsListMember) SetBackupPlanId

func (s *SelectionsListMember) SetBackupPlanId(v string) *SelectionsListMember

SetBackupPlanId sets the BackupPlanId field's value.

func (*SelectionsListMember) SetCreationDate

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

SetCreationDate sets the CreationDate field's value.

func (*SelectionsListMember) SetCreatorRequestId

func (s *SelectionsListMember) SetCreatorRequestId(v string) *SelectionsListMember

SetCreatorRequestId sets the CreatorRequestId field's value.

func (*SelectionsListMember) SetIamRoleArn

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

SetIamRoleArn sets the IamRoleArn field's value.

func (*SelectionsListMember) SetSelectionId

func (s *SelectionsListMember) SetSelectionId(v string) *SelectionsListMember

SetSelectionId sets the SelectionId field's value.

func (*SelectionsListMember) SetSelectionName

func (s *SelectionsListMember) SetSelectionName(v string) *SelectionsListMember

SetSelectionName sets the SelectionName field's value.

func (SelectionsListMember) String

func (s SelectionsListMember) String() string

String returns the string representation

type ServiceUnavailableException added in v1.28.0

type ServiceUnavailableException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Code_ *string `locationName:"Code" type:"string"`

	Context *string `type:"string"`

	Message_ *string `locationName:"Message" type:"string"`

	Type *string `type:"string"`
	// contains filtered or unexported fields
}

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

func (*ServiceUnavailableException) Code added in v1.28.0

Code returns the exception type name.

func (*ServiceUnavailableException) Error added in v1.28.0

func (ServiceUnavailableException) GoString added in v1.28.0

func (s ServiceUnavailableException) GoString() string

GoString returns the string representation

func (*ServiceUnavailableException) Message added in v1.28.0

func (s *ServiceUnavailableException) Message() string

Message returns the exception's message.

func (*ServiceUnavailableException) OrigErr added in v1.28.0

func (s *ServiceUnavailableException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ServiceUnavailableException) RequestID added in v1.28.0

func (s *ServiceUnavailableException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ServiceUnavailableException) StatusCode added in v1.28.0

func (s *ServiceUnavailableException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ServiceUnavailableException) String added in v1.28.0

String returns the string representation

type StartBackupJobInput

type StartBackupJobInput struct {

	// 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. The WindowsVSS option is not enabled by default.
	BackupOptions map[string]*string `type:"map"`

	// 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 is a required field
	BackupVaultName *string `type:"string" required:"true"`

	// A value in minutes during which a successfully started backup must complete,
	// or else AWS Backup will cancel the job. This value is optional. This value
	// begins counting down from when the backup was scheduled. It does not add
	// additional time for StartWindowMinutes, or if the backup started later than
	// scheduled.
	CompleteWindowMinutes *int64 `type:"long"`

	// Specifies the IAM role ARN used to create the target recovery point; for
	// example, arn:aws:iam::123456789012:role/S3Access.
	//
	// IamRoleArn is a required field
	IamRoleArn *string `type:"string" required:"true"`

	// A customer chosen string that can be used to distinguish between calls to
	// StartBackupJob.
	IdempotencyToken *string `type:"string"`

	// 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.
	//
	// Only Amazon EFS file system backups can be transitioned to cold storage.
	Lifecycle *Lifecycle `type:"structure"`

	// 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 `type:"map" sensitive:"true"`

	// An Amazon Resource Name (ARN) that uniquely identifies a resource. The format
	// of the ARN depends on the resource type.
	//
	// ResourceArn is a required field
	ResourceArn *string `type:"string" required:"true"`

	// 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, and the default
	// is 8 hours.
	StartWindowMinutes *int64 `type:"long"`
	// contains filtered or unexported fields
}

func (StartBackupJobInput) GoString

func (s StartBackupJobInput) GoString() string

GoString returns the string representation

func (*StartBackupJobInput) SetBackupOptions added in v1.34.30

func (s *StartBackupJobInput) SetBackupOptions(v map[string]*string) *StartBackupJobInput

SetBackupOptions sets the BackupOptions field's value.

func (*StartBackupJobInput) SetBackupVaultName

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

SetBackupVaultName sets the BackupVaultName field's value.

func (*StartBackupJobInput) SetCompleteWindowMinutes

func (s *StartBackupJobInput) SetCompleteWindowMinutes(v int64) *StartBackupJobInput

SetCompleteWindowMinutes sets the CompleteWindowMinutes field's value.

func (*StartBackupJobInput) SetIamRoleArn

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

SetIamRoleArn sets the IamRoleArn field's value.

func (*StartBackupJobInput) SetIdempotencyToken

func (s *StartBackupJobInput) SetIdempotencyToken(v string) *StartBackupJobInput

SetIdempotencyToken sets the IdempotencyToken field's value.

func (*StartBackupJobInput) SetLifecycle

func (s *StartBackupJobInput) SetLifecycle(v *Lifecycle) *StartBackupJobInput

SetLifecycle sets the Lifecycle field's value.

func (*StartBackupJobInput) SetRecoveryPointTags

func (s *StartBackupJobInput) SetRecoveryPointTags(v map[string]*string) *StartBackupJobInput

SetRecoveryPointTags sets the RecoveryPointTags field's value.

func (*StartBackupJobInput) SetResourceArn

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

SetResourceArn sets the ResourceArn field's value.

func (*StartBackupJobInput) SetStartWindowMinutes

func (s *StartBackupJobInput) SetStartWindowMinutes(v int64) *StartBackupJobInput

SetStartWindowMinutes sets the StartWindowMinutes field's value.

func (StartBackupJobInput) String

func (s StartBackupJobInput) String() string

String returns the string representation

func (*StartBackupJobInput) Validate

func (s *StartBackupJobInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StartBackupJobOutput

type StartBackupJobOutput struct {

	// Uniquely identifies a request to AWS Backup to back up a resource.
	BackupJobId *string `type:"string"`

	// 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.
	CreationDate *time.Time `type:"timestamp"`

	// 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 `type:"string"`
	// contains filtered or unexported fields
}

func (StartBackupJobOutput) GoString

func (s StartBackupJobOutput) GoString() string

GoString returns the string representation

func (*StartBackupJobOutput) SetBackupJobId

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

SetBackupJobId sets the BackupJobId field's value.

func (*StartBackupJobOutput) SetCreationDate

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

SetCreationDate sets the CreationDate field's value.

func (*StartBackupJobOutput) SetRecoveryPointArn

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

SetRecoveryPointArn sets the RecoveryPointArn field's value.

func (StartBackupJobOutput) String

func (s StartBackupJobOutput) String() string

String returns the string representation

type StartCopyJobInput added in v1.28.1

type StartCopyJobInput struct {

	// An Amazon Resource Name (ARN) that uniquely identifies a destination backup
	// vault to copy to; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
	//
	// DestinationBackupVaultArn is a required field
	DestinationBackupVaultArn *string `type:"string" required:"true"`

	// Specifies the IAM role ARN used to copy the target recovery point; for example,
	// arn:aws:iam::123456789012:role/S3Access.
	//
	// IamRoleArn is a required field
	IamRoleArn *string `type:"string" required:"true"`

	// A customer chosen string that can be used to distinguish between calls to
	// StartCopyJob.
	IdempotencyToken *string `type:"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.
	//
	// Only Amazon EFS file system backups can be transitioned to cold storage.
	Lifecycle *Lifecycle `type:"structure"`

	// An ARN that uniquely identifies a recovery point to use for the copy job;
	// for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
	//
	// RecoveryPointArn is a required field
	RecoveryPointArn *string `type:"string" required:"true"`

	// The name of a logical source 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.
	//
	// SourceBackupVaultName is a required field
	SourceBackupVaultName *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (StartCopyJobInput) GoString added in v1.28.1

func (s StartCopyJobInput) GoString() string

GoString returns the string representation

func (*StartCopyJobInput) SetDestinationBackupVaultArn added in v1.28.1

func (s *StartCopyJobInput) SetDestinationBackupVaultArn(v string) *StartCopyJobInput

SetDestinationBackupVaultArn sets the DestinationBackupVaultArn field's value.

func (*StartCopyJobInput) SetIamRoleArn added in v1.28.1

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

SetIamRoleArn sets the IamRoleArn field's value.

func (*StartCopyJobInput) SetIdempotencyToken added in v1.28.1

func (s *StartCopyJobInput) SetIdempotencyToken(v string) *StartCopyJobInput

SetIdempotencyToken sets the IdempotencyToken field's value.

func (*StartCopyJobInput) SetLifecycle added in v1.28.1

func (s *StartCopyJobInput) SetLifecycle(v *Lifecycle) *StartCopyJobInput

SetLifecycle sets the Lifecycle field's value.

func (*StartCopyJobInput) SetRecoveryPointArn added in v1.28.1

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

SetRecoveryPointArn sets the RecoveryPointArn field's value.

func (*StartCopyJobInput) SetSourceBackupVaultName added in v1.28.1

func (s *StartCopyJobInput) SetSourceBackupVaultName(v string) *StartCopyJobInput

SetSourceBackupVaultName sets the SourceBackupVaultName field's value.

func (StartCopyJobInput) String added in v1.28.1

func (s StartCopyJobInput) String() string

String returns the string representation

func (*StartCopyJobInput) Validate added in v1.28.1

func (s *StartCopyJobInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StartCopyJobOutput added in v1.28.1

type StartCopyJobOutput struct {

	// Uniquely identifies a copy job.
	CopyJobId *string `type:"string"`

	// The date and time that 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 `type:"timestamp"`
	// contains filtered or unexported fields
}

func (StartCopyJobOutput) GoString added in v1.28.1

func (s StartCopyJobOutput) GoString() string

GoString returns the string representation

func (*StartCopyJobOutput) SetCopyJobId added in v1.28.1

func (s *StartCopyJobOutput) SetCopyJobId(v string) *StartCopyJobOutput

SetCopyJobId sets the CopyJobId field's value.

func (*StartCopyJobOutput) SetCreationDate added in v1.28.1

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

SetCreationDate sets the CreationDate field's value.

func (StartCopyJobOutput) String added in v1.28.1

func (s StartCopyJobOutput) String() string

String returns the string representation

type StartRestoreJobInput

type StartRestoreJobInput struct {

	// The Amazon Resource Name (ARN) of the IAM role that AWS Backup uses to create
	// the target recovery point; for example, arn:aws:iam::123456789012:role/S3Access.
	//
	// IamRoleArn is a required field
	IamRoleArn *string `type:"string" required:"true"`

	// A customer chosen string that can be used to distinguish between calls to
	// StartRestoreJob.
	IdempotencyToken *string `type:"string"`

	// A set of metadata key-value pairs. Contains information, such as a resource
	// name, required to restore a recovery point.
	//
	// You can get configuration metadata about a resource at the time it was backed
	// up by calling GetRecoveryPointRestoreMetadata. However, values in addition
	// to those provided by GetRecoveryPointRestoreMetadata might be required to
	// restore a resource. For example, you might need to provide a new resource
	// name if the original already exists.
	//
	// You need to specify specific metadata to restore an Amazon Elastic File System
	// (Amazon EFS) instance:
	//
	//    * file-system-id: The ID of the Amazon EFS file system that is backed
	//    up by AWS Backup. Returned in GetRecoveryPointRestoreMetadata.
	//
	//    * Encrypted: A Boolean value that, if true, specifies that the file system
	//    is encrypted. If KmsKeyId is specified, Encrypted must be set to true.
	//
	//    * KmsKeyId: Specifies the AWS KMS key that is used to encrypt the restored
	//    file system. You can specify a key from another AWS account provided that
	//    key it is properly shared with your account via AWS KMS.
	//
	//    * PerformanceMode: Specifies the throughput mode of the file system.
	//
	//    * CreationToken: A user-supplied value that ensures the uniqueness (idempotency)
	//    of the request.
	//
	//    * newFileSystem: A Boolean value that, if true, specifies that the recovery
	//    point is restored to a new Amazon EFS file system.
	//
	//    * ItemsToRestore : An array of one to five strings where each string is
	//    a file path. Use ItemsToRestore to restore specific files or directories
	//    rather than the entire file system. This parameter is optional. For example,
	//    "itemsToRestore":"[\"/my.test\"]".
	//
	// Metadata is a required field
	Metadata map[string]*string `type:"map" required:"true" sensitive:"true"`

	// 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 is a required field
	RecoveryPointArn *string `type:"string" required:"true"`

	// Starts a job to restore a recovery point for one of the following resources:
	//
	//    * DynamoDB for Amazon DynamoDB
	//
	//    * EBS for Amazon Elastic Block Store
	//
	//    * EC2 for Amazon Elastic Compute Cloud
	//
	//    * EFS for Amazon Elastic File System
	//
	//    * RDS for Amazon Relational Database Service
	//
	//    * Aurora for Amazon Aurora
	//
	//    * Storage Gateway for AWS Storage Gateway
	ResourceType *string `type:"string"`
	// contains filtered or unexported fields
}

func (StartRestoreJobInput) GoString

func (s StartRestoreJobInput) GoString() string

GoString returns the string representation

func (*StartRestoreJobInput) SetIamRoleArn

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

SetIamRoleArn sets the IamRoleArn field's value.

func (*StartRestoreJobInput) SetIdempotencyToken

func (s *StartRestoreJobInput) SetIdempotencyToken(v string) *StartRestoreJobInput

SetIdempotencyToken sets the IdempotencyToken field's value.

func (*StartRestoreJobInput) SetMetadata

func (s *StartRestoreJobInput) SetMetadata(v map[string]*string) *StartRestoreJobInput

SetMetadata sets the Metadata field's value.

func (*StartRestoreJobInput) SetRecoveryPointArn

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

SetRecoveryPointArn sets the RecoveryPointArn field's value.

func (*StartRestoreJobInput) SetResourceType

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

SetResourceType sets the ResourceType field's value.

func (StartRestoreJobInput) String

func (s StartRestoreJobInput) String() string

String returns the string representation

func (*StartRestoreJobInput) Validate

func (s *StartRestoreJobInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StartRestoreJobOutput

type StartRestoreJobOutput struct {

	// Uniquely identifies the job that restores a recovery point.
	RestoreJobId *string `type:"string"`
	// contains filtered or unexported fields
}

func (StartRestoreJobOutput) GoString

func (s StartRestoreJobOutput) GoString() string

GoString returns the string representation

func (*StartRestoreJobOutput) SetRestoreJobId

func (s *StartRestoreJobOutput) SetRestoreJobId(v string) *StartRestoreJobOutput

SetRestoreJobId sets the RestoreJobId field's value.

func (StartRestoreJobOutput) String

func (s StartRestoreJobOutput) String() string

String returns the string representation

type StopBackupJobInput

type StopBackupJobInput struct {

	// Uniquely identifies a request to AWS Backup to back up a resource.
	//
	// BackupJobId is a required field
	BackupJobId *string `location:"uri" locationName:"backupJobId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (StopBackupJobInput) GoString

func (s StopBackupJobInput) GoString() string

GoString returns the string representation

func (*StopBackupJobInput) SetBackupJobId

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

SetBackupJobId sets the BackupJobId field's value.

func (StopBackupJobInput) String

func (s StopBackupJobInput) String() string

String returns the string representation

func (*StopBackupJobInput) Validate

func (s *StopBackupJobInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StopBackupJobOutput

type StopBackupJobOutput struct {
	// contains filtered or unexported fields
}

func (StopBackupJobOutput) GoString

func (s StopBackupJobOutput) GoString() string

GoString returns the string representation

func (StopBackupJobOutput) String

func (s StopBackupJobOutput) String() string

String returns the string representation

type TagResourceInput

type TagResourceInput struct {

	// An ARN that uniquely identifies a resource. The format of the ARN depends
	// on the type of the tagged resource.
	//
	// ResourceArn is a required field
	ResourceArn *string `location:"uri" locationName:"resourceArn" type:"string" required:"true"`

	// Key-value pairs that are used to help organize your resources. You can assign
	// your own metadata to the resources you create.
	//
	// Tags is a required field
	Tags map[string]*string `type:"map" required:"true" sensitive:"true"`
	// contains filtered or unexported fields
}

func (TagResourceInput) GoString

func (s TagResourceInput) GoString() string

GoString returns the string representation

func (*TagResourceInput) SetResourceArn

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

SetResourceArn sets the ResourceArn field's value.

func (*TagResourceInput) SetTags

func (s *TagResourceInput) SetTags(v map[string]*string) *TagResourceInput

SetTags sets the Tags field's value.

func (TagResourceInput) String

func (s TagResourceInput) String() string

String returns the string representation

func (*TagResourceInput) Validate

func (s *TagResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TagResourceOutput

type TagResourceOutput struct {
	// contains filtered or unexported fields
}

func (TagResourceOutput) GoString

func (s TagResourceOutput) GoString() string

GoString returns the string representation

func (TagResourceOutput) String

func (s TagResourceOutput) String() string

String returns the string representation

type UntagResourceInput

type UntagResourceInput struct {

	// An ARN that uniquely identifies a resource. The format of the ARN depends
	// on the type of the tagged resource.
	//
	// ResourceArn is a required field
	ResourceArn *string `location:"uri" locationName:"resourceArn" type:"string" required:"true"`

	// A list of keys to identify which key-value tags to remove from a resource.
	//
	// TagKeyList is a required field
	TagKeyList []*string `type:"list" required:"true" sensitive:"true"`
	// contains filtered or unexported fields
}

func (UntagResourceInput) GoString

func (s UntagResourceInput) GoString() string

GoString returns the string representation

func (*UntagResourceInput) SetResourceArn

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

SetResourceArn sets the ResourceArn field's value.

func (*UntagResourceInput) SetTagKeyList

func (s *UntagResourceInput) SetTagKeyList(v []*string) *UntagResourceInput

SetTagKeyList sets the TagKeyList field's value.

func (UntagResourceInput) String

func (s UntagResourceInput) String() string

String returns the string representation

func (*UntagResourceInput) Validate

func (s *UntagResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UntagResourceOutput

type UntagResourceOutput struct {
	// contains filtered or unexported fields
}

func (UntagResourceOutput) GoString

func (s UntagResourceOutput) GoString() string

GoString returns the string representation

func (UntagResourceOutput) String

func (s UntagResourceOutput) String() string

String returns the string representation

type UpdateBackupPlanInput

type UpdateBackupPlanInput struct {

	// Specifies the body of a backup plan. Includes a BackupPlanName and one or
	// more sets of Rules.
	//
	// BackupPlan is a required field
	BackupPlan *PlanInput `type:"structure" required:"true"`

	// Uniquely identifies a backup plan.
	//
	// BackupPlanId is a required field
	BackupPlanId *string `location:"uri" locationName:"backupPlanId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateBackupPlanInput) GoString

func (s UpdateBackupPlanInput) GoString() string

GoString returns the string representation

func (*UpdateBackupPlanInput) SetBackupPlan

SetBackupPlan sets the BackupPlan field's value.

func (*UpdateBackupPlanInput) SetBackupPlanId

func (s *UpdateBackupPlanInput) SetBackupPlanId(v string) *UpdateBackupPlanInput

SetBackupPlanId sets the BackupPlanId field's value.

func (UpdateBackupPlanInput) String

func (s UpdateBackupPlanInput) String() string

String returns the string representation

func (*UpdateBackupPlanInput) Validate

func (s *UpdateBackupPlanInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateBackupPlanOutput

type UpdateBackupPlanOutput struct {

	// Contains a list of BackupOptions for each resource type.
	AdvancedBackupSettings []*AdvancedBackupSetting `type:"list"`

	// 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 `type:"string"`

	// Uniquely identifies a backup plan.
	BackupPlanId *string `type:"string"`

	// The date and time a backup plan is updated, 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 `type:"timestamp"`

	// Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most
	// 1,024 bytes long. Version Ids cannot be edited.
	VersionId *string `type:"string"`
	// contains filtered or unexported fields
}

func (UpdateBackupPlanOutput) GoString

func (s UpdateBackupPlanOutput) GoString() string

GoString returns the string representation

func (*UpdateBackupPlanOutput) SetAdvancedBackupSettings added in v1.34.30

func (s *UpdateBackupPlanOutput) SetAdvancedBackupSettings(v []*AdvancedBackupSetting) *UpdateBackupPlanOutput

SetAdvancedBackupSettings sets the AdvancedBackupSettings field's value.

func (*UpdateBackupPlanOutput) SetBackupPlanArn

func (s *UpdateBackupPlanOutput) SetBackupPlanArn(v string) *UpdateBackupPlanOutput

SetBackupPlanArn sets the BackupPlanArn field's value.

func (*UpdateBackupPlanOutput) SetBackupPlanId

func (s *UpdateBackupPlanOutput) SetBackupPlanId(v string) *UpdateBackupPlanOutput

SetBackupPlanId sets the BackupPlanId field's value.

func (*UpdateBackupPlanOutput) SetCreationDate

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

SetCreationDate sets the CreationDate field's value.

func (*UpdateBackupPlanOutput) SetVersionId

SetVersionId sets the VersionId field's value.

func (UpdateBackupPlanOutput) String

func (s UpdateBackupPlanOutput) String() string

String returns the string representation

type UpdateGlobalSettingsInput added in v1.35.31

type UpdateGlobalSettingsInput struct {

	// A list of resources along with the opt-in preferences for the account.
	GlobalSettings map[string]*string `type:"map"`
	// contains filtered or unexported fields
}

func (UpdateGlobalSettingsInput) GoString added in v1.35.31

func (s UpdateGlobalSettingsInput) GoString() string

GoString returns the string representation

func (*UpdateGlobalSettingsInput) SetGlobalSettings added in v1.35.31

func (s *UpdateGlobalSettingsInput) SetGlobalSettings(v map[string]*string) *UpdateGlobalSettingsInput

SetGlobalSettings sets the GlobalSettings field's value.

func (UpdateGlobalSettingsInput) String added in v1.35.31

func (s UpdateGlobalSettingsInput) String() string

String returns the string representation

type UpdateGlobalSettingsOutput added in v1.35.31

type UpdateGlobalSettingsOutput struct {
	// contains filtered or unexported fields
}

func (UpdateGlobalSettingsOutput) GoString added in v1.35.31

func (s UpdateGlobalSettingsOutput) GoString() string

GoString returns the string representation

func (UpdateGlobalSettingsOutput) String added in v1.35.31

String returns the string representation

type UpdateRecoveryPointLifecycleInput

type UpdateRecoveryPointLifecycleInput 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.
	//
	// BackupVaultName is a required field
	BackupVaultName *string `location:"uri" locationName:"backupVaultName" type:"string" required:"true"`

	// 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 `type:"structure"`

	// 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 is a required field
	RecoveryPointArn *string `location:"uri" locationName:"recoveryPointArn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateRecoveryPointLifecycleInput) GoString

GoString returns the string representation

func (*UpdateRecoveryPointLifecycleInput) SetBackupVaultName

SetBackupVaultName sets the BackupVaultName field's value.

func (*UpdateRecoveryPointLifecycleInput) SetLifecycle

SetLifecycle sets the Lifecycle field's value.

func (*UpdateRecoveryPointLifecycleInput) SetRecoveryPointArn

SetRecoveryPointArn sets the RecoveryPointArn field's value.

func (UpdateRecoveryPointLifecycleInput) String

String returns the string representation

func (*UpdateRecoveryPointLifecycleInput) Validate

Validate inspects the fields of the type to determine if they are valid.

type UpdateRecoveryPointLifecycleOutput

type UpdateRecoveryPointLifecycleOutput struct {

	// An ARN that uniquely identifies a backup vault; for example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
	BackupVaultArn *string `type:"string"`

	// A CalculatedLifecycle object containing DeleteAt and MoveToColdStorageAt
	// timestamps.
	CalculatedLifecycle *CalculatedLifecycle `type:"structure"`

	// 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.
	//
	// Only Amazon EFS file system backups can be transitioned to cold storage.
	Lifecycle *Lifecycle `type:"structure"`

	// 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 `type:"string"`
	// contains filtered or unexported fields
}

func (UpdateRecoveryPointLifecycleOutput) GoString

GoString returns the string representation

func (*UpdateRecoveryPointLifecycleOutput) SetBackupVaultArn

SetBackupVaultArn sets the BackupVaultArn field's value.

func (*UpdateRecoveryPointLifecycleOutput) SetCalculatedLifecycle

SetCalculatedLifecycle sets the CalculatedLifecycle field's value.

func (*UpdateRecoveryPointLifecycleOutput) SetLifecycle

SetLifecycle sets the Lifecycle field's value.

func (*UpdateRecoveryPointLifecycleOutput) SetRecoveryPointArn

SetRecoveryPointArn sets the RecoveryPointArn field's value.

func (UpdateRecoveryPointLifecycleOutput) String

String returns the string representation

type UpdateRegionSettingsInput added in v1.31.2

type UpdateRegionSettingsInput struct {

	// Updates the list of services along with the opt-in preferences for the Region.
	ResourceTypeOptInPreference map[string]*bool `type:"map"`
	// contains filtered or unexported fields
}

func (UpdateRegionSettingsInput) GoString added in v1.31.2

func (s UpdateRegionSettingsInput) GoString() string

GoString returns the string representation

func (*UpdateRegionSettingsInput) SetResourceTypeOptInPreference added in v1.31.2

func (s *UpdateRegionSettingsInput) SetResourceTypeOptInPreference(v map[string]*bool) *UpdateRegionSettingsInput

SetResourceTypeOptInPreference sets the ResourceTypeOptInPreference field's value.

func (UpdateRegionSettingsInput) String added in v1.31.2

func (s UpdateRegionSettingsInput) String() string

String returns the string representation

type UpdateRegionSettingsOutput added in v1.31.2

type UpdateRegionSettingsOutput struct {
	// contains filtered or unexported fields
}

func (UpdateRegionSettingsOutput) GoString added in v1.31.2

func (s UpdateRegionSettingsOutput) GoString() string

GoString returns the string representation

func (UpdateRegionSettingsOutput) String added in v1.31.2

String returns the string representation

type VaultListMember

type VaultListMember struct {

	// An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for
	// example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault.
	BackupVaultArn *string `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.
	BackupVaultName *string `type:"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 `type:"timestamp"`

	// A unique string that identifies the request and allows failed requests to
	// be retried without the risk of running the operation twice.
	CreatorRequestId *string `type:"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 `type:"string"`

	// The number of recovery points that are stored in a backup vault.
	NumberOfRecoveryPoints *int64 `type:"long"`
	// contains filtered or unexported fields
}

Contains metadata about a backup vault.

func (VaultListMember) GoString

func (s VaultListMember) GoString() string

GoString returns the string representation

func (*VaultListMember) SetBackupVaultArn

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

SetBackupVaultArn sets the BackupVaultArn field's value.

func (*VaultListMember) SetBackupVaultName

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

SetBackupVaultName sets the BackupVaultName field's value.

func (*VaultListMember) SetCreationDate

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

SetCreationDate sets the CreationDate field's value.

func (*VaultListMember) SetCreatorRequestId

func (s *VaultListMember) SetCreatorRequestId(v string) *VaultListMember

SetCreatorRequestId sets the CreatorRequestId field's value.

func (*VaultListMember) SetEncryptionKeyArn

func (s *VaultListMember) SetEncryptionKeyArn(v string) *VaultListMember

SetEncryptionKeyArn sets the EncryptionKeyArn field's value.

func (*VaultListMember) SetNumberOfRecoveryPoints

func (s *VaultListMember) SetNumberOfRecoveryPoints(v int64) *VaultListMember

SetNumberOfRecoveryPoints sets the NumberOfRecoveryPoints field's value.

func (VaultListMember) String

func (s VaultListMember) String() string

String returns the string representation

Directories

Path Synopsis
Package backupiface provides an interface to enable mocking the AWS Backup service client for testing your code.
Package backupiface provides an interface to enable mocking the AWS Backup service client for testing your code.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL