backup

package
v1.44.279 Latest Latest
Warning

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

Go to latest
Published: Jun 8, 2023 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.

Backup is a unified backup service designed to protect Amazon Web Services services and their associated data. 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"

	// CopyJobStatePartial is a CopyJobState enum value
	CopyJobStatePartial = "PARTIAL"
)
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"

	// JobStatePartial is a JobState enum value
	JobStatePartial = "PARTIAL"
)
View Source
const (
	// LegalHoldStatusCreating is a LegalHoldStatus enum value
	LegalHoldStatusCreating = "CREATING"

	// LegalHoldStatusActive is a LegalHoldStatus enum value
	LegalHoldStatusActive = "ACTIVE"

	// LegalHoldStatusCanceling is a LegalHoldStatus enum value
	LegalHoldStatusCanceling = "CANCELING"

	// LegalHoldStatusCanceled is a LegalHoldStatus enum value
	LegalHoldStatusCanceled = "CANCELED"
)
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"

	// VaultEventS3BackupObjectFailed is a VaultEvent enum value
	VaultEventS3BackupObjectFailed = "S3_BACKUP_OBJECT_FAILED"

	// VaultEventS3RestoreObjectFailed is a VaultEvent enum value
	VaultEventS3RestoreObjectFailed = "S3_RESTORE_OBJECT_FAILED"
)
View Source
const (

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

	// ErrCodeConflictException for service response error code
	// "ConflictException".
	//
	// Backup can't perform the action that you requested until it finishes performing
	// a previous action. Try again later.
	ErrCodeConflictException = "ConflictException"

	// ErrCodeDependencyFailureException for service response error code
	// "DependencyFailureException".
	//
	// A dependent Amazon Web Services service or resource returned an error to
	// the 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".
	//
	// 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 LegalHoldStatus_Values added in v1.44.146

func LegalHoldStatus_Values() []string

LegalHoldStatus_Values returns all elements of the LegalHoldStatus 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 Windows VSS 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 Volume Shadow
	// Copy Service (VSS). For a 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 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) CancelLegalHold added in v1.44.146

func (c *Backup) CancelLegalHold(input *CancelLegalHoldInput) (*CancelLegalHoldOutput, error)

CancelLegalHold API operation for AWS Backup.

This action removes the specified legal hold on a recovery point. This action can only be performed by a user with sufficient permissions.

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 CancelLegalHold 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.

  • InvalidResourceStateException 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.

  • 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/CancelLegalHold

func (*Backup) CancelLegalHoldRequest added in v1.44.146

func (c *Backup) CancelLegalHoldRequest(input *CancelLegalHoldInput) (req *request.Request, output *CancelLegalHoldOutput)

CancelLegalHoldRequest generates a "aws/request.Request" representing the client's request for the CancelLegalHold 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 CancelLegalHold for more information on using the CancelLegalHold 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 CancelLegalHoldRequest method.
req, resp := client.CancelLegalHoldRequest(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/CancelLegalHold

func (*Backup) CancelLegalHoldWithContext added in v1.44.146

func (c *Backup) CancelLegalHoldWithContext(ctx aws.Context, input *CancelLegalHoldInput, opts ...request.Option) (*CancelLegalHoldOutput, error)

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

See CancelLegalHold 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) 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 Backup uses to schedule tasks that create recovery points for resources.

If you call CreateBackupPlan with a plan that already exists, you receive an AlreadyExistsException exception.

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. For examples, see Assigning resources programmatically (https://docs.aws.amazon.com/aws-backup/latest/devguide/assigning-resources.html#assigning-resources-json).

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.

Do not include sensitive data, such as passport numbers, in 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) CreateFramework added in v1.40.28

func (c *Backup) CreateFramework(input *CreateFrameworkInput) (*CreateFrameworkOutput, error)

CreateFramework API operation for AWS Backup.

Creates a framework with one or more controls. A framework is a collection of controls that you can use to evaluate your backup practices. By using pre-built customizable controls to define your policies, you can evaluate whether your backup practices comply with your policies and which resources are not yet in compliance.

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 CreateFramework for usage and error information.

Returned Error Types:

  • AlreadyExistsException The required resource already exists.

  • 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.

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

func (*Backup) CreateFrameworkRequest added in v1.40.28

func (c *Backup) CreateFrameworkRequest(input *CreateFrameworkInput) (req *request.Request, output *CreateFrameworkOutput)

CreateFrameworkRequest generates a "aws/request.Request" representing the client's request for the CreateFramework 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 CreateFramework for more information on using the CreateFramework 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 CreateFrameworkRequest method.
req, resp := client.CreateFrameworkRequest(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/CreateFramework

func (*Backup) CreateFrameworkWithContext added in v1.40.28

func (c *Backup) CreateFrameworkWithContext(ctx aws.Context, input *CreateFrameworkInput, opts ...request.Option) (*CreateFrameworkOutput, error)

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

See CreateFramework 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) CreateLegalHold added in v1.44.146

func (c *Backup) CreateLegalHold(input *CreateLegalHoldInput) (*CreateLegalHoldOutput, error)

CreateLegalHold API operation for AWS Backup.

This action creates a legal hold on a recovery point (backup). A legal hold is a restraint on altering or deleting a backup until an authorized user cancels the legal hold. Any actions to delete or disassociate a recovery point will fail with an error if one or more active legal holds are on the recovery point.

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 CreateLegalHold 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.

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

func (*Backup) CreateLegalHoldRequest added in v1.44.146

func (c *Backup) CreateLegalHoldRequest(input *CreateLegalHoldInput) (req *request.Request, output *CreateLegalHoldOutput)

CreateLegalHoldRequest generates a "aws/request.Request" representing the client's request for the CreateLegalHold 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 CreateLegalHold for more information on using the CreateLegalHold 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 CreateLegalHoldRequest method.
req, resp := client.CreateLegalHoldRequest(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/CreateLegalHold

func (*Backup) CreateLegalHoldWithContext added in v1.44.146

func (c *Backup) CreateLegalHoldWithContext(ctx aws.Context, input *CreateLegalHoldInput, opts ...request.Option) (*CreateLegalHoldOutput, error)

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

See CreateLegalHold 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) CreateReportPlan added in v1.40.28

func (c *Backup) CreateReportPlan(input *CreateReportPlanInput) (*CreateReportPlanOutput, error)

CreateReportPlan API operation for AWS Backup.

Creates a report plan. A report plan is a document that contains information about the contents of the report and where Backup will deliver it.

If you call CreateReportPlan with a plan that already exists, you receive an AlreadyExistsException exception.

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 CreateReportPlan for usage and error information.

Returned Error Types:

  • AlreadyExistsException The required resource already exists.

  • 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.

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

  • MissingParameterValueException Indicates that a required parameter is missing.

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

func (*Backup) CreateReportPlanRequest added in v1.40.28

func (c *Backup) CreateReportPlanRequest(input *CreateReportPlanInput) (req *request.Request, output *CreateReportPlanOutput)

CreateReportPlanRequest generates a "aws/request.Request" representing the client's request for the CreateReportPlan 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 CreateReportPlan for more information on using the CreateReportPlan 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 CreateReportPlanRequest method.
req, resp := client.CreateReportPlanRequest(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/CreateReportPlan

func (*Backup) CreateReportPlanWithContext added in v1.40.28

func (c *Backup) CreateReportPlanWithContext(ctx aws.Context, input *CreateReportPlanInput, opts ...request.Option) (*CreateReportPlanOutput, error)

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

See CreateReportPlan 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) DeleteBackupVaultLockConfiguration added in v1.40.58

func (c *Backup) DeleteBackupVaultLockConfiguration(input *DeleteBackupVaultLockConfigurationInput) (*DeleteBackupVaultLockConfigurationOutput, error)

DeleteBackupVaultLockConfiguration API operation for AWS Backup.

Deletes Backup Vault Lock from a backup vault specified by a backup vault name.

If the Vault Lock configuration is immutable, then you cannot delete Vault Lock using API operations, and you will receive an InvalidRequestException if you attempt to do so. For more information, see Vault Lock (https://docs.aws.amazon.com/aws-backup/latest/devguide/vault-lock.html) in the Backup Developer Guide.

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 DeleteBackupVaultLockConfiguration 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.

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

func (*Backup) DeleteBackupVaultLockConfigurationRequest added in v1.40.58

func (c *Backup) DeleteBackupVaultLockConfigurationRequest(input *DeleteBackupVaultLockConfigurationInput) (req *request.Request, output *DeleteBackupVaultLockConfigurationOutput)

DeleteBackupVaultLockConfigurationRequest generates a "aws/request.Request" representing the client's request for the DeleteBackupVaultLockConfiguration 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 DeleteBackupVaultLockConfiguration for more information on using the DeleteBackupVaultLockConfiguration 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 DeleteBackupVaultLockConfigurationRequest method.
req, resp := client.DeleteBackupVaultLockConfigurationRequest(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/DeleteBackupVaultLockConfiguration

func (*Backup) DeleteBackupVaultLockConfigurationWithContext added in v1.40.58

func (c *Backup) DeleteBackupVaultLockConfigurationWithContext(ctx aws.Context, input *DeleteBackupVaultLockConfigurationInput, opts ...request.Option) (*DeleteBackupVaultLockConfigurationOutput, error)

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

See DeleteBackupVaultLockConfiguration 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) DeleteFramework added in v1.40.28

func (c *Backup) DeleteFramework(input *DeleteFrameworkInput) (*DeleteFrameworkOutput, error)

DeleteFramework API operation for AWS Backup.

Deletes the framework specified by a framework 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 DeleteFramework 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.

  • ConflictException Backup can't perform the action that you requested until it finishes performing a previous action. Try again later.

  • 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/DeleteFramework

func (*Backup) DeleteFrameworkRequest added in v1.40.28

func (c *Backup) DeleteFrameworkRequest(input *DeleteFrameworkInput) (req *request.Request, output *DeleteFrameworkOutput)

DeleteFrameworkRequest generates a "aws/request.Request" representing the client's request for the DeleteFramework 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 DeleteFramework for more information on using the DeleteFramework 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 DeleteFrameworkRequest method.
req, resp := client.DeleteFrameworkRequest(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/DeleteFramework

func (*Backup) DeleteFrameworkWithContext added in v1.40.28

func (c *Backup) DeleteFrameworkWithContext(ctx aws.Context, input *DeleteFrameworkInput, opts ...request.Option) (*DeleteFrameworkOutput, error)

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

See DeleteFramework 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.

When an IAM role's permissions are insufficient to call this API, the service sends back an HTTP 200 response with an empty HTTP body, but the recovery point is not deleted. Instead, it enters an EXPIRED state.

EXPIRED recovery points can be deleted with this API once the IAM role has the iam:CreateServiceLinkedRole action. To learn more about adding this role, see Troubleshooting manual deletions (https://docs.aws.amazon.com/aws-backup/latest/devguide/deleting-backups.html#deleting-backups-troubleshooting).

If the user or role is deleted or the permission within the role is removed, the deletion will not be successful and will enter an EXPIRED state.

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 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) DeleteReportPlan added in v1.40.28

func (c *Backup) DeleteReportPlan(input *DeleteReportPlanInput) (*DeleteReportPlanOutput, error)

DeleteReportPlan API operation for AWS Backup.

Deletes the report plan specified by a report plan 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 DeleteReportPlan 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.

  • ConflictException Backup can't perform the action that you requested until it finishes performing a previous action. Try again later.

  • 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/DeleteReportPlan

func (*Backup) DeleteReportPlanRequest added in v1.40.28

func (c *Backup) DeleteReportPlanRequest(input *DeleteReportPlanInput) (req *request.Request, output *DeleteReportPlanOutput)

DeleteReportPlanRequest generates a "aws/request.Request" representing the client's request for the DeleteReportPlan 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 DeleteReportPlan for more information on using the DeleteReportPlan 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 DeleteReportPlanRequest method.
req, resp := client.DeleteReportPlanRequest(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/DeleteReportPlan

func (*Backup) DeleteReportPlanWithContext added in v1.40.28

func (c *Backup) DeleteReportPlanWithContext(ctx aws.Context, input *DeleteReportPlanInput, opts ...request.Option) (*DeleteReportPlanOutput, error)

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

See DeleteReportPlan 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 Amazon Web Services service or resource returned an error to the 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) DescribeFramework added in v1.40.28

func (c *Backup) DescribeFramework(input *DescribeFrameworkInput) (*DescribeFrameworkOutput, error)

DescribeFramework API operation for AWS Backup.

Returns the framework details for the specified FrameworkName.

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 DescribeFramework 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/DescribeFramework

func (*Backup) DescribeFrameworkRequest added in v1.40.28

func (c *Backup) DescribeFrameworkRequest(input *DescribeFrameworkInput) (req *request.Request, output *DescribeFrameworkOutput)

DescribeFrameworkRequest generates a "aws/request.Request" representing the client's request for the DescribeFramework 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 DescribeFramework for more information on using the DescribeFramework 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 DescribeFrameworkRequest method.
req, resp := client.DescribeFrameworkRequest(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/DescribeFramework

func (*Backup) DescribeFrameworkWithContext added in v1.40.28

func (c *Backup) DescribeFrameworkWithContext(ctx aws.Context, input *DescribeFrameworkInput, opts ...request.Option) (*DescribeFrameworkOutput, error)

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

See DescribeFramework 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 whether the Amazon Web Services account is opted in to cross-account backup. Returns an error if the account is not a member of an Organizations organization. Example: describe-global-settings --region us-west-2

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 Amazon Web Services 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, 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, 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) DescribeReportJob added in v1.40.28

func (c *Backup) DescribeReportJob(input *DescribeReportJobInput) (*DescribeReportJobOutput, error)

DescribeReportJob API operation for AWS Backup.

Returns the details associated with creating a report as specified by its ReportJobId.

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 DescribeReportJob 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.

  • 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/DescribeReportJob

func (*Backup) DescribeReportJobRequest added in v1.40.28

func (c *Backup) DescribeReportJobRequest(input *DescribeReportJobInput) (req *request.Request, output *DescribeReportJobOutput)

DescribeReportJobRequest generates a "aws/request.Request" representing the client's request for the DescribeReportJob 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 DescribeReportJob for more information on using the DescribeReportJob 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 DescribeReportJobRequest method.
req, resp := client.DescribeReportJobRequest(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/DescribeReportJob

func (*Backup) DescribeReportJobWithContext added in v1.40.28

func (c *Backup) DescribeReportJobWithContext(ctx aws.Context, input *DescribeReportJobInput, opts ...request.Option) (*DescribeReportJobOutput, error)

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

See DescribeReportJob 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) DescribeReportPlan added in v1.40.28

func (c *Backup) DescribeReportPlan(input *DescribeReportPlanInput) (*DescribeReportPlanOutput, error)

DescribeReportPlan API operation for AWS Backup.

Returns a list of all report plans for an Amazon Web Services account and Amazon Web Services 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 DescribeReportPlan 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.

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

  • 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/DescribeReportPlan

func (*Backup) DescribeReportPlanRequest added in v1.40.28

func (c *Backup) DescribeReportPlanRequest(input *DescribeReportPlanInput) (req *request.Request, output *DescribeReportPlanOutput)

DescribeReportPlanRequest generates a "aws/request.Request" representing the client's request for the DescribeReportPlan 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 DescribeReportPlan for more information on using the DescribeReportPlan 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 DescribeReportPlanRequest method.
req, resp := client.DescribeReportPlanRequest(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/DescribeReportPlan

func (*Backup) DescribeReportPlanWithContext added in v1.40.28

func (c *Backup) DescribeReportPlanWithContext(ctx aws.Context, input *DescribeReportPlanInput, opts ...request.Option) (*DescribeReportPlanOutput, error)

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

See DescribeReportPlan 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 Amazon Web Services service or resource returned an error to the 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 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 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) DisassociateRecoveryPointFromParent added in v1.44.146

func (c *Backup) DisassociateRecoveryPointFromParent(input *DisassociateRecoveryPointFromParentInput) (*DisassociateRecoveryPointFromParentOutput, error)

DisassociateRecoveryPointFromParent API operation for AWS Backup.

This action to a specific child (nested) recovery point removes the relationship between the specified recovery point and its parent (composite) recovery point.

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 DisassociateRecoveryPointFromParent 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/DisassociateRecoveryPointFromParent

func (*Backup) DisassociateRecoveryPointFromParentRequest added in v1.44.146

func (c *Backup) DisassociateRecoveryPointFromParentRequest(input *DisassociateRecoveryPointFromParentInput) (req *request.Request, output *DisassociateRecoveryPointFromParentOutput)

DisassociateRecoveryPointFromParentRequest generates a "aws/request.Request" representing the client's request for the DisassociateRecoveryPointFromParent 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 DisassociateRecoveryPointFromParent for more information on using the DisassociateRecoveryPointFromParent 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 DisassociateRecoveryPointFromParentRequest method.
req, resp := client.DisassociateRecoveryPointFromParentRequest(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/DisassociateRecoveryPointFromParent

func (*Backup) DisassociateRecoveryPointFromParentWithContext added in v1.44.146

func (c *Backup) DisassociateRecoveryPointFromParentWithContext(ctx aws.Context, input *DisassociateRecoveryPointFromParentInput, opts ...request.Option) (*DisassociateRecoveryPointFromParentOutput, error)

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

See DisassociateRecoveryPointFromParent 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) 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) GetLegalHold added in v1.44.146

func (c *Backup) GetLegalHold(input *GetLegalHoldInput) (*GetLegalHoldOutput, error)

GetLegalHold API operation for AWS Backup.

This action returns details for a specified legal hold. The details are the body of a legal hold in JSON format, in addition to 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 GetLegalHold 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/GetLegalHold

func (*Backup) GetLegalHoldRequest added in v1.44.146

func (c *Backup) GetLegalHoldRequest(input *GetLegalHoldInput) (req *request.Request, output *GetLegalHoldOutput)

GetLegalHoldRequest generates a "aws/request.Request" representing the client's request for the GetLegalHold 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 GetLegalHold for more information on using the GetLegalHold 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 GetLegalHoldRequest method.
req, resp := client.GetLegalHoldRequest(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/GetLegalHold

func (*Backup) GetLegalHoldWithContext added in v1.44.146

func (c *Backup) GetLegalHoldWithContext(ctx aws.Context, input *GetLegalHoldInput, opts ...request.Option) (*GetLegalHoldOutput, error)

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

See GetLegalHold 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 Amazon Web Services resource types supported by 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 all active backup plans for an authenticated account. 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) ListFrameworks added in v1.40.28

func (c *Backup) ListFrameworks(input *ListFrameworksInput) (*ListFrameworksOutput, error)

ListFrameworks API operation for AWS Backup.

Returns a list of all frameworks for an Amazon Web Services account and Amazon Web Services 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 ListFrameworks 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/ListFrameworks

func (*Backup) ListFrameworksPages added in v1.40.28

func (c *Backup) ListFrameworksPages(input *ListFrameworksInput, fn func(*ListFrameworksOutput, bool) bool) error

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

See ListFrameworks 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 ListFrameworks operation.
pageNum := 0
err := client.ListFrameworksPages(params,
    func(page *backup.ListFrameworksOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Backup) ListFrameworksPagesWithContext added in v1.40.28

func (c *Backup) ListFrameworksPagesWithContext(ctx aws.Context, input *ListFrameworksInput, fn func(*ListFrameworksOutput, bool) bool, opts ...request.Option) error

ListFrameworksPagesWithContext same as ListFrameworksPages 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) ListFrameworksRequest added in v1.40.28

func (c *Backup) ListFrameworksRequest(input *ListFrameworksInput) (req *request.Request, output *ListFrameworksOutput)

ListFrameworksRequest generates a "aws/request.Request" representing the client's request for the ListFrameworks 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 ListFrameworks for more information on using the ListFrameworks 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 ListFrameworksRequest method.
req, resp := client.ListFrameworksRequest(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/ListFrameworks

func (*Backup) ListFrameworksWithContext added in v1.40.28

func (c *Backup) ListFrameworksWithContext(ctx aws.Context, input *ListFrameworksInput, opts ...request.Option) (*ListFrameworksOutput, error)

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

See ListFrameworks 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) ListLegalHolds added in v1.44.146

func (c *Backup) ListLegalHolds(input *ListLegalHoldsInput) (*ListLegalHoldsOutput, error)

ListLegalHolds API operation for AWS Backup.

This action returns metadata about active and previous legal holds.

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 ListLegalHolds 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/ListLegalHolds

func (*Backup) ListLegalHoldsPages added in v1.44.146

func (c *Backup) ListLegalHoldsPages(input *ListLegalHoldsInput, fn func(*ListLegalHoldsOutput, bool) bool) error

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

See ListLegalHolds 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 ListLegalHolds operation.
pageNum := 0
err := client.ListLegalHoldsPages(params,
    func(page *backup.ListLegalHoldsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Backup) ListLegalHoldsPagesWithContext added in v1.44.146

func (c *Backup) ListLegalHoldsPagesWithContext(ctx aws.Context, input *ListLegalHoldsInput, fn func(*ListLegalHoldsOutput, bool) bool, opts ...request.Option) error

ListLegalHoldsPagesWithContext same as ListLegalHoldsPages 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) ListLegalHoldsRequest added in v1.44.146

func (c *Backup) ListLegalHoldsRequest(input *ListLegalHoldsInput) (req *request.Request, output *ListLegalHoldsOutput)

ListLegalHoldsRequest generates a "aws/request.Request" representing the client's request for the ListLegalHolds 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 ListLegalHolds for more information on using the ListLegalHolds 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 ListLegalHoldsRequest method.
req, resp := client.ListLegalHoldsRequest(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/ListLegalHolds

func (*Backup) ListLegalHoldsWithContext added in v1.44.146

func (c *Backup) ListLegalHoldsWithContext(ctx aws.Context, input *ListLegalHoldsInput, opts ...request.Option) (*ListLegalHoldsOutput, error)

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

See ListLegalHolds 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 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) ListRecoveryPointsByLegalHold added in v1.44.146

func (c *Backup) ListRecoveryPointsByLegalHold(input *ListRecoveryPointsByLegalHoldInput) (*ListRecoveryPointsByLegalHoldOutput, error)

ListRecoveryPointsByLegalHold API operation for AWS Backup.

This action returns recovery point ARNs (Amazon Resource Names) of the specified legal hold.

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 ListRecoveryPointsByLegalHold 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.

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

func (*Backup) ListRecoveryPointsByLegalHoldPages added in v1.44.146

func (c *Backup) ListRecoveryPointsByLegalHoldPages(input *ListRecoveryPointsByLegalHoldInput, fn func(*ListRecoveryPointsByLegalHoldOutput, bool) bool) error

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

See ListRecoveryPointsByLegalHold 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 ListRecoveryPointsByLegalHold operation.
pageNum := 0
err := client.ListRecoveryPointsByLegalHoldPages(params,
    func(page *backup.ListRecoveryPointsByLegalHoldOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Backup) ListRecoveryPointsByLegalHoldPagesWithContext added in v1.44.146

func (c *Backup) ListRecoveryPointsByLegalHoldPagesWithContext(ctx aws.Context, input *ListRecoveryPointsByLegalHoldInput, fn func(*ListRecoveryPointsByLegalHoldOutput, bool) bool, opts ...request.Option) error

ListRecoveryPointsByLegalHoldPagesWithContext same as ListRecoveryPointsByLegalHoldPages 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) ListRecoveryPointsByLegalHoldRequest added in v1.44.146

func (c *Backup) ListRecoveryPointsByLegalHoldRequest(input *ListRecoveryPointsByLegalHoldInput) (req *request.Request, output *ListRecoveryPointsByLegalHoldOutput)

ListRecoveryPointsByLegalHoldRequest generates a "aws/request.Request" representing the client's request for the ListRecoveryPointsByLegalHold 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 ListRecoveryPointsByLegalHold for more information on using the ListRecoveryPointsByLegalHold 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 ListRecoveryPointsByLegalHoldRequest method.
req, resp := client.ListRecoveryPointsByLegalHoldRequest(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/ListRecoveryPointsByLegalHold

func (*Backup) ListRecoveryPointsByLegalHoldWithContext added in v1.44.146

func (c *Backup) ListRecoveryPointsByLegalHoldWithContext(ctx aws.Context, input *ListRecoveryPointsByLegalHoldInput, opts ...request.Option) (*ListRecoveryPointsByLegalHoldOutput, error)

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

See ListRecoveryPointsByLegalHold 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 all the recovery points of the type specified by a resource Amazon Resource Name (ARN).

For Amazon EFS and Amazon EC2, this action only lists recovery points created by 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 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) ListReportJobs added in v1.40.28

func (c *Backup) ListReportJobs(input *ListReportJobsInput) (*ListReportJobsOutput, error)

ListReportJobs API operation for AWS Backup.

Returns details about your report 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 ListReportJobs 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.

  • 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/ListReportJobs

func (*Backup) ListReportJobsPages added in v1.40.28

func (c *Backup) ListReportJobsPages(input *ListReportJobsInput, fn func(*ListReportJobsOutput, bool) bool) error

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

See ListReportJobs 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 ListReportJobs operation.
pageNum := 0
err := client.ListReportJobsPages(params,
    func(page *backup.ListReportJobsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Backup) ListReportJobsPagesWithContext added in v1.40.28

func (c *Backup) ListReportJobsPagesWithContext(ctx aws.Context, input *ListReportJobsInput, fn func(*ListReportJobsOutput, bool) bool, opts ...request.Option) error

ListReportJobsPagesWithContext same as ListReportJobsPages 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) ListReportJobsRequest added in v1.40.28

func (c *Backup) ListReportJobsRequest(input *ListReportJobsInput) (req *request.Request, output *ListReportJobsOutput)

ListReportJobsRequest generates a "aws/request.Request" representing the client's request for the ListReportJobs 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 ListReportJobs for more information on using the ListReportJobs 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 ListReportJobsRequest method.
req, resp := client.ListReportJobsRequest(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/ListReportJobs

func (*Backup) ListReportJobsWithContext added in v1.40.28

func (c *Backup) ListReportJobsWithContext(ctx aws.Context, input *ListReportJobsInput, opts ...request.Option) (*ListReportJobsOutput, error)

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

See ListReportJobs 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) ListReportPlans added in v1.40.28

func (c *Backup) ListReportPlans(input *ListReportPlansInput) (*ListReportPlansOutput, error)

ListReportPlans API operation for AWS Backup.

Returns a list of your report plans. For detailed information about a single report plan, use DescribeReportPlan.

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 ListReportPlans 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/ListReportPlans

func (*Backup) ListReportPlansPages added in v1.40.28

func (c *Backup) ListReportPlansPages(input *ListReportPlansInput, fn func(*ListReportPlansOutput, bool) bool) error

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

See ListReportPlans 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 ListReportPlans operation.
pageNum := 0
err := client.ListReportPlansPages(params,
    func(page *backup.ListReportPlansOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*Backup) ListReportPlansPagesWithContext added in v1.40.28

func (c *Backup) ListReportPlansPagesWithContext(ctx aws.Context, input *ListReportPlansInput, fn func(*ListReportPlansOutput, bool) bool, opts ...request.Option) error

ListReportPlansPagesWithContext same as ListReportPlansPages 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) ListReportPlansRequest added in v1.40.28

func (c *Backup) ListReportPlansRequest(input *ListReportPlansInput) (req *request.Request, output *ListReportPlansOutput)

ListReportPlansRequest generates a "aws/request.Request" representing the client's request for the ListReportPlans 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 ListReportPlans for more information on using the ListReportPlans 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 ListReportPlansRequest method.
req, resp := client.ListReportPlansRequest(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/ListReportPlans

func (*Backup) ListReportPlansWithContext added in v1.40.28

func (c *Backup) ListReportPlansWithContext(ctx aws.Context, input *ListReportPlansInput, opts ...request.Option) (*ListReportPlansOutput, error)

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

See ListReportPlans 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 Backup initiated to restore a saved resource, including details 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 only works for resource types that support full Backup management of their backups. Those resource types are listed in the "Full Backup management" section of the Feature availability by resource (https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#features-by-resource) table.

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) PutBackupVaultLockConfiguration added in v1.40.58

func (c *Backup) PutBackupVaultLockConfiguration(input *PutBackupVaultLockConfigurationInput) (*PutBackupVaultLockConfigurationOutput, error)

PutBackupVaultLockConfiguration API operation for AWS Backup.

Applies Backup Vault Lock to a backup vault, preventing attempts to delete any recovery point stored in or created in a backup vault. Vault Lock also prevents attempts to update the lifecycle policy that controls the retention period of any recovery point currently stored in a backup vault. If specified, Vault Lock enforces a minimum and maximum retention period for future backup and copy jobs that target a backup vault.

Backup Vault Lock has been assessed by Cohasset Associates for use in environments that are subject to SEC 17a-4, CFTC, and FINRA regulations. For more information about how Backup Vault Lock relates to these regulations, see the Cohasset Associates Compliance Assessment. (samples/cohassetreport.zip)

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 PutBackupVaultLockConfiguration 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.

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

func (*Backup) PutBackupVaultLockConfigurationRequest added in v1.40.58

func (c *Backup) PutBackupVaultLockConfigurationRequest(input *PutBackupVaultLockConfigurationInput) (req *request.Request, output *PutBackupVaultLockConfigurationOutput)

PutBackupVaultLockConfigurationRequest generates a "aws/request.Request" representing the client's request for the PutBackupVaultLockConfiguration 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 PutBackupVaultLockConfiguration for more information on using the PutBackupVaultLockConfiguration 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 PutBackupVaultLockConfigurationRequest method.
req, resp := client.PutBackupVaultLockConfigurationRequest(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/PutBackupVaultLockConfiguration

func (*Backup) PutBackupVaultLockConfigurationWithContext added in v1.40.58

func (c *Backup) PutBackupVaultLockConfigurationWithContext(ctx aws.Context, input *PutBackupVaultLockConfigurationInput, opts ...request.Option) (*PutBackupVaultLockConfigurationOutput, error)

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

See PutBackupVaultLockConfiguration 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) StartReportJob added in v1.40.28

func (c *Backup) StartReportJob(input *StartReportJobInput) (*StartReportJobOutput, error)

StartReportJob API operation for AWS Backup.

Starts an on-demand report job for the specified report 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 StartReportJob 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.

  • MissingParameterValueException Indicates that a required parameter is missing.

  • 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/StartReportJob

func (*Backup) StartReportJobRequest added in v1.40.28

func (c *Backup) StartReportJobRequest(input *StartReportJobInput) (req *request.Request, output *StartReportJobOutput)

StartReportJobRequest generates a "aws/request.Request" representing the client's request for the StartReportJob 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 StartReportJob for more information on using the StartReportJob 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 StartReportJobRequest method.
req, resp := client.StartReportJobRequest(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/StartReportJob

func (*Backup) StartReportJobWithContext added in v1.40.28

func (c *Backup) StartReportJobWithContext(ctx aws.Context, input *StartReportJobInput, opts ...request.Option) (*StartReportJobOutput, error)

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

See StartReportJob 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.

  • 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/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.

This action is not supported for the following services: Amazon FSx for Windows File Server, Amazon FSx for Lustre, FSx for ONTAP , Amazon FSx for OpenZFS, Amazon DocumentDB (with MongoDB compatibility), Amazon RDS, Amazon Aurora, and Amazon Neptune.

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) UpdateFramework added in v1.40.28

func (c *Backup) UpdateFramework(input *UpdateFrameworkInput) (*UpdateFrameworkOutput, error)

UpdateFramework API operation for AWS Backup.

Updates an existing framework identified by its FrameworkName with the input 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 UpdateFramework for usage and error information.

Returned Error Types:

  • AlreadyExistsException The required resource already exists.

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

  • 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.

  • ConflictException Backup can't perform the action that you requested until it finishes performing a previous action. Try again later.

  • 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/UpdateFramework

func (*Backup) UpdateFrameworkRequest added in v1.40.28

func (c *Backup) UpdateFrameworkRequest(input *UpdateFrameworkInput) (req *request.Request, output *UpdateFrameworkOutput)

UpdateFrameworkRequest generates a "aws/request.Request" representing the client's request for the UpdateFramework 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 UpdateFramework for more information on using the UpdateFramework 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 UpdateFrameworkRequest method.
req, resp := client.UpdateFrameworkRequest(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/UpdateFramework

func (*Backup) UpdateFrameworkWithContext added in v1.40.28

func (c *Backup) UpdateFrameworkWithContext(ctx aws.Context, input *UpdateFrameworkInput, opts ...request.Option) (*UpdateFrameworkOutput, error)

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

See UpdateFramework 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 whether the Amazon Web Services account is opted in to cross-account backup. Returns an error if the account is not an Organizations management 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. 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 “retention” 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.

Resource types that are able to be transitioned to cold storage are listed in the "Lifecycle to cold storage" section of the Feature availability by resource (https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#features-by-resource) table. Backup ignores this expression for other resource types.

This operation 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.

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

  • 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, 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, 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.

func (*Backup) UpdateReportPlan added in v1.40.28

func (c *Backup) UpdateReportPlan(input *UpdateReportPlanInput) (*UpdateReportPlanOutput, error)

UpdateReportPlan API operation for AWS Backup.

Updates an existing report plan identified by its ReportPlanName with the input 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 UpdateReportPlan 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.

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

  • MissingParameterValueException Indicates that a required parameter is missing.

  • ConflictException Backup can't perform the action that you requested until it finishes performing a previous action. Try again later.

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

func (*Backup) UpdateReportPlanRequest added in v1.40.28

func (c *Backup) UpdateReportPlanRequest(input *UpdateReportPlanInput) (req *request.Request, output *UpdateReportPlanOutput)

UpdateReportPlanRequest generates a "aws/request.Request" representing the client's request for the UpdateReportPlan 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 UpdateReportPlan for more information on using the UpdateReportPlan 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 UpdateReportPlanRequest method.
req, resp := client.UpdateReportPlanRequest(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/UpdateReportPlan

func (*Backup) UpdateReportPlanWithContext added in v1.40.28

func (c *Backup) UpdateReportPlanWithContext(ctx aws.Context, input *UpdateReportPlanInput, opts ...request.Option) (*UpdateReportPlanOutput, error)

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

See UpdateReportPlan 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. 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 “retention” 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.

Resource types that are able to be transitioned to cold storage are listed in the "Lifecycle to cold storage" section of the Feature availability by resource (https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#features-by-resource) table. Backup ignores this expression for other resource types.

func (CalculatedLifecycle) GoString

func (s CalculatedLifecycle) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CancelLegalHoldInput added in v1.44.146

type CancelLegalHoldInput struct {

	// String describing the reason for removing the legal hold.
	//
	// CancelDescription is a required field
	CancelDescription *string `location:"querystring" locationName:"cancelDescription" type:"string" required:"true"`

	// Legal hold ID required to remove the specified legal hold on a recovery point.
	//
	// LegalHoldId is a required field
	LegalHoldId *string `location:"uri" locationName:"legalHoldId" type:"string" required:"true"`

	// The integer amount in days specifying amount of days after this API operation
	// to remove legal hold.
	RetainRecordInDays *int64 `location:"querystring" locationName:"retainRecordInDays" type:"long"`
	// contains filtered or unexported fields
}

func (CancelLegalHoldInput) GoString added in v1.44.146

func (s CancelLegalHoldInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CancelLegalHoldInput) SetCancelDescription added in v1.44.146

func (s *CancelLegalHoldInput) SetCancelDescription(v string) *CancelLegalHoldInput

SetCancelDescription sets the CancelDescription field's value.

func (*CancelLegalHoldInput) SetLegalHoldId added in v1.44.146

func (s *CancelLegalHoldInput) SetLegalHoldId(v string) *CancelLegalHoldInput

SetLegalHoldId sets the LegalHoldId field's value.

func (*CancelLegalHoldInput) SetRetainRecordInDays added in v1.44.146

func (s *CancelLegalHoldInput) SetRetainRecordInDays(v int64) *CancelLegalHoldInput

SetRetainRecordInDays sets the RetainRecordInDays field's value.

func (CancelLegalHoldInput) String added in v1.44.146

func (s CancelLegalHoldInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CancelLegalHoldInput) Validate added in v1.44.146

func (s *CancelLegalHoldInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CancelLegalHoldOutput added in v1.44.146

type CancelLegalHoldOutput struct {
	// contains filtered or unexported fields
}

func (CancelLegalHoldOutput) GoString added in v1.44.146

func (s CancelLegalHoldOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (CancelLegalHoldOutput) String added in v1.44.146

func (s CancelLegalHoldOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Condition

type Condition struct {

	// The key in a key-value pair. For example, in the tag Department: Accounting,
	// Department is the key.
	//
	// ConditionKey is a required field
	ConditionKey *string `type:"string" required:"true"`

	// An operation applied to a key-value pair used to assign resources to your
	// backup plan. Condition only supports StringEquals. For more flexible assignment
	// options, including StringLike and the ability to exclude resources from your
	// backup plan, use Conditions (with an "s" on the end) for your BackupSelection
	// (https://docs.aws.amazon.com/aws-backup/latest/devguide/API_BackupSelection.html).
	//
	// ConditionType is a required field
	ConditionType *string `type:"string" required:"true" enum:"ConditionType"`

	// The value in a key-value pair. For example, in the tag 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. Used to filter resources using their tags and assign them to a backup plan. Case sensitive.

func (Condition) GoString

func (s Condition) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Condition) Validate

func (s *Condition) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ConditionParameter added in v1.42.2

type ConditionParameter struct {

	// The key in a key-value pair. For example, in the tag Department: Accounting,
	// Department is the key.
	ConditionKey *string `type:"string"`

	// The value in a key-value pair. For example, in the tag Department: Accounting,
	// Accounting is the value.
	ConditionValue *string `type:"string"`
	// contains filtered or unexported fields
}

Includes information about tags you define to assign tagged resources to a backup plan.

func (ConditionParameter) GoString added in v1.42.2

func (s ConditionParameter) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ConditionParameter) SetConditionKey added in v1.42.2

func (s *ConditionParameter) SetConditionKey(v string) *ConditionParameter

SetConditionKey sets the ConditionKey field's value.

func (*ConditionParameter) SetConditionValue added in v1.42.2

func (s *ConditionParameter) SetConditionValue(v string) *ConditionParameter

SetConditionValue sets the ConditionValue field's value.

func (ConditionParameter) String added in v1.42.2

func (s ConditionParameter) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Conditions added in v1.42.2

type Conditions struct {

	// Filters the values of your tagged resources for only those resources that
	// you tagged with the same value. Also called "exact matching."
	StringEquals []*ConditionParameter `type:"list"`

	// Filters the values of your tagged resources for matching tag values with
	// the use of a wildcard character (*) anywhere in the string. For example,
	// "prod*" or "*rod*" matches the tag value "production".
	StringLike []*ConditionParameter `type:"list"`

	// Filters the values of your tagged resources for only those resources that
	// you tagged that do not have the same value. Also called "negated matching."
	StringNotEquals []*ConditionParameter `type:"list"`

	// Filters the values of your tagged resources for non-matching tag values with
	// the use of a wildcard character (*) anywhere in the string.
	StringNotLike []*ConditionParameter `type:"list"`
	// contains filtered or unexported fields
}

Contains information about which resources to include or exclude from a backup plan using their tags. Conditions are case sensitive.

func (Conditions) GoString added in v1.42.2

func (s Conditions) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Conditions) SetStringEquals added in v1.42.2

func (s *Conditions) SetStringEquals(v []*ConditionParameter) *Conditions

SetStringEquals sets the StringEquals field's value.

func (*Conditions) SetStringLike added in v1.42.2

func (s *Conditions) SetStringLike(v []*ConditionParameter) *Conditions

SetStringLike sets the StringLike field's value.

func (*Conditions) SetStringNotEquals added in v1.42.2

func (s *Conditions) SetStringNotEquals(v []*ConditionParameter) *Conditions

SetStringNotEquals sets the StringNotEquals field's value.

func (*Conditions) SetStringNotLike added in v1.42.2

func (s *Conditions) SetStringNotLike(v []*ConditionParameter) *Conditions

SetStringNotLike sets the StringNotLike field's value.

func (Conditions) String added in v1.42.2

func (s Conditions) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ConflictException added in v1.40.28

type ConflictException 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
}

Backup can't perform the action that you requested until it finishes performing a previous action. Try again later.

func (*ConflictException) Code added in v1.40.28

func (s *ConflictException) Code() string

Code returns the exception type name.

func (*ConflictException) Error added in v1.40.28

func (s *ConflictException) Error() string

func (ConflictException) GoString added in v1.40.28

func (s ConflictException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ConflictException) Message added in v1.40.28

func (s *ConflictException) Message() string

Message returns the exception's message.

func (*ConflictException) OrigErr added in v1.40.28

func (s *ConflictException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ConflictException) RequestID added in v1.40.28

func (s *ConflictException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ConflictException) StatusCode added in v1.40.28

func (s *ConflictException) StatusCode() int

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

func (ConflictException) String added in v1.40.28

func (s ConflictException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ControlInputParameter added in v1.40.28

type ControlInputParameter struct {

	// The name of a parameter, for example, BackupPlanFrequency.
	ParameterName *string `type:"string"`

	// The value of parameter, for example, hourly.
	ParameterValue *string `type:"string"`
	// contains filtered or unexported fields
}

A list of parameters for a control. A control can have zero, one, or more than one parameter. An example of a control with two parameters is: "backup plan frequency is at least daily and the retention period is at least 1 year". The first parameter is daily. The second parameter is 1 year.

func (ControlInputParameter) GoString added in v1.40.28

func (s ControlInputParameter) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ControlInputParameter) SetParameterName added in v1.40.28

func (s *ControlInputParameter) SetParameterName(v string) *ControlInputParameter

SetParameterName sets the ParameterName field's value.

func (*ControlInputParameter) SetParameterValue added in v1.40.28

func (s *ControlInputParameter) SetParameterValue(v string) *ControlInputParameter

SetParameterValue sets the ParameterValue field's value.

func (ControlInputParameter) String added in v1.40.28

func (s ControlInputParameter) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ControlScope added in v1.40.28

type ControlScope struct {

	// The ID of the only Amazon Web Services resource that you want your control
	// scope to contain.
	ComplianceResourceIds []*string `min:"1" type:"list"`

	// Describes whether the control scope includes one or more types of resources,
	// such as EFS or RDS.
	ComplianceResourceTypes []*string `type:"list"`

	// The tag key-value pair applied to those Amazon Web Services resources that
	// you want to trigger an evaluation for a rule. A maximum of one key-value
	// pair can be provided. The tag value is optional, but it cannot be an empty
	// string. The structure to assign a tag is: [{"Key":"string","Value":"string"}].
	Tags map[string]*string `type:"map"`
	// contains filtered or unexported fields
}

A framework consists of one or more controls. Each control has its own control scope. The control scope can include one or more resource types, a combination of a tag key and value, or a combination of one resource type and one resource ID. If no scope is specified, evaluations for the rule are triggered when any resource in your recording group changes in configuration.

To set a control scope that includes all of a particular resource, leave the ControlScope empty or do not pass it when calling CreateFramework.

func (ControlScope) GoString added in v1.40.28

func (s ControlScope) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ControlScope) SetComplianceResourceIds added in v1.40.28

func (s *ControlScope) SetComplianceResourceIds(v []*string) *ControlScope

SetComplianceResourceIds sets the ComplianceResourceIds field's value.

func (*ControlScope) SetComplianceResourceTypes added in v1.40.28

func (s *ControlScope) SetComplianceResourceTypes(v []*string) *ControlScope

SetComplianceResourceTypes sets the ComplianceResourceTypes field's value.

func (*ControlScope) SetTags added in v1.40.28

func (s *ControlScope) SetTags(v map[string]*string) *ControlScope

SetTags sets the Tags field's value.

func (ControlScope) String added in v1.40.28

func (s ControlScope) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ControlScope) Validate added in v1.40.28

func (s *ControlScope) 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 “retention” 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.
	//
	// Resource types that are able to be transitioned to cold storage are listed
	// in the "Lifecycle to cold storage" section of the Feature availability by
	// resource (https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#features-by-resource)
	// table. Backup ignores this expression for other resource types.
	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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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"`

	// This returns the statistics of the included child (nested) copy jobs.
	ChildJobsInState map[string]*int64 `type:"map"`

	// 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"`

	// This is the identifier of a resource within a composite group, such as nested
	// (child) recovery point belonging to a composite (parent) stack. The ID is
	// transferred from the logical ID (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/resources-section-structure.html#resources-section-structure-syntax)
	// within a stack.
	CompositeMemberIdentifier *string `type:"string"`

	// Uniquely identifies a copy job.
	CopyJobId *string `type:"string"`

	// Contains information about the backup plan and rule that 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"`

	// This is a boolean value indicating this is a parent (composite) copy job.
	IsParent *bool `type:"boolean"`

	// This is the number of child (nested) copy jobs.
	NumberOfChildJobs *int64 `type:"long"`

	// This uniquely identifies a request to Backup to copy a resource. The return
	// will be the parent (composite) job ID.
	ParentJobId *string `type:"string"`

	// The Amazon Web Services 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"`

	// This is the non-unique name of the resource that belongs to the specified
	// backup.
	ResourceName *string `type:"string"`

	// The type of Amazon Web Services 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) SetChildJobsInState added in v1.44.146

func (s *CopyJob) SetChildJobsInState(v map[string]*int64) *CopyJob

SetChildJobsInState sets the ChildJobsInState 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) SetCompositeMemberIdentifier added in v1.44.146

func (s *CopyJob) SetCompositeMemberIdentifier(v string) *CopyJob

SetCompositeMemberIdentifier sets the CompositeMemberIdentifier 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) SetIsParent added in v1.44.146

func (s *CopyJob) SetIsParent(v bool) *CopyJob

SetIsParent sets the IsParent field's value.

func (*CopyJob) SetNumberOfChildJobs added in v1.44.146

func (s *CopyJob) SetNumberOfChildJobs(v int64) *CopyJob

SetNumberOfChildJobs sets the NumberOfChildJobs field's value.

func (*CopyJob) SetParentJobId added in v1.44.146

func (s *CopyJob) SetParentJobId(v string) *CopyJob

SetParentJobId sets the ParentJobId 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) SetResourceName added in v1.44.197

func (s *CopyJob) SetResourceName(v string) *CopyJob

SetResourceName sets the ResourceName 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by CreateBackupPlanInput's
	// String and GoString methods.
	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.
	//
	// If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters.
	CreatorRequestId *string `type:"string"`
	// contains filtered or unexported fields
}

func (CreateBackupPlanInput) GoString

func (s CreateBackupPlanInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 Volume Shadow Copy Service (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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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. This parameter
	// is optional.
	//
	// If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters.
	CreatorRequestId *string `type:"string"`
	// contains filtered or unexported fields
}

func (CreateBackupSelectionInput) GoString

func (s CreateBackupSelectionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 Amazon Web Services 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 is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by CreateBackupVaultInput's
	// String and GoString methods.
	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. This parameter
	// is optional.
	//
	// If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters.
	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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateFrameworkInput added in v1.40.28

type CreateFrameworkInput struct {

	// A list of the controls that make up the framework. Each control in the list
	// has a name, input parameters, and scope.
	//
	// FrameworkControls is a required field
	FrameworkControls []*FrameworkControl `type:"list" required:"true"`

	// An optional description of the framework with a maximum of 1,024 characters.
	FrameworkDescription *string `type:"string"`

	// The unique name of the framework. The name must be between 1 and 256 characters,
	// starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9),
	// and underscores (_).
	//
	// FrameworkName is a required field
	FrameworkName *string `min:"1" type:"string" required:"true"`

	// Metadata that you can assign to help organize the frameworks that you create.
	// Each tag is a key-value pair.
	FrameworkTags map[string]*string `type:"map"`

	// A customer-chosen string that you can use to distinguish between otherwise
	// identical calls to CreateFrameworkInput. Retrying a successful request with
	// the same idempotency token results in a success message with no action taken.
	IdempotencyToken *string `type:"string" idempotencyToken:"true"`
	// contains filtered or unexported fields
}

func (CreateFrameworkInput) GoString added in v1.40.28

func (s CreateFrameworkInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateFrameworkInput) SetFrameworkControls added in v1.40.28

func (s *CreateFrameworkInput) SetFrameworkControls(v []*FrameworkControl) *CreateFrameworkInput

SetFrameworkControls sets the FrameworkControls field's value.

func (*CreateFrameworkInput) SetFrameworkDescription added in v1.40.28

func (s *CreateFrameworkInput) SetFrameworkDescription(v string) *CreateFrameworkInput

SetFrameworkDescription sets the FrameworkDescription field's value.

func (*CreateFrameworkInput) SetFrameworkName added in v1.40.28

func (s *CreateFrameworkInput) SetFrameworkName(v string) *CreateFrameworkInput

SetFrameworkName sets the FrameworkName field's value.

func (*CreateFrameworkInput) SetFrameworkTags added in v1.40.28

func (s *CreateFrameworkInput) SetFrameworkTags(v map[string]*string) *CreateFrameworkInput

SetFrameworkTags sets the FrameworkTags field's value.

func (*CreateFrameworkInput) SetIdempotencyToken added in v1.40.28

func (s *CreateFrameworkInput) SetIdempotencyToken(v string) *CreateFrameworkInput

SetIdempotencyToken sets the IdempotencyToken field's value.

func (CreateFrameworkInput) String added in v1.40.28

func (s CreateFrameworkInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateFrameworkInput) Validate added in v1.40.28

func (s *CreateFrameworkInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateFrameworkOutput added in v1.40.28

type CreateFrameworkOutput struct {

	// An Amazon Resource Name (ARN) that uniquely identifies a resource. The format
	// of the ARN depends on the resource type.
	FrameworkArn *string `type:"string"`

	// The unique name of the framework. The name must be between 1 and 256 characters,
	// starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9),
	// and underscores (_).
	FrameworkName *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (CreateFrameworkOutput) GoString added in v1.40.28

func (s CreateFrameworkOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateFrameworkOutput) SetFrameworkArn added in v1.40.28

func (s *CreateFrameworkOutput) SetFrameworkArn(v string) *CreateFrameworkOutput

SetFrameworkArn sets the FrameworkArn field's value.

func (*CreateFrameworkOutput) SetFrameworkName added in v1.40.28

func (s *CreateFrameworkOutput) SetFrameworkName(v string) *CreateFrameworkOutput

SetFrameworkName sets the FrameworkName field's value.

func (CreateFrameworkOutput) String added in v1.40.28

func (s CreateFrameworkOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateLegalHoldInput added in v1.44.146

type CreateLegalHoldInput struct {

	// This is the string description of the legal hold.
	//
	// Description is a required field
	Description *string `type:"string" required:"true"`

	// This is a user-chosen string used to distinguish between otherwise identical
	// calls. Retrying a successful request with the same idempotency token results
	// in a success message with no action taken.
	IdempotencyToken *string `type:"string"`

	// This specifies criteria to assign a set of resources, such as resource types
	// or backup vaults.
	RecoveryPointSelection *RecoveryPointSelection `type:"structure"`

	// Optional tags to include. A tag is a key-value pair you can use to manage,
	// filter, and search for your resources. Allowed characters include UTF-8 letters,
	// numbers, spaces, and the following characters: + - = . _ : /.
	//
	// Tags is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by CreateLegalHoldInput's
	// String and GoString methods.
	Tags map[string]*string `type:"map" sensitive:"true"`

	// This is the string title of the legal hold.
	//
	// Title is a required field
	Title *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateLegalHoldInput) GoString added in v1.44.146

func (s CreateLegalHoldInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateLegalHoldInput) SetDescription added in v1.44.146

func (s *CreateLegalHoldInput) SetDescription(v string) *CreateLegalHoldInput

SetDescription sets the Description field's value.

func (*CreateLegalHoldInput) SetIdempotencyToken added in v1.44.146

func (s *CreateLegalHoldInput) SetIdempotencyToken(v string) *CreateLegalHoldInput

SetIdempotencyToken sets the IdempotencyToken field's value.

func (*CreateLegalHoldInput) SetRecoveryPointSelection added in v1.44.146

func (s *CreateLegalHoldInput) SetRecoveryPointSelection(v *RecoveryPointSelection) *CreateLegalHoldInput

SetRecoveryPointSelection sets the RecoveryPointSelection field's value.

func (*CreateLegalHoldInput) SetTags added in v1.44.146

SetTags sets the Tags field's value.

func (*CreateLegalHoldInput) SetTitle added in v1.44.146

SetTitle sets the Title field's value.

func (CreateLegalHoldInput) String added in v1.44.146

func (s CreateLegalHoldInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateLegalHoldInput) Validate added in v1.44.146

func (s *CreateLegalHoldInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateLegalHoldOutput added in v1.44.146

type CreateLegalHoldOutput struct {

	// Time in number format when legal hold was created.
	CreationDate *time.Time `type:"timestamp"`

	// This is the returned string description of the legal hold.
	Description *string `type:"string"`

	// This is the ARN (Amazon Resource Number) of the created legal hold.
	LegalHoldArn *string `type:"string"`

	// Legal hold ID returned for the specified legal hold on a recovery point.
	LegalHoldId *string `type:"string"`

	// This specifies criteria to assign a set of resources, such as resource types
	// or backup vaults.
	RecoveryPointSelection *RecoveryPointSelection `type:"structure"`

	// This displays the status of the legal hold returned after creating the legal
	// hold. Statuses can be ACTIVE, PENDING, CANCELED, CANCELING, or FAILED.
	Status *string `type:"string" enum:"LegalHoldStatus"`

	// This is the string title of the legal hold returned after creating the legal
	// hold.
	Title *string `type:"string"`
	// contains filtered or unexported fields
}

func (CreateLegalHoldOutput) GoString added in v1.44.146

func (s CreateLegalHoldOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateLegalHoldOutput) SetCreationDate added in v1.44.146

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

SetCreationDate sets the CreationDate field's value.

func (*CreateLegalHoldOutput) SetDescription added in v1.44.146

func (s *CreateLegalHoldOutput) SetDescription(v string) *CreateLegalHoldOutput

SetDescription sets the Description field's value.

func (*CreateLegalHoldOutput) SetLegalHoldArn added in v1.44.146

func (s *CreateLegalHoldOutput) SetLegalHoldArn(v string) *CreateLegalHoldOutput

SetLegalHoldArn sets the LegalHoldArn field's value.

func (*CreateLegalHoldOutput) SetLegalHoldId added in v1.44.146

func (s *CreateLegalHoldOutput) SetLegalHoldId(v string) *CreateLegalHoldOutput

SetLegalHoldId sets the LegalHoldId field's value.

func (*CreateLegalHoldOutput) SetRecoveryPointSelection added in v1.44.146

func (s *CreateLegalHoldOutput) SetRecoveryPointSelection(v *RecoveryPointSelection) *CreateLegalHoldOutput

SetRecoveryPointSelection sets the RecoveryPointSelection field's value.

func (*CreateLegalHoldOutput) SetStatus added in v1.44.146

SetStatus sets the Status field's value.

func (*CreateLegalHoldOutput) SetTitle added in v1.44.146

SetTitle sets the Title field's value.

func (CreateLegalHoldOutput) String added in v1.44.146

func (s CreateLegalHoldOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateReportPlanInput added in v1.40.28

type CreateReportPlanInput struct {

	// A customer-chosen string that you can use to distinguish between otherwise
	// identical calls to CreateReportPlanInput. Retrying a successful request with
	// the same idempotency token results in a success message with no action taken.
	IdempotencyToken *string `type:"string" idempotencyToken:"true"`

	// A structure that contains information about where and how to deliver your
	// reports, specifically your Amazon S3 bucket name, S3 key prefix, and the
	// formats of your reports.
	//
	// ReportDeliveryChannel is a required field
	ReportDeliveryChannel *ReportDeliveryChannel `type:"structure" required:"true"`

	// An optional description of the report plan with a maximum of 1,024 characters.
	ReportPlanDescription *string `type:"string"`

	// The unique name of the report plan. The name must be between 1 and 256 characters,
	// starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9),
	// and underscores (_).
	//
	// ReportPlanName is a required field
	ReportPlanName *string `min:"1" type:"string" required:"true"`

	// Metadata that you can assign to help organize the report plans that you create.
	// Each tag is a key-value pair.
	ReportPlanTags map[string]*string `type:"map"`

	// Identifies the report template for the report. Reports are built using a
	// report template. The report templates are:
	//
	// RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT
	// | COPY_JOB_REPORT | RESTORE_JOB_REPORT
	//
	// If the report template is RESOURCE_COMPLIANCE_REPORT or CONTROL_COMPLIANCE_REPORT,
	// this API resource also describes the report coverage by Amazon Web Services
	// Regions and frameworks.
	//
	// ReportSetting is a required field
	ReportSetting *ReportSetting `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (CreateReportPlanInput) GoString added in v1.40.28

func (s CreateReportPlanInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateReportPlanInput) SetIdempotencyToken added in v1.40.28

func (s *CreateReportPlanInput) SetIdempotencyToken(v string) *CreateReportPlanInput

SetIdempotencyToken sets the IdempotencyToken field's value.

func (*CreateReportPlanInput) SetReportDeliveryChannel added in v1.40.28

func (s *CreateReportPlanInput) SetReportDeliveryChannel(v *ReportDeliveryChannel) *CreateReportPlanInput

SetReportDeliveryChannel sets the ReportDeliveryChannel field's value.

func (*CreateReportPlanInput) SetReportPlanDescription added in v1.40.28

func (s *CreateReportPlanInput) SetReportPlanDescription(v string) *CreateReportPlanInput

SetReportPlanDescription sets the ReportPlanDescription field's value.

func (*CreateReportPlanInput) SetReportPlanName added in v1.40.28

func (s *CreateReportPlanInput) SetReportPlanName(v string) *CreateReportPlanInput

SetReportPlanName sets the ReportPlanName field's value.

func (*CreateReportPlanInput) SetReportPlanTags added in v1.40.28

func (s *CreateReportPlanInput) SetReportPlanTags(v map[string]*string) *CreateReportPlanInput

SetReportPlanTags sets the ReportPlanTags field's value.

func (*CreateReportPlanInput) SetReportSetting added in v1.40.28

SetReportSetting sets the ReportSetting field's value.

func (CreateReportPlanInput) String added in v1.40.28

func (s CreateReportPlanInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateReportPlanInput) Validate added in v1.40.28

func (s *CreateReportPlanInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateReportPlanOutput added in v1.40.28

type CreateReportPlanOutput struct {

	// The date and time a backup vault is created, in Unix format and Coordinated
	// Universal Time (UTC). The value of CreationTime is accurate to milliseconds.
	// For example, the value 1516925490.087 represents Friday, January 26, 2018
	// 12:11:30.087 AM.
	CreationTime *time.Time `type:"timestamp"`

	// An Amazon Resource Name (ARN) that uniquely identifies a resource. The format
	// of the ARN depends on the resource type.
	ReportPlanArn *string `type:"string"`

	// The unique name of the report plan.
	ReportPlanName *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (CreateReportPlanOutput) GoString added in v1.40.28

func (s CreateReportPlanOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateReportPlanOutput) SetCreationTime added in v1.40.56

func (s *CreateReportPlanOutput) SetCreationTime(v time.Time) *CreateReportPlanOutput

SetCreationTime sets the CreationTime field's value.

func (*CreateReportPlanOutput) SetReportPlanArn added in v1.40.28

func (s *CreateReportPlanOutput) SetReportPlanArn(v string) *CreateReportPlanOutput

SetReportPlanArn sets the ReportPlanArn field's value.

func (*CreateReportPlanOutput) SetReportPlanName added in v1.40.28

func (s *CreateReportPlanOutput) SetReportPlanName(v string) *CreateReportPlanOutput

SetReportPlanName sets the ReportPlanName field's value.

func (CreateReportPlanOutput) String added in v1.40.28

func (s CreateReportPlanOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DateRange added in v1.44.146

type DateRange struct {

	// This value is the beginning date, inclusive.
	//
	// The date and time are in Unix format and Coordinated Universal Time (UTC),
	// and it is accurate to milliseconds (milliseconds are optional).
	//
	// FromDate is a required field
	FromDate *time.Time `type:"timestamp" required:"true"`

	// This value is the end date, inclusive.
	//
	// The date and time are in Unix format and Coordinated Universal Time (UTC),
	// and it is accurate to milliseconds (milliseconds are optional).
	//
	// ToDate is a required field
	ToDate *time.Time `type:"timestamp" required:"true"`
	// contains filtered or unexported fields
}

This is a resource filter containing FromDate: DateTime and ToDate: DateTime. Both values are required. Future DateTime values are not permitted.

The date and time are in Unix format and Coordinated Universal Time (UTC), and it is accurate to milliseconds ((milliseconds are optional). For example, the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM.

func (DateRange) GoString added in v1.44.146

func (s DateRange) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DateRange) SetFromDate added in v1.44.146

func (s *DateRange) SetFromDate(v time.Time) *DateRange

SetFromDate sets the FromDate field's value.

func (*DateRange) SetToDate added in v1.44.146

func (s *DateRange) SetToDate(v time.Time) *DateRange

SetToDate sets the ToDate field's value.

func (DateRange) String added in v1.44.146

func (s DateRange) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DateRange) Validate added in v1.44.146

func (s *DateRange) Validate() error

Validate inspects the fields of the type to determine if they are valid.

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteBackupSelectionOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 Amazon Web Services 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteBackupVaultAccessPolicyInput) SetBackupVaultName

SetBackupVaultName sets the BackupVaultName field's value.

func (DeleteBackupVaultAccessPolicyInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteBackupVaultAccessPolicyOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 Amazon Web Services 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteBackupVaultInput) Validate

func (s *DeleteBackupVaultInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteBackupVaultLockConfigurationInput added in v1.40.58

type DeleteBackupVaultLockConfigurationInput struct {

	// The name of the backup vault from which to delete Backup Vault Lock.
	//
	// BackupVaultName is a required field
	BackupVaultName *string `location:"uri" locationName:"backupVaultName" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteBackupVaultLockConfigurationInput) GoString added in v1.40.58

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteBackupVaultLockConfigurationInput) SetBackupVaultName added in v1.40.58

SetBackupVaultName sets the BackupVaultName field's value.

func (DeleteBackupVaultLockConfigurationInput) String added in v1.40.58

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteBackupVaultLockConfigurationInput) Validate added in v1.40.58

Validate inspects the fields of the type to determine if they are valid.

type DeleteBackupVaultLockConfigurationOutput added in v1.40.58

type DeleteBackupVaultLockConfigurationOutput struct {
	// contains filtered or unexported fields
}

func (DeleteBackupVaultLockConfigurationOutput) GoString added in v1.40.58

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteBackupVaultLockConfigurationOutput) String added in v1.40.58

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteBackupVaultNotificationsInput) SetBackupVaultName

SetBackupVaultName sets the BackupVaultName field's value.

func (DeleteBackupVaultNotificationsInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteBackupVaultNotificationsOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteBackupVaultOutput

type DeleteBackupVaultOutput struct {
	// contains filtered or unexported fields
}

func (DeleteBackupVaultOutput) GoString

func (s DeleteBackupVaultOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteBackupVaultOutput) String

func (s DeleteBackupVaultOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteFrameworkInput added in v1.40.28

type DeleteFrameworkInput struct {

	// The unique name of a framework.
	//
	// FrameworkName is a required field
	FrameworkName *string `location:"uri" locationName:"frameworkName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteFrameworkInput) GoString added in v1.40.28

func (s DeleteFrameworkInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteFrameworkInput) SetFrameworkName added in v1.40.28

func (s *DeleteFrameworkInput) SetFrameworkName(v string) *DeleteFrameworkInput

SetFrameworkName sets the FrameworkName field's value.

func (DeleteFrameworkInput) String added in v1.40.28

func (s DeleteFrameworkInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteFrameworkInput) Validate added in v1.40.28

func (s *DeleteFrameworkInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteFrameworkOutput added in v1.40.28

type DeleteFrameworkOutput struct {
	// contains filtered or unexported fields
}

func (DeleteFrameworkOutput) GoString added in v1.40.28

func (s DeleteFrameworkOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteFrameworkOutput) String added in v1.40.28

func (s DeleteFrameworkOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 Amazon Web Services 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteRecoveryPointOutput) String

func (s DeleteRecoveryPointOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteReportPlanInput added in v1.40.28

type DeleteReportPlanInput struct {

	// The unique name of a report plan.
	//
	// ReportPlanName is a required field
	ReportPlanName *string `location:"uri" locationName:"reportPlanName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteReportPlanInput) GoString added in v1.40.28

func (s DeleteReportPlanInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteReportPlanInput) SetReportPlanName added in v1.40.28

func (s *DeleteReportPlanInput) SetReportPlanName(v string) *DeleteReportPlanInput

SetReportPlanName sets the ReportPlanName field's value.

func (DeleteReportPlanInput) String added in v1.40.28

func (s DeleteReportPlanInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteReportPlanInput) Validate added in v1.40.28

func (s *DeleteReportPlanInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteReportPlanOutput added in v1.40.28

type DeleteReportPlanOutput struct {
	// contains filtered or unexported fields
}

func (DeleteReportPlanOutput) GoString added in v1.40.28

func (s DeleteReportPlanOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteReportPlanOutput) String added in v1.40.28

func (s DeleteReportPlanOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 Amazon Web Services service or resource returned an error to the 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeBackupJobInput

type DescribeBackupJobInput struct {

	// Uniquely identifies a request to 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeBackupJobInput) SetBackupJobId

SetBackupJobId sets the BackupJobId field's value.

func (DescribeBackupJobInput) String

func (s DescribeBackupJobInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 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 Windows Volume Shadow Copy Service (VSS) backup was taken,
	// BackupType returns "WindowsVSS". If BackupType is empty, then the backup
	// type was 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 Amazon Web Services 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"`

	// This returns the statistics of the included child (nested) backup jobs.
	ChildJobsInState map[string]*int64 `type:"map"`

	// 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"`

	// This returns the boolean value that a backup job is a parent (composite)
	// job.
	IsParent *bool `type:"boolean"`

	// This returns the number of child (nested) backup jobs.
	NumberOfChildJobs *int64 `type:"long"`

	// This returns the parent (composite) resource backup job ID.
	ParentJobId *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"`

	// This is the non-unique name of the resource that belongs to the specified
	// backup.
	ResourceName *string `type:"string"`

	// The type of Amazon Web Services 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) SetChildJobsInState added in v1.44.146

func (s *DescribeBackupJobOutput) SetChildJobsInState(v map[string]*int64) *DescribeBackupJobOutput

SetChildJobsInState sets the ChildJobsInState 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) SetIsParent added in v1.44.146

SetIsParent sets the IsParent field's value.

func (*DescribeBackupJobOutput) SetNumberOfChildJobs added in v1.44.146

func (s *DescribeBackupJobOutput) SetNumberOfChildJobs(v int64) *DescribeBackupJobOutput

SetNumberOfChildJobs sets the NumberOfChildJobs field's value.

func (*DescribeBackupJobOutput) SetParentJobId added in v1.44.146

SetParentJobId sets the ParentJobId 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) SetResourceName added in v1.44.197

SetResourceName sets the ResourceName 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 Amazon Web Services 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 date and time when Backup Vault Lock configuration cannot be changed
	// or deleted.
	//
	// If you applied Vault Lock to your vault without specifying a lock date, you
	// can change any of your Vault Lock settings, or delete Vault Lock from the
	// vault entirely, at any time.
	//
	// This value is in Unix format, Coordinated Universal Time (UTC), and accurate
	// to milliseconds. For example, the value 1516925490.087 represents Friday,
	// January 26, 2018 12:11:30.087 AM.
	LockDate *time.Time `type:"timestamp"`

	// A Boolean that indicates whether Backup Vault Lock is currently protecting
	// the backup vault. True means that Vault Lock causes delete or update operations
	// on the recovery points stored in the vault to fail.
	Locked *bool `type:"boolean"`

	// The Backup Vault Lock setting that specifies the maximum retention period
	// that the vault retains its recovery points. If this parameter is not specified,
	// Vault Lock does not enforce a maximum retention period on the recovery points
	// in the vault (allowing indefinite storage).
	//
	// If specified, any backup or copy job to the vault must have a lifecycle policy
	// with a retention period equal to or shorter than the maximum retention period.
	// If the job's retention period is longer than that maximum retention period,
	// then the vault fails the backup or copy job, and you should either modify
	// your lifecycle settings or use a different vault. Recovery points already
	// stored in the vault prior to Vault Lock are not affected.
	MaxRetentionDays *int64 `type:"long"`

	// The Backup Vault Lock setting that specifies the minimum retention period
	// that the vault retains its recovery points. If this parameter is not specified,
	// Vault Lock does not enforce a minimum retention period.
	//
	// If specified, any backup or copy job to the vault must have a lifecycle policy
	// with a retention period equal to or longer than the minimum retention period.
	// If the job's retention period is shorter than that minimum retention period,
	// then the vault fails the backup or copy job, and you should either modify
	// your lifecycle settings or use a different vault. Recovery points already
	// stored in the vault prior to Vault Lock are not affected.
	MinRetentionDays *int64 `type:"long"`

	// 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) SetLockDate added in v1.40.58

SetLockDate sets the LockDate field's value.

func (*DescribeBackupVaultOutput) SetLocked added in v1.40.58

SetLocked sets the Locked field's value.

func (*DescribeBackupVaultOutput) SetMaxRetentionDays added in v1.40.58

func (s *DescribeBackupVaultOutput) SetMaxRetentionDays(v int64) *DescribeBackupVaultOutput

SetMaxRetentionDays sets the MaxRetentionDays field's value.

func (*DescribeBackupVaultOutput) SetMinRetentionDays added in v1.40.58

func (s *DescribeBackupVaultOutput) SetMinRetentionDays(v int64) *DescribeBackupVaultOutput

SetMinRetentionDays sets the MinRetentionDays 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeFrameworkInput added in v1.40.28

type DescribeFrameworkInput struct {

	// The unique name of a framework.
	//
	// FrameworkName is a required field
	FrameworkName *string `location:"uri" locationName:"frameworkName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeFrameworkInput) GoString added in v1.40.28

func (s DescribeFrameworkInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeFrameworkInput) SetFrameworkName added in v1.40.28

func (s *DescribeFrameworkInput) SetFrameworkName(v string) *DescribeFrameworkInput

SetFrameworkName sets the FrameworkName field's value.

func (DescribeFrameworkInput) String added in v1.40.28

func (s DescribeFrameworkInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeFrameworkInput) Validate added in v1.40.28

func (s *DescribeFrameworkInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeFrameworkOutput added in v1.40.28

type DescribeFrameworkOutput struct {

	// The date and time that a framework is created, in ISO 8601 representation.
	// The value of CreationTime is accurate to milliseconds. For example, 2020-07-10T15:00:00.000-08:00
	// represents the 10th of July 2020 at 3:00 PM 8 hours behind UTC.
	CreationTime *time.Time `type:"timestamp"`

	// The deployment status of a framework. The statuses are:
	//
	// CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED
	// | FAILED
	DeploymentStatus *string `type:"string"`

	// An Amazon Resource Name (ARN) that uniquely identifies a resource. The format
	// of the ARN depends on the resource type.
	FrameworkArn *string `type:"string"`

	// A list of the controls that make up the framework. Each control in the list
	// has a name, input parameters, and scope.
	FrameworkControls []*FrameworkControl `type:"list"`

	// An optional description of the framework.
	FrameworkDescription *string `type:"string"`

	// The unique name of a framework.
	FrameworkName *string `min:"1" type:"string"`

	// A framework consists of one or more controls. Each control governs a resource,
	// such as backup plans, backup selections, backup vaults, or recovery points.
	// You can also turn Config recording on or off for each resource. The statuses
	// are:
	//
	//    * ACTIVE when recording is turned on for all resources governed by the
	//    framework.
	//
	//    * PARTIALLY_ACTIVE when recording is turned off for at least one resource
	//    governed by the framework.
	//
	//    * INACTIVE when recording is turned off for all resources governed by
	//    the framework.
	//
	//    * UNAVAILABLE when Backup is unable to validate recording status at this
	//    time.
	FrameworkStatus *string `type:"string"`

	// A customer-chosen string that you can use to distinguish between otherwise
	// identical calls to DescribeFrameworkOutput. Retrying a successful request
	// with the same idempotency token results in a success message with no action
	// taken.
	IdempotencyToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (DescribeFrameworkOutput) GoString added in v1.40.28

func (s DescribeFrameworkOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeFrameworkOutput) SetCreationTime added in v1.40.28

SetCreationTime sets the CreationTime field's value.

func (*DescribeFrameworkOutput) SetDeploymentStatus added in v1.40.28

func (s *DescribeFrameworkOutput) SetDeploymentStatus(v string) *DescribeFrameworkOutput

SetDeploymentStatus sets the DeploymentStatus field's value.

func (*DescribeFrameworkOutput) SetFrameworkArn added in v1.40.28

SetFrameworkArn sets the FrameworkArn field's value.

func (*DescribeFrameworkOutput) SetFrameworkControls added in v1.40.28

func (s *DescribeFrameworkOutput) SetFrameworkControls(v []*FrameworkControl) *DescribeFrameworkOutput

SetFrameworkControls sets the FrameworkControls field's value.

func (*DescribeFrameworkOutput) SetFrameworkDescription added in v1.40.28

func (s *DescribeFrameworkOutput) SetFrameworkDescription(v string) *DescribeFrameworkOutput

SetFrameworkDescription sets the FrameworkDescription field's value.

func (*DescribeFrameworkOutput) SetFrameworkName added in v1.40.28

func (s *DescribeFrameworkOutput) SetFrameworkName(v string) *DescribeFrameworkOutput

SetFrameworkName sets the FrameworkName field's value.

func (*DescribeFrameworkOutput) SetFrameworkStatus added in v1.40.28

func (s *DescribeFrameworkOutput) SetFrameworkStatus(v string) *DescribeFrameworkOutput

SetFrameworkStatus sets the FrameworkStatus field's value.

func (*DescribeFrameworkOutput) SetIdempotencyToken added in v1.40.28

func (s *DescribeFrameworkOutput) SetIdempotencyToken(v string) *DescribeFrameworkOutput

SetIdempotencyToken sets the IdempotencyToken field's value.

func (DescribeFrameworkOutput) String added in v1.40.28

func (s DescribeFrameworkOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DescribeGlobalSettingsInput) String added in v1.35.31

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeGlobalSettingsOutput added in v1.35.31

type DescribeGlobalSettingsOutput struct {

	// The status of the flag isCrossAccountBackupEnabled.
	GlobalSettings map[string]*string `type:"map"`

	// The date and time that the flag isCrossAccountBackupEnabled was 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeProtectedResourceInput) SetResourceArn

SetResourceArn sets the ResourceArn field's value.

func (DescribeProtectedResourceInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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"`

	// This is the non-unique name of the resource that belongs to the specified
	// backup.
	ResourceName *string `type:"string"`

	// The type of Amazon Web Services resource saved as a recovery point; for example,
	// an Amazon EBS volume or an Amazon RDS database.
	ResourceType *string `type:"string"`
	// contains filtered or unexported fields
}

func (DescribeProtectedResourceOutput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeProtectedResourceOutput) SetLastBackupTime

SetLastBackupTime sets the LastBackupTime field's value.

func (*DescribeProtectedResourceOutput) SetResourceArn

SetResourceArn sets the ResourceArn field's value.

func (*DescribeProtectedResourceOutput) SetResourceName added in v1.44.197

SetResourceName sets the ResourceName field's value.

func (*DescribeProtectedResourceOutput) SetResourceType

SetResourceType sets the ResourceType field's value.

func (DescribeProtectedResourceOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 Amazon Web Services 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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"`

	// This is the identifier of a resource within a composite group, such as nested
	// (child) recovery point belonging to a composite (parent) stack. The ID is
	// transferred from the logical ID (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/resources-section-structure.html#resources-section-structure-syntax)
	// within a stack.
	CompositeMemberIdentifier *string `type:"string"`

	// 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"`

	// This returns the boolean value that a recovery point is a parent (composite)
	// job.
	IsParent *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. 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 “retention” 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.
	//
	// Resource types that are able to be transitioned to cold storage are listed
	// in the "Lifecycle to cold storage" section of the Feature availability by
	// resource (https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#features-by-resource)
	// table. Backup ignores this expression for other resource types.
	Lifecycle *Lifecycle `type:"structure"`

	// This is an ARN that uniquely identifies a parent (composite) recovery point;
	// for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
	ParentRecoveryPointArn *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"`

	// This is the non-unique name of the resource that belongs to the specified
	// backup.
	ResourceName *string `type:"string"`

	// The type of Amazon Web Services 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 Amazon Web Services account or Region,
	// this value will be null.
	SourceBackupVaultArn *string `type:"string"`

	// A status code specifying the state of the recovery point.
	//
	// PARTIAL status indicates Backup could not create the recovery point before
	// the backup window closed. To increase your backup plan window using the API,
	// see UpdateBackupPlan (https://docs.aws.amazon.com/aws-backup/latest/devguide/API_UpdateBackupPlan.html).
	// You can also increase your backup plan window using the Console by choosing
	// and editing your backup plan.
	//
	// EXPIRED status indicates that the recovery point has exceeded its retention
	// period, but Backup lacks permission or is otherwise unable to delete it.
	// To manually delete these recovery points, see Step 3: Delete the recovery
	// points (https://docs.aws.amazon.com/aws-backup/latest/devguide/gs-cleanup-resources.html#cleanup-backups)
	// in the Clean up resources section of Getting started.
	//
	// STOPPED status occurs on a continuous backup where a user has taken some
	// action that causes the continuous backup to be disabled. This can be caused
	// by the removal of permissions, turning off versioning, turning off events
	// being sent to EventBridge, or disabling the EventBridge rules that are put
	// in place by Backup.
	//
	// To resolve STOPPED status, ensure that all requested permissions are in place
	// and that versioning is enabled on the S3 bucket. Once these conditions are
	// met, the next instance of a backup rule running will result in a new continuous
	// recovery point being created. The recovery points with STOPPED status do
	// not need to be deleted.
	//
	// For SAP HANA on Amazon EC2 STOPPED status occurs due to user action, application
	// misconfiguration, or backup failure. To ensure that future continuous backups
	// succeed, refer to the recovery point status and check SAP HANA for details.
	Status *string `type:"string" enum:"RecoveryPointStatus"`

	// A status message explaining the status of the recovery point.
	StatusMessage *string `type:"string"`

	// 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) SetCompositeMemberIdentifier added in v1.44.146

func (s *DescribeRecoveryPointOutput) SetCompositeMemberIdentifier(v string) *DescribeRecoveryPointOutput

SetCompositeMemberIdentifier sets the CompositeMemberIdentifier 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) SetIsParent added in v1.44.146

SetIsParent sets the IsParent 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) SetParentRecoveryPointArn added in v1.44.146

func (s *DescribeRecoveryPointOutput) SetParentRecoveryPointArn(v string) *DescribeRecoveryPointOutput

SetParentRecoveryPointArn sets the ParentRecoveryPointArn 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) SetResourceName added in v1.44.197

SetResourceName sets the ResourceName 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) SetStatusMessage added in v1.40.28

SetStatusMessage sets the StatusMessage field's value.

func (*DescribeRecoveryPointOutput) SetStorageClass

SetStorageClass sets the StorageClass field's value.

func (DescribeRecoveryPointOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DescribeRegionSettingsInput) String added in v1.31.2

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeRegionSettingsOutput added in v1.31.2

type DescribeRegionSettingsOutput struct {

	// Returns whether Backup fully manages the backups for a resource type.
	//
	// For the benefits of full Backup management, see Full Backup management (https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#full-management).
	//
	// For a list of resource types and whether each supports full Backup management,
	// see the Feature availability by resource (https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#features-by-resource)
	// table.
	//
	// If "DynamoDB":false, you can enable full Backup management for DynamoDB backup
	// by enabling Backup's advanced DynamoDB backup features (https://docs.aws.amazon.com/aws-backup/latest/devguide/advanced-ddb-backup.html#advanced-ddb-backup-enable-cli).
	ResourceTypeManagementPreference map[string]*bool `type:"map"`

	// 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeRegionSettingsOutput) SetResourceTypeManagementPreference added in v1.42.11

func (s *DescribeRegionSettingsOutput) SetResourceTypeManagementPreference(v map[string]*bool) *DescribeRegionSettingsOutput

SetResourceTypeManagementPreference sets the ResourceTypeManagementPreference field's value.

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeReportJobInput added in v1.40.28

type DescribeReportJobInput struct {

	// The identifier of the report job. A unique, randomly generated, Unicode,
	// UTF-8 encoded string that is at most 1,024 bytes long. The report job ID
	// cannot be edited.
	//
	// ReportJobId is a required field
	ReportJobId *string `location:"uri" locationName:"reportJobId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeReportJobInput) GoString added in v1.40.28

func (s DescribeReportJobInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeReportJobInput) SetReportJobId added in v1.40.28

SetReportJobId sets the ReportJobId field's value.

func (DescribeReportJobInput) String added in v1.40.28

func (s DescribeReportJobInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeReportJobInput) Validate added in v1.40.28

func (s *DescribeReportJobInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeReportJobOutput added in v1.40.28

type DescribeReportJobOutput struct {

	// A list of information about a report job, including its completion and creation
	// times, report destination, unique report job ID, Amazon Resource Name (ARN),
	// report template, status, and status message.
	ReportJob *ReportJob `type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeReportJobOutput) GoString added in v1.40.28

func (s DescribeReportJobOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeReportJobOutput) SetReportJob added in v1.40.28

SetReportJob sets the ReportJob field's value.

func (DescribeReportJobOutput) String added in v1.40.28

func (s DescribeReportJobOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeReportPlanInput added in v1.40.28

type DescribeReportPlanInput struct {

	// The unique name of a report plan.
	//
	// ReportPlanName is a required field
	ReportPlanName *string `location:"uri" locationName:"reportPlanName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeReportPlanInput) GoString added in v1.40.28

func (s DescribeReportPlanInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeReportPlanInput) SetReportPlanName added in v1.40.28

func (s *DescribeReportPlanInput) SetReportPlanName(v string) *DescribeReportPlanInput

SetReportPlanName sets the ReportPlanName field's value.

func (DescribeReportPlanInput) String added in v1.40.28

func (s DescribeReportPlanInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeReportPlanInput) Validate added in v1.40.28

func (s *DescribeReportPlanInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeReportPlanOutput added in v1.40.28

type DescribeReportPlanOutput struct {

	// Returns details about the report plan that is specified by its name. These
	// details include the report plan's Amazon Resource Name (ARN), description,
	// settings, delivery channel, deployment status, creation time, and last attempted
	// and successful run times.
	ReportPlan *ReportPlan `type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeReportPlanOutput) GoString added in v1.40.28

func (s DescribeReportPlanOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeReportPlanOutput) SetReportPlan added in v1.40.28

SetReportPlan sets the ReportPlan field's value.

func (DescribeReportPlanOutput) String added in v1.40.28

func (s DescribeReportPlanOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeRestoreJobInput) SetRestoreJobId

SetRestoreJobId sets the RestoreJobId field's value.

func (DescribeRestoreJobInput) String

func (s DescribeRestoreJobInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DisassociateRecoveryPointFromParentInput added in v1.44.146

type DisassociateRecoveryPointFromParentInput struct {

	// This is the name of a logical container where the child (nested) recovery
	// point is stored. Backup vaults are identified by names that are unique to
	// the account used to create them and the Amazon Web Services 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"`

	// This is the Amazon Resource Name (ARN) that uniquely identifies the child
	// (nested) 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 (DisassociateRecoveryPointFromParentInput) GoString added in v1.44.146

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DisassociateRecoveryPointFromParentInput) SetBackupVaultName added in v1.44.146

SetBackupVaultName sets the BackupVaultName field's value.

func (*DisassociateRecoveryPointFromParentInput) SetRecoveryPointArn added in v1.44.146

SetRecoveryPointArn sets the RecoveryPointArn field's value.

func (DisassociateRecoveryPointFromParentInput) String added in v1.44.146

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DisassociateRecoveryPointFromParentInput) Validate added in v1.44.146

Validate inspects the fields of the type to determine if they are valid.

type DisassociateRecoveryPointFromParentOutput added in v1.44.146

type DisassociateRecoveryPointFromParentOutput struct {
	// contains filtered or unexported fields
}

func (DisassociateRecoveryPointFromParentOutput) GoString added in v1.44.146

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DisassociateRecoveryPointFromParentOutput) String added in v1.44.146

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DisassociateRecoveryPointInput added in v1.37.28

type DisassociateRecoveryPointInput struct {

	// The unique name of an Backup vault.
	//
	// BackupVaultName is a required field
	BackupVaultName *string `location:"uri" locationName:"backupVaultName" type:"string" required:"true"`

	// An Amazon Resource Name (ARN) that uniquely identifies an Backup recovery
	// point.
	//
	// 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DisassociateRecoveryPointOutput) String added in v1.37.28

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ExportBackupPlanTemplateInput) SetBackupPlanId

SetBackupPlanId sets the BackupPlanId field's value.

func (ExportBackupPlanTemplateInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Framework added in v1.40.28

type Framework struct {

	// The date and time that a framework is created, in ISO 8601 representation.
	// The value of CreationTime is accurate to milliseconds. For example, 2020-07-10T15:00:00.000-08:00
	// represents the 10th of July 2020 at 3:00 PM 8 hours behind UTC.
	CreationTime *time.Time `type:"timestamp"`

	// The deployment status of a framework. The statuses are:
	//
	// CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED
	// | FAILED
	DeploymentStatus *string `type:"string"`

	// An Amazon Resource Name (ARN) that uniquely identifies a resource. The format
	// of the ARN depends on the resource type.
	FrameworkArn *string `type:"string"`

	// An optional description of the framework with a maximum 1,024 characters.
	FrameworkDescription *string `type:"string"`

	// The unique name of a framework. This name is between 1 and 256 characters,
	// starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9),
	// and underscores (_).
	FrameworkName *string `min:"1" type:"string"`

	// The number of controls contained by the framework.
	NumberOfControls *int64 `type:"integer"`
	// contains filtered or unexported fields
}

Contains detailed information about a framework. Frameworks contain controls, which evaluate and report on your backup events and resources. Frameworks generate daily compliance results.

func (Framework) GoString added in v1.40.28

func (s Framework) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Framework) SetCreationTime added in v1.40.28

func (s *Framework) SetCreationTime(v time.Time) *Framework

SetCreationTime sets the CreationTime field's value.

func (*Framework) SetDeploymentStatus added in v1.40.28

func (s *Framework) SetDeploymentStatus(v string) *Framework

SetDeploymentStatus sets the DeploymentStatus field's value.

func (*Framework) SetFrameworkArn added in v1.40.28

func (s *Framework) SetFrameworkArn(v string) *Framework

SetFrameworkArn sets the FrameworkArn field's value.

func (*Framework) SetFrameworkDescription added in v1.40.28

func (s *Framework) SetFrameworkDescription(v string) *Framework

SetFrameworkDescription sets the FrameworkDescription field's value.

func (*Framework) SetFrameworkName added in v1.40.28

func (s *Framework) SetFrameworkName(v string) *Framework

SetFrameworkName sets the FrameworkName field's value.

func (*Framework) SetNumberOfControls added in v1.40.28

func (s *Framework) SetNumberOfControls(v int64) *Framework

SetNumberOfControls sets the NumberOfControls field's value.

func (Framework) String added in v1.40.28

func (s Framework) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type FrameworkControl added in v1.40.28

type FrameworkControl struct {

	// A list of ParameterName and ParameterValue pairs.
	ControlInputParameters []*ControlInputParameter `type:"list"`

	// The name of a control. This name is between 1 and 256 characters.
	//
	// ControlName is a required field
	ControlName *string `type:"string" required:"true"`

	// The scope of a control. The control scope defines what the control will evaluate.
	// Three examples of control scopes are: a specific backup plan, all backup
	// plans with a specific tag, or all backup plans. For more information, see
	// ControlScope. (aws-backup/latest/devguide/API_ControlScope.html)
	ControlScope *ControlScope `type:"structure"`
	// contains filtered or unexported fields
}

Contains detailed information about all of the controls of a framework. Each framework must contain at least one control.

func (FrameworkControl) GoString added in v1.40.28

func (s FrameworkControl) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FrameworkControl) SetControlInputParameters added in v1.40.28

func (s *FrameworkControl) SetControlInputParameters(v []*ControlInputParameter) *FrameworkControl

SetControlInputParameters sets the ControlInputParameters field's value.

func (*FrameworkControl) SetControlName added in v1.40.28

func (s *FrameworkControl) SetControlName(v string) *FrameworkControl

SetControlName sets the ControlName field's value.

func (*FrameworkControl) SetControlScope added in v1.40.28

func (s *FrameworkControl) SetControlScope(v *ControlScope) *FrameworkControl

SetControlScope sets the ControlScope field's value.

func (FrameworkControl) String added in v1.40.28

func (s FrameworkControl) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FrameworkControl) Validate added in v1.40.28

func (s *FrameworkControl) Validate() error

Validate inspects the fields of the type to determine if they are valid.

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetBackupPlanFromJSONOutput) SetBackupPlan

SetBackupPlan sets the BackupPlan field's value.

func (GetBackupPlanFromJSONOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetBackupPlanFromTemplateInput) SetBackupPlanTemplateId

SetBackupPlanTemplateId sets the BackupPlanTemplateId field's value.

func (GetBackupPlanFromTemplateInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetBackupPlanFromTemplateOutput) SetBackupPlanDocument

SetBackupPlanDocument sets the BackupPlanDocument field's value.

func (GetBackupPlanFromTemplateOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 Amazon Web Services 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetBackupVaultAccessPolicyInput) SetBackupVaultName

SetBackupVaultName sets the BackupVaultName field's value.

func (GetBackupVaultAccessPolicyInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 Amazon Web Services 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetBackupVaultNotificationsInput) SetBackupVaultName

SetBackupVaultName sets the BackupVaultName field's value.

func (GetBackupVaultNotificationsInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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" enum:"VaultEvent"`

	// 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetLegalHoldInput added in v1.44.146

type GetLegalHoldInput struct {

	// This is the ID required to use GetLegalHold. This unique ID is associated
	// with a specific legal hold.
	//
	// LegalHoldId is a required field
	LegalHoldId *string `location:"uri" locationName:"legalHoldId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (GetLegalHoldInput) GoString added in v1.44.146

func (s GetLegalHoldInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetLegalHoldInput) SetLegalHoldId added in v1.44.146

func (s *GetLegalHoldInput) SetLegalHoldId(v string) *GetLegalHoldInput

SetLegalHoldId sets the LegalHoldId field's value.

func (GetLegalHoldInput) String added in v1.44.146

func (s GetLegalHoldInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetLegalHoldInput) Validate added in v1.44.146

func (s *GetLegalHoldInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetLegalHoldOutput added in v1.44.146

type GetLegalHoldOutput struct {

	// String describing the reason for removing the legal hold.
	CancelDescription *string `type:"string"`

	// Time in number when legal hold was cancelled.
	CancellationDate *time.Time `type:"timestamp"`

	// Time in number format when legal hold was created.
	CreationDate *time.Time `type:"timestamp"`

	// This is the returned string description of the legal hold.
	Description *string `type:"string"`

	// This is the returned framework ARN for the specified legal hold. An Amazon
	// Resource Name (ARN) uniquely identifies a resource. The format of the ARN
	// depends on the resource type.
	LegalHoldArn *string `type:"string"`

	// This is the returned ID associated with a specified legal hold.
	LegalHoldId *string `type:"string"`

	// This specifies criteria to assign a set of resources, such as resource types
	// or backup vaults.
	RecoveryPointSelection *RecoveryPointSelection `type:"structure"`

	// This is the date and time until which the legal hold record will be retained.
	RetainRecordUntil *time.Time `type:"timestamp"`

	// This is the status of the legal hold. Statuses can be ACTIVE, CREATING, CANCELED,
	// and CANCELING.
	Status *string `type:"string" enum:"LegalHoldStatus"`

	// This is the string title of the legal hold.
	Title *string `type:"string"`
	// contains filtered or unexported fields
}

func (GetLegalHoldOutput) GoString added in v1.44.146

func (s GetLegalHoldOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetLegalHoldOutput) SetCancelDescription added in v1.44.146

func (s *GetLegalHoldOutput) SetCancelDescription(v string) *GetLegalHoldOutput

SetCancelDescription sets the CancelDescription field's value.

func (*GetLegalHoldOutput) SetCancellationDate added in v1.44.146

func (s *GetLegalHoldOutput) SetCancellationDate(v time.Time) *GetLegalHoldOutput

SetCancellationDate sets the CancellationDate field's value.

func (*GetLegalHoldOutput) SetCreationDate added in v1.44.146

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

SetCreationDate sets the CreationDate field's value.

func (*GetLegalHoldOutput) SetDescription added in v1.44.146

func (s *GetLegalHoldOutput) SetDescription(v string) *GetLegalHoldOutput

SetDescription sets the Description field's value.

func (*GetLegalHoldOutput) SetLegalHoldArn added in v1.44.146

func (s *GetLegalHoldOutput) SetLegalHoldArn(v string) *GetLegalHoldOutput

SetLegalHoldArn sets the LegalHoldArn field's value.

func (*GetLegalHoldOutput) SetLegalHoldId added in v1.44.146

func (s *GetLegalHoldOutput) SetLegalHoldId(v string) *GetLegalHoldOutput

SetLegalHoldId sets the LegalHoldId field's value.

func (*GetLegalHoldOutput) SetRecoveryPointSelection added in v1.44.146

func (s *GetLegalHoldOutput) SetRecoveryPointSelection(v *RecoveryPointSelection) *GetLegalHoldOutput

SetRecoveryPointSelection sets the RecoveryPointSelection field's value.

func (*GetLegalHoldOutput) SetRetainRecordUntil added in v1.44.146

func (s *GetLegalHoldOutput) SetRetainRecordUntil(v time.Time) *GetLegalHoldOutput

SetRetainRecordUntil sets the RetainRecordUntil field's value.

func (*GetLegalHoldOutput) SetStatus added in v1.44.146

func (s *GetLegalHoldOutput) SetStatus(v string) *GetLegalHoldOutput

SetStatus sets the Status field's value.

func (*GetLegalHoldOutput) SetTitle added in v1.44.146

SetTitle sets the Title field's value.

func (GetLegalHoldOutput) String added in v1.44.146

func (s GetLegalHoldOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 Amazon Web Services 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by GetRecoveryPointRestoreMetadataOutput's
	// String and GoString methods.
	RestoreMetadata map[string]*string `type:"map" sensitive:"true"`
	// contains filtered or unexported fields
}

func (GetRecoveryPointRestoreMetadataOutput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetSupportedResourceTypesInput

type GetSupportedResourceTypesInput struct {
	// contains filtered or unexported fields
}

func (GetSupportedResourceTypesInput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (GetSupportedResourceTypesInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetSupportedResourceTypesOutput

type GetSupportedResourceTypesOutput struct {

	// Contains a string with the supported Amazon Web Services resource types:
	//
	//    * Aurora for Amazon Aurora
	//
	//    * DynamoDB for Amazon DynamoDB
	//
	//    * EBS for Amazon Elastic Block Store
	//
	//    * EC2 for Amazon Elastic Compute Cloud
	//
	//    * EFS for Amazon Elastic File System
	//
	//    * FSX for Amazon FSx
	//
	//    * RDS for Amazon Relational Database Service
	//
	//    * Storage Gateway for Storage Gateway
	//
	//    * DocDB for Amazon DocumentDB (with MongoDB compatibility)
	//
	//    * Neptune for Amazon Neptune
	ResourceTypes []*string `type:"list"`
	// contains filtered or unexported fields
}

func (GetSupportedResourceTypesOutput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetSupportedResourceTypesOutput) SetResourceTypes

SetResourceTypes sets the ResourceTypes field's value.

func (GetSupportedResourceTypesOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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
}

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Job

type Job struct {

	// The account ID that owns the backup job.
	AccountId *string `type:"string"`

	// Uniquely identifies a request to 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 Volume Shadow Copy Service (VSS) backup jobs.
	//
	// Valid values: Set to "WindowsVSS":"enabled" to enable the WindowsVSS backup
	// option and create a Windows VSS 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 Amazon Web Services 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"`

	// This is a boolean value indicating this is a parent (composite) backup job.
	IsParent *bool `type:"boolean"`

	// This uniquely identifies a request to Backup to back up a resource. The return
	// will be the parent (composite) job ID.
	ParentJobId *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"`

	// This is the non-unique name of the resource that belongs to the specified
	// backup.
	ResourceName *string `type:"string"`

	// The type of Amazon Web Services 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 Windows Volume Shadow Copy Service (VSS)
	// 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) SetIsParent added in v1.44.146

func (s *Job) SetIsParent(v bool) *Job

SetIsParent sets the IsParent field's value.

func (*Job) SetParentJobId added in v1.44.146

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

SetParentJobId sets the ParentJobId 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) SetResourceName added in v1.44.197

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

SetResourceName sets the ResourceName 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type LegalHold added in v1.44.146

type LegalHold struct {

	// This is the time in number format when legal hold was cancelled.
	CancellationDate *time.Time `type:"timestamp"`

	// This is the time in number format when legal hold was created.
	CreationDate *time.Time `type:"timestamp"`

	// This is the description of a legal hold.
	Description *string `type:"string"`

	// This is an Amazon Resource Number (ARN) that uniquely identifies the legal
	// hold; for example, arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45.
	LegalHoldArn *string `type:"string"`

	// ID of specific legal hold on one or more recovery points.
	LegalHoldId *string `type:"string"`

	// This is the status of the legal hold. Statuses can be ACTIVE, CREATING, CANCELED,
	// and CANCELING.
	Status *string `type:"string" enum:"LegalHoldStatus"`

	// This is the title of a legal hold.
	Title *string `type:"string"`
	// contains filtered or unexported fields
}

A legal hold is an administrative tool that helps prevent backups from being deleted while under a hold. While the hold is in place, backups under a hold cannot be deleted and lifecycle policies that would alter the backup status (such as transition to cold storage) are delayed until the legal hold is removed. A backup can have more than one legal hold. Legal holds are applied to one or more backups (also known as recovery points). These backups can be filtered by resource types and by resource IDs.

func (LegalHold) GoString added in v1.44.146

func (s LegalHold) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LegalHold) SetCancellationDate added in v1.44.146

func (s *LegalHold) SetCancellationDate(v time.Time) *LegalHold

SetCancellationDate sets the CancellationDate field's value.

func (*LegalHold) SetCreationDate added in v1.44.146

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

SetCreationDate sets the CreationDate field's value.

func (*LegalHold) SetDescription added in v1.44.146

func (s *LegalHold) SetDescription(v string) *LegalHold

SetDescription sets the Description field's value.

func (*LegalHold) SetLegalHoldArn added in v1.44.146

func (s *LegalHold) SetLegalHoldArn(v string) *LegalHold

SetLegalHoldArn sets the LegalHoldArn field's value.

func (*LegalHold) SetLegalHoldId added in v1.44.146

func (s *LegalHold) SetLegalHoldId(v string) *LegalHold

SetLegalHoldId sets the LegalHoldId field's value.

func (*LegalHold) SetStatus added in v1.44.146

func (s *LegalHold) SetStatus(v string) *LegalHold

SetStatus sets the Status field's value.

func (*LegalHold) SetTitle added in v1.44.146

func (s *LegalHold) SetTitle(v string) *LegalHold

SetTitle sets the Title field's value.

func (LegalHold) String added in v1.44.146

func (s LegalHold) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 “retention” 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.

Resource types that are able to be transitioned to cold storage are listed in the "Lifecycle to cold storage" section of the Feature availability by resource (https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#features-by-resource) table. Backup ignores this expression for other resource types.

func (Lifecycle) GoString

func (s Lifecycle) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 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 Amazon Web Services 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 completed after a date expressed in Unix format
	// and Coordinated Universal Time (UTC).
	ByCompleteAfter *time.Time `location:"querystring" locationName:"completeAfter" type:"timestamp"`

	// Returns only backup jobs completed before a date expressed in Unix format
	// and Coordinated Universal Time (UTC).
	ByCompleteBefore *time.Time `location:"querystring" locationName:"completeBefore" type:"timestamp"`

	// 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"`

	// This is a filter to list child (nested) jobs based on parent job ID.
	ByParentJobId *string `location:"querystring" locationName:"parentJobId" type:"string"`

	// 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:
	//
	//    * Aurora for Amazon Aurora
	//
	//    * DocumentDB for Amazon DocumentDB (with MongoDB compatibility)
	//
	//    * DynamoDB for Amazon DynamoDB
	//
	//    * EBS for Amazon Elastic Block Store
	//
	//    * EC2 for Amazon Elastic Compute Cloud
	//
	//    * EFS for Amazon Elastic File System
	//
	//    * FSx for Amazon FSx
	//
	//    * Neptune for Amazon Neptune
	//
	//    * RDS for Amazon Relational Database Service
	//
	//    * Storage Gateway for Storage Gateway
	//
	//    * S3 for Amazon S3
	//
	//    * VirtualMachine for virtual machines
	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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) SetByCompleteAfter added in v1.44.7

func (s *ListBackupJobsInput) SetByCompleteAfter(v time.Time) *ListBackupJobsInput

SetByCompleteAfter sets the ByCompleteAfter field's value.

func (*ListBackupJobsInput) SetByCompleteBefore added in v1.44.7

func (s *ListBackupJobsInput) SetByCompleteBefore(v time.Time) *ListBackupJobsInput

SetByCompleteBefore sets the ByCompleteBefore 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) SetByParentJobId added in v1.44.146

func (s *ListBackupJobsInput) SetByParentJobId(v string) *ListBackupJobsInput

SetByParentJobId sets the ByParentJobId 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 completed after a date expressed in Unix format and
	// Coordinated Universal Time (UTC).
	ByCompleteAfter *time.Time `location:"querystring" locationName:"completeAfter" type:"timestamp"`

	// Returns only copy jobs completed before a date expressed in Unix format and
	// Coordinated Universal Time (UTC).
	ByCompleteBefore *time.Time `location:"querystring" locationName:"completeBefore" type:"timestamp"`

	// 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"`

	// This is a filter to list child (nested) jobs based on parent job ID.
	ByParentJobId *string `location:"querystring" locationName:"parentJobId" 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:
	//
	//    * Aurora for Amazon Aurora
	//
	//    * DocumentDB for Amazon DocumentDB (with MongoDB compatibility)
	//
	//    * DynamoDB for Amazon DynamoDB
	//
	//    * EBS for Amazon Elastic Block Store
	//
	//    * EC2 for Amazon Elastic Compute Cloud
	//
	//    * EFS for Amazon Elastic File System
	//
	//    * FSx for Amazon FSx
	//
	//    * Neptune for Amazon Neptune
	//
	//    * RDS for Amazon Relational Database Service
	//
	//    * Storage Gateway for Storage Gateway
	//
	//    * S3 for Amazon S3
	//
	//    * VirtualMachine for virtual machines
	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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListCopyJobsInput) SetByAccountId added in v1.32.9

func (s *ListCopyJobsInput) SetByAccountId(v string) *ListCopyJobsInput

SetByAccountId sets the ByAccountId field's value.

func (*ListCopyJobsInput) SetByCompleteAfter added in v1.44.7

func (s *ListCopyJobsInput) SetByCompleteAfter(v time.Time) *ListCopyJobsInput

SetByCompleteAfter sets the ByCompleteAfter field's value.

func (*ListCopyJobsInput) SetByCompleteBefore added in v1.44.7

func (s *ListCopyJobsInput) SetByCompleteBefore(v time.Time) *ListCopyJobsInput

SetByCompleteBefore sets the ByCompleteBefore 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) SetByParentJobId added in v1.44.146

func (s *ListCopyJobsInput) SetByParentJobId(v string) *ListCopyJobsInput

SetByParentJobId sets the ByParentJobId 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListFrameworksInput added in v1.40.28

type ListFrameworksInput struct {

	// The number of desired results from 1 to 1000. Optional. If unspecified, the
	// query will return 1 MB of data.
	MaxResults *int64 `location:"querystring" locationName:"MaxResults" min:"1" type:"integer"`

	// An identifier that was returned from the previous call to this operation,
	// which can be used to return the next set of items in the list.
	NextToken *string `location:"querystring" locationName:"NextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListFrameworksInput) GoString added in v1.40.28

func (s ListFrameworksInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListFrameworksInput) SetMaxResults added in v1.40.28

func (s *ListFrameworksInput) SetMaxResults(v int64) *ListFrameworksInput

SetMaxResults sets the MaxResults field's value.

func (*ListFrameworksInput) SetNextToken added in v1.40.28

func (s *ListFrameworksInput) SetNextToken(v string) *ListFrameworksInput

SetNextToken sets the NextToken field's value.

func (ListFrameworksInput) String added in v1.40.28

func (s ListFrameworksInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListFrameworksInput) Validate added in v1.40.28

func (s *ListFrameworksInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListFrameworksOutput added in v1.40.28

type ListFrameworksOutput struct {

	// A list of frameworks with details for each framework, including the framework
	// name, Amazon Resource Name (ARN), description, number of controls, creation
	// time, and deployment status.
	Frameworks []*Framework `type:"list"`

	// An identifier that was returned from the previous call to this operation,
	// which can be used to return the next set of items in the list.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListFrameworksOutput) GoString added in v1.40.28

func (s ListFrameworksOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListFrameworksOutput) SetFrameworks added in v1.40.28

func (s *ListFrameworksOutput) SetFrameworks(v []*Framework) *ListFrameworksOutput

SetFrameworks sets the Frameworks field's value.

func (*ListFrameworksOutput) SetNextToken added in v1.40.28

func (s *ListFrameworksOutput) SetNextToken(v string) *ListFrameworksOutput

SetNextToken sets the NextToken field's value.

func (ListFrameworksOutput) String added in v1.40.28

func (s ListFrameworksOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListLegalHoldsInput added in v1.44.146

type ListLegalHoldsInput struct {

	// The maximum number of resource list items to be returned.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	// The next item following a partial list of returned resources. For example,
	// if a request is made to return maxResults number of resources, 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 (ListLegalHoldsInput) GoString added in v1.44.146

func (s ListLegalHoldsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListLegalHoldsInput) SetMaxResults added in v1.44.146

func (s *ListLegalHoldsInput) SetMaxResults(v int64) *ListLegalHoldsInput

SetMaxResults sets the MaxResults field's value.

func (*ListLegalHoldsInput) SetNextToken added in v1.44.146

func (s *ListLegalHoldsInput) SetNextToken(v string) *ListLegalHoldsInput

SetNextToken sets the NextToken field's value.

func (ListLegalHoldsInput) String added in v1.44.146

func (s ListLegalHoldsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListLegalHoldsInput) Validate added in v1.44.146

func (s *ListLegalHoldsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListLegalHoldsOutput added in v1.44.146

type ListLegalHoldsOutput struct {

	// This is an array of returned legal holds, both active and previous.
	LegalHolds []*LegalHold `type:"list"`

	// The next item following a partial list of returned resources. For example,
	// if a request is made to return maxResults number of resources, 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 (ListLegalHoldsOutput) GoString added in v1.44.146

func (s ListLegalHoldsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListLegalHoldsOutput) SetLegalHolds added in v1.44.146

func (s *ListLegalHoldsOutput) SetLegalHolds(v []*LegalHold) *ListLegalHoldsOutput

SetLegalHolds sets the LegalHolds field's value.

func (*ListLegalHoldsOutput) SetNextToken added in v1.44.146

func (s *ListLegalHoldsOutput) SetNextToken(v string) *ListLegalHoldsOutput

SetNextToken sets the NextToken field's value.

func (ListLegalHoldsOutput) String added in v1.44.146

func (s ListLegalHoldsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 Amazon Web Services Region where they are created. They consist of lowercase
	// letters, numbers, and hyphens.
	//
	// Backup vault name might not be available when a supported service creates
	// the backup.
	//
	// 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"`

	// This returns only recovery points that match the specified parent (composite)
	// recovery point Amazon Resource Name (ARN).
	ByParentRecoveryPointArn *string `location:"querystring" locationName:"parentRecoveryPointArn" type:"string"`

	// 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) SetByParentRecoveryPointArn added in v1.44.146

SetByParentRecoveryPointArn sets the ByParentRecoveryPointArn 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListRecoveryPointsByLegalHoldInput added in v1.44.146

type ListRecoveryPointsByLegalHoldInput struct {

	// This is the ID of the legal hold.
	//
	// LegalHoldId is a required field
	LegalHoldId *string `location:"uri" locationName:"legalHoldId" type:"string" required:"true"`

	// This is the maximum number of resource list items to be returned.
	MaxResults *int64 `location:"querystring" locationName:"maxResults" min:"1" type:"integer"`

	// This is the next item following a partial list of returned resources. For
	// example, if a request is made to return maxResults number of resources, 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 (ListRecoveryPointsByLegalHoldInput) GoString added in v1.44.146

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListRecoveryPointsByLegalHoldInput) SetLegalHoldId added in v1.44.146

SetLegalHoldId sets the LegalHoldId field's value.

func (*ListRecoveryPointsByLegalHoldInput) SetMaxResults added in v1.44.146

SetMaxResults sets the MaxResults field's value.

func (*ListRecoveryPointsByLegalHoldInput) SetNextToken added in v1.44.146

SetNextToken sets the NextToken field's value.

func (ListRecoveryPointsByLegalHoldInput) String added in v1.44.146

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListRecoveryPointsByLegalHoldInput) Validate added in v1.44.146

Validate inspects the fields of the type to determine if they are valid.

type ListRecoveryPointsByLegalHoldOutput added in v1.44.146

type ListRecoveryPointsByLegalHoldOutput struct {

	// This return is the next item following a partial list of returned resources.
	NextToken *string `type:"string"`

	// This is a list of the recovery points returned by ListRecoveryPointsByLegalHold.
	RecoveryPoints []*RecoveryPointMember `type:"list"`
	// contains filtered or unexported fields
}

func (ListRecoveryPointsByLegalHoldOutput) GoString added in v1.44.146

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListRecoveryPointsByLegalHoldOutput) SetNextToken added in v1.44.146

SetNextToken sets the NextToken field's value.

func (*ListRecoveryPointsByLegalHoldOutput) SetRecoveryPoints added in v1.44.146

SetRecoveryPoints sets the RecoveryPoints field's value.

func (ListRecoveryPointsByLegalHoldOutput) String added in v1.44.146

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListRecoveryPointsByResourceInput

type ListRecoveryPointsByResourceInput struct {

	// The maximum number of items to be returned.
	//
	// Amazon RDS requires a value of at least 20.
	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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.
	//
	// Only Amazon EFS and Amazon EC2 recovery points return BackupVaultName.
	RecoveryPoints []*RecoveryPointByResource `type:"list"`
	// contains filtered or unexported fields
}

func (ListRecoveryPointsByResourceOutput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListReportJobsInput added in v1.40.28

type ListReportJobsInput struct {

	// Returns only report jobs that were created after the date and time specified
	// in Unix format and Coordinated Universal Time (UTC). For example, the value
	// 1516925490 represents Friday, January 26, 2018 12:11:30 AM.
	ByCreationAfter *time.Time `location:"querystring" locationName:"CreationAfter" type:"timestamp"`

	// Returns only report jobs that were created before the date and time specified
	// in Unix format and Coordinated Universal Time (UTC). For example, the value
	// 1516925490 represents Friday, January 26, 2018 12:11:30 AM.
	ByCreationBefore *time.Time `location:"querystring" locationName:"CreationBefore" type:"timestamp"`

	// Returns only report jobs with the specified report plan name.
	ByReportPlanName *string `location:"querystring" locationName:"ReportPlanName" min:"1" type:"string"`

	// Returns only report jobs that are in the specified status. The statuses are:
	//
	// CREATED | RUNNING | COMPLETED | FAILED
	ByStatus *string `location:"querystring" locationName:"Status" type:"string"`

	// The number of desired results from 1 to 1000. Optional. If unspecified, the
	// query will return 1 MB of data.
	MaxResults *int64 `location:"querystring" locationName:"MaxResults" min:"1" type:"integer"`

	// An identifier that was returned from the previous call to this operation,
	// which can be used to return the next set of items in the list.
	NextToken *string `location:"querystring" locationName:"NextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListReportJobsInput) GoString added in v1.40.28

func (s ListReportJobsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListReportJobsInput) SetByCreationAfter added in v1.40.28

func (s *ListReportJobsInput) SetByCreationAfter(v time.Time) *ListReportJobsInput

SetByCreationAfter sets the ByCreationAfter field's value.

func (*ListReportJobsInput) SetByCreationBefore added in v1.40.28

func (s *ListReportJobsInput) SetByCreationBefore(v time.Time) *ListReportJobsInput

SetByCreationBefore sets the ByCreationBefore field's value.

func (*ListReportJobsInput) SetByReportPlanName added in v1.40.28

func (s *ListReportJobsInput) SetByReportPlanName(v string) *ListReportJobsInput

SetByReportPlanName sets the ByReportPlanName field's value.

func (*ListReportJobsInput) SetByStatus added in v1.40.28

func (s *ListReportJobsInput) SetByStatus(v string) *ListReportJobsInput

SetByStatus sets the ByStatus field's value.

func (*ListReportJobsInput) SetMaxResults added in v1.40.28

func (s *ListReportJobsInput) SetMaxResults(v int64) *ListReportJobsInput

SetMaxResults sets the MaxResults field's value.

func (*ListReportJobsInput) SetNextToken added in v1.40.28

func (s *ListReportJobsInput) SetNextToken(v string) *ListReportJobsInput

SetNextToken sets the NextToken field's value.

func (ListReportJobsInput) String added in v1.40.28

func (s ListReportJobsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListReportJobsInput) Validate added in v1.40.28

func (s *ListReportJobsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListReportJobsOutput added in v1.40.28

type ListReportJobsOutput struct {

	// An identifier that was returned from the previous call to this operation,
	// which can be used to return the next set of items in the list.
	NextToken *string `type:"string"`

	// Details about your report jobs in JSON format.
	ReportJobs []*ReportJob `type:"list"`
	// contains filtered or unexported fields
}

func (ListReportJobsOutput) GoString added in v1.40.28

func (s ListReportJobsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListReportJobsOutput) SetNextToken added in v1.40.28

func (s *ListReportJobsOutput) SetNextToken(v string) *ListReportJobsOutput

SetNextToken sets the NextToken field's value.

func (*ListReportJobsOutput) SetReportJobs added in v1.40.28

func (s *ListReportJobsOutput) SetReportJobs(v []*ReportJob) *ListReportJobsOutput

SetReportJobs sets the ReportJobs field's value.

func (ListReportJobsOutput) String added in v1.40.28

func (s ListReportJobsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListReportPlansInput added in v1.40.28

type ListReportPlansInput struct {

	// The number of desired results from 1 to 1000. Optional. If unspecified, the
	// query will return 1 MB of data.
	MaxResults *int64 `location:"querystring" locationName:"MaxResults" min:"1" type:"integer"`

	// An identifier that was returned from the previous call to this operation,
	// which can be used to return the next set of items in the list.
	NextToken *string `location:"querystring" locationName:"NextToken" type:"string"`
	// contains filtered or unexported fields
}

func (ListReportPlansInput) GoString added in v1.40.28

func (s ListReportPlansInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListReportPlansInput) SetMaxResults added in v1.40.28

func (s *ListReportPlansInput) SetMaxResults(v int64) *ListReportPlansInput

SetMaxResults sets the MaxResults field's value.

func (*ListReportPlansInput) SetNextToken added in v1.40.28

func (s *ListReportPlansInput) SetNextToken(v string) *ListReportPlansInput

SetNextToken sets the NextToken field's value.

func (ListReportPlansInput) String added in v1.40.28

func (s ListReportPlansInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListReportPlansInput) Validate added in v1.40.28

func (s *ListReportPlansInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListReportPlansOutput added in v1.40.28

type ListReportPlansOutput struct {

	// An identifier that was returned from the previous call to this operation,
	// which can be used to return the next set of items in the list.
	NextToken *string `type:"string"`

	// A list of your report plans with detailed information for each plan. This
	// information includes the Amazon Resource Name (ARN), report plan name, description,
	// settings, delivery channel, deployment status, creation time, and last times
	// the report plan attempted to and successfully ran.
	ReportPlans []*ReportPlan `type:"list"`
	// contains filtered or unexported fields
}

func (ListReportPlansOutput) GoString added in v1.40.28

func (s ListReportPlansOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListReportPlansOutput) SetNextToken added in v1.40.28

SetNextToken sets the NextToken field's value.

func (*ListReportPlansOutput) SetReportPlans added in v1.40.28

func (s *ListReportPlansOutput) SetReportPlans(v []*ReportPlan) *ListReportPlansOutput

SetReportPlans sets the ReportPlans field's value.

func (ListReportPlansOutput) String added in v1.40.28

func (s ListReportPlansOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 copy jobs completed after a date expressed in Unix format and
	// Coordinated Universal Time (UTC).
	ByCompleteAfter *time.Time `location:"querystring" locationName:"completeAfter" type:"timestamp"`

	// Returns only copy jobs completed before a date expressed in Unix format and
	// Coordinated Universal Time (UTC).
	ByCompleteBefore *time.Time `location:"querystring" locationName:"completeBefore" type:"timestamp"`

	// 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListRestoreJobsInput) SetByAccountId added in v1.32.9

func (s *ListRestoreJobsInput) SetByAccountId(v string) *ListRestoreJobsInput

SetByAccountId sets the ByAccountId field's value.

func (*ListRestoreJobsInput) SetByCompleteAfter added in v1.44.7

func (s *ListRestoreJobsInput) SetByCompleteAfter(v time.Time) *ListRestoreJobsInput

SetByCompleteAfter sets the ByCompleteAfter field's value.

func (*ListRestoreJobsInput) SetByCompleteBefore added in v1.44.7

func (s *ListRestoreJobsInput) SetByCompleteBefore(v time.Time) *ListRestoreJobsInput

SetByCompleteBefore sets the ByCompleteBefore 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by ListTagsOutput's
	// String and GoString methods.
	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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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. Must contain 1 to 50 alphanumeric or '-_.'
	// characters.
	//
	// 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 Amazon Web Services resources.

func (Plan) GoString

func (s Plan) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PlanInput

type PlanInput struct {

	// Specifies a list of BackupOptions for each resource type. These settings
	// are only available for Windows Volume Shadow Copy Service (VSS) backup jobs.
	AdvancedBackupSettings []*AdvancedBackupSetting `type:"list"`

	// The display name of a backup plan. Must contain 1 to 50 alphanumeric or '-_.'
	// characters.
	//
	// 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.

func (PlanInput) GoString

func (s PlanInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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. This parameter
	// is optional.
	//
	// If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters.
	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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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"`

	// This is the non-unique name of the resource that belongs to the specified
	// backup.
	ResourceName *string `type:"string"`

	// The type of Amazon Web Services resource; for example, an Amazon Elastic
	// Block Store (Amazon EBS) volume or an Amazon Relational Database Service
	// (Amazon RDS) database. For Windows Volume Shadow Copy Service (VSS) 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) SetResourceName added in v1.44.197

func (s *ProtectedResource) SetResourceName(v string) *ProtectedResource

SetResourceName sets the ResourceName 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 Amazon Web Services 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (PutBackupVaultAccessPolicyOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PutBackupVaultLockConfigurationInput added in v1.40.58

type PutBackupVaultLockConfigurationInput struct {

	// The Backup Vault Lock configuration that specifies the name of the backup
	// vault it protects.
	//
	// BackupVaultName is a required field
	BackupVaultName *string `location:"uri" locationName:"backupVaultName" type:"string" required:"true"`

	// The Backup Vault Lock configuration that specifies the number of days before
	// the lock date. For example, setting ChangeableForDays to 30 on Jan. 1, 2022
	// at 8pm UTC will set the lock date to Jan. 31, 2022 at 8pm UTC.
	//
	// Backup enforces a 72-hour cooling-off period before Vault Lock takes effect
	// and becomes immutable. Therefore, you must set ChangeableForDays to 3 or
	// greater.
	//
	// Before the lock date, you can delete Vault Lock from the vault using DeleteBackupVaultLockConfiguration
	// or change the Vault Lock configuration using PutBackupVaultLockConfiguration.
	// On and after the lock date, the Vault Lock becomes immutable and cannot be
	// changed or deleted.
	//
	// If this parameter is not specified, you can delete Vault Lock from the vault
	// using DeleteBackupVaultLockConfiguration or change the Vault Lock configuration
	// using PutBackupVaultLockConfiguration at any time.
	ChangeableForDays *int64 `type:"long"`

	// The Backup Vault Lock configuration that specifies the maximum retention
	// period that the vault retains its recovery points. This setting can be useful
	// if, for example, your organization's policies require you to destroy certain
	// data after retaining it for four years (1460 days).
	//
	// If this parameter is not included, Vault Lock does not enforce a maximum
	// retention period on the recovery points in the vault. If this parameter is
	// included without a value, Vault Lock will not enforce a maximum retention
	// period.
	//
	// If this parameter is specified, any backup or copy job to the vault must
	// have a lifecycle policy with a retention period equal to or shorter than
	// the maximum retention period. If the job's retention period is longer than
	// that maximum retention period, then the vault fails the backup or copy job,
	// and you should either modify your lifecycle settings or use a different vault.
	// The longest maximum retention period you can specify is 36500 days (approximately
	// 100 years). Recovery points already saved in the vault prior to Vault Lock
	// are not affected.
	MaxRetentionDays *int64 `type:"long"`

	// The Backup Vault Lock configuration that specifies the minimum retention
	// period that the vault retains its recovery points. This setting can be useful
	// if, for example, your organization's policies require you to retain certain
	// data for at least seven years (2555 days).
	//
	// If this parameter is not specified, Vault Lock will not enforce a minimum
	// retention period.
	//
	// If this parameter is specified, any backup or copy job to the vault must
	// have a lifecycle policy with a retention period equal to or longer than the
	// minimum retention period. If the job's retention period is shorter than that
	// minimum retention period, then the vault fails that backup or copy job, and
	// you should either modify your lifecycle settings or use a different vault.
	// The shortest minimum retention period you can specify is 1 day. Recovery
	// points already saved in the vault prior to Vault Lock are not affected.
	MinRetentionDays *int64 `type:"long"`
	// contains filtered or unexported fields
}

func (PutBackupVaultLockConfigurationInput) GoString added in v1.40.58

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutBackupVaultLockConfigurationInput) SetBackupVaultName added in v1.40.58

SetBackupVaultName sets the BackupVaultName field's value.

func (*PutBackupVaultLockConfigurationInput) SetChangeableForDays added in v1.40.58

SetChangeableForDays sets the ChangeableForDays field's value.

func (*PutBackupVaultLockConfigurationInput) SetMaxRetentionDays added in v1.40.58

SetMaxRetentionDays sets the MaxRetentionDays field's value.

func (*PutBackupVaultLockConfigurationInput) SetMinRetentionDays added in v1.40.58

SetMinRetentionDays sets the MinRetentionDays field's value.

func (PutBackupVaultLockConfigurationInput) String added in v1.40.58

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutBackupVaultLockConfigurationInput) Validate added in v1.40.58

Validate inspects the fields of the type to determine if they are valid.

type PutBackupVaultLockConfigurationOutput added in v1.40.58

type PutBackupVaultLockConfigurationOutput struct {
	// contains filtered or unexported fields
}

func (PutBackupVaultLockConfigurationOutput) GoString added in v1.40.58

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (PutBackupVaultLockConfigurationOutput) String added in v1.40.58

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PutBackupVaultNotificationsInput

type PutBackupVaultNotificationsInput struct {

	// An array of events that indicate the status of jobs to back up resources
	// to the backup vault.
	//
	// For common use cases and code samples, see Using Amazon SNS to track Backup
	// events (https://docs.aws.amazon.com/aws-backup/latest/devguide/sns-notifications.html).
	//
	// The following events are supported:
	//
	//    * BACKUP_JOB_STARTED | BACKUP_JOB_COMPLETED
	//
	//    * COPY_JOB_STARTED | COPY_JOB_SUCCESSFUL | COPY_JOB_FAILED
	//
	//    * RESTORE_JOB_STARTED | RESTORE_JOB_COMPLETED | RECOVERY_POINT_MODIFIED
	//
	//    * S3_BACKUP_OBJECT_FAILED | S3_RESTORE_OBJECT_FAILED
	//
	// The list below shows items that are deprecated events (for reference) and
	// are no longer in use. They are no longer supported and will not return statuses
	// or notifications. Refer to the list above for current supported events.
	//
	// BackupVaultEvents is a required field
	BackupVaultEvents []*string `type:"list" required:"true" enum:"VaultEvent"`

	// 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 Amazon Web Services 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (PutBackupVaultNotificationsOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 Amazon Web Services 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"`

	// This is the identifier of a resource within a composite group, such as nested
	// (child) recovery point belonging to a composite (parent) stack. The ID is
	// transferred from the logical ID (https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/resources-section-structure.html#resources-section-structure-syntax)
	// within a stack.
	CompositeMemberIdentifier *string `type:"string"`

	// 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"`

	// This is a boolean value indicating this is a parent (composite) recovery
	// point.
	IsParent *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. 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 “retention” 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.
	//
	// Resource types that are able to be transitioned to cold storage are listed
	// in the "Lifecycle to cold storage" section of the Feature availability by
	// resource (https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#features-by-resource)
	// table. Backup ignores this expression for other resource types.
	Lifecycle *Lifecycle `type:"structure"`

	// This is the Amazon Resource Name (ARN) of the parent (composite) recovery
	// point.
	ParentRecoveryPointArn *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"`

	// An ARN that uniquely identifies a resource. The format of the ARN depends
	// on the resource type.
	ResourceArn *string `type:"string"`

	// This is the non-unique name of the resource that belongs to the specified
	// backup.
	ResourceName *string `type:"string"`

	// The type of Amazon Web Services 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 Windows Volume Shadow Copy Service
	// (VSS) 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"`

	// A message explaining the reason of the recovery point deletion failure.
	StatusMessage *string `type:"string"`
	// 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) SetCompositeMemberIdentifier added in v1.44.146

func (s *RecoveryPointByBackupVault) SetCompositeMemberIdentifier(v string) *RecoveryPointByBackupVault

SetCompositeMemberIdentifier sets the CompositeMemberIdentifier 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) SetIsParent added in v1.44.146

SetIsParent sets the IsParent 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) SetParentRecoveryPointArn added in v1.44.146

func (s *RecoveryPointByBackupVault) SetParentRecoveryPointArn(v string) *RecoveryPointByBackupVault

SetParentRecoveryPointArn sets the ParentRecoveryPointArn 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) SetResourceName added in v1.44.197

SetResourceName sets the ResourceName 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) SetStatusMessage added in v1.40.28

SetStatusMessage sets the StatusMessage field's value.

func (RecoveryPointByBackupVault) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 Amazon Web Services 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"`

	// This is a boolean value indicating this is a parent (composite) recovery
	// point.
	IsParent *bool `type:"boolean"`

	// This is the Amazon Resource Name (ARN) of the parent (composite) recovery
	// point.
	ParentRecoveryPointArn *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"`

	// This is the non-unique name of the resource that belongs to the specified
	// backup.
	ResourceName *string `type:"string"`

	// A status code specifying the state of the recovery point.
	Status *string `type:"string" enum:"RecoveryPointStatus"`

	// A message explaining the reason of the recovery point deletion failure.
	StatusMessage *string `type:"string"`
	// 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) SetIsParent added in v1.44.146

SetIsParent sets the IsParent field's value.

func (*RecoveryPointByResource) SetParentRecoveryPointArn added in v1.44.146

func (s *RecoveryPointByResource) SetParentRecoveryPointArn(v string) *RecoveryPointByResource

SetParentRecoveryPointArn sets the ParentRecoveryPointArn field's value.

func (*RecoveryPointByResource) SetRecoveryPointArn

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

SetRecoveryPointArn sets the RecoveryPointArn field's value.

func (*RecoveryPointByResource) SetResourceName added in v1.44.197

SetResourceName sets the ResourceName field's value.

func (*RecoveryPointByResource) SetStatus

SetStatus sets the Status field's value.

func (*RecoveryPointByResource) SetStatusMessage added in v1.40.28

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

SetStatusMessage sets the StatusMessage field's value.

func (RecoveryPointByResource) String

func (s RecoveryPointByResource) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 Backup used to initiate the recovery point backup.

func (RecoveryPointCreator) GoString

func (s RecoveryPointCreator) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RecoveryPointMember added in v1.44.146

type RecoveryPointMember struct {

	// This is the name of the backup vault (the logical container in which backups
	// are stored).
	BackupVaultName *string `type:"string"`

	// This is the Amazon Resource Name (ARN) of the parent (composite) recovery
	// point.
	RecoveryPointArn *string `type:"string"`

	// This is the Amazon Resource Name (ARN) that uniquely identifies a saved resource.
	ResourceArn *string `type:"string"`

	// This is the Amazon Web Services resource type that is saved as a recovery
	// point.
	ResourceType *string `type:"string"`
	// contains filtered or unexported fields
}

This is a recovery point which is a child (nested) recovery point of a parent (composite) recovery point. These recovery points can be disassociated from their parent (composite) recovery point, in which case they will no longer be a member.

func (RecoveryPointMember) GoString added in v1.44.146

func (s RecoveryPointMember) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RecoveryPointMember) SetBackupVaultName added in v1.44.266

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

SetBackupVaultName sets the BackupVaultName field's value.

func (*RecoveryPointMember) SetRecoveryPointArn added in v1.44.146

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

SetRecoveryPointArn sets the RecoveryPointArn field's value.

func (*RecoveryPointMember) SetResourceArn added in v1.44.266

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

SetResourceArn sets the ResourceArn field's value.

func (*RecoveryPointMember) SetResourceType added in v1.44.266

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

SetResourceType sets the ResourceType field's value.

func (RecoveryPointMember) String added in v1.44.146

func (s RecoveryPointMember) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RecoveryPointSelection added in v1.44.146

type RecoveryPointSelection struct {

	// This is a resource filter containing FromDate: DateTime and ToDate: DateTime.
	// Both values are required. Future DateTime values are not permitted.
	//
	// The date and time are in Unix format and Coordinated Universal Time (UTC),
	// and it is accurate to milliseconds ((milliseconds are optional). For example,
	// the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087
	// AM.
	DateRange *DateRange `type:"structure"`

	// These are the resources included in the resource selection (including type
	// of resources and vaults).
	ResourceIdentifiers []*string `type:"list"`

	// These are the names of the vaults in which the selected recovery points are
	// contained.
	VaultNames []*string `type:"list"`
	// contains filtered or unexported fields
}

This specifies criteria to assign a set of resources, such as resource types or backup vaults.

func (RecoveryPointSelection) GoString added in v1.44.146

func (s RecoveryPointSelection) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RecoveryPointSelection) SetDateRange added in v1.44.146

SetDateRange sets the DateRange field's value.

func (*RecoveryPointSelection) SetResourceIdentifiers added in v1.44.146

func (s *RecoveryPointSelection) SetResourceIdentifiers(v []*string) *RecoveryPointSelection

SetResourceIdentifiers sets the ResourceIdentifiers field's value.

func (*RecoveryPointSelection) SetVaultNames added in v1.44.146

func (s *RecoveryPointSelection) SetVaultNames(v []*string) *RecoveryPointSelection

SetVaultNames sets the VaultNames field's value.

func (RecoveryPointSelection) String added in v1.44.146

func (s RecoveryPointSelection) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RecoveryPointSelection) Validate added in v1.44.146

func (s *RecoveryPointSelection) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ReportDeliveryChannel added in v1.40.28

type ReportDeliveryChannel struct {

	// A list of the format of your reports: CSV, JSON, or both. If not specified,
	// the default format is CSV.
	Formats []*string `type:"list"`

	// The unique name of the S3 bucket that receives your reports.
	//
	// S3BucketName is a required field
	S3BucketName *string `type:"string" required:"true"`

	// The prefix for where Backup Audit Manager delivers your reports to Amazon
	// S3. The prefix is this part of the following path: s3://your-bucket-name/prefix/Backup/us-west-2/year/month/day/report-name.
	// If not specified, there is no prefix.
	S3KeyPrefix *string `type:"string"`
	// contains filtered or unexported fields
}

Contains information from your report plan about where to deliver your reports, specifically your Amazon S3 bucket name, S3 key prefix, and the formats of your reports.

func (ReportDeliveryChannel) GoString added in v1.40.28

func (s ReportDeliveryChannel) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ReportDeliveryChannel) SetFormats added in v1.40.28

func (s *ReportDeliveryChannel) SetFormats(v []*string) *ReportDeliveryChannel

SetFormats sets the Formats field's value.

func (*ReportDeliveryChannel) SetS3BucketName added in v1.40.28

func (s *ReportDeliveryChannel) SetS3BucketName(v string) *ReportDeliveryChannel

SetS3BucketName sets the S3BucketName field's value.

func (*ReportDeliveryChannel) SetS3KeyPrefix added in v1.40.28

func (s *ReportDeliveryChannel) SetS3KeyPrefix(v string) *ReportDeliveryChannel

SetS3KeyPrefix sets the S3KeyPrefix field's value.

func (ReportDeliveryChannel) String added in v1.40.28

func (s ReportDeliveryChannel) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ReportDeliveryChannel) Validate added in v1.40.28

func (s *ReportDeliveryChannel) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ReportDestination added in v1.40.28

type ReportDestination struct {

	// The unique name of the Amazon S3 bucket that receives your reports.
	S3BucketName *string `type:"string"`

	// The object key that uniquely identifies your reports in your S3 bucket.
	S3Keys []*string `type:"list"`
	// contains filtered or unexported fields
}

Contains information from your report job about your report destination.

func (ReportDestination) GoString added in v1.40.28

func (s ReportDestination) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ReportDestination) SetS3BucketName added in v1.40.28

func (s *ReportDestination) SetS3BucketName(v string) *ReportDestination

SetS3BucketName sets the S3BucketName field's value.

func (*ReportDestination) SetS3Keys added in v1.40.28

func (s *ReportDestination) SetS3Keys(v []*string) *ReportDestination

SetS3Keys sets the S3Keys field's value.

func (ReportDestination) String added in v1.40.28

func (s ReportDestination) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ReportJob added in v1.40.28

type ReportJob struct {

	// The date and time that a report job is completed, in Unix format and Coordinated
	// Universal Time (UTC). The value of CompletionTime is accurate to milliseconds.
	// For example, the value 1516925490.087 represents Friday, January 26, 2018
	// 12:11:30.087 AM.
	CompletionTime *time.Time `type:"timestamp"`

	// The date and time that a report job is created, in Unix format and Coordinated
	// Universal Time (UTC). The value of CreationTime is accurate to milliseconds.
	// For example, the value 1516925490.087 represents Friday, January 26, 2018
	// 12:11:30.087 AM.
	CreationTime *time.Time `type:"timestamp"`

	// The S3 bucket name and S3 keys for the destination where the report job publishes
	// the report.
	ReportDestination *ReportDestination `type:"structure"`

	// The identifier for a report job. A unique, randomly generated, Unicode, UTF-8
	// encoded string that is at most 1,024 bytes long. Report job IDs cannot be
	// edited.
	ReportJobId *string `type:"string"`

	// An Amazon Resource Name (ARN) that uniquely identifies a resource. The format
	// of the ARN depends on the resource type.
	ReportPlanArn *string `type:"string"`

	// Identifies the report template for the report. Reports are built using a
	// report template. The report templates are:
	//
	// RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT
	// | COPY_JOB_REPORT | RESTORE_JOB_REPORT
	ReportTemplate *string `type:"string"`

	// The status of a report job. The statuses are:
	//
	// CREATED | RUNNING | COMPLETED | FAILED
	//
	// COMPLETED means that the report is available for your review at your designated
	// destination. If the status is FAILED, review the StatusMessage for the reason.
	Status *string `type:"string"`

	// A message explaining the status of the report job.
	StatusMessage *string `type:"string"`
	// contains filtered or unexported fields
}

Contains detailed information about a report job. A report job compiles a report based on a report plan and publishes it to Amazon S3.

func (ReportJob) GoString added in v1.40.28

func (s ReportJob) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ReportJob) SetCompletionTime added in v1.40.28

func (s *ReportJob) SetCompletionTime(v time.Time) *ReportJob

SetCompletionTime sets the CompletionTime field's value.

func (*ReportJob) SetCreationTime added in v1.40.28

func (s *ReportJob) SetCreationTime(v time.Time) *ReportJob

SetCreationTime sets the CreationTime field's value.

func (*ReportJob) SetReportDestination added in v1.40.28

func (s *ReportJob) SetReportDestination(v *ReportDestination) *ReportJob

SetReportDestination sets the ReportDestination field's value.

func (*ReportJob) SetReportJobId added in v1.40.28

func (s *ReportJob) SetReportJobId(v string) *ReportJob

SetReportJobId sets the ReportJobId field's value.

func (*ReportJob) SetReportPlanArn added in v1.40.28

func (s *ReportJob) SetReportPlanArn(v string) *ReportJob

SetReportPlanArn sets the ReportPlanArn field's value.

func (*ReportJob) SetReportTemplate added in v1.40.28

func (s *ReportJob) SetReportTemplate(v string) *ReportJob

SetReportTemplate sets the ReportTemplate field's value.

func (*ReportJob) SetStatus added in v1.40.28

func (s *ReportJob) SetStatus(v string) *ReportJob

SetStatus sets the Status field's value.

func (*ReportJob) SetStatusMessage added in v1.40.28

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

SetStatusMessage sets the StatusMessage field's value.

func (ReportJob) String added in v1.40.28

func (s ReportJob) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ReportPlan added in v1.40.28

type ReportPlan struct {

	// The date and time that a report plan is created, in Unix format and Coordinated
	// Universal Time (UTC). The value of CreationTime is accurate to milliseconds.
	// For example, the value 1516925490.087 represents Friday, January 26, 2018
	// 12:11:30.087 AM.
	CreationTime *time.Time `type:"timestamp"`

	// The deployment status of a report plan. The statuses are:
	//
	// CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED
	DeploymentStatus *string `type:"string"`

	// The date and time that a report job associated with this report plan last
	// attempted to run, in Unix format and Coordinated Universal Time (UTC). The
	// value of LastAttemptedExecutionTime is accurate to milliseconds. For example,
	// the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087
	// AM.
	LastAttemptedExecutionTime *time.Time `type:"timestamp"`

	// The date and time that a report job associated with this report plan last
	// successfully ran, in Unix format and Coordinated Universal Time (UTC). The
	// value of LastSuccessfulExecutionTime is accurate to milliseconds. For example,
	// the value 1516925490.087 represents Friday, January 26, 2018 12:11:30.087
	// AM.
	LastSuccessfulExecutionTime *time.Time `type:"timestamp"`

	// Contains information about where and how to deliver your reports, specifically
	// your Amazon S3 bucket name, S3 key prefix, and the formats of your reports.
	ReportDeliveryChannel *ReportDeliveryChannel `type:"structure"`

	// An Amazon Resource Name (ARN) that uniquely identifies a resource. The format
	// of the ARN depends on the resource type.
	ReportPlanArn *string `type:"string"`

	// An optional description of the report plan with a maximum 1,024 characters.
	ReportPlanDescription *string `type:"string"`

	// The unique name of the report plan. This name is between 1 and 256 characters
	// starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9),
	// and underscores (_).
	ReportPlanName *string `min:"1" type:"string"`

	// Identifies the report template for the report. Reports are built using a
	// report template. The report templates are:
	//
	// RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT
	// | COPY_JOB_REPORT | RESTORE_JOB_REPORT
	//
	// If the report template is RESOURCE_COMPLIANCE_REPORT or CONTROL_COMPLIANCE_REPORT,
	// this API resource also describes the report coverage by Amazon Web Services
	// Regions and frameworks.
	ReportSetting *ReportSetting `type:"structure"`
	// contains filtered or unexported fields
}

Contains detailed information about a report plan.

func (ReportPlan) GoString added in v1.40.28

func (s ReportPlan) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ReportPlan) SetCreationTime added in v1.40.28

func (s *ReportPlan) SetCreationTime(v time.Time) *ReportPlan

SetCreationTime sets the CreationTime field's value.

func (*ReportPlan) SetDeploymentStatus added in v1.40.28

func (s *ReportPlan) SetDeploymentStatus(v string) *ReportPlan

SetDeploymentStatus sets the DeploymentStatus field's value.

func (*ReportPlan) SetLastAttemptedExecutionTime added in v1.40.28

func (s *ReportPlan) SetLastAttemptedExecutionTime(v time.Time) *ReportPlan

SetLastAttemptedExecutionTime sets the LastAttemptedExecutionTime field's value.

func (*ReportPlan) SetLastSuccessfulExecutionTime added in v1.40.28

func (s *ReportPlan) SetLastSuccessfulExecutionTime(v time.Time) *ReportPlan

SetLastSuccessfulExecutionTime sets the LastSuccessfulExecutionTime field's value.

func (*ReportPlan) SetReportDeliveryChannel added in v1.40.28

func (s *ReportPlan) SetReportDeliveryChannel(v *ReportDeliveryChannel) *ReportPlan

SetReportDeliveryChannel sets the ReportDeliveryChannel field's value.

func (*ReportPlan) SetReportPlanArn added in v1.40.28

func (s *ReportPlan) SetReportPlanArn(v string) *ReportPlan

SetReportPlanArn sets the ReportPlanArn field's value.

func (*ReportPlan) SetReportPlanDescription added in v1.40.28

func (s *ReportPlan) SetReportPlanDescription(v string) *ReportPlan

SetReportPlanDescription sets the ReportPlanDescription field's value.

func (*ReportPlan) SetReportPlanName added in v1.40.28

func (s *ReportPlan) SetReportPlanName(v string) *ReportPlan

SetReportPlanName sets the ReportPlanName field's value.

func (*ReportPlan) SetReportSetting added in v1.40.28

func (s *ReportPlan) SetReportSetting(v *ReportSetting) *ReportPlan

SetReportSetting sets the ReportSetting field's value.

func (ReportPlan) String added in v1.40.28

func (s ReportPlan) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ReportSetting added in v1.40.28

type ReportSetting struct {

	// These are the accounts to be included in the report.
	Accounts []*string `type:"list"`

	// The Amazon Resource Names (ARNs) of the frameworks a report covers.
	FrameworkArns []*string `type:"list"`

	// The number of frameworks a report covers.
	NumberOfFrameworks *int64 `type:"integer"`

	// These are the Organizational Units to be included in the report.
	OrganizationUnits []*string `type:"list"`

	// These are the Regions to be included in the report.
	Regions []*string `type:"list"`

	// Identifies the report template for the report. Reports are built using a
	// report template. The report templates are:
	//
	// RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT
	// | COPY_JOB_REPORT | RESTORE_JOB_REPORT
	//
	// ReportTemplate is a required field
	ReportTemplate *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Contains detailed information about a report setting.

func (ReportSetting) GoString added in v1.40.28

func (s ReportSetting) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ReportSetting) SetAccounts added in v1.44.146

func (s *ReportSetting) SetAccounts(v []*string) *ReportSetting

SetAccounts sets the Accounts field's value.

func (*ReportSetting) SetFrameworkArns added in v1.40.56

func (s *ReportSetting) SetFrameworkArns(v []*string) *ReportSetting

SetFrameworkArns sets the FrameworkArns field's value.

func (*ReportSetting) SetNumberOfFrameworks added in v1.40.56

func (s *ReportSetting) SetNumberOfFrameworks(v int64) *ReportSetting

SetNumberOfFrameworks sets the NumberOfFrameworks field's value.

func (*ReportSetting) SetOrganizationUnits added in v1.44.146

func (s *ReportSetting) SetOrganizationUnits(v []*string) *ReportSetting

SetOrganizationUnits sets the OrganizationUnits field's value.

func (*ReportSetting) SetRegions added in v1.44.146

func (s *ReportSetting) SetRegions(v []*string) *ReportSetting

SetRegions sets the Regions field's value.

func (*ReportSetting) SetReportTemplate added in v1.40.28

func (s *ReportSetting) SetReportTemplate(v string) *ReportSetting

SetReportTemplate sets the ReportTemplate field's value.

func (ReportSetting) String added in v1.40.28

func (s ReportSetting) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ReportSetting) Validate added in v1.40.28

func (s *ReportSetting) Validate() error

Validate inspects the fields of the type to determine if they are valid.

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 Windows Volume Shadow Copy Service (VSS) 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 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 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 Backup creates continuous backups. True causes Backup to
	// create continuous backups capable of point-in-time restore (PITR). False
	// (or not specified) causes 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. 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 “retention” 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.
	//
	// Resource types that are able to be transitioned to cold storage are listed
	// in the "Lifecycle to cold storage" section of the Feature availability by
	// resource (https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#features-by-resource)
	// table. Backup ignores this expression for other resource types.
	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 is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by Rule's
	// String and GoString methods.
	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"`

	// A display name for a backup rule. Must contain 1 to 50 alphanumeric or '-_.'
	// characters.
	//
	// RuleName is a required field
	RuleName *string `type:"string" required:"true"`

	// A cron expression in UTC specifying when Backup initiates a backup job. For
	// more information about Amazon Web Services cron expressions, see Schedule
	// Expressions for Rules (https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/ScheduledEvents.html)
	// in the Amazon CloudWatch Events User Guide.. Two examples of Amazon Web Services
	// cron expressions are 15 * ? * * * (take a backup every hour at 15 minutes
	// past the hour) and 0 12 * * ? * (take a backup every day at 12 noon UTC).
	// For a table of examples, click the preceding link and scroll down the page.
	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. If this value is
	// included, it must be at least 60 minutes to avoid errors.
	//
	// During the start window, the backup job status remains in CREATED status
	// until it has successfully begun or until the start window time has run out.
	// If within the start window time Backup receives an error that allows the
	// job to be retried, Backup will automatically retry to begin the job at least
	// every 10 minutes until the backup successfully begins (the job status changes
	// to RUNNING) or until the job status changes to EXPIRED (which is expected
	// to occur when the start window time is over).
	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 Amazon Web Services 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 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 Backup creates continuous backups. True causes Backup to
	// create continuous backups capable of point-in-time restore (PITR). False
	// (or not specified) causes 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. 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 “retention” 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.
	//
	// Resource types that are able to be transitioned to cold storage are listed
	// in the "Lifecycle to cold storage" section of the Feature availability by
	// resource (https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#features-by-resource)
	// table. Backup ignores this expression for other resource types.
	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 is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by RuleInput's
	// String and GoString methods.
	RecoveryPointTags map[string]*string `type:"map" sensitive:"true"`

	// A display name for a backup rule. Must contain 1 to 50 alphanumeric or '-_.'
	// characters.
	//
	// RuleName is a required field
	RuleName *string `type:"string" required:"true"`

	// A CRON expression in UTC specifying when 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. If this value is
	// included, it must be at least 60 minutes to avoid errors.
	//
	// During the start window, the backup job status remains in CREATED status
	// until it has successfully begun or until the start window time has run out.
	// If within the start window time Backup receives an error that allows the
	// job to be retried, Backup will automatically retry to begin the job at least
	// every 10 minutes until the backup successfully begins (the job status changes
	// to RUNNING) or until the job status changes to EXPIRED (which is expected
	// to occur when the start window time is over).
	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 Amazon Web Services 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 {

	// A list of conditions that you define to assign resources to your backup plans
	// using tags. For example, "StringEquals": { "ConditionKey": "aws:ResourceTag/CreatedByCryo",
	// "ConditionValue": "true" },. Condition operators are case sensitive.
	//
	// Conditions differs from ListOfTags as follows:
	//
	//    * When you specify more than one condition, you only assign the resources
	//    that match ALL conditions (using AND logic).
	//
	//    * Conditions supports StringEquals, StringLike, StringNotEquals, and StringNotLike.
	//    ListOfTags only supports StringEquals.
	Conditions *Conditions `type:"structure"`

	// The ARN of the IAM role that 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"`

	// A list of conditions that you define to assign resources to your backup plans
	// using tags. For example, "StringEquals": { "ConditionKey": "aws:ResourceTag/CreatedByCryo",
	// "ConditionValue": "true" },. Condition operators are case sensitive.
	//
	// ListOfTags differs from Conditions as follows:
	//
	//    * When you specify more than one condition, you assign all resources that
	//    match AT LEAST ONE condition (using OR logic).
	//
	//    * ListOfTags only supports StringEquals. Conditions supports StringEquals,
	//    StringLike, StringNotEquals, and StringNotLike.
	ListOfTags []*Condition `type:"list"`

	// A list of Amazon Resource Names (ARNs) to exclude from a backup plan. The
	// maximum number of ARNs is 500 without wildcards, or 30 ARNs with wildcards.
	//
	// If you need to exclude many resources from a backup plan, consider a different
	// resource selection strategy, such as assigning only one or a few resource
	// types or refining your resource selection using tags.
	NotResources []*string `type:"list"`

	// A list of Amazon Resource Names (ARNs) to assign to a backup plan. The maximum
	// number of ARNs is 500 without wildcards, or 30 ARNs with wildcards.
	//
	// If you need to assign many resources to a backup plan, consider a different
	// resource selection strategy, such as assigning all resources of a resource
	// type or refining your resource selection using tags.
	Resources []*string `type:"list"`

	// The display name of a resource selection document. Must contain 1 to 50 alphanumeric
	// or '-_.' characters.
	//
	// 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.

Specifying your desired Conditions, ListOfTags, NotResources, and/or Resources is recommended. If none of these are specified, Backup will attempt to select all supported and opted-in storage resources, which could have unintended cost implications.

func (Selection) GoString

func (s Selection) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Selection) SetConditions added in v1.42.2

func (s *Selection) SetConditions(v *Conditions) *Selection

SetConditions sets the Conditions field's value.

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) SetNotResources added in v1.42.2

func (s *Selection) SetNotResources(v []*string) *Selection

SetNotResources sets the NotResources 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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. This parameter
	// is optional.
	//
	// If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters.
	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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StartBackupJobInput

type StartBackupJobInput struct {

	// Specifies the backup option for a selected resource. This option is only
	// available for Windows Volume Shadow Copy Service (VSS) backup jobs.
	//
	// Valid values: Set to "WindowsVSS":"enabled" to enable the WindowsVSS backup
	// option and create a Windows VSS 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 Amazon Web Services 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 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 you can use to distinguish between otherwise
	// identical calls to StartBackupJob. Retrying a successful request with the
	// same idempotency token results in a success message with no action taken.
	IdempotencyToken *string `type:"string"`

	// The lifecycle defines when a protected resource is transitioned to cold storage
	// and when it expires. 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 “retention” 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.
	//
	// Resource types that are able to be transitioned to cold storage are listed
	// in the "Lifecycle to cold storage" section of the Feature availability by
	// resource (https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#features-by-resource)
	// table. Backup ignores this expression for other resource types.
	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 is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by StartBackupJobInput's
	// String and GoString methods.
	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. If this value is included, it must be at least 60 minutes to
	// avoid errors.
	//
	// During the start window, the backup job status remains in CREATED status
	// until it has successfully begun or until the start window time has run out.
	// If within the start window time Backup receives an error that allows the
	// job to be retried, Backup will automatically retry to begin the job at least
	// every 10 minutes until the backup successfully begins (the job status changes
	// to RUNNING) or until the job status changes to EXPIRED (which is expected
	// to occur when the start window time is over).
	StartWindowMinutes *int64 `type:"long"`
	// contains filtered or unexported fields
}

func (StartBackupJobInput) GoString

func (s StartBackupJobInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 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"`

	// This is a returned boolean value indicating this is a parent (composite)
	// backup job.
	IsParent *bool `type:"boolean"`

	// Note: This field is only returned for Amazon EFS and Advanced DynamoDB resources.
	//
	// 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) SetIsParent added in v1.44.146

func (s *StartBackupJobOutput) SetIsParent(v bool) *StartBackupJobOutput

SetIsParent sets the IsParent 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 you can use to distinguish between otherwise
	// identical calls to StartCopyJob. Retrying a successful request with the same
	// idempotency token results in a success message with no action taken.
	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 “retention” 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.
	//
	// Resource types that are able to be transitioned to cold storage are listed
	// in the "Lifecycle to cold storage" section of the Feature availability by
	// resource (https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#features-by-resource)
	// table. Backup ignores this expression for other resource types.
	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 Amazon Web Services 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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"`

	// This is a returned boolean value indicating this is a parent (composite)
	// copy job.
	IsParent *bool `type:"boolean"`
	// contains filtered or unexported fields
}

func (StartCopyJobOutput) GoString added in v1.28.1

func (s StartCopyJobOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) SetIsParent added in v1.44.146

func (s *StartCopyJobOutput) SetIsParent(v bool) *StartCopyJobOutput

SetIsParent sets the IsParent field's value.

func (StartCopyJobOutput) String added in v1.28.1

func (s StartCopyJobOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StartReportJobInput added in v1.40.28

type StartReportJobInput struct {

	// A customer-chosen string that you can use to distinguish between otherwise
	// identical calls to StartReportJobInput. Retrying a successful request with
	// the same idempotency token results in a success message with no action taken.
	IdempotencyToken *string `type:"string" idempotencyToken:"true"`

	// The unique name of a report plan.
	//
	// ReportPlanName is a required field
	ReportPlanName *string `location:"uri" locationName:"reportPlanName" min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (StartReportJobInput) GoString added in v1.40.28

func (s StartReportJobInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartReportJobInput) SetIdempotencyToken added in v1.40.28

func (s *StartReportJobInput) SetIdempotencyToken(v string) *StartReportJobInput

SetIdempotencyToken sets the IdempotencyToken field's value.

func (*StartReportJobInput) SetReportPlanName added in v1.40.28

func (s *StartReportJobInput) SetReportPlanName(v string) *StartReportJobInput

SetReportPlanName sets the ReportPlanName field's value.

func (StartReportJobInput) String added in v1.40.28

func (s StartReportJobInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartReportJobInput) Validate added in v1.40.28

func (s *StartReportJobInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StartReportJobOutput added in v1.40.28

type StartReportJobOutput struct {

	// The identifier of the report job. A unique, randomly generated, Unicode,
	// UTF-8 encoded string that is at most 1,024 bytes long. The report job ID
	// cannot be edited.
	ReportJobId *string `type:"string"`
	// contains filtered or unexported fields
}

func (StartReportJobOutput) GoString added in v1.40.28

func (s StartReportJobOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartReportJobOutput) SetReportJobId added in v1.40.28

func (s *StartReportJobOutput) SetReportJobId(v string) *StartReportJobOutput

SetReportJobId sets the ReportJobId field's value.

func (StartReportJobOutput) String added in v1.40.28

func (s StartReportJobOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StartRestoreJobInput

type StartRestoreJobInput struct {

	// This is an optional parameter. If this equals True, tags included in the
	// backup will be copied to the restored resource.
	//
	// This can only be applied to backups created through Backup.
	CopySourceTagsToRestoredResource *bool `type:"boolean"`

	// The Amazon Resource Name (ARN) of the IAM role that Backup uses to create
	// the target resource; for example: arn:aws:iam::123456789012:role/S3Access.
	IamRoleArn *string `type:"string"`

	// A customer-chosen string that you can use to distinguish between otherwise
	// identical calls to StartRestoreJob. Retrying a successful request with the
	// same idempotency token results in a success message with no action taken.
	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 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 Amazon Web Services KMS key that is used to
	//    encrypt the restored file system. You can specify a key from another Amazon
	//    Web Services account provided that key it is properly shared with your
	//    account via Amazon Web Services 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 sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by StartRestoreJobInput's
	// String and GoString methods.
	//
	// 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:
	//
	//    * Aurora for Amazon Aurora
	//
	//    * DocumentDB for Amazon DocumentDB (with MongoDB compatibility)
	//
	//    * CloudFormation for CloudFormation
	//
	//    * DynamoDB for Amazon DynamoDB
	//
	//    * EBS for Amazon Elastic Block Store
	//
	//    * EC2 for Amazon Elastic Compute Cloud
	//
	//    * EFS for Amazon Elastic File System
	//
	//    * FSx for Amazon FSx
	//
	//    * Neptune for Amazon Neptune
	//
	//    * RDS for Amazon Relational Database Service
	//
	//    * Redshift for Amazon Redshift
	//
	//    * Storage Gateway for Storage Gateway
	//
	//    * S3 for Amazon S3
	//
	//    * Timestream for Amazon Timestream
	//
	//    * VirtualMachine for virtual machines
	ResourceType *string `type:"string"`
	// contains filtered or unexported fields
}

func (StartRestoreJobInput) GoString

func (s StartRestoreJobInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartRestoreJobInput) SetCopySourceTagsToRestoredResource added in v1.44.267

func (s *StartRestoreJobInput) SetCopySourceTagsToRestoredResource(v bool) *StartRestoreJobInput

SetCopySourceTagsToRestoredResource sets the CopySourceTagsToRestoredResource field's value.

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StopBackupJobInput

type StopBackupJobInput struct {

	// Uniquely identifies a request to 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (StopBackupJobOutput) String

func (s StopBackupJobOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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. For clarity, this is the structure
	// to assign tags: [{"Key":"string","Value":"string"}].
	//
	// Tags is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by TagResourceInput's
	// String and GoString methods.
	//
	// 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (TagResourceOutput) String

func (s TagResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by UntagResourceInput's
	// String and GoString methods.
	//
	// 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (UntagResourceOutput) String

func (s UntagResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 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. 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateFrameworkInput added in v1.40.28

type UpdateFrameworkInput struct {

	// A list of the controls that make up the framework. Each control in the list
	// has a name, input parameters, and scope.
	FrameworkControls []*FrameworkControl `type:"list"`

	// An optional description of the framework with a maximum 1,024 characters.
	FrameworkDescription *string `type:"string"`

	// The unique name of a framework. This name is between 1 and 256 characters,
	// starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9),
	// and underscores (_).
	//
	// FrameworkName is a required field
	FrameworkName *string `location:"uri" locationName:"frameworkName" min:"1" type:"string" required:"true"`

	// A customer-chosen string that you can use to distinguish between otherwise
	// identical calls to UpdateFrameworkInput. Retrying a successful request with
	// the same idempotency token results in a success message with no action taken.
	IdempotencyToken *string `type:"string" idempotencyToken:"true"`
	// contains filtered or unexported fields
}

func (UpdateFrameworkInput) GoString added in v1.40.28

func (s UpdateFrameworkInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateFrameworkInput) SetFrameworkControls added in v1.40.28

func (s *UpdateFrameworkInput) SetFrameworkControls(v []*FrameworkControl) *UpdateFrameworkInput

SetFrameworkControls sets the FrameworkControls field's value.

func (*UpdateFrameworkInput) SetFrameworkDescription added in v1.40.28

func (s *UpdateFrameworkInput) SetFrameworkDescription(v string) *UpdateFrameworkInput

SetFrameworkDescription sets the FrameworkDescription field's value.

func (*UpdateFrameworkInput) SetFrameworkName added in v1.40.28

func (s *UpdateFrameworkInput) SetFrameworkName(v string) *UpdateFrameworkInput

SetFrameworkName sets the FrameworkName field's value.

func (*UpdateFrameworkInput) SetIdempotencyToken added in v1.40.28

func (s *UpdateFrameworkInput) SetIdempotencyToken(v string) *UpdateFrameworkInput

SetIdempotencyToken sets the IdempotencyToken field's value.

func (UpdateFrameworkInput) String added in v1.40.28

func (s UpdateFrameworkInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateFrameworkInput) Validate added in v1.40.28

func (s *UpdateFrameworkInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateFrameworkOutput added in v1.40.28

type UpdateFrameworkOutput struct {

	// The date and time that a framework is created, in ISO 8601 representation.
	// The value of CreationTime is accurate to milliseconds. For example, 2020-07-10T15:00:00.000-08:00
	// represents the 10th of July 2020 at 3:00 PM 8 hours behind UTC.
	CreationTime *time.Time `type:"timestamp"`

	// An Amazon Resource Name (ARN) that uniquely identifies a resource. The format
	// of the ARN depends on the resource type.
	FrameworkArn *string `type:"string"`

	// The unique name of a framework. This name is between 1 and 256 characters,
	// starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9),
	// and underscores (_).
	FrameworkName *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (UpdateFrameworkOutput) GoString added in v1.40.28

func (s UpdateFrameworkOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateFrameworkOutput) SetCreationTime added in v1.40.28

func (s *UpdateFrameworkOutput) SetCreationTime(v time.Time) *UpdateFrameworkOutput

SetCreationTime sets the CreationTime field's value.

func (*UpdateFrameworkOutput) SetFrameworkArn added in v1.40.28

func (s *UpdateFrameworkOutput) SetFrameworkArn(v string) *UpdateFrameworkOutput

SetFrameworkArn sets the FrameworkArn field's value.

func (*UpdateFrameworkOutput) SetFrameworkName added in v1.40.28

func (s *UpdateFrameworkOutput) SetFrameworkName(v string) *UpdateFrameworkOutput

SetFrameworkName sets the FrameworkName field's value.

func (UpdateFrameworkOutput) String added in v1.40.28

func (s UpdateFrameworkOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateGlobalSettingsInput added in v1.35.31

type UpdateGlobalSettingsInput struct {

	// A value for isCrossAccountBackupEnabled and a Region. Example: update-global-settings
	// --global-settings isCrossAccountBackupEnabled=false --region us-west-2.
	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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (UpdateGlobalSettingsOutput) String added in v1.35.31

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 Amazon Web Services 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. 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 “retention” 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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. 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 “retention” 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.
	//
	// Resource types that are able to be transitioned to cold storage are listed
	// in the "Lifecycle to cold storage" section of the Feature availability by
	// resource (https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#features-by-resource)
	// table. Backup ignores this expression for other resource types.
	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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateRegionSettingsInput added in v1.31.2

type UpdateRegionSettingsInput struct {

	// Enables or disables full Backup management of backups for a resource type.
	// To enable full Backup management for DynamoDB along with Backup's advanced
	// DynamoDB backup features (https://docs.aws.amazon.com/aws-backup/latest/devguide/advanced-ddb-backup.html),
	// follow the procedure to enable advanced DynamoDB backup programmatically
	// (https://docs.aws.amazon.com/aws-backup/latest/devguide/advanced-ddb-backup.html#advanced-ddb-backup-enable-cli).
	ResourceTypeManagementPreference map[string]*bool `type:"map"`

	// 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateRegionSettingsInput) SetResourceTypeManagementPreference added in v1.42.11

func (s *UpdateRegionSettingsInput) SetResourceTypeManagementPreference(v map[string]*bool) *UpdateRegionSettingsInput

SetResourceTypeManagementPreference sets the ResourceTypeManagementPreference field's value.

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (UpdateRegionSettingsOutput) String added in v1.31.2

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateReportPlanInput added in v1.40.28

type UpdateReportPlanInput struct {

	// A customer-chosen string that you can use to distinguish between otherwise
	// identical calls to UpdateReportPlanInput. Retrying a successful request with
	// the same idempotency token results in a success message with no action taken.
	IdempotencyToken *string `type:"string" idempotencyToken:"true"`

	// A structure that contains information about where to deliver your reports,
	// specifically your Amazon S3 bucket name, S3 key prefix, and the formats of
	// your reports.
	ReportDeliveryChannel *ReportDeliveryChannel `type:"structure"`

	// An optional description of the report plan with a maximum 1,024 characters.
	ReportPlanDescription *string `type:"string"`

	// The unique name of the report plan. This name is between 1 and 256 characters,
	// starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9),
	// and underscores (_).
	//
	// ReportPlanName is a required field
	ReportPlanName *string `location:"uri" locationName:"reportPlanName" min:"1" type:"string" required:"true"`

	// Identifies the report template for the report. Reports are built using a
	// report template. The report templates are:
	//
	// RESOURCE_COMPLIANCE_REPORT | CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT
	// | COPY_JOB_REPORT | RESTORE_JOB_REPORT
	//
	// If the report template is RESOURCE_COMPLIANCE_REPORT or CONTROL_COMPLIANCE_REPORT,
	// this API resource also describes the report coverage by Amazon Web Services
	// Regions and frameworks.
	ReportSetting *ReportSetting `type:"structure"`
	// contains filtered or unexported fields
}

func (UpdateReportPlanInput) GoString added in v1.40.28

func (s UpdateReportPlanInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateReportPlanInput) SetIdempotencyToken added in v1.40.28

func (s *UpdateReportPlanInput) SetIdempotencyToken(v string) *UpdateReportPlanInput

SetIdempotencyToken sets the IdempotencyToken field's value.

func (*UpdateReportPlanInput) SetReportDeliveryChannel added in v1.40.28

func (s *UpdateReportPlanInput) SetReportDeliveryChannel(v *ReportDeliveryChannel) *UpdateReportPlanInput

SetReportDeliveryChannel sets the ReportDeliveryChannel field's value.

func (*UpdateReportPlanInput) SetReportPlanDescription added in v1.40.28

func (s *UpdateReportPlanInput) SetReportPlanDescription(v string) *UpdateReportPlanInput

SetReportPlanDescription sets the ReportPlanDescription field's value.

func (*UpdateReportPlanInput) SetReportPlanName added in v1.40.28

func (s *UpdateReportPlanInput) SetReportPlanName(v string) *UpdateReportPlanInput

SetReportPlanName sets the ReportPlanName field's value.

func (*UpdateReportPlanInput) SetReportSetting added in v1.40.28

SetReportSetting sets the ReportSetting field's value.

func (UpdateReportPlanInput) String added in v1.40.28

func (s UpdateReportPlanInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateReportPlanInput) Validate added in v1.40.28

func (s *UpdateReportPlanInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateReportPlanOutput added in v1.40.28

type UpdateReportPlanOutput struct {

	// The date and time that a report plan is created, in Unix format and Coordinated
	// Universal Time (UTC). The value of CreationTime is accurate to milliseconds.
	// For example, the value 1516925490.087 represents Friday, January 26, 2018
	// 12:11:30.087 AM.
	CreationTime *time.Time `type:"timestamp"`

	// An Amazon Resource Name (ARN) that uniquely identifies a resource. The format
	// of the ARN depends on the resource type.
	ReportPlanArn *string `type:"string"`

	// The unique name of the report plan.
	ReportPlanName *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (UpdateReportPlanOutput) GoString added in v1.40.28

func (s UpdateReportPlanOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateReportPlanOutput) SetCreationTime added in v1.40.28

func (s *UpdateReportPlanOutput) SetCreationTime(v time.Time) *UpdateReportPlanOutput

SetCreationTime sets the CreationTime field's value.

func (*UpdateReportPlanOutput) SetReportPlanArn added in v1.40.28

func (s *UpdateReportPlanOutput) SetReportPlanArn(v string) *UpdateReportPlanOutput

SetReportPlanArn sets the ReportPlanArn field's value.

func (*UpdateReportPlanOutput) SetReportPlanName added in v1.40.28

func (s *UpdateReportPlanOutput) SetReportPlanName(v string) *UpdateReportPlanOutput

SetReportPlanName sets the ReportPlanName field's value.

func (UpdateReportPlanOutput) String added in v1.40.28

func (s UpdateReportPlanOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 Amazon Web Services 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. This parameter
	// is optional.
	//
	// If used, this parameter must contain 1 to 50 alphanumeric or '-_.' characters.
	CreatorRequestId *string `type:"string"`

	// A server-side encryption key you can specify to encrypt your backups from
	// services that support full Backup management; for example, arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab.
	// If you specify a key, you must specify its ARN, not its alias. If you do
	// not specify a key, Backup creates a KMS key for you by default.
	//
	// To learn which Backup services support full Backup management and how Backup
	// handles encryption for backups from services that do not yet support full
	// Backup, see Encryption for backups in Backup (https://docs.aws.amazon.com/aws-backup/latest/devguide/encryption.html)
	EncryptionKeyArn *string `type:"string"`

	// The date and time when Backup Vault Lock configuration becomes immutable,
	// meaning it cannot be changed or deleted.
	//
	// If you applied Vault Lock to your vault without specifying a lock date, you
	// can change your Vault Lock settings, or delete Vault Lock from the vault
	// entirely, at any time.
	//
	// This value is in Unix format, Coordinated Universal Time (UTC), and accurate
	// to milliseconds. For example, the value 1516925490.087 represents Friday,
	// January 26, 2018 12:11:30.087 AM.
	LockDate *time.Time `type:"timestamp"`

	// A Boolean value that indicates whether Backup Vault Lock applies to the selected
	// backup vault. If true, Vault Lock prevents delete and update operations on
	// the recovery points in the selected vault.
	Locked *bool `type:"boolean"`

	// The Backup Vault Lock setting that specifies the maximum retention period
	// that the vault retains its recovery points. If this parameter is not specified,
	// Vault Lock does not enforce a maximum retention period on the recovery points
	// in the vault (allowing indefinite storage).
	//
	// If specified, any backup or copy job to the vault must have a lifecycle policy
	// with a retention period equal to or shorter than the maximum retention period.
	// If the job's retention period is longer than that maximum retention period,
	// then the vault fails the backup or copy job, and you should either modify
	// your lifecycle settings or use a different vault. Recovery points already
	// stored in the vault prior to Vault Lock are not affected.
	MaxRetentionDays *int64 `type:"long"`

	// The Backup Vault Lock setting that specifies the minimum retention period
	// that the vault retains its recovery points. If this parameter is not specified,
	// Vault Lock does not enforce a minimum retention period.
	//
	// If specified, any backup or copy job to the vault must have a lifecycle policy
	// with a retention period equal to or longer than the minimum retention period.
	// If the job's retention period is shorter than that minimum retention period,
	// then the vault fails the backup or copy job, and you should either modify
	// your lifecycle settings or use a different vault. Recovery points already
	// stored in the vault prior to Vault Lock are not affected.
	MinRetentionDays *int64 `type:"long"`

	// 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) SetLockDate added in v1.40.58

func (s *VaultListMember) SetLockDate(v time.Time) *VaultListMember

SetLockDate sets the LockDate field's value.

func (*VaultListMember) SetLocked added in v1.40.58

func (s *VaultListMember) SetLocked(v bool) *VaultListMember

SetLocked sets the Locked field's value.

func (*VaultListMember) SetMaxRetentionDays added in v1.40.58

func (s *VaultListMember) SetMaxRetentionDays(v int64) *VaultListMember

SetMaxRetentionDays sets the MaxRetentionDays field's value.

func (*VaultListMember) SetMinRetentionDays added in v1.40.58

func (s *VaultListMember) SetMinRetentionDays(v int64) *VaultListMember

SetMinRetentionDays sets the MinRetentionDays 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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