AWS SDK for Go (PILOT)
API Reference

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

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

Backup

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

type Backup struct { *client.Client }

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

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

Client

Type: *client.Client

Method

CreateBackupPlan

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

CreateBackupPlan API operation for AWS Backup.

Backup plans are documents that contain information that AWS Backup uses to schedule tasks that create recovery points of resources.

If you call CreateBackupPlan with a plan that already exists, the existing backupPlanId is returned.

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

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

Returned Error Codes:

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

  • ErrCodeAlreadyExistsException "AlreadyExistsException" The required resource already exists.

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

  • ErrCodeMissingParameterValueException "MissingParameterValueException" Indicates that a required parameter is missing.

  • ErrCodeServiceUnavailableException "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

CreateBackupPlanRequest

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

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

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

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

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

// Example sending a request using the CreateBackupPlanRequest method. req, resp := client.CreateBackupPlanRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

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

CreateBackupPlanWithContext

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

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

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

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

See Also

For more information about using this API, see AWS API Documentation.

CreateBackupSelection

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

CreateBackupSelection API operation for AWS Backup.

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

For example, consider the following patterns:

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

  • ConditionKey:"department"

ConditionValue:"finance"

ConditionType:"StringEquals"

  • ConditionKey:"importance"

ConditionValue:"critical"

ConditionType:"StringEquals"

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

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

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

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

Returned Error Codes:

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

  • ErrCodeAlreadyExistsException "AlreadyExistsException" The required resource already exists.

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

  • ErrCodeMissingParameterValueException "MissingParameterValueException" Indicates that a required parameter is missing.

  • ErrCodeServiceUnavailableException "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

CreateBackupSelectionRequest

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

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

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

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

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

// Example sending a request using the CreateBackupSelectionRequest method. req, resp := client.CreateBackupSelectionRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

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

CreateBackupSelectionWithContext

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

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

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

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

See Also

For more information about using this API, see AWS API Documentation.

CreateBackupVault

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

CreateBackupVault API operation for AWS Backup.

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

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

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

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

Returned Error Codes:

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

  • ErrCodeMissingParameterValueException "MissingParameterValueException" Indicates that a required parameter is missing.

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

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

  • ErrCodeAlreadyExistsException "AlreadyExistsException" The required resource already exists.

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

CreateBackupVaultRequest

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

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

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

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

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

// Example sending a request using the CreateBackupVaultRequest method. req, resp := client.CreateBackupVaultRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

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

CreateBackupVaultWithContext

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

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

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

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

See Also

For more information about using this API, see AWS API Documentation.

DeleteBackupPlan

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

DeleteBackupPlan API operation for AWS Backup.

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

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

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

Returned Error Codes:

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

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

  • ErrCodeMissingParameterValueException "MissingParameterValueException" Indicates that a required parameter is missing.

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

  • ErrCodeInvalidRequestException "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

DeleteBackupPlanRequest

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

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

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

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

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

// Example sending a request using the DeleteBackupPlanRequest method. req, resp := client.DeleteBackupPlanRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

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

DeleteBackupPlanWithContext

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

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

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

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

See Also

For more information about using this API, see AWS API Documentation.

DeleteBackupSelection

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

DeleteBackupSelection API operation for AWS Backup.

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

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

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

Returned Error Codes:

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

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

  • ErrCodeMissingParameterValueException "MissingParameterValueException" Indicates that a required parameter is missing.

  • ErrCodeServiceUnavailableException "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

DeleteBackupSelectionRequest

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

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

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

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

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

// Example sending a request using the DeleteBackupSelectionRequest method. req, resp := client.DeleteBackupSelectionRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

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

DeleteBackupSelectionWithContext

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

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

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

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

See Also

For more information about using this API, see AWS API Documentation.

DeleteBackupVault

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

DeleteBackupVault API operation for AWS Backup.

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

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

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

Returned Error Codes:

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

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

  • ErrCodeMissingParameterValueException "MissingParameterValueException" Indicates that a required parameter is missing.

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

  • ErrCodeInvalidRequestException "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

DeleteBackupVaultAccessPolicy

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

DeleteBackupVaultAccessPolicy API operation for AWS Backup.

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

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

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

Returned Error Codes:

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

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

  • ErrCodeMissingParameterValueException "MissingParameterValueException" Indicates that a required parameter is missing.

  • ErrCodeServiceUnavailableException "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

DeleteBackupVaultAccessPolicyRequest

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

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

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

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

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

// Example sending a request using the DeleteBackupVaultAccessPolicyRequest method. req, resp := client.DeleteBackupVaultAccessPolicyRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

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

DeleteBackupVaultAccessPolicyWithContext

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

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

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

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

See Also

For more information about using this API, see AWS API Documentation.

DeleteBackupVaultNotifications

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

DeleteBackupVaultNotifications API operation for AWS Backup.

Deletes event notifications for the specified backup vault.

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

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

Returned Error Codes:

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

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

  • ErrCodeMissingParameterValueException "MissingParameterValueException" Indicates that a required parameter is missing.

  • ErrCodeServiceUnavailableException "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

DeleteBackupVaultNotificationsRequest

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

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

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

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

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

// Example sending a request using the DeleteBackupVaultNotificationsRequest method. req, resp := client.DeleteBackupVaultNotificationsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

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

DeleteBackupVaultNotificationsWithContext

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

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

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

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

See Also

For more information about using this API, see AWS API Documentation.

DeleteBackupVaultRequest

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

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

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

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

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

// Example sending a request using the DeleteBackupVaultRequest method. req, resp := client.DeleteBackupVaultRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

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

DeleteBackupVaultWithContext

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

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

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

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

See Also

For more information about using this API, see AWS API Documentation.

DeleteRecoveryPoint

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

DeleteRecoveryPoint API operation for AWS Backup.

Deletes the recovery point specified by a recovery point ID.

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 Codes:

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

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

  • ErrCodeMissingParameterValueException "MissingParameterValueException" Indicates that a required parameter is missing.

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

  • ErrCodeInvalidRequestException "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

DeleteRecoveryPointRequest

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

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

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

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

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

// Example sending a request using the DeleteRecoveryPointRequest method. req, resp := client.DeleteRecoveryPointRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

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

DeleteRecoveryPointWithContext

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

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

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

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

See Also

For more information about using this API, see AWS API Documentation.

DescribeBackupJob

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

DescribeBackupJob API operation for AWS Backup.

Returns metadata associated with creating a backup of a resource.

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

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

Returned Error Codes:

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

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

  • ErrCodeMissingParameterValueException "MissingParameterValueException" Indicates that a required parameter is missing.

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

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

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

DescribeBackupJobRequest

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

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

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

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

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

// Example sending a request using the DescribeBackupJobRequest method. req, resp := client.DescribeBackupJobRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

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

DescribeBackupJobWithContext

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

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

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

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

See Also

For more information about using this API, see AWS API Documentation.

DescribeBackupVault

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

DescribeBackupVault API operation for AWS Backup.

Returns metadata about a backup vault specified by its name.

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

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

Returned Error Codes:

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

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

  • ErrCodeMissingParameterValueException "MissingParameterValueException" Indicates that a required parameter is missing.

  • ErrCodeServiceUnavailableException "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

DescribeBackupVaultRequest

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

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

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

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

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

// Example sending a request using the DescribeBackupVaultRequest method. req, resp := client.DescribeBackupVaultRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

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

DescribeBackupVaultWithContext

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

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

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

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

See Also

For more information about using this API, see AWS API Documentation.

DescribeProtectedResource

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

DescribeProtectedResource API operation for AWS Backup.

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

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

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

Returned Error Codes:

  • ErrCodeMissingParameterValueException "MissingParameterValueException" Indicates that a required parameter is missing.

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

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

  • ErrCodeResourceNotFoundException "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

DescribeProtectedResourceRequest

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

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

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

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

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

// Example sending a request using the DescribeProtectedResourceRequest method. req, resp := client.DescribeProtectedResourceRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

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

DescribeProtectedResourceWithContext

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

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

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

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

See Also

For more information about using this API, see AWS API Documentation.

DescribeRecoveryPoint

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

DescribeRecoveryPoint API operation for AWS Backup.

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

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

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

Returned Error Codes:

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

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

  • ErrCodeMissingParameterValueException "MissingParameterValueException" Indicates that a required parameter is missing.

  • ErrCodeServiceUnavailableException "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

DescribeRecoveryPointRequest

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

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

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

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

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

// Example sending a request using the DescribeRecoveryPointRequest method. req, resp := client.DescribeRecoveryPointRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

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

DescribeRecoveryPointWithContext

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

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

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

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

See Also

For more information about using this API, see AWS API Documentation.

DescribeRestoreJob

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

DescribeRestoreJob API operation for AWS Backup.

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

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

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

Returned Error Codes:

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

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

  • ErrCodeMissingParameterValueException "MissingParameterValueException" Indicates that a required parameter is missing.

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

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

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

DescribeRestoreJobRequest

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

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

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

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

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

// Example sending a request using the DescribeRestoreJobRequest method. req, resp := client.DescribeRestoreJobRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

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

DescribeRestoreJobWithContext

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

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

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

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

See Also

For more information about using this API, see AWS API Documentation.

ExportBackupPlanTemplate

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

ExportBackupPlanTemplate API operation for AWS Backup.

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

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

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

Returned Error Codes:

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

  • ErrCodeMissingParameterValueException "MissingParameterValueException" Indicates that a required parameter is missing.

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

  • ErrCodeResourceNotFoundException "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

ExportBackupPlanTemplateRequest

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

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

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

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

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

// Example sending a request using the ExportBackupPlanTemplateRequest method. req, resp := client.ExportBackupPlanTemplateRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

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

ExportBackupPlanTemplateWithContext

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

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

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

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

See Also

For more information about using this API, see AWS API Documentation.

GetBackupPlan

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

GetBackupPlan API operation for AWS Backup.

Returns 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 Codes:

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

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

  • ErrCodeMissingParameterValueException "MissingParameterValueException" Indicates that a required parameter is missing.

  • ErrCodeServiceUnavailableException "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

GetBackupPlanFromJSON

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

GetBackupPlanFromJSON API operation for AWS Backup.

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

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

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

Returned Error Codes:

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

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

  • ErrCodeMissingParameterValueException "MissingParameterValueException" Indicates that a required parameter is missing.

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

  • ErrCodeInvalidRequestException "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

GetBackupPlanFromJSONRequest

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

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

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

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

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

// Example sending a request using the GetBackupPlanFromJSONRequest method. req, resp := client.GetBackupPlanFromJSONRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

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

GetBackupPlanFromJSONWithContext

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

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

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

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

See Also

For more information about using this API, see AWS API Documentation.

GetBackupPlanFromTemplate

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

GetBackupPlanFromTemplate API operation for AWS Backup.

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

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

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

Returned Error Codes:

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

  • ErrCodeMissingParameterValueException "MissingParameterValueException" Indicates that a required parameter is missing.

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

  • ErrCodeResourceNotFoundException "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

GetBackupPlanFromTemplateRequest

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

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

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

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

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

// Example sending a request using the GetBackupPlanFromTemplateRequest method. req, resp := client.GetBackupPlanFromTemplateRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

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

GetBackupPlanFromTemplateWithContext

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

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

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

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

See Also

For more information about using this API, see AWS API Documentation.

GetBackupPlanRequest

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

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

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

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

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

// Example sending a request using the GetBackupPlanRequest method. req, resp := client.GetBackupPlanRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

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

GetBackupPlanWithContext

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

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

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

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

See Also

For more information about using this API, see AWS API Documentation.

GetBackupSelection

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

GetBackupSelection API operation for AWS Backup.

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

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

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

Returned Error Codes:

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

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

  • ErrCodeMissingParameterValueException "MissingParameterValueException" Indicates that a required parameter is missing.

  • ErrCodeServiceUnavailableException "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

GetBackupSelectionRequest

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

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

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

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

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

// Example sending a request using the GetBackupSelectionRequest method. req, resp := client.GetBackupSelectionRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

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

GetBackupSelectionWithContext

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

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

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

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

See Also

For more information about using this API, see AWS API Documentation.

GetBackupVaultAccessPolicy

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

GetBackupVaultAccessPolicy API operation for AWS Backup.

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

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

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

Returned Error Codes:

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

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

  • ErrCodeMissingParameterValueException "MissingParameterValueException" Indicates that a required parameter is missing.

  • ErrCodeServiceUnavailableException "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

GetBackupVaultAccessPolicyRequest

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

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

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

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

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

// Example sending a request using the GetBackupVaultAccessPolicyRequest method. req, resp := client.GetBackupVaultAccessPolicyRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

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

GetBackupVaultAccessPolicyWithContext

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

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

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

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

See Also

For more information about using this API, see AWS API Documentation.

GetBackupVaultNotifications

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

GetBackupVaultNotifications API operation for AWS Backup.

Returns event notifications for the specified backup vault.

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

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

Returned Error Codes:

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

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

  • ErrCodeMissingParameterValueException "MissingParameterValueException" Indicates that a required parameter is missing.

  • ErrCodeServiceUnavailableException "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

GetBackupVaultNotificationsRequest

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

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

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

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

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

// Example sending a request using the GetBackupVaultNotificationsRequest method. req, resp := client.GetBackupVaultNotificationsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

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

GetBackupVaultNotificationsWithContext

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

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

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

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

See Also

For more information about using this API, see AWS API Documentation.

GetRecoveryPointRestoreMetadata

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

GetRecoveryPointRestoreMetadata API operation for AWS Backup.

Returns two sets of metadata key-value pairs. The first set lists the metadata that the recovery point was created with. The second set lists the metadata key-value pairs that are required to restore the recovery point.

These sets can be the same, or the restore metadata set can contain different values if the target service to be restored has changed since the recovery point was created and now requires additional or different information in order to be restored.

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 Codes:

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

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

  • ErrCodeMissingParameterValueException "MissingParameterValueException" Indicates that a required parameter is missing.

  • ErrCodeServiceUnavailableException "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

GetRecoveryPointRestoreMetadataRequest

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

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

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

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

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

// Example sending a request using the GetRecoveryPointRestoreMetadataRequest method. req, resp := client.GetRecoveryPointRestoreMetadataRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

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

GetRecoveryPointRestoreMetadataWithContext

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

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

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

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

See Also

For more information about using this API, see AWS API Documentation.

GetSupportedResourceTypes

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

GetSupportedResourceTypes API operation for AWS Backup.

Returns the AWS resource types supported by AWS Backup.

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

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

Returned Error Codes:

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

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

GetSupportedResourceTypesRequest

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

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

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

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

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

// Example sending a request using the GetSupportedResourceTypesRequest method. req, resp := client.GetSupportedResourceTypesRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

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

GetSupportedResourceTypesWithContext

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

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

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

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

See Also

For more information about using this API, see AWS API Documentation.

ListBackupJobs

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

ListBackupJobs API operation for AWS Backup.

Returns metadata about your backup 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 ListBackupJobs for usage and error information.

Returned Error Codes:

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

  • ErrCodeServiceUnavailableException "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

ListBackupJobsPages

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

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

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

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

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

See Also

For more information about using this API, see AWS API Documentation.

ListBackupJobsPagesWithContext

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

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

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

See Also

For more information about using this API, see AWS API Documentation.

ListBackupJobsRequest

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

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

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

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

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

// Example sending a request using the ListBackupJobsRequest method. req, resp := client.ListBackupJobsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

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

ListBackupJobsWithContext

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

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

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

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

See Also

For more information about using this API, see AWS API Documentation.

ListBackupPlanTemplates

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

ListBackupPlanTemplates API operation for AWS Backup.

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

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

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

Returned Error Codes:

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

  • ErrCodeMissingParameterValueException "MissingParameterValueException" Indicates that a required parameter is missing.

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

  • ErrCodeResourceNotFoundException "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

ListBackupPlanTemplatesPages

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

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

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

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

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

See Also

For more information about using this API, see AWS API Documentation.

ListBackupPlanTemplatesPagesWithContext

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

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

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

See Also

For more information about using this API, see AWS API Documentation.

ListBackupPlanTemplatesRequest

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

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

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

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

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

// Example sending a request using the ListBackupPlanTemplatesRequest method. req, resp := client.ListBackupPlanTemplatesRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

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

ListBackupPlanTemplatesWithContext

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

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

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

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

See Also

For more information about using this API, see AWS API Documentation.

ListBackupPlanVersions

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

ListBackupPlanVersions API operation for AWS Backup.

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

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

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

Returned Error Codes:

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

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

  • ErrCodeMissingParameterValueException "MissingParameterValueException" Indicates that a required parameter is missing.

  • ErrCodeServiceUnavailableException "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

ListBackupPlanVersionsPages

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

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

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

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

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

See Also

For more information about using this API, see AWS API Documentation.

ListBackupPlanVersionsPagesWithContext

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

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

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

See Also

For more information about using this API, see AWS API Documentation.

ListBackupPlanVersionsRequest

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

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

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

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

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

// Example sending a request using the ListBackupPlanVersionsRequest method. req, resp := client.ListBackupPlanVersionsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

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

ListBackupPlanVersionsWithContext

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

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

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

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

See Also

For more information about using this API, see AWS API Documentation.

ListBackupPlans

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

ListBackupPlans API operation for AWS Backup.

Returns metadata of your saved backup plans, including 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 Codes:

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

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

  • ErrCodeMissingParameterValueException "MissingParameterValueException" Indicates that a required parameter is missing.

  • ErrCodeServiceUnavailableException "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

ListBackupPlansPages

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

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

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

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

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

See Also

For more information about using this API, see AWS API Documentation.

ListBackupPlansPagesWithContext

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

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

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

See Also

For more information about using this API, see AWS API Documentation.

ListBackupPlansRequest

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

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

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

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

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

// Example sending a request using the ListBackupPlansRequest method. req, resp := client.ListBackupPlansRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

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

ListBackupPlansWithContext

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

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

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

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

See Also

For more information about using this API, see AWS API Documentation.

ListBackupSelections

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

ListBackupSelections API operation for AWS Backup.

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

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

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

Returned Error Codes:

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

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

  • ErrCodeMissingParameterValueException "MissingParameterValueException" Indicates that a required parameter is missing.

  • ErrCodeServiceUnavailableException "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

ListBackupSelectionsPages

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

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

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

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

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

See Also

For more information about using this API, see AWS API Documentation.

ListBackupSelectionsPagesWithContext

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

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

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

See Also

For more information about using this API, see AWS API Documentation.

ListBackupSelectionsRequest

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

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

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

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

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

// Example sending a request using the ListBackupSelectionsRequest method. req, resp := client.ListBackupSelectionsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

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

ListBackupSelectionsWithContext

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

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

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

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

See Also

For more information about using this API, see AWS API Documentation.

ListBackupVaults

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

ListBackupVaults API operation for AWS Backup.

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

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

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

Returned Error Codes:

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

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

  • ErrCodeMissingParameterValueException "MissingParameterValueException" Indicates that a required parameter is missing.

  • ErrCodeServiceUnavailableException "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

ListBackupVaultsPages

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

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

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

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

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

See Also

For more information about using this API, see AWS API Documentation.

ListBackupVaultsPagesWithContext

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

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

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

See Also

For more information about using this API, see AWS API Documentation.

ListBackupVaultsRequest

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

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

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

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

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

// Example sending a request using the ListBackupVaultsRequest method. req, resp := client.ListBackupVaultsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

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

ListBackupVaultsWithContext

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

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

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

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

See Also

For more information about using this API, see AWS API Documentation.

ListProtectedResources

func (c *Backup) ListProtectedResources(input *ListProtectedResourcesInput) (*ListProtectedResourcesOutput, error)

ListProtectedResources API operation for AWS Backup.

Returns an array of resources successfully backed up by AWS Backup, including the time the resource was saved, an Amazon Resource Name (ARN) of the resource, and a resource type.

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

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

Returned Error Codes:

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

  • ErrCodeServiceUnavailableException "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

ListProtectedResourcesPages

func (c *Backup) ListProtectedResourcesPages(input *ListProtectedResourcesInput, fn func(*ListProtectedResourcesOutput, bool) bool) error

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

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

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

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

See Also

For more information about using this API, see AWS API Documentation.

ListProtectedResourcesPagesWithContext

func (c *Backup) ListProtectedResourcesPagesWithContext(ctx aws.Context, input *ListProtectedResourcesInput, fn func(*ListProtectedResourcesOutput, bool) bool, opts ...request.Option) error

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

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

See Also

For more information about using this API, see AWS API Documentation.

ListProtectedResourcesRequest

func (c *Backup) ListProtectedResourcesRequest(input *ListProtectedResourcesInput) (req *request.Request, output *ListProtectedResourcesOutput)

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

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

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

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

// Example sending a request using the ListProtectedResourcesRequest method. req, resp := client.ListProtectedResourcesRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

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

ListProtectedResourcesWithContext

func (c *Backup) ListProtectedResourcesWithContext(ctx aws.Context, input *ListProtectedResourcesInput, opts ...request.Option) (*ListProtectedResourcesOutput, error)

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

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

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

See Also

For more information about using this API, see AWS API Documentation.

ListRecoveryPointsByBackupVault

func (c *Backup) ListRecoveryPointsByBackupVault(input *ListRecoveryPointsByBackupVaultInput) (*ListRecoveryPointsByBackupVaultOutput, error)

ListRecoveryPointsByBackupVault API operation for AWS Backup.

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

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

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

Returned Error Codes:

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

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

  • ErrCodeMissingParameterValueException "MissingParameterValueException" Indicates that a required parameter is missing.

  • ErrCodeServiceUnavailableException "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

ListRecoveryPointsByBackupVaultPages

func (c *Backup) ListRecoveryPointsByBackupVaultPages(input *ListRecoveryPointsByBackupVaultInput, fn func(*ListRecoveryPointsByBackupVaultOutput, bool) bool) error

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

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

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

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

See Also

For more information about using this API, see AWS API Documentation.

ListRecoveryPointsByBackupVaultPagesWithContext

func (c *Backup) ListRecoveryPointsByBackupVaultPagesWithContext(ctx aws.Context, input *ListRecoveryPointsByBackupVaultInput, fn func(*ListRecoveryPointsByBackupVaultOutput, bool) bool, opts ...request.Option) error

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

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

See Also

For more information about using this API, see AWS API Documentation.

ListRecoveryPointsByBackupVaultRequest

func (c *Backup) ListRecoveryPointsByBackupVaultRequest(input *ListRecoveryPointsByBackupVaultInput) (req *request.Request, output *ListRecoveryPointsByBackupVaultOutput)

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

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

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

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

// Example sending a request using the ListRecoveryPointsByBackupVaultRequest method. req, resp := client.ListRecoveryPointsByBackupVaultRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

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

ListRecoveryPointsByBackupVaultWithContext

func (c *Backup) ListRecoveryPointsByBackupVaultWithContext(ctx aws.Context, input *ListRecoveryPointsByBackupVaultInput, opts ...request.Option) (*ListRecoveryPointsByBackupVaultOutput, error)

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

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

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

See Also

For more information about using this API, see AWS API Documentation.

ListRecoveryPointsByResource

func (c *Backup) ListRecoveryPointsByResource(input *ListRecoveryPointsByResourceInput) (*ListRecoveryPointsByResourceOutput, error)

ListRecoveryPointsByResource API operation for AWS Backup.

Returns detailed information about recovery points of the type specified by a resource Amazon Resource Name (ARN).

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

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

Returned Error Codes:

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

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

  • ErrCodeMissingParameterValueException "MissingParameterValueException" Indicates that a required parameter is missing.

  • ErrCodeServiceUnavailableException "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

ListRecoveryPointsByResourcePages

func (c *Backup) ListRecoveryPointsByResourcePages(input *ListRecoveryPointsByResourceInput, fn func(*ListRecoveryPointsByResourceOutput, bool) bool) error

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

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

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

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

See Also

For more information about using this API, see AWS API Documentation.

ListRecoveryPointsByResourcePagesWithContext

func (c *Backup) ListRecoveryPointsByResourcePagesWithContext(ctx aws.Context, input *ListRecoveryPointsByResourceInput, fn func(*ListRecoveryPointsByResourceOutput, bool) bool, opts ...request.Option) error

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

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

See Also

For more information about using this API, see AWS API Documentation.

ListRecoveryPointsByResourceRequest

func (c *Backup) ListRecoveryPointsByResourceRequest(input *ListRecoveryPointsByResourceInput) (req *request.Request, output *ListRecoveryPointsByResourceOutput)

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

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

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

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

// Example sending a request using the ListRecoveryPointsByResourceRequest method. req, resp := client.ListRecoveryPointsByResourceRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

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

ListRecoveryPointsByResourceWithContext

func (c *Backup) ListRecoveryPointsByResourceWithContext(ctx aws.Context, input *ListRecoveryPointsByResourceInput, opts ...request.Option) (*ListRecoveryPointsByResourceOutput, error)

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

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

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

See Also

For more information about using this API, see AWS API Documentation.

ListRestoreJobs

func (c *Backup) ListRestoreJobs(input *ListRestoreJobsInput) (*ListRestoreJobsOutput, error)

ListRestoreJobs API operation for AWS Backup.

Returns a list of jobs that AWS Backup initiated to restore a saved resource, including metadata about the recovery process.

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

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

Returned Error Codes:

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

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

  • ErrCodeMissingParameterValueException "MissingParameterValueException" Indicates that a required parameter is missing.

  • ErrCodeServiceUnavailableException "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

ListRestoreJobsPages

func (c *Backup) ListRestoreJobsPages(input *ListRestoreJobsInput, fn func(*ListRestoreJobsOutput, bool) bool) error

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

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

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

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

See Also

For more information about using this API, see AWS API Documentation.

ListRestoreJobsPagesWithContext

func (c *Backup) ListRestoreJobsPagesWithContext(ctx aws.Context, input *ListRestoreJobsInput, fn func(*ListRestoreJobsOutput, bool) bool, opts ...request.Option) error

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

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

See Also

For more information about using this API, see AWS API Documentation.

ListRestoreJobsRequest

func (c *Backup) ListRestoreJobsRequest(input *ListRestoreJobsInput) (req *request.Request, output *ListRestoreJobsOutput)

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

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

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

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

// Example sending a request using the ListRestoreJobsRequest method. req, resp := client.ListRestoreJobsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

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

ListRestoreJobsWithContext

func (c *Backup) ListRestoreJobsWithContext(ctx aws.Context, input *ListRestoreJobsInput, opts ...request.Option) (*ListRestoreJobsOutput, error)

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

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

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

See Also

For more information about using this API, see AWS API Documentation.

ListTags

func (c *Backup) ListTags(input *ListTagsInput) (*ListTagsOutput, error)

ListTags API operation for AWS Backup.

Returns a list of key-value pairs assigned to a target recovery point, backup plan, or backup vault.

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 Codes:

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

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

  • ErrCodeMissingParameterValueException "MissingParameterValueException" Indicates that a required parameter is missing.

  • ErrCodeServiceUnavailableException "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

ListTagsPages

func (c *Backup) ListTagsPages(input *ListTagsInput, fn func(*ListTagsOutput, bool) bool) error

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

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

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

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

See Also

For more information about using this API, see AWS API Documentation.

ListTagsPagesWithContext

func (c *Backup) ListTagsPagesWithContext(ctx aws.Context, input *ListTagsInput, fn func(*ListTagsOutput, bool) bool, opts ...request.Option) error

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

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

See Also

For more information about using this API, see AWS API Documentation.

ListTagsRequest

func (c *Backup) ListTagsRequest(input *ListTagsInput) (req *request.Request, output *ListTagsOutput)

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

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

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

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

// Example sending a request using the ListTagsRequest method. req, resp := client.ListTagsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

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

ListTagsWithContext

func (c *Backup) ListTagsWithContext(ctx aws.Context, input *ListTagsInput, opts ...request.Option) (*ListTagsOutput, error)

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

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

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

See Also

For more information about using this API, see AWS API Documentation.

PutBackupVaultAccessPolicy

func (c *Backup) PutBackupVaultAccessPolicy(input *PutBackupVaultAccessPolicyInput) (*PutBackupVaultAccessPolicyOutput, error)

PutBackupVaultAccessPolicy API operation for AWS Backup.

Sets a resource-based policy that is used to manage access permissions on the target backup vault. Requires a backup vault name and an access policy document in JSON format.

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

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

Returned Error Codes:

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

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

  • ErrCodeMissingParameterValueException "MissingParameterValueException" Indicates that a required parameter is missing.

  • ErrCodeServiceUnavailableException "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

PutBackupVaultAccessPolicyRequest

func (c *Backup) PutBackupVaultAccessPolicyRequest(input *PutBackupVaultAccessPolicyInput) (req *request.Request, output *PutBackupVaultAccessPolicyOutput)

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

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

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

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

// Example sending a request using the PutBackupVaultAccessPolicyRequest method. req, resp := client.PutBackupVaultAccessPolicyRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

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

PutBackupVaultAccessPolicyWithContext

func (c *Backup) PutBackupVaultAccessPolicyWithContext(ctx aws.Context, input *PutBackupVaultAccessPolicyInput, opts ...request.Option) (*PutBackupVaultAccessPolicyOutput, error)

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

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

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

See Also

For more information about using this API, see AWS API Documentation.

PutBackupVaultNotifications

func (c *Backup) PutBackupVaultNotifications(input *PutBackupVaultNotificationsInput) (*PutBackupVaultNotificationsOutput, error)

PutBackupVaultNotifications API operation for AWS Backup.

Turns on notifications on a backup vault for the specified topic and events.

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

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

Returned Error Codes:

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

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

  • ErrCodeMissingParameterValueException "MissingParameterValueException" Indicates that a required parameter is missing.

  • ErrCodeServiceUnavailableException "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

PutBackupVaultNotificationsRequest

func (c *Backup) PutBackupVaultNotificationsRequest(input *PutBackupVaultNotificationsInput) (req *request.Request, output *PutBackupVaultNotificationsOutput)

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

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

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

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

// Example sending a request using the PutBackupVaultNotificationsRequest method. req, resp := client.PutBackupVaultNotificationsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

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

PutBackupVaultNotificationsWithContext

func (c *Backup) PutBackupVaultNotificationsWithContext(ctx aws.Context, input *PutBackupVaultNotificationsInput, opts ...request.Option) (*PutBackupVaultNotificationsOutput, error)

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

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

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

See Also

For more information about using this API, see AWS API Documentation.

StartBackupJob

func (c *Backup) StartBackupJob(input *StartBackupJobInput) (*StartBackupJobOutput, error)

StartBackupJob API operation for AWS Backup.

Starts a job to create a one-time backup of 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 Codes:

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

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

  • ErrCodeMissingParameterValueException "MissingParameterValueException" Indicates that a required parameter is missing.

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

  • ErrCodeLimitExceededException "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

StartBackupJobRequest

func (c *Backup) StartBackupJobRequest(input *StartBackupJobInput) (req *request.Request, output *StartBackupJobOutput)

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

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

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

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

// Example sending a request using the StartBackupJobRequest method. req, resp := client.StartBackupJobRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

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

StartBackupJobWithContext

func (c *Backup) StartBackupJobWithContext(ctx aws.Context, input *StartBackupJobInput, opts ...request.Option) (*StartBackupJobOutput, error)

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

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

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

See Also

For more information about using this API, see AWS API Documentation.

StartRestoreJob

func (c *Backup) StartRestoreJob(input *StartRestoreJobInput) (*StartRestoreJobOutput, error)

StartRestoreJob API operation for AWS Backup.

Recovers the saved resource identified by an Amazon Resource Name (ARN).

If the resource ARN is included in the request, then the last complete backup of that resource is recovered. If the ARN of a recovery point is supplied, then that recovery point is restored.

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 Codes:

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

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

  • ErrCodeMissingParameterValueException "MissingParameterValueException" Indicates that a required parameter is missing.

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

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

StartRestoreJobRequest

func (c *Backup) StartRestoreJobRequest(input *StartRestoreJobInput) (req *request.Request, output *StartRestoreJobOutput)

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

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

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

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

// Example sending a request using the StartRestoreJobRequest method. req, resp := client.StartRestoreJobRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

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

StartRestoreJobWithContext

func (c *Backup) StartRestoreJobWithContext(ctx aws.Context, input *StartRestoreJobInput, opts ...request.Option) (*StartRestoreJobOutput, error)

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

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

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

See Also

For more information about using this API, see AWS API Documentation.

StopBackupJob

func (c *Backup) StopBackupJob(input *StopBackupJobInput) (*StopBackupJobOutput, error)

StopBackupJob API operation for AWS Backup.

Attempts to cancel a job to create a one-time backup of a resource.

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

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

Returned Error Codes:

  • ErrCodeMissingParameterValueException "MissingParameterValueException" Indicates that a required parameter is missing.

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

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

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

  • ErrCodeServiceUnavailableException "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

StopBackupJobRequest

func (c *Backup) StopBackupJobRequest(input *StopBackupJobInput) (req *request.Request, output *StopBackupJobOutput)

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

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

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

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

// Example sending a request using the StopBackupJobRequest method. req, resp := client.StopBackupJobRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

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

StopBackupJobWithContext

func (c *Backup) StopBackupJobWithContext(ctx aws.Context, input *StopBackupJobInput, opts ...request.Option) (*StopBackupJobOutput, error)

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

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

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

See Also

For more information about using this API, see AWS API Documentation.

TagResource

func (c *Backup) TagResource(input *TagResourceInput) (*TagResourceOutput, error)

TagResource API operation for AWS Backup.

Assigns a set of key-value pairs to a recovery point, backup plan, or backup vault identified by an Amazon Resource Name (ARN).

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

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

Returned Error Codes:

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

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

  • ErrCodeMissingParameterValueException "MissingParameterValueException" Indicates that a required parameter is missing.

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

  • ErrCodeLimitExceededException "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

TagResourceRequest

func (c *Backup) TagResourceRequest(input *TagResourceInput) (req *request.Request, output *TagResourceOutput)

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

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

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

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

// Example sending a request using the TagResourceRequest method. req, resp := client.TagResourceRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

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

TagResourceWithContext

func (c *Backup) TagResourceWithContext(ctx aws.Context, input *TagResourceInput, opts ...request.Option) (*TagResourceOutput, error)

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

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

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

See Also

For more information about using this API, see AWS API Documentation.

UntagResource

func (c *Backup) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error)

UntagResource API operation for AWS Backup.

Removes a set of key-value pairs from a recovery point, backup plan, or backup vault identified by an Amazon Resource Name (ARN)

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

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

Returned Error Codes:

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

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

  • ErrCodeMissingParameterValueException "MissingParameterValueException" Indicates that a required parameter is missing.

  • ErrCodeServiceUnavailableException "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

UntagResourceRequest

func (c *Backup) UntagResourceRequest(input *UntagResourceInput) (req *request.Request, output *UntagResourceOutput)

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

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

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

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

// Example sending a request using the UntagResourceRequest method. req, resp := client.UntagResourceRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

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

UntagResourceWithContext

func (c *Backup) UntagResourceWithContext(ctx aws.Context, input *UntagResourceInput, opts ...request.Option) (*UntagResourceOutput, error)

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

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

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

See Also

For more information about using this API, see AWS API Documentation.

UpdateBackupPlan

func (c *Backup) UpdateBackupPlan(input *UpdateBackupPlanInput) (*UpdateBackupPlanOutput, error)

UpdateBackupPlan API operation for AWS Backup.

Replaces the body of a saved 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 Codes:

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

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

  • ErrCodeMissingParameterValueException "MissingParameterValueException" Indicates that a required parameter is missing.

  • ErrCodeServiceUnavailableException "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

UpdateBackupPlanRequest

func (c *Backup) UpdateBackupPlanRequest(input *UpdateBackupPlanInput) (req *request.Request, output *UpdateBackupPlanOutput)

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

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

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

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

// Example sending a request using the UpdateBackupPlanRequest method. req, resp := client.UpdateBackupPlanRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

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

UpdateBackupPlanWithContext

func (c *Backup) UpdateBackupPlanWithContext(ctx aws.Context, input *UpdateBackupPlanInput, opts ...request.Option) (*UpdateBackupPlanOutput, error)

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

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

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

See Also

For more information about using this API, see AWS API Documentation.

UpdateRecoveryPointLifecycle

func (c *Backup) UpdateRecoveryPointLifecycle(input *UpdateRecoveryPointLifecycleInput) (*UpdateRecoveryPointLifecycleOutput, error)

UpdateRecoveryPointLifecycle API operation for AWS Backup.

Sets the transition lifecycle of a recovery point.

The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. AWS Backup transitions and expires backups automatically according to the lifecycle that you define.

Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “expire after days” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold.

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 Codes:

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

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

  • ErrCodeMissingParameterValueException "MissingParameterValueException" Indicates that a required parameter is missing.

  • ErrCodeServiceUnavailableException "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

UpdateRecoveryPointLifecycleRequest

func (c *Backup) UpdateRecoveryPointLifecycleRequest(input *UpdateRecoveryPointLifecycleInput) (req *request.Request, output *UpdateRecoveryPointLifecycleOutput)

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

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

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

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

// Example sending a request using the UpdateRecoveryPointLifecycleRequest method. req, resp := client.UpdateRecoveryPointLifecycleRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }

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

UpdateRecoveryPointLifecycleWithContext

func (c *Backup) UpdateRecoveryPointLifecycleWithContext(ctx aws.Context, input *UpdateRecoveryPointLifecycleInput, opts ...request.Option) (*UpdateRecoveryPointLifecycleOutput, error)

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

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

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

See Also

For more information about using this API, see AWS API Documentation.

On this page: