func ConditionType_Values() []string
ConditionType_Values returns all elements of the ConditionType enum
func CopyJobState_Values() []string
CopyJobState_Values returns all elements of the CopyJobState enum
func JobState_Values() []string
JobState_Values returns all elements of the JobState enum
func LegalHoldStatus_Values() []string
LegalHoldStatus_Values returns all elements of the LegalHoldStatus enum
func RecoveryPointStatus_Values() []string
RecoveryPointStatus_Values returns all elements of the RecoveryPointStatus enum
func RestoreJobStatus_Values() []string
RestoreJobStatus_Values returns all elements of the RestoreJobStatus enum
func StorageClass_Values() []string
StorageClass_Values returns all elements of the StorageClass enum
func VaultEvent_Values() []string
VaultEvent_Values returns all elements of the VaultEvent enum
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 (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 (s *AdvancedBackupSetting) SetBackupOptions(v map[string]*string) *AdvancedBackupSetting
SetBackupOptions sets the BackupOptions field's value.
func (s *AdvancedBackupSetting) SetResourceType(v string) *AdvancedBackupSetting
SetResourceType sets the ResourceType field's value.
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 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 (s *AlreadyExistsException) Code() string
Code returns the exception type name.
func (s *AlreadyExistsException) Error() string
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 (s *AlreadyExistsException) Message() string
Message returns the exception's message.
func (s *AlreadyExistsException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *AlreadyExistsException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *AlreadyExistsException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
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 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(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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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:
See also, https://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/DescribeRegionSettings
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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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:
See also, https://docs.aws.amazon.com/goto/WebAPI/backup-2018-11-15/GetSupportedResourceTypes
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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 (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 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 (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 (s *CalculatedLifecycle) SetDeleteAt(v time.Time) *CalculatedLifecycle
SetDeleteAt sets the DeleteAt field's value.
func (s *CalculatedLifecycle) SetMoveToColdStorageAt(v time.Time) *CalculatedLifecycle
SetMoveToColdStorageAt sets the MoveToColdStorageAt field's value.
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 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 (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 (s *CancelLegalHoldInput) SetCancelDescription(v string) *CancelLegalHoldInput
SetCancelDescription sets the CancelDescription field's value.
func (s *CancelLegalHoldInput) SetLegalHoldId(v string) *CancelLegalHoldInput
SetLegalHoldId sets the LegalHoldId field's value.
func (s *CancelLegalHoldInput) SetRetainRecordInDays(v int64) *CancelLegalHoldInput
SetRetainRecordInDays sets the RetainRecordInDays field's value.
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 (s *CancelLegalHoldInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CancelLegalHoldOutput struct {
// contains filtered or unexported fields
}
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 (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 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 (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 (s *Condition) SetConditionKey(v string) *Condition
SetConditionKey sets the ConditionKey field's value.
func (s *Condition) SetConditionType(v string) *Condition
SetConditionType sets the ConditionType field's value.
func (s *Condition) SetConditionValue(v string) *Condition
SetConditionValue sets the ConditionValue field's value.
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 (s *Condition) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (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 (s *ConditionParameter) SetConditionKey(v string) *ConditionParameter
SetConditionKey sets the ConditionKey field's value.
func (s *ConditionParameter) SetConditionValue(v string) *ConditionParameter
SetConditionValue sets the ConditionValue field's value.
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 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 (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 (s *Conditions) SetStringEquals(v []*ConditionParameter) *Conditions
SetStringEquals sets the StringEquals field's value.
func (s *Conditions) SetStringLike(v []*ConditionParameter) *Conditions
SetStringLike sets the StringLike field's value.
func (s *Conditions) SetStringNotEquals(v []*ConditionParameter) *Conditions
SetStringNotEquals sets the StringNotEquals field's value.
func (s *Conditions) SetStringNotLike(v []*ConditionParameter) *Conditions
SetStringNotLike sets the StringNotLike field's value.
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 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 (s *ConflictException) Code() string
Code returns the exception type name.
func (s *ConflictException) Error() string
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 (s *ConflictException) Message() string
Message returns the exception's message.
func (s *ConflictException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *ConflictException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *ConflictException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
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 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 (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 (s *ControlInputParameter) SetParameterName(v string) *ControlInputParameter
SetParameterName sets the ParameterName field's value.
func (s *ControlInputParameter) SetParameterValue(v string) *ControlInputParameter
SetParameterValue sets the ParameterValue field's value.
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 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 (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 (s *ControlScope) SetComplianceResourceIds(v []*string) *ControlScope
SetComplianceResourceIds sets the ComplianceResourceIds field's value.
func (s *ControlScope) SetComplianceResourceTypes(v []*string) *ControlScope
SetComplianceResourceTypes sets the ComplianceResourceTypes field's value.
func (s *ControlScope) SetTags(v map[string]*string) *ControlScope
SetTags sets the Tags field's value.
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 (s *ControlScope) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (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 (s *CopyAction) SetDestinationBackupVaultArn(v string) *CopyAction
SetDestinationBackupVaultArn sets the DestinationBackupVaultArn field's value.
func (s *CopyAction) SetLifecycle(v *Lifecycle) *CopyAction
SetLifecycle sets the Lifecycle field's value.
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 (s *CopyAction) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (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 (s *CopyJob) SetAccountId(v string) *CopyJob
SetAccountId sets the AccountId field's value.
func (s *CopyJob) SetBackupSizeInBytes(v int64) *CopyJob
SetBackupSizeInBytes sets the BackupSizeInBytes field's value.
func (s *CopyJob) SetChildJobsInState(v map[string]*int64) *CopyJob
SetChildJobsInState sets the ChildJobsInState field's value.
func (s *CopyJob) SetCompletionDate(v time.Time) *CopyJob
SetCompletionDate sets the CompletionDate field's value.
func (s *CopyJob) SetCompositeMemberIdentifier(v string) *CopyJob
SetCompositeMemberIdentifier sets the CompositeMemberIdentifier field's value.
func (s *CopyJob) SetCopyJobId(v string) *CopyJob
SetCopyJobId sets the CopyJobId field's value.
func (s *CopyJob) SetCreatedBy(v *RecoveryPointCreator) *CopyJob
SetCreatedBy sets the CreatedBy field's value.
func (s *CopyJob) SetCreationDate(v time.Time) *CopyJob
SetCreationDate sets the CreationDate field's value.
func (s *CopyJob) SetDestinationBackupVaultArn(v string) *CopyJob
SetDestinationBackupVaultArn sets the DestinationBackupVaultArn field's value.
func (s *CopyJob) SetDestinationRecoveryPointArn(v string) *CopyJob
SetDestinationRecoveryPointArn sets the DestinationRecoveryPointArn field's value.
func (s *CopyJob) SetIamRoleArn(v string) *CopyJob
SetIamRoleArn sets the IamRoleArn field's value.
func (s *CopyJob) SetIsParent(v bool) *CopyJob
SetIsParent sets the IsParent field's value.
func (s *CopyJob) SetNumberOfChildJobs(v int64) *CopyJob
SetNumberOfChildJobs sets the NumberOfChildJobs field's value.
func (s *CopyJob) SetParentJobId(v string) *CopyJob
SetParentJobId sets the ParentJobId field's value.
func (s *CopyJob) SetResourceArn(v string) *CopyJob
SetResourceArn sets the ResourceArn field's value.
func (s *CopyJob) SetResourceName(v string) *CopyJob
SetResourceName sets the ResourceName field's value.
func (s *CopyJob) SetResourceType(v string) *CopyJob
SetResourceType sets the ResourceType field's value.
func (s *CopyJob) SetSourceBackupVaultArn(v string) *CopyJob
SetSourceBackupVaultArn sets the SourceBackupVaultArn field's value.
func (s *CopyJob) SetSourceRecoveryPointArn(v string) *CopyJob
SetSourceRecoveryPointArn sets the SourceRecoveryPointArn field's value.
func (s *CopyJob) SetState(v string) *CopyJob
SetState sets the State field's value.
func (s *CopyJob) SetStatusMessage(v string) *CopyJob
SetStatusMessage sets the StatusMessage field's value.
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 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 (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 (s *CreateBackupPlanInput) SetBackupPlan(v *PlanInput) *CreateBackupPlanInput
SetBackupPlan sets the BackupPlan field's value.
func (s *CreateBackupPlanInput) SetBackupPlanTags(v map[string]*string) *CreateBackupPlanInput
SetBackupPlanTags sets the BackupPlanTags field's value.
func (s *CreateBackupPlanInput) SetCreatorRequestId(v string) *CreateBackupPlanInput
SetCreatorRequestId sets the CreatorRequestId field's value.
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 (s *CreateBackupPlanInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (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 (s *CreateBackupPlanOutput) SetAdvancedBackupSettings(v []*AdvancedBackupSetting) *CreateBackupPlanOutput
SetAdvancedBackupSettings sets the AdvancedBackupSettings field's value.
func (s *CreateBackupPlanOutput) SetBackupPlanArn(v string) *CreateBackupPlanOutput
SetBackupPlanArn sets the BackupPlanArn field's value.
func (s *CreateBackupPlanOutput) SetBackupPlanId(v string) *CreateBackupPlanOutput
SetBackupPlanId sets the BackupPlanId field's value.
func (s *CreateBackupPlanOutput) SetCreationDate(v time.Time) *CreateBackupPlanOutput
SetCreationDate sets the CreationDate field's value.
func (s *CreateBackupPlanOutput) SetVersionId(v string) *CreateBackupPlanOutput
SetVersionId sets the VersionId field's value.
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 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 (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 (s *CreateBackupSelectionInput) SetBackupPlanId(v string) *CreateBackupSelectionInput
SetBackupPlanId sets the BackupPlanId field's value.
func (s *CreateBackupSelectionInput) SetBackupSelection(v *Selection) *CreateBackupSelectionInput
SetBackupSelection sets the BackupSelection field's value.
func (s *CreateBackupSelectionInput) SetCreatorRequestId(v string) *CreateBackupSelectionInput
SetCreatorRequestId sets the CreatorRequestId field's value.
func (s CreateBackupSelectionInput) 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 (s *CreateBackupSelectionInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (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 (s *CreateBackupSelectionOutput) SetBackupPlanId(v string) *CreateBackupSelectionOutput
SetBackupPlanId sets the BackupPlanId field's value.
func (s *CreateBackupSelectionOutput) SetCreationDate(v time.Time) *CreateBackupSelectionOutput
SetCreationDate sets the CreationDate field's value.
func (s *CreateBackupSelectionOutput) SetSelectionId(v string) *CreateBackupSelectionOutput
SetSelectionId sets the SelectionId field's value.
func (s CreateBackupSelectionOutput) 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 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 (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 (s *CreateBackupVaultInput) SetBackupVaultName(v string) *CreateBackupVaultInput
SetBackupVaultName sets the BackupVaultName field's value.
func (s *CreateBackupVaultInput) SetBackupVaultTags(v map[string]*string) *CreateBackupVaultInput
SetBackupVaultTags sets the BackupVaultTags field's value.
func (s *CreateBackupVaultInput) SetCreatorRequestId(v string) *CreateBackupVaultInput
SetCreatorRequestId sets the CreatorRequestId field's value.
func (s *CreateBackupVaultInput) SetEncryptionKeyArn(v string) *CreateBackupVaultInput
SetEncryptionKeyArn sets the EncryptionKeyArn field's value.
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 (s *CreateBackupVaultInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (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 (s *CreateBackupVaultOutput) SetBackupVaultArn(v string) *CreateBackupVaultOutput
SetBackupVaultArn sets the BackupVaultArn field's value.
func (s *CreateBackupVaultOutput) SetBackupVaultName(v string) *CreateBackupVaultOutput
SetBackupVaultName sets the BackupVaultName field's value.
func (s *CreateBackupVaultOutput) SetCreationDate(v time.Time) *CreateBackupVaultOutput
SetCreationDate sets the CreationDate field's value.
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 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 (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 (s *CreateFrameworkInput) SetFrameworkControls(v []*FrameworkControl) *CreateFrameworkInput
SetFrameworkControls sets the FrameworkControls field's value.
func (s *CreateFrameworkInput) SetFrameworkDescription(v string) *CreateFrameworkInput
SetFrameworkDescription sets the FrameworkDescription field's value.
func (s *CreateFrameworkInput) SetFrameworkName(v string) *CreateFrameworkInput
SetFrameworkName sets the FrameworkName field's value.
func (s *CreateFrameworkInput) SetFrameworkTags(v map[string]*string) *CreateFrameworkInput
SetFrameworkTags sets the FrameworkTags field's value.
func (s *CreateFrameworkInput) SetIdempotencyToken(v string) *CreateFrameworkInput
SetIdempotencyToken sets the IdempotencyToken field's value.
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 (s *CreateFrameworkInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (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 (s *CreateFrameworkOutput) SetFrameworkArn(v string) *CreateFrameworkOutput
SetFrameworkArn sets the FrameworkArn field's value.
func (s *CreateFrameworkOutput) SetFrameworkName(v string) *CreateFrameworkOutput
SetFrameworkName sets the FrameworkName field's value.
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 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 (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 (s *CreateLegalHoldInput) SetDescription(v string) *CreateLegalHoldInput
SetDescription sets the Description field's value.
func (s *CreateLegalHoldInput) SetIdempotencyToken(v string) *CreateLegalHoldInput
SetIdempotencyToken sets the IdempotencyToken field's value.
func (s *CreateLegalHoldInput) SetRecoveryPointSelection(v *RecoveryPointSelection) *CreateLegalHoldInput
SetRecoveryPointSelection sets the RecoveryPointSelection field's value.
func (s *CreateLegalHoldInput) SetTags(v map[string]*string) *CreateLegalHoldInput
SetTags sets the Tags field's value.
func (s *CreateLegalHoldInput) SetTitle(v string) *CreateLegalHoldInput
SetTitle sets the Title field's value.
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 (s *CreateLegalHoldInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (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 (s *CreateLegalHoldOutput) SetCreationDate(v time.Time) *CreateLegalHoldOutput
SetCreationDate sets the CreationDate field's value.
func (s *CreateLegalHoldOutput) SetDescription(v string) *CreateLegalHoldOutput
SetDescription sets the Description field's value.
func (s *CreateLegalHoldOutput) SetLegalHoldArn(v string) *CreateLegalHoldOutput
SetLegalHoldArn sets the LegalHoldArn field's value.
func (s *CreateLegalHoldOutput) SetLegalHoldId(v string) *CreateLegalHoldOutput
SetLegalHoldId sets the LegalHoldId field's value.
func (s *CreateLegalHoldOutput) SetRecoveryPointSelection(v *RecoveryPointSelection) *CreateLegalHoldOutput
SetRecoveryPointSelection sets the RecoveryPointSelection field's value.
func (s *CreateLegalHoldOutput) SetStatus(v string) *CreateLegalHoldOutput
SetStatus sets the Status field's value.
func (s *CreateLegalHoldOutput) SetTitle(v string) *CreateLegalHoldOutput
SetTitle sets the Title field's value.
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 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 (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 (s *CreateReportPlanInput) SetIdempotencyToken(v string) *CreateReportPlanInput
SetIdempotencyToken sets the IdempotencyToken field's value.
func (s *CreateReportPlanInput) SetReportDeliveryChannel(v *ReportDeliveryChannel) *CreateReportPlanInput
SetReportDeliveryChannel sets the ReportDeliveryChannel field's value.
func (s *CreateReportPlanInput) SetReportPlanDescription(v string) *CreateReportPlanInput
SetReportPlanDescription sets the ReportPlanDescription field's value.
func (s *CreateReportPlanInput) SetReportPlanName(v string) *CreateReportPlanInput
SetReportPlanName sets the ReportPlanName field's value.
func (s *CreateReportPlanInput) SetReportPlanTags(v map[string]*string) *CreateReportPlanInput
SetReportPlanTags sets the ReportPlanTags field's value.
func (s *CreateReportPlanInput) SetReportSetting(v *ReportSetting) *CreateReportPlanInput
SetReportSetting sets the ReportSetting field's value.
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 (s *CreateReportPlanInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (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 (s *CreateReportPlanOutput) SetCreationTime(v time.Time) *CreateReportPlanOutput
SetCreationTime sets the CreationTime field's value.
func (s *CreateReportPlanOutput) SetReportPlanArn(v string) *CreateReportPlanOutput
SetReportPlanArn sets the ReportPlanArn field's value.
func (s *CreateReportPlanOutput) SetReportPlanName(v string) *CreateReportPlanOutput
SetReportPlanName sets the ReportPlanName field's value.
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 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 (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 (s *DateRange) SetFromDate(v time.Time) *DateRange
SetFromDate sets the FromDate field's value.
func (s *DateRange) SetToDate(v time.Time) *DateRange
SetToDate sets the ToDate field's value.
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 (s *DateRange) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (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 (s *DeleteBackupPlanInput) SetBackupPlanId(v string) *DeleteBackupPlanInput
SetBackupPlanId sets the BackupPlanId field's value.
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 (s *DeleteBackupPlanInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (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 (s *DeleteBackupPlanOutput) SetBackupPlanArn(v string) *DeleteBackupPlanOutput
SetBackupPlanArn sets the BackupPlanArn field's value.
func (s *DeleteBackupPlanOutput) SetBackupPlanId(v string) *DeleteBackupPlanOutput
SetBackupPlanId sets the BackupPlanId field's value.
func (s *DeleteBackupPlanOutput) SetDeletionDate(v time.Time) *DeleteBackupPlanOutput
SetDeletionDate sets the DeletionDate field's value.
func (s *DeleteBackupPlanOutput) SetVersionId(v string) *DeleteBackupPlanOutput
SetVersionId sets the VersionId field's value.
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 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 (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 (s *DeleteBackupSelectionInput) SetBackupPlanId(v string) *DeleteBackupSelectionInput
SetBackupPlanId sets the BackupPlanId field's value.
func (s *DeleteBackupSelectionInput) SetSelectionId(v string) *DeleteBackupSelectionInput
SetSelectionId sets the SelectionId field's value.
func (s DeleteBackupSelectionInput) 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 (s *DeleteBackupSelectionInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteBackupSelectionOutput struct {
// contains filtered or unexported fields
}
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 (s DeleteBackupSelectionOutput) 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 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 (s DeleteBackupVaultAccessPolicyInput) 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 (s *DeleteBackupVaultAccessPolicyInput) SetBackupVaultName(v string) *DeleteBackupVaultAccessPolicyInput
SetBackupVaultName sets the BackupVaultName field's value.
func (s DeleteBackupVaultAccessPolicyInput) 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 (s *DeleteBackupVaultAccessPolicyInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteBackupVaultAccessPolicyOutput struct {
// contains filtered or unexported fields
}
func (s DeleteBackupVaultAccessPolicyOutput) 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 (s DeleteBackupVaultAccessPolicyOutput) 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 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 (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 (s *DeleteBackupVaultInput) SetBackupVaultName(v string) *DeleteBackupVaultInput
SetBackupVaultName sets the BackupVaultName field's value.
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 (s *DeleteBackupVaultInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (s DeleteBackupVaultLockConfigurationInput) 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 (s *DeleteBackupVaultLockConfigurationInput) SetBackupVaultName(v string) *DeleteBackupVaultLockConfigurationInput
SetBackupVaultName sets the BackupVaultName field's value.
func (s DeleteBackupVaultLockConfigurationInput) 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 (s *DeleteBackupVaultLockConfigurationInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteBackupVaultLockConfigurationOutput struct {
// contains filtered or unexported fields
}
func (s DeleteBackupVaultLockConfigurationOutput) 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 (s DeleteBackupVaultLockConfigurationOutput) 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 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 (s DeleteBackupVaultNotificationsInput) 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 (s *DeleteBackupVaultNotificationsInput) SetBackupVaultName(v string) *DeleteBackupVaultNotificationsInput
SetBackupVaultName sets the BackupVaultName field's value.
func (s DeleteBackupVaultNotificationsInput) 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 (s *DeleteBackupVaultNotificationsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteBackupVaultNotificationsOutput struct {
// contains filtered or unexported fields
}
func (s DeleteBackupVaultNotificationsOutput) 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 (s DeleteBackupVaultNotificationsOutput) 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 DeleteBackupVaultOutput struct {
// contains filtered or unexported fields
}
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 (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 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 (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 (s *DeleteFrameworkInput) SetFrameworkName(v string) *DeleteFrameworkInput
SetFrameworkName sets the FrameworkName field's value.
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 (s *DeleteFrameworkInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteFrameworkOutput struct {
// contains filtered or unexported fields
}
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 (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 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 (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 (s *DeleteRecoveryPointInput) SetBackupVaultName(v string) *DeleteRecoveryPointInput
SetBackupVaultName sets the BackupVaultName field's value.
func (s *DeleteRecoveryPointInput) SetRecoveryPointArn(v string) *DeleteRecoveryPointInput
SetRecoveryPointArn sets the RecoveryPointArn field's value.
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 (s *DeleteRecoveryPointInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteRecoveryPointOutput struct {
// contains filtered or unexported fields
}
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 (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 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 (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 (s *DeleteReportPlanInput) SetReportPlanName(v string) *DeleteReportPlanInput
SetReportPlanName sets the ReportPlanName field's value.
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 (s *DeleteReportPlanInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteReportPlanOutput struct {
// contains filtered or unexported fields
}
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 (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 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 (s *DependencyFailureException) Code() string
Code returns the exception type name.
func (s *DependencyFailureException) Error() string
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 (s *DependencyFailureException) Message() string
Message returns the exception's message.
func (s *DependencyFailureException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *DependencyFailureException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *DependencyFailureException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (s DependencyFailureException) 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 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 (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 (s *DescribeBackupJobInput) SetBackupJobId(v string) *DescribeBackupJobInput
SetBackupJobId sets the BackupJobId field's value.
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 (s *DescribeBackupJobInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (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 (s *DescribeBackupJobOutput) SetAccountId(v string) *DescribeBackupJobOutput
SetAccountId sets the AccountId field's value.
func (s *DescribeBackupJobOutput) SetBackupJobId(v string) *DescribeBackupJobOutput
SetBackupJobId sets the BackupJobId field's value.
func (s *DescribeBackupJobOutput) SetBackupOptions(v map[string]*string) *DescribeBackupJobOutput
SetBackupOptions sets the BackupOptions field's value.
func (s *DescribeBackupJobOutput) SetBackupSizeInBytes(v int64) *DescribeBackupJobOutput
SetBackupSizeInBytes sets the BackupSizeInBytes field's value.
func (s *DescribeBackupJobOutput) SetBackupType(v string) *DescribeBackupJobOutput
SetBackupType sets the BackupType field's value.
func (s *DescribeBackupJobOutput) SetBackupVaultArn(v string) *DescribeBackupJobOutput
SetBackupVaultArn sets the BackupVaultArn field's value.
func (s *DescribeBackupJobOutput) SetBackupVaultName(v string) *DescribeBackupJobOutput
SetBackupVaultName sets the BackupVaultName field's value.
func (s *DescribeBackupJobOutput) SetBytesTransferred(v int64) *DescribeBackupJobOutput
SetBytesTransferred sets the BytesTransferred field's value.
func (s *DescribeBackupJobOutput) SetChildJobsInState(v map[string]*int64) *DescribeBackupJobOutput
SetChildJobsInState sets the ChildJobsInState field's value.
func (s *DescribeBackupJobOutput) SetCompletionDate(v time.Time) *DescribeBackupJobOutput
SetCompletionDate sets the CompletionDate field's value.
func (s *DescribeBackupJobOutput) SetCreatedBy(v *RecoveryPointCreator) *DescribeBackupJobOutput
SetCreatedBy sets the CreatedBy field's value.
func (s *DescribeBackupJobOutput) SetCreationDate(v time.Time) *DescribeBackupJobOutput
SetCreationDate sets the CreationDate field's value.
func (s *DescribeBackupJobOutput) SetExpectedCompletionDate(v time.Time) *DescribeBackupJobOutput
SetExpectedCompletionDate sets the ExpectedCompletionDate field's value.
func (s *DescribeBackupJobOutput) SetIamRoleArn(v string) *DescribeBackupJobOutput
SetIamRoleArn sets the IamRoleArn field's value.
func (s *DescribeBackupJobOutput) SetIsParent(v bool) *DescribeBackupJobOutput
SetIsParent sets the IsParent field's value.
func (s *DescribeBackupJobOutput) SetNumberOfChildJobs(v int64) *DescribeBackupJobOutput
SetNumberOfChildJobs sets the NumberOfChildJobs field's value.
func (s *DescribeBackupJobOutput) SetParentJobId(v string) *DescribeBackupJobOutput
SetParentJobId sets the ParentJobId field's value.
func (s *DescribeBackupJobOutput) SetPercentDone(v string) *DescribeBackupJobOutput
SetPercentDone sets the PercentDone field's value.
func (s *DescribeBackupJobOutput) SetRecoveryPointArn(v string) *DescribeBackupJobOutput
SetRecoveryPointArn sets the RecoveryPointArn field's value.
func (s *DescribeBackupJobOutput) SetResourceArn(v string) *DescribeBackupJobOutput
SetResourceArn sets the ResourceArn field's value.
func (s *DescribeBackupJobOutput) SetResourceName(v string) *DescribeBackupJobOutput
SetResourceName sets the ResourceName field's value.
func (s *DescribeBackupJobOutput) SetResourceType(v string) *DescribeBackupJobOutput
SetResourceType sets the ResourceType field's value.
func (s *DescribeBackupJobOutput) SetStartBy(v time.Time) *DescribeBackupJobOutput
SetStartBy sets the StartBy field's value.
func (s *DescribeBackupJobOutput) SetState(v string) *DescribeBackupJobOutput
SetState sets the State field's value.
func (s *DescribeBackupJobOutput) SetStatusMessage(v string) *DescribeBackupJobOutput
SetStatusMessage sets the StatusMessage field's value.
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 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 (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 (s *DescribeBackupVaultInput) SetBackupVaultName(v string) *DescribeBackupVaultInput
SetBackupVaultName sets the BackupVaultName field's value.
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 (s *DescribeBackupVaultInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (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 (s *DescribeBackupVaultOutput) SetBackupVaultArn(v string) *DescribeBackupVaultOutput
SetBackupVaultArn sets the BackupVaultArn field's value.
func (s *DescribeBackupVaultOutput) SetBackupVaultName(v string) *DescribeBackupVaultOutput
SetBackupVaultName sets the BackupVaultName field's value.
func (s *DescribeBackupVaultOutput) SetCreationDate(v time.Time) *DescribeBackupVaultOutput
SetCreationDate sets the CreationDate field's value.
func (s *DescribeBackupVaultOutput) SetCreatorRequestId(v string) *DescribeBackupVaultOutput
SetCreatorRequestId sets the CreatorRequestId field's value.
func (s *DescribeBackupVaultOutput) SetEncryptionKeyArn(v string) *DescribeBackupVaultOutput
SetEncryptionKeyArn sets the EncryptionKeyArn field's value.
func (s *DescribeBackupVaultOutput) SetLockDate(v time.Time) *DescribeBackupVaultOutput
SetLockDate sets the LockDate field's value.
func (s *DescribeBackupVaultOutput) SetLocked(v bool) *DescribeBackupVaultOutput
SetLocked sets the Locked field's value.
func (s *DescribeBackupVaultOutput) SetMaxRetentionDays(v int64) *DescribeBackupVaultOutput
SetMaxRetentionDays sets the MaxRetentionDays field's value.
func (s *DescribeBackupVaultOutput) SetMinRetentionDays(v int64) *DescribeBackupVaultOutput
SetMinRetentionDays sets the MinRetentionDays field's value.
func (s *DescribeBackupVaultOutput) SetNumberOfRecoveryPoints(v int64) *DescribeBackupVaultOutput
SetNumberOfRecoveryPoints sets the NumberOfRecoveryPoints field's value.
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 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 (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 (s *DescribeCopyJobInput) SetCopyJobId(v string) *DescribeCopyJobInput
SetCopyJobId sets the CopyJobId field's value.
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 (s *DescribeCopyJobInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeCopyJobOutput struct {
// Contains detailed information about a copy job.
CopyJob *CopyJob `type:"structure"`
// contains filtered or unexported fields
}
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 (s *DescribeCopyJobOutput) SetCopyJob(v *CopyJob) *DescribeCopyJobOutput
SetCopyJob sets the CopyJob field's value.
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 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 (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 (s *DescribeFrameworkInput) SetFrameworkName(v string) *DescribeFrameworkInput
SetFrameworkName sets the FrameworkName field's value.
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 (s *DescribeFrameworkInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (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 (s *DescribeFrameworkOutput) SetCreationTime(v time.Time) *DescribeFrameworkOutput
SetCreationTime sets the CreationTime field's value.
func (s *DescribeFrameworkOutput) SetDeploymentStatus(v string) *DescribeFrameworkOutput
SetDeploymentStatus sets the DeploymentStatus field's value.
func (s *DescribeFrameworkOutput) SetFrameworkArn(v string) *DescribeFrameworkOutput
SetFrameworkArn sets the FrameworkArn field's value.
func (s *DescribeFrameworkOutput) SetFrameworkControls(v []*FrameworkControl) *DescribeFrameworkOutput
SetFrameworkControls sets the FrameworkControls field's value.
func (s *DescribeFrameworkOutput) SetFrameworkDescription(v string) *DescribeFrameworkOutput
SetFrameworkDescription sets the FrameworkDescription field's value.
func (s *DescribeFrameworkOutput) SetFrameworkName(v string) *DescribeFrameworkOutput
SetFrameworkName sets the FrameworkName field's value.
func (s *DescribeFrameworkOutput) SetFrameworkStatus(v string) *DescribeFrameworkOutput
SetFrameworkStatus sets the FrameworkStatus field's value.
func (s *DescribeFrameworkOutput) SetIdempotencyToken(v string) *DescribeFrameworkOutput
SetIdempotencyToken sets the IdempotencyToken field's value.
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 struct {
// contains filtered or unexported fields
}
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 (s DescribeGlobalSettingsInput) 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 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 (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 (s *DescribeGlobalSettingsOutput) SetGlobalSettings(v map[string]*string) *DescribeGlobalSettingsOutput
SetGlobalSettings sets the GlobalSettings field's value.
func (s *DescribeGlobalSettingsOutput) SetLastUpdateTime(v time.Time) *DescribeGlobalSettingsOutput
SetLastUpdateTime sets the LastUpdateTime field's value.
func (s DescribeGlobalSettingsOutput) 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 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 (s DescribeProtectedResourceInput) 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 (s *DescribeProtectedResourceInput) SetResourceArn(v string) *DescribeProtectedResourceInput
SetResourceArn sets the ResourceArn field's value.
func (s DescribeProtectedResourceInput) 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 (s *DescribeProtectedResourceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (s DescribeProtectedResourceOutput) 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 (s *DescribeProtectedResourceOutput) SetLastBackupTime(v time.Time) *DescribeProtectedResourceOutput
SetLastBackupTime sets the LastBackupTime field's value.
func (s *DescribeProtectedResourceOutput) SetResourceArn(v string) *DescribeProtectedResourceOutput
SetResourceArn sets the ResourceArn field's value.
func (s *DescribeProtectedResourceOutput) SetResourceName(v string) *DescribeProtectedResourceOutput
SetResourceName sets the ResourceName field's value.
func (s *DescribeProtectedResourceOutput) SetResourceType(v string) *DescribeProtectedResourceOutput
SetResourceType sets the ResourceType field's value.
func (s DescribeProtectedResourceOutput) 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 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 (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 (s *DescribeRecoveryPointInput) SetBackupVaultName(v string) *DescribeRecoveryPointInput
SetBackupVaultName sets the BackupVaultName field's value.
func (s *DescribeRecoveryPointInput) SetRecoveryPointArn(v string) *DescribeRecoveryPointInput
SetRecoveryPointArn sets the RecoveryPointArn field's value.
func (s DescribeRecoveryPointInput) 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 (s *DescribeRecoveryPointInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (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 (s *DescribeRecoveryPointOutput) SetBackupSizeInBytes(v int64) *DescribeRecoveryPointOutput
SetBackupSizeInBytes sets the BackupSizeInBytes field's value.
func (s *DescribeRecoveryPointOutput) SetBackupVaultArn(v string) *DescribeRecoveryPointOutput
SetBackupVaultArn sets the BackupVaultArn field's value.
func (s *DescribeRecoveryPointOutput) SetBackupVaultName(v string) *DescribeRecoveryPointOutput
SetBackupVaultName sets the BackupVaultName field's value.
func (s *DescribeRecoveryPointOutput) SetCalculatedLifecycle(v *CalculatedLifecycle) *DescribeRecoveryPointOutput
SetCalculatedLifecycle sets the CalculatedLifecycle field's value.
func (s *DescribeRecoveryPointOutput) SetCompletionDate(v time.Time) *DescribeRecoveryPointOutput
SetCompletionDate sets the CompletionDate field's value.
func (s *DescribeRecoveryPointOutput) SetCompositeMemberIdentifier(v string) *DescribeRecoveryPointOutput
SetCompositeMemberIdentifier sets the CompositeMemberIdentifier field's value.
func (s *DescribeRecoveryPointOutput) SetCreatedBy(v *RecoveryPointCreator) *DescribeRecoveryPointOutput
SetCreatedBy sets the CreatedBy field's value.
func (s *DescribeRecoveryPointOutput) SetCreationDate(v time.Time) *DescribeRecoveryPointOutput
SetCreationDate sets the CreationDate field's value.
func (s *DescribeRecoveryPointOutput) SetEncryptionKeyArn(v string) *DescribeRecoveryPointOutput
SetEncryptionKeyArn sets the EncryptionKeyArn field's value.
func (s *DescribeRecoveryPointOutput) SetIamRoleArn(v string) *DescribeRecoveryPointOutput
SetIamRoleArn sets the IamRoleArn field's value.
func (s *DescribeRecoveryPointOutput) SetIsEncrypted(v bool) *DescribeRecoveryPointOutput
SetIsEncrypted sets the IsEncrypted field's value.
func (s *DescribeRecoveryPointOutput) SetIsParent(v bool) *DescribeRecoveryPointOutput
SetIsParent sets the IsParent field's value.
func (s *DescribeRecoveryPointOutput) SetLastRestoreTime(v time.Time) *DescribeRecoveryPointOutput
SetLastRestoreTime sets the LastRestoreTime field's value.
func (s *DescribeRecoveryPointOutput) SetLifecycle(v *Lifecycle) *DescribeRecoveryPointOutput
SetLifecycle sets the Lifecycle field's value.
func (s *DescribeRecoveryPointOutput) SetParentRecoveryPointArn(v string) *DescribeRecoveryPointOutput
SetParentRecoveryPointArn sets the ParentRecoveryPointArn field's value.
func (s *DescribeRecoveryPointOutput) SetRecoveryPointArn(v string) *DescribeRecoveryPointOutput
SetRecoveryPointArn sets the RecoveryPointArn field's value.
func (s *DescribeRecoveryPointOutput) SetResourceArn(v string) *DescribeRecoveryPointOutput
SetResourceArn sets the ResourceArn field's value.
func (s *DescribeRecoveryPointOutput) SetResourceName(v string) *DescribeRecoveryPointOutput
SetResourceName sets the ResourceName field's value.
func (s *DescribeRecoveryPointOutput) SetResourceType(v string) *DescribeRecoveryPointOutput
SetResourceType sets the ResourceType field's value.
func (s *DescribeRecoveryPointOutput) SetSourceBackupVaultArn(v string) *DescribeRecoveryPointOutput
SetSourceBackupVaultArn sets the SourceBackupVaultArn field's value.
func (s *DescribeRecoveryPointOutput) SetStatus(v string) *DescribeRecoveryPointOutput
SetStatus sets the Status field's value.
func (s *DescribeRecoveryPointOutput) SetStatusMessage(v string) *DescribeRecoveryPointOutput
SetStatusMessage sets the StatusMessage field's value.
func (s *DescribeRecoveryPointOutput) SetStorageClass(v string) *DescribeRecoveryPointOutput
SetStorageClass sets the StorageClass field's value.
func (s DescribeRecoveryPointOutput) 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 DescribeRegionSettingsInput struct {
// contains filtered or unexported fields
}
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 (s DescribeRegionSettingsInput) 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 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 (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 (s *DescribeRegionSettingsOutput) SetResourceTypeManagementPreference(v map[string]*bool) *DescribeRegionSettingsOutput
SetResourceTypeManagementPreference sets the ResourceTypeManagementPreference field's value.
func (s *DescribeRegionSettingsOutput) SetResourceTypeOptInPreference(v map[string]*bool) *DescribeRegionSettingsOutput
SetResourceTypeOptInPreference sets the ResourceTypeOptInPreference field's value.
func (s DescribeRegionSettingsOutput) 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 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 (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 (s *DescribeReportJobInput) SetReportJobId(v string) *DescribeReportJobInput
SetReportJobId sets the ReportJobId field's value.
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 (s *DescribeReportJobInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (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 (s *DescribeReportJobOutput) SetReportJob(v *ReportJob) *DescribeReportJobOutput
SetReportJob sets the ReportJob field's value.
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 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 (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 (s *DescribeReportPlanInput) SetReportPlanName(v string) *DescribeReportPlanInput
SetReportPlanName sets the ReportPlanName field's value.
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 (s *DescribeReportPlanInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (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 (s *DescribeReportPlanOutput) SetReportPlan(v *ReportPlan) *DescribeReportPlanOutput
SetReportPlan sets the ReportPlan field's value.
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 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 (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 (s *DescribeRestoreJobInput) SetRestoreJobId(v string) *DescribeRestoreJobInput
SetRestoreJobId sets the RestoreJobId field's value.
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 (s *DescribeRestoreJobInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (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 (s *DescribeRestoreJobOutput) SetAccountId(v string) *DescribeRestoreJobOutput
SetAccountId sets the AccountId field's value.
func (s *DescribeRestoreJobOutput) SetBackupSizeInBytes(v int64) *DescribeRestoreJobOutput
SetBackupSizeInBytes sets the BackupSizeInBytes field's value.
func (s *DescribeRestoreJobOutput) SetCompletionDate(v time.Time) *DescribeRestoreJobOutput
SetCompletionDate sets the CompletionDate field's value.
func (s *DescribeRestoreJobOutput) SetCreatedResourceArn(v string) *DescribeRestoreJobOutput
SetCreatedResourceArn sets the CreatedResourceArn field's value.
func (s *DescribeRestoreJobOutput) SetCreationDate(v time.Time) *DescribeRestoreJobOutput
SetCreationDate sets the CreationDate field's value.
func (s *DescribeRestoreJobOutput) SetExpectedCompletionTimeMinutes(v int64) *DescribeRestoreJobOutput
SetExpectedCompletionTimeMinutes sets the ExpectedCompletionTimeMinutes field's value.
func (s *DescribeRestoreJobOutput) SetIamRoleArn(v string) *DescribeRestoreJobOutput
SetIamRoleArn sets the IamRoleArn field's value.
func (s *DescribeRestoreJobOutput) SetPercentDone(v string) *DescribeRestoreJobOutput
SetPercentDone sets the PercentDone field's value.
func (s *DescribeRestoreJobOutput) SetRecoveryPointArn(v string) *DescribeRestoreJobOutput
SetRecoveryPointArn sets the RecoveryPointArn field's value.
func (s *DescribeRestoreJobOutput) SetResourceType(v string) *DescribeRestoreJobOutput
SetResourceType sets the ResourceType field's value.
func (s *DescribeRestoreJobOutput) SetRestoreJobId(v string) *DescribeRestoreJobOutput
SetRestoreJobId sets the RestoreJobId field's value.
func (s *DescribeRestoreJobOutput) SetStatus(v string) *DescribeRestoreJobOutput
SetStatus sets the Status field's value.
func (s *DescribeRestoreJobOutput) SetStatusMessage(v string) *DescribeRestoreJobOutput
SetStatusMessage sets the StatusMessage field's value.
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 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 (s DisassociateRecoveryPointFromParentInput) 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 (s *DisassociateRecoveryPointFromParentInput) SetBackupVaultName(v string) *DisassociateRecoveryPointFromParentInput
SetBackupVaultName sets the BackupVaultName field's value.
func (s *DisassociateRecoveryPointFromParentInput) SetRecoveryPointArn(v string) *DisassociateRecoveryPointFromParentInput
SetRecoveryPointArn sets the RecoveryPointArn field's value.
func (s DisassociateRecoveryPointFromParentInput) 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 (s *DisassociateRecoveryPointFromParentInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DisassociateRecoveryPointFromParentOutput struct {
// contains filtered or unexported fields
}
func (s DisassociateRecoveryPointFromParentOutput) 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 (s DisassociateRecoveryPointFromParentOutput) 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 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 (s DisassociateRecoveryPointInput) 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 (s *DisassociateRecoveryPointInput) SetBackupVaultName(v string) *DisassociateRecoveryPointInput
SetBackupVaultName sets the BackupVaultName field's value.
func (s *DisassociateRecoveryPointInput) SetRecoveryPointArn(v string) *DisassociateRecoveryPointInput
SetRecoveryPointArn sets the RecoveryPointArn field's value.
func (s DisassociateRecoveryPointInput) 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 (s *DisassociateRecoveryPointInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DisassociateRecoveryPointOutput struct {
// contains filtered or unexported fields
}
func (s DisassociateRecoveryPointOutput) 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 (s DisassociateRecoveryPointOutput) 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 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 (s ExportBackupPlanTemplateInput) 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 (s *ExportBackupPlanTemplateInput) SetBackupPlanId(v string) *ExportBackupPlanTemplateInput
SetBackupPlanId sets the BackupPlanId field's value.
func (s ExportBackupPlanTemplateInput) 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 (s *ExportBackupPlanTemplateInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (s ExportBackupPlanTemplateOutput) 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 (s *ExportBackupPlanTemplateOutput) SetBackupPlanTemplateJson(v string) *ExportBackupPlanTemplateOutput
SetBackupPlanTemplateJson sets the BackupPlanTemplateJson field's value.
func (s ExportBackupPlanTemplateOutput) 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 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 (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 (s *Framework) SetCreationTime(v time.Time) *Framework
SetCreationTime sets the CreationTime field's value.
func (s *Framework) SetDeploymentStatus(v string) *Framework
SetDeploymentStatus sets the DeploymentStatus field's value.
func (s *Framework) SetFrameworkArn(v string) *Framework
SetFrameworkArn sets the FrameworkArn field's value.
func (s *Framework) SetFrameworkDescription(v string) *Framework
SetFrameworkDescription sets the FrameworkDescription field's value.
func (s *Framework) SetFrameworkName(v string) *Framework
SetFrameworkName sets the FrameworkName field's value.
func (s *Framework) SetNumberOfControls(v int64) *Framework
SetNumberOfControls sets the NumberOfControls field's value.
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 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 (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 (s *FrameworkControl) SetControlInputParameters(v []*ControlInputParameter) *FrameworkControl
SetControlInputParameters sets the ControlInputParameters field's value.
func (s *FrameworkControl) SetControlName(v string) *FrameworkControl
SetControlName sets the ControlName field's value.
func (s *FrameworkControl) SetControlScope(v *ControlScope) *FrameworkControl
SetControlScope sets the ControlScope field's value.
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 (s *FrameworkControl) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (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 (s *GetBackupPlanFromJSONInput) SetBackupPlanTemplateJson(v string) *GetBackupPlanFromJSONInput
SetBackupPlanTemplateJson sets the BackupPlanTemplateJson field's value.
func (s GetBackupPlanFromJSONInput) 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 (s *GetBackupPlanFromJSONInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (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 (s *GetBackupPlanFromJSONOutput) SetBackupPlan(v *Plan) *GetBackupPlanFromJSONOutput
SetBackupPlan sets the BackupPlan field's value.
func (s GetBackupPlanFromJSONOutput) 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 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 (s GetBackupPlanFromTemplateInput) 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 (s *GetBackupPlanFromTemplateInput) SetBackupPlanTemplateId(v string) *GetBackupPlanFromTemplateInput
SetBackupPlanTemplateId sets the BackupPlanTemplateId field's value.
func (s GetBackupPlanFromTemplateInput) 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 (s *GetBackupPlanFromTemplateInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (s GetBackupPlanFromTemplateOutput) 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 (s *GetBackupPlanFromTemplateOutput) SetBackupPlanDocument(v *Plan) *GetBackupPlanFromTemplateOutput
SetBackupPlanDocument sets the BackupPlanDocument field's value.
func (s GetBackupPlanFromTemplateOutput) 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 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 (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 (s *GetBackupPlanInput) SetBackupPlanId(v string) *GetBackupPlanInput
SetBackupPlanId sets the BackupPlanId field's value.
func (s *GetBackupPlanInput) SetVersionId(v string) *GetBackupPlanInput
SetVersionId sets the VersionId field's value.
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 (s *GetBackupPlanInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (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 (s *GetBackupPlanOutput) SetAdvancedBackupSettings(v []*AdvancedBackupSetting) *GetBackupPlanOutput
SetAdvancedBackupSettings sets the AdvancedBackupSettings field's value.
func (s *GetBackupPlanOutput) SetBackupPlan(v *Plan) *GetBackupPlanOutput
SetBackupPlan sets the BackupPlan field's value.
func (s *GetBackupPlanOutput) SetBackupPlanArn(v string) *GetBackupPlanOutput
SetBackupPlanArn sets the BackupPlanArn field's value.
func (s *GetBackupPlanOutput) SetBackupPlanId(v string) *GetBackupPlanOutput
SetBackupPlanId sets the BackupPlanId field's value.
func (s *GetBackupPlanOutput) SetCreationDate(v time.Time) *GetBackupPlanOutput
SetCreationDate sets the CreationDate field's value.
func (s *GetBackupPlanOutput) SetCreatorRequestId(v string) *GetBackupPlanOutput
SetCreatorRequestId sets the CreatorRequestId field's value.
func (s *GetBackupPlanOutput) SetDeletionDate(v time.Time) *GetBackupPlanOutput
SetDeletionDate sets the DeletionDate field's value.
func (s *GetBackupPlanOutput) SetLastExecutionDate(v time.Time) *GetBackupPlanOutput
SetLastExecutionDate sets the LastExecutionDate field's value.
func (s *GetBackupPlanOutput) SetVersionId(v string) *GetBackupPlanOutput
SetVersionId sets the VersionId field's value.
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 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 (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 (s *GetBackupSelectionInput) SetBackupPlanId(v string) *GetBackupSelectionInput
SetBackupPlanId sets the BackupPlanId field's value.
func (s *GetBackupSelectionInput) SetSelectionId(v string) *GetBackupSelectionInput
SetSelectionId sets the SelectionId field's value.
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 (s *GetBackupSelectionInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (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 (s *GetBackupSelectionOutput) SetBackupPlanId(v string) *GetBackupSelectionOutput
SetBackupPlanId sets the BackupPlanId field's value.
func (s *GetBackupSelectionOutput) SetBackupSelection(v *Selection) *GetBackupSelectionOutput
SetBackupSelection sets the BackupSelection field's value.
func (s *GetBackupSelectionOutput) SetCreationDate(v time.Time) *GetBackupSelectionOutput
SetCreationDate sets the CreationDate field's value.
func (s *GetBackupSelectionOutput) SetCreatorRequestId(v string) *GetBackupSelectionOutput
SetCreatorRequestId sets the CreatorRequestId field's value.
func (s *GetBackupSelectionOutput) SetSelectionId(v string) *GetBackupSelectionOutput
SetSelectionId sets the SelectionId field's value.
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 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 (s GetBackupVaultAccessPolicyInput) 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 (s *GetBackupVaultAccessPolicyInput) SetBackupVaultName(v string) *GetBackupVaultAccessPolicyInput
SetBackupVaultName sets the BackupVaultName field's value.
func (s GetBackupVaultAccessPolicyInput) 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 (s *GetBackupVaultAccessPolicyInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (s GetBackupVaultAccessPolicyOutput) 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 (s *GetBackupVaultAccessPolicyOutput) SetBackupVaultArn(v string) *GetBackupVaultAccessPolicyOutput
SetBackupVaultArn sets the BackupVaultArn field's value.
func (s *GetBackupVaultAccessPolicyOutput) SetBackupVaultName(v string) *GetBackupVaultAccessPolicyOutput
SetBackupVaultName sets the BackupVaultName field's value.
func (s *GetBackupVaultAccessPolicyOutput) SetPolicy(v string) *GetBackupVaultAccessPolicyOutput
SetPolicy sets the Policy field's value.
func (s GetBackupVaultAccessPolicyOutput) 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 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 (s GetBackupVaultNotificationsInput) 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 (s *GetBackupVaultNotificationsInput) SetBackupVaultName(v string) *GetBackupVaultNotificationsInput
SetBackupVaultName sets the BackupVaultName field's value.
func (s GetBackupVaultNotificationsInput) 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 (s *GetBackupVaultNotificationsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (s GetBackupVaultNotificationsOutput) 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 (s *GetBackupVaultNotificationsOutput) SetBackupVaultArn(v string) *GetBackupVaultNotificationsOutput
SetBackupVaultArn sets the BackupVaultArn field's value.
func (s *GetBackupVaultNotificationsOutput) SetBackupVaultEvents(v []*string) *GetBackupVaultNotificationsOutput
SetBackupVaultEvents sets the BackupVaultEvents field's value.
func (s *GetBackupVaultNotificationsOutput) SetBackupVaultName(v string) *GetBackupVaultNotificationsOutput
SetBackupVaultName sets the BackupVaultName field's value.
func (s *GetBackupVaultNotificationsOutput) SetSNSTopicArn(v string) *GetBackupVaultNotificationsOutput
SetSNSTopicArn sets the SNSTopicArn field's value.
func (s GetBackupVaultNotificationsOutput) 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 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 (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 (s *GetLegalHoldInput) SetLegalHoldId(v string) *GetLegalHoldInput
SetLegalHoldId sets the LegalHoldId field's value.
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 (s *GetLegalHoldInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (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 (s *GetLegalHoldOutput) SetCancelDescription(v string) *GetLegalHoldOutput
SetCancelDescription sets the CancelDescription field's value.
func (s *GetLegalHoldOutput) SetCancellationDate(v time.Time) *GetLegalHoldOutput
SetCancellationDate sets the CancellationDate field's value.
func (s *GetLegalHoldOutput) SetCreationDate(v time.Time) *GetLegalHoldOutput
SetCreationDate sets the CreationDate field's value.
func (s *GetLegalHoldOutput) SetDescription(v string) *GetLegalHoldOutput
SetDescription sets the Description field's value.
func (s *GetLegalHoldOutput) SetLegalHoldArn(v string) *GetLegalHoldOutput
SetLegalHoldArn sets the LegalHoldArn field's value.
func (s *GetLegalHoldOutput) SetLegalHoldId(v string) *GetLegalHoldOutput
SetLegalHoldId sets the LegalHoldId field's value.
func (s *GetLegalHoldOutput) SetRecoveryPointSelection(v *RecoveryPointSelection) *GetLegalHoldOutput
SetRecoveryPointSelection sets the RecoveryPointSelection field's value.
func (s *GetLegalHoldOutput) SetRetainRecordUntil(v time.Time) *GetLegalHoldOutput
SetRetainRecordUntil sets the RetainRecordUntil field's value.
func (s *GetLegalHoldOutput) SetStatus(v string) *GetLegalHoldOutput
SetStatus sets the Status field's value.
func (s *GetLegalHoldOutput) SetTitle(v string) *GetLegalHoldOutput
SetTitle sets the Title field's value.
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 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 (s GetRecoveryPointRestoreMetadataInput) 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 (s *GetRecoveryPointRestoreMetadataInput) SetBackupVaultName(v string) *GetRecoveryPointRestoreMetadataInput
SetBackupVaultName sets the BackupVaultName field's value.
func (s *GetRecoveryPointRestoreMetadataInput) SetRecoveryPointArn(v string) *GetRecoveryPointRestoreMetadataInput
SetRecoveryPointArn sets the RecoveryPointArn field's value.
func (s GetRecoveryPointRestoreMetadataInput) 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 (s *GetRecoveryPointRestoreMetadataInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (s GetRecoveryPointRestoreMetadataOutput) 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 (s *GetRecoveryPointRestoreMetadataOutput) SetBackupVaultArn(v string) *GetRecoveryPointRestoreMetadataOutput
SetBackupVaultArn sets the BackupVaultArn field's value.
func (s *GetRecoveryPointRestoreMetadataOutput) SetRecoveryPointArn(v string) *GetRecoveryPointRestoreMetadataOutput
SetRecoveryPointArn sets the RecoveryPointArn field's value.
func (s *GetRecoveryPointRestoreMetadataOutput) SetRestoreMetadata(v map[string]*string) *GetRecoveryPointRestoreMetadataOutput
SetRestoreMetadata sets the RestoreMetadata field's value.
func (s GetRecoveryPointRestoreMetadataOutput) 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 GetSupportedResourceTypesInput struct {
// contains filtered or unexported fields
}
func (s GetSupportedResourceTypesInput) 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 (s GetSupportedResourceTypesInput) 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 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 (s GetSupportedResourceTypesOutput) 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 (s *GetSupportedResourceTypesOutput) SetResourceTypes(v []*string) *GetSupportedResourceTypesOutput
SetResourceTypes sets the ResourceTypes field's value.
func (s GetSupportedResourceTypesOutput) 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 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 (s *InvalidParameterValueException) Code() string
Code returns the exception type name.
func (s *InvalidParameterValueException) Error() string
func (s InvalidParameterValueException) 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 (s *InvalidParameterValueException) Message() string
Message returns the exception's message.
func (s *InvalidParameterValueException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *InvalidParameterValueException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *InvalidParameterValueException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (s InvalidParameterValueException) 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 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 (s *InvalidRequestException) Code() string
Code returns the exception type name.
func (s *InvalidRequestException) Error() string
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 (s *InvalidRequestException) Message() string
Message returns the exception's message.
func (s *InvalidRequestException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *InvalidRequestException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *InvalidRequestException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
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 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 (s *InvalidResourceStateException) Code() string
Code returns the exception type name.
func (s *InvalidResourceStateException) Error() string
func (s InvalidResourceStateException) 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 (s *InvalidResourceStateException) Message() string
Message returns the exception's message.
func (s *InvalidResourceStateException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *InvalidResourceStateException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *InvalidResourceStateException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
func (s InvalidResourceStateException) 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 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 (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 (s *Job) SetAccountId(v string) *Job
SetAccountId sets the AccountId field's value.
func (s *Job) SetBackupJobId(v string) *Job
SetBackupJobId sets the BackupJobId field's value.
func (s *Job) SetBackupOptions(v map[string]*string) *Job
SetBackupOptions sets the BackupOptions field's value.
func (s *Job) SetBackupSizeInBytes(v int64) *Job
SetBackupSizeInBytes sets the BackupSizeInBytes field's value.
func (s *Job) SetBackupType(v string) *Job
SetBackupType sets the BackupType field's value.
func (s *Job) SetBackupVaultArn(v string) *Job
SetBackupVaultArn sets the BackupVaultArn field's value.
func (s *Job) SetBackupVaultName(v string) *Job
SetBackupVaultName sets the BackupVaultName field's value.
func (s *Job) SetBytesTransferred(v int64) *Job
SetBytesTransferred sets the BytesTransferred field's value.
func (s *Job) SetCompletionDate(v time.Time) *Job
SetCompletionDate sets the CompletionDate field's value.
func (s *Job) SetCreatedBy(v *RecoveryPointCreator) *Job
SetCreatedBy sets the CreatedBy field's value.
func (s *Job) SetCreationDate(v time.Time) *Job
SetCreationDate sets the CreationDate field's value.
func (s *Job) SetExpectedCompletionDate(v time.Time) *Job
SetExpectedCompletionDate sets the ExpectedCompletionDate field's value.
func (s *Job) SetIamRoleArn(v string) *Job
SetIamRoleArn sets the IamRoleArn field's value.
func (s *Job) SetIsParent(v bool) *Job
SetIsParent sets the IsParent field's value.
func (s *Job) SetParentJobId(v string) *Job
SetParentJobId sets the ParentJobId field's value.
func (s *Job) SetPercentDone(v string) *Job
SetPercentDone sets the PercentDone field's value.
func (s *Job) SetRecoveryPointArn(v string) *Job
SetRecoveryPointArn sets the RecoveryPointArn field's value.
func (s *Job) SetResourceArn(v string) *Job
SetResourceArn sets the ResourceArn field's value.
func (s *Job) SetResourceName(v string) *Job
SetResourceName sets the ResourceName field's value.
func (s *Job) SetResourceType(v string) *Job
SetResourceType sets the ResourceType field's value.
func (s *Job) SetStartBy(v time.Time) *Job
SetStartBy sets the StartBy field's value.
func (s *Job) SetState(v string) *Job
SetState sets the State field's value.
func (s *Job) SetStatusMessage(v string) *Job
SetStatusMessage sets the StatusMessage field's value.
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 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 (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 (s *LegalHold) SetCancellationDate(v time.Time) *LegalHold
SetCancellationDate sets the CancellationDate field's value.
func (s *LegalHold) SetCreationDate(v time.Time) *LegalHold
SetCreationDate sets the CreationDate field's value.
func (s *LegalHold) SetDescription(v string) *LegalHold
SetDescription sets the Description field's value.
func (s *LegalHold) SetLegalHoldArn(v string) *LegalHold
SetLegalHoldArn sets the LegalHoldArn field's value.
func (s *LegalHold) SetLegalHoldId(v string) *LegalHold
SetLegalHoldId sets the LegalHoldId field's value.
func (s *LegalHold) SetStatus(v string) *LegalHold
SetStatus sets the Status field's value.
func (s *LegalHold) SetTitle(v string) *LegalHold
SetTitle sets the Title field's value.
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 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 (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 (s *Lifecycle) SetDeleteAfterDays(v int64) *Lifecycle
SetDeleteAfterDays sets the DeleteAfterDays field's value.
func (s *Lifecycle) SetMoveToColdStorageAfterDays(v int64) *Lifecycle
SetMoveToColdStorageAfterDays sets the MoveToColdStorageAfterDays field's value.
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 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 (s *LimitExceededException) Code() string
Code returns the exception type name.
func (s *LimitExceededException) Error() string
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 (s *LimitExceededException) Message() string
Message returns the exception's message.
func (s *LimitExceededException) OrigErr() error
OrigErr always returns nil, satisfies awserr.Error interface.
func (s *LimitExceededException) RequestID() string
RequestID returns the service's response RequestID for request.
func (s *LimitExceededException) StatusCode() int
Status code returns the HTTP status code for the request's response error.
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 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 (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 (s *ListBackupJobsInput) SetByAccountId(v string) *ListBackupJobsInput
SetByAccountId sets the ByAccountId field's value.
func (s *ListBackupJobsInput) SetByBackupVaultName(v string) *ListBackupJobsInput
SetByBackupVaultName sets the ByBackupVaultName field's value.
func (s *ListBackupJobsInput) SetByCompleteAfter(v time.Time) *ListBackupJobsInput
SetByCompleteAfter sets the ByCompleteAfter field's value.
func (s *ListBackupJobsInput) SetByCompleteBefore(v time.Time) *ListBackupJobsInput
SetByCompleteBefore sets the ByCompleteBefore field's value.
func (s *ListBackupJobsInput) SetByCreatedAfter(v time.Time) *ListBackupJobsInput
SetByCreatedAfter sets the ByCreatedAfter field's value.
func (s *ListBackupJobsInput) SetByCreatedBefore(v time.Time) *ListBackupJobsInput
SetByCreatedBefore sets the ByCreatedBefore field's value.
func (s *ListBackupJobsInput) SetByParentJobId(v string) *ListBackupJobsInput
SetByParentJobId sets the ByParentJobId field's value.
func (s *ListBackupJobsInput) SetByResourceArn(v string) *ListBackupJobsInput
SetByResourceArn sets the ByResourceArn field's value.
func (s *ListBackupJobsInput) SetByResourceType(v string) *ListBackupJobsInput
SetByResourceType sets the ByResourceType field's value.
func (s *ListBackupJobsInput) SetByState(v string) *ListBackupJobsInput
SetByState sets the ByState field's value.
func (s *ListBackupJobsInput) SetMaxResults(v int64) *ListBackupJobsInput
SetMaxResults sets the MaxResults field's value.
func (s *ListBackupJobsInput) SetNextToken(v string) *ListBackupJobsInput
SetNextToken sets the NextToken field's value.
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 (s *ListBackupJobsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (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 (s *ListBackupJobsOutput) SetBackupJobs(v []*Job) *ListBackupJobsOutput
SetBackupJobs sets the BackupJobs field's value.
func (s *ListBackupJobsOutput) SetNextToken(v string) *ListBackupJobsOutput
SetNextToken sets the NextToken field's value.
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 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 (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 (s *ListBackupPlanTemplatesInput) SetMaxResults(v int64) *ListBackupPlanTemplatesInput
SetMaxResults sets the MaxResults field's value.
func (s *ListBackupPlanTemplatesInput) SetNextToken(v string) *ListBackupPlanTemplatesInput
SetNextToken sets the NextToken field's value.
func (s ListBackupPlanTemplatesInput) 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 (s *ListBackupPlanTemplatesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (s ListBackupPlanTemplatesOutput) 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 (s *ListBackupPlanTemplatesOutput) SetBackupPlanTemplatesList(v []*PlanTemplatesListMember) *ListBackupPlanTemplatesOutput
SetBackupPlanTemplatesList sets the BackupPlanTemplatesList field's value.
func (s *ListBackupPlanTemplatesOutput) SetNextToken(v string) *ListBackupPlanTemplatesOutput
SetNextToken sets the NextToken field's value.
func (s ListBackupPlanTemplatesOutput) 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 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 (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 (s *ListBackupPlanVersionsInput) SetBackupPlanId(v string) *ListBackupPlanVersionsInput
SetBackupPlanId sets the BackupPlanId field's value.
func (s *ListBackupPlanVersionsInput) SetMaxResults(v int64) *ListBackupPlanVersionsInput
SetMaxResults sets the MaxResults field's value.
func (s *ListBackupPlanVersionsInput) SetNextToken(v string) *ListBackupPlanVersionsInput
SetNextToken sets the NextToken field's value.
func (s ListBackupPlanVersionsInput) 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 (s *ListBackupPlanVersionsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (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 (s *ListBackupPlanVersionsOutput) SetBackupPlanVersionsList(v []*PlansListMember) *ListBackupPlanVersionsOutput
SetBackupPlanVersionsList sets the BackupPlanVersionsList field's value.
func (s *ListBackupPlanVersionsOutput) SetNextToken(v string) *ListBackupPlanVersionsOutput
SetNextToken sets the NextToken field's value.
func (s ListBackupPlanVersionsOutput) 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 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 (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 (s *ListBackupPlansInput) SetIncludeDeleted(v bool) *ListBackupPlansInput
SetIncludeDeleted sets the IncludeDeleted field's value.
func (s *ListBackupPlansInput) SetMaxResults(v int64) *ListBackupPlansInput
SetMaxResults sets the MaxResults field's value.
func (s *ListBackupPlansInput) SetNextToken(v string) *ListBackupPlansInput
SetNextToken sets the NextToken field's value.
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 (s *ListBackupPlansInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (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 (s *ListBackupPlansOutput) SetBackupPlansList(v []*PlansListMember) *ListBackupPlansOutput
SetBackupPlansList sets the BackupPlansList field's value.
func (s *ListBackupPlansOutput) SetNextToken(v string) *ListBackupPlansOutput
SetNextToken sets the NextToken field's value.
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 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 (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 (s *ListBackupSelectionsInput) SetBackupPlanId(v string) *ListBackupSelectionsInput
SetBackupPlanId sets the BackupPlanId field's value.
func (s *ListBackupSelectionsInput) SetMaxResults(v int64) *ListBackupSelectionsInput
SetMaxResults sets the MaxResults field's value.
func (s *ListBackupSelectionsInput) SetNextToken(v string) *ListBackupSelectionsInput
SetNextToken sets the NextToken field's value.
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 (s *ListBackupSelectionsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (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 (s *ListBackupSelectionsOutput) SetBackupSelectionsList(v []*SelectionsListMember) *ListBackupSelectionsOutput
SetBackupSelectionsList sets the BackupSelectionsList field's value.
func (s *ListBackupSelectionsOutput) SetNextToken(v string) *ListBackupSelectionsOutput
SetNextToken sets the NextToken field's value.
func (s ListBackupSelectionsOutput) 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 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 (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 (s *ListBackupVaultsInput) SetMaxResults(v int64) *ListBackupVaultsInput
SetMaxResults sets the MaxResults field's value.
func (s *ListBackupVaultsInput) SetNextToken(v string) *ListBackupVaultsInput
SetNextToken sets the NextToken field's value.
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 (s *ListBackupVaultsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (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 (s *ListBackupVaultsOutput) SetBackupVaultList(v []*VaultListMember) *ListBackupVaultsOutput
SetBackupVaultList sets the BackupVaultList field's value.
func (s *ListBackupVaultsOutput) SetNextToken(v string) *ListBackupVaultsOutput
SetNextToken sets the NextToken field's value.
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 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 (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 (s *ListCopyJobsInput) SetByAccountId(v string) *ListCopyJobsInput
SetByAccountId sets the ByAccountId field's value.
func (s *ListCopyJobsInput) SetByCompleteAfter(v time.Time) *ListCopyJobsInput
SetByCompleteAfter sets the ByCompleteAfter field's value.
func (s *ListCopyJobsInput) SetByCompleteBefore(v time.Time) *ListCopyJobsInput
SetByCompleteBefore sets the ByCompleteBefore field's value.
func (s *ListCopyJobsInput) SetByCreatedAfter(v time.Time) *ListCopyJobsInput
SetByCreatedAfter sets the ByCreatedAfter field's value.
func (s *ListCopyJobsInput) SetByCreatedBefore(v time.Time) *ListCopyJobsInput
SetByCreatedBefore sets the ByCreatedBefore field's value.
func (s *ListCopyJobsInput) SetByDestinationVaultArn(v string) *ListCopyJobsInput
SetByDestinationVaultArn sets the ByDestinationVaultArn field's value.
func (s *ListCopyJobsInput) SetByParentJobId(v string) *ListCopyJobsInput
SetByParentJobId sets the ByParentJobId field's value.
func (s *ListCopyJobsInput) SetByResourceArn(v string) *ListCopyJobsInput
SetByResourceArn sets the ByResourceArn field's value.
func (s *ListCopyJobsInput) SetByResourceType(v string) *ListCopyJobsInput
SetByResourceType sets the ByResourceType field's value.
func (s *ListCopyJobsInput) SetByState(v string) *ListCopyJobsInput
SetByState sets the ByState field's value.
func (s *ListCopyJobsInput) SetMaxResults(v int64) *ListCopyJobsInput
SetMaxResults sets the MaxResults field's value.
func (s *ListCopyJobsInput) SetNextToken(v string) *ListCopyJobsInput
SetNextToken sets the NextToken field's value.
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 (s *ListCopyJobsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (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 (s *ListCopyJobsOutput) SetCopyJobs(v []*CopyJob) *ListCopyJobsOutput
SetCopyJobs sets the CopyJobs field's value.
func (s *ListCopyJobsOutput) SetNextToken(v string) *ListCopyJobsOutput
SetNextToken sets the NextToken field's value.
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 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 (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 (s *ListFrameworksInput) SetMaxResults(v int64) *ListFrameworksInput
SetMaxResults sets the MaxResults field's value.
func (s *ListFrameworksInput) SetNextToken(v string) *ListFrameworksInput
SetNextToken sets the NextToken field's value.
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 (s *ListFrameworksInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (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 (s *ListFrameworksOutput) SetFrameworks(v []*Framework) *ListFrameworksOutput
SetFrameworks sets the Frameworks field's value.
func (s *ListFrameworksOutput) SetNextToken(v string) *ListFrameworksOutput
SetNextToken sets the NextToken field's value.
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 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 (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 (s *ListLegalHoldsInput) SetMaxResults(v int64) *ListLegalHoldsInput
SetMaxResults sets the MaxResults field's value.
func (s *ListLegalHoldsInput) SetNextToken(v string) *ListLegalHoldsInput
SetNextToken sets the NextToken field's value.
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 (s *ListLegalHoldsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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 (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 (s *ListLegalHoldsOutput) SetLegalHolds(v []*LegalHold) *ListLegalHoldsOutput
SetLegalHolds sets the LegalHolds field's value.
func (s *ListLegalHoldsOutput) SetNextToken(v string) *ListLegalHoldsOutput
SetNextToken sets the NextToken field's value.
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 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 (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 (s *ListProtectedResourcesInput) SetMaxResults(v int64) *ListProtectedResourcesInput
SetMaxResults sets the MaxResults field's value.
func (s *ListProtectedResourcesInput) SetNextToken(v string) *ListProtectedResourcesInput
SetNextToken sets the NextToken field's value.
func (s ListProtectedResourcesInput) 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 (s *ListProtectedResourcesInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
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
<