Documentation ¶
Overview ¶
Package backup provides the API client, operations, and parameter types for AWS Backup.
Backup Backup is a unified backup service designed to protect Amazon Web Services services and their associated data. Backup simplifies the creation, migration, restoration, and deletion of backups, while also providing reporting and auditing.
Index ¶
- Constants
- func NewDefaultEndpointResolver() *internalendpoints.Resolver
- func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)
- func WithEndpointResolver(v EndpointResolver) func(*Options)
- type Client
- func (c *Client) CreateBackupPlan(ctx context.Context, params *CreateBackupPlanInput, optFns ...func(*Options)) (*CreateBackupPlanOutput, error)
- func (c *Client) CreateBackupSelection(ctx context.Context, params *CreateBackupSelectionInput, ...) (*CreateBackupSelectionOutput, error)
- func (c *Client) CreateBackupVault(ctx context.Context, params *CreateBackupVaultInput, optFns ...func(*Options)) (*CreateBackupVaultOutput, error)
- func (c *Client) CreateFramework(ctx context.Context, params *CreateFrameworkInput, optFns ...func(*Options)) (*CreateFrameworkOutput, error)
- func (c *Client) CreateReportPlan(ctx context.Context, params *CreateReportPlanInput, optFns ...func(*Options)) (*CreateReportPlanOutput, error)
- func (c *Client) DeleteBackupPlan(ctx context.Context, params *DeleteBackupPlanInput, optFns ...func(*Options)) (*DeleteBackupPlanOutput, error)
- func (c *Client) DeleteBackupSelection(ctx context.Context, params *DeleteBackupSelectionInput, ...) (*DeleteBackupSelectionOutput, error)
- func (c *Client) DeleteBackupVault(ctx context.Context, params *DeleteBackupVaultInput, optFns ...func(*Options)) (*DeleteBackupVaultOutput, error)
- func (c *Client) DeleteBackupVaultAccessPolicy(ctx context.Context, params *DeleteBackupVaultAccessPolicyInput, ...) (*DeleteBackupVaultAccessPolicyOutput, error)
- func (c *Client) DeleteBackupVaultLockConfiguration(ctx context.Context, params *DeleteBackupVaultLockConfigurationInput, ...) (*DeleteBackupVaultLockConfigurationOutput, error)
- func (c *Client) DeleteBackupVaultNotifications(ctx context.Context, params *DeleteBackupVaultNotificationsInput, ...) (*DeleteBackupVaultNotificationsOutput, error)
- func (c *Client) DeleteFramework(ctx context.Context, params *DeleteFrameworkInput, optFns ...func(*Options)) (*DeleteFrameworkOutput, error)
- func (c *Client) DeleteRecoveryPoint(ctx context.Context, params *DeleteRecoveryPointInput, ...) (*DeleteRecoveryPointOutput, error)
- func (c *Client) DeleteReportPlan(ctx context.Context, params *DeleteReportPlanInput, optFns ...func(*Options)) (*DeleteReportPlanOutput, error)
- func (c *Client) DescribeBackupJob(ctx context.Context, params *DescribeBackupJobInput, optFns ...func(*Options)) (*DescribeBackupJobOutput, error)
- func (c *Client) DescribeBackupVault(ctx context.Context, params *DescribeBackupVaultInput, ...) (*DescribeBackupVaultOutput, error)
- func (c *Client) DescribeCopyJob(ctx context.Context, params *DescribeCopyJobInput, optFns ...func(*Options)) (*DescribeCopyJobOutput, error)
- func (c *Client) DescribeFramework(ctx context.Context, params *DescribeFrameworkInput, optFns ...func(*Options)) (*DescribeFrameworkOutput, error)
- func (c *Client) DescribeGlobalSettings(ctx context.Context, params *DescribeGlobalSettingsInput, ...) (*DescribeGlobalSettingsOutput, error)
- func (c *Client) DescribeProtectedResource(ctx context.Context, params *DescribeProtectedResourceInput, ...) (*DescribeProtectedResourceOutput, error)
- func (c *Client) DescribeRecoveryPoint(ctx context.Context, params *DescribeRecoveryPointInput, ...) (*DescribeRecoveryPointOutput, error)
- func (c *Client) DescribeRegionSettings(ctx context.Context, params *DescribeRegionSettingsInput, ...) (*DescribeRegionSettingsOutput, error)
- func (c *Client) DescribeReportJob(ctx context.Context, params *DescribeReportJobInput, optFns ...func(*Options)) (*DescribeReportJobOutput, error)
- func (c *Client) DescribeReportPlan(ctx context.Context, params *DescribeReportPlanInput, optFns ...func(*Options)) (*DescribeReportPlanOutput, error)
- func (c *Client) DescribeRestoreJob(ctx context.Context, params *DescribeRestoreJobInput, optFns ...func(*Options)) (*DescribeRestoreJobOutput, error)
- func (c *Client) DisassociateRecoveryPoint(ctx context.Context, params *DisassociateRecoveryPointInput, ...) (*DisassociateRecoveryPointOutput, error)
- func (c *Client) ExportBackupPlanTemplate(ctx context.Context, params *ExportBackupPlanTemplateInput, ...) (*ExportBackupPlanTemplateOutput, error)
- func (c *Client) GetBackupPlan(ctx context.Context, params *GetBackupPlanInput, optFns ...func(*Options)) (*GetBackupPlanOutput, error)
- func (c *Client) GetBackupPlanFromJSON(ctx context.Context, params *GetBackupPlanFromJSONInput, ...) (*GetBackupPlanFromJSONOutput, error)
- func (c *Client) GetBackupPlanFromTemplate(ctx context.Context, params *GetBackupPlanFromTemplateInput, ...) (*GetBackupPlanFromTemplateOutput, error)
- func (c *Client) GetBackupSelection(ctx context.Context, params *GetBackupSelectionInput, optFns ...func(*Options)) (*GetBackupSelectionOutput, error)
- func (c *Client) GetBackupVaultAccessPolicy(ctx context.Context, params *GetBackupVaultAccessPolicyInput, ...) (*GetBackupVaultAccessPolicyOutput, error)
- func (c *Client) GetBackupVaultNotifications(ctx context.Context, params *GetBackupVaultNotificationsInput, ...) (*GetBackupVaultNotificationsOutput, error)
- func (c *Client) GetRecoveryPointRestoreMetadata(ctx context.Context, params *GetRecoveryPointRestoreMetadataInput, ...) (*GetRecoveryPointRestoreMetadataOutput, error)
- func (c *Client) GetSupportedResourceTypes(ctx context.Context, params *GetSupportedResourceTypesInput, ...) (*GetSupportedResourceTypesOutput, error)
- func (c *Client) ListBackupJobs(ctx context.Context, params *ListBackupJobsInput, optFns ...func(*Options)) (*ListBackupJobsOutput, error)
- func (c *Client) ListBackupPlanTemplates(ctx context.Context, params *ListBackupPlanTemplatesInput, ...) (*ListBackupPlanTemplatesOutput, error)
- func (c *Client) ListBackupPlanVersions(ctx context.Context, params *ListBackupPlanVersionsInput, ...) (*ListBackupPlanVersionsOutput, error)
- func (c *Client) ListBackupPlans(ctx context.Context, params *ListBackupPlansInput, optFns ...func(*Options)) (*ListBackupPlansOutput, error)
- func (c *Client) ListBackupSelections(ctx context.Context, params *ListBackupSelectionsInput, ...) (*ListBackupSelectionsOutput, error)
- func (c *Client) ListBackupVaults(ctx context.Context, params *ListBackupVaultsInput, optFns ...func(*Options)) (*ListBackupVaultsOutput, error)
- func (c *Client) ListCopyJobs(ctx context.Context, params *ListCopyJobsInput, optFns ...func(*Options)) (*ListCopyJobsOutput, error)
- func (c *Client) ListFrameworks(ctx context.Context, params *ListFrameworksInput, optFns ...func(*Options)) (*ListFrameworksOutput, error)
- func (c *Client) ListProtectedResources(ctx context.Context, params *ListProtectedResourcesInput, ...) (*ListProtectedResourcesOutput, error)
- func (c *Client) ListRecoveryPointsByBackupVault(ctx context.Context, params *ListRecoveryPointsByBackupVaultInput, ...) (*ListRecoveryPointsByBackupVaultOutput, error)
- func (c *Client) ListRecoveryPointsByResource(ctx context.Context, params *ListRecoveryPointsByResourceInput, ...) (*ListRecoveryPointsByResourceOutput, error)
- func (c *Client) ListReportJobs(ctx context.Context, params *ListReportJobsInput, optFns ...func(*Options)) (*ListReportJobsOutput, error)
- func (c *Client) ListReportPlans(ctx context.Context, params *ListReportPlansInput, optFns ...func(*Options)) (*ListReportPlansOutput, error)
- func (c *Client) ListRestoreJobs(ctx context.Context, params *ListRestoreJobsInput, optFns ...func(*Options)) (*ListRestoreJobsOutput, error)
- func (c *Client) ListTags(ctx context.Context, params *ListTagsInput, optFns ...func(*Options)) (*ListTagsOutput, error)
- func (c *Client) PutBackupVaultAccessPolicy(ctx context.Context, params *PutBackupVaultAccessPolicyInput, ...) (*PutBackupVaultAccessPolicyOutput, error)
- func (c *Client) PutBackupVaultLockConfiguration(ctx context.Context, params *PutBackupVaultLockConfigurationInput, ...) (*PutBackupVaultLockConfigurationOutput, error)
- func (c *Client) PutBackupVaultNotifications(ctx context.Context, params *PutBackupVaultNotificationsInput, ...) (*PutBackupVaultNotificationsOutput, error)
- func (c *Client) StartBackupJob(ctx context.Context, params *StartBackupJobInput, optFns ...func(*Options)) (*StartBackupJobOutput, error)
- func (c *Client) StartCopyJob(ctx context.Context, params *StartCopyJobInput, optFns ...func(*Options)) (*StartCopyJobOutput, error)
- func (c *Client) StartReportJob(ctx context.Context, params *StartReportJobInput, optFns ...func(*Options)) (*StartReportJobOutput, error)
- func (c *Client) StartRestoreJob(ctx context.Context, params *StartRestoreJobInput, optFns ...func(*Options)) (*StartRestoreJobOutput, error)
- func (c *Client) StopBackupJob(ctx context.Context, params *StopBackupJobInput, optFns ...func(*Options)) (*StopBackupJobOutput, error)
- func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)
- func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)
- func (c *Client) UpdateBackupPlan(ctx context.Context, params *UpdateBackupPlanInput, optFns ...func(*Options)) (*UpdateBackupPlanOutput, error)
- func (c *Client) UpdateFramework(ctx context.Context, params *UpdateFrameworkInput, optFns ...func(*Options)) (*UpdateFrameworkOutput, error)
- func (c *Client) UpdateGlobalSettings(ctx context.Context, params *UpdateGlobalSettingsInput, ...) (*UpdateGlobalSettingsOutput, error)
- func (c *Client) UpdateRecoveryPointLifecycle(ctx context.Context, params *UpdateRecoveryPointLifecycleInput, ...) (*UpdateRecoveryPointLifecycleOutput, error)
- func (c *Client) UpdateRegionSettings(ctx context.Context, params *UpdateRegionSettingsInput, ...) (*UpdateRegionSettingsOutput, error)
- func (c *Client) UpdateReportPlan(ctx context.Context, params *UpdateReportPlanInput, optFns ...func(*Options)) (*UpdateReportPlanOutput, error)
- type CreateBackupPlanInput
- type CreateBackupPlanOutput
- type CreateBackupSelectionInput
- type CreateBackupSelectionOutput
- type CreateBackupVaultInput
- type CreateBackupVaultOutput
- type CreateFrameworkInput
- type CreateFrameworkOutput
- type CreateReportPlanInput
- type CreateReportPlanOutput
- type DeleteBackupPlanInput
- type DeleteBackupPlanOutput
- type DeleteBackupSelectionInput
- type DeleteBackupSelectionOutput
- type DeleteBackupVaultAccessPolicyInput
- type DeleteBackupVaultAccessPolicyOutput
- type DeleteBackupVaultInput
- type DeleteBackupVaultLockConfigurationInput
- type DeleteBackupVaultLockConfigurationOutput
- type DeleteBackupVaultNotificationsInput
- type DeleteBackupVaultNotificationsOutput
- type DeleteBackupVaultOutput
- type DeleteFrameworkInput
- type DeleteFrameworkOutput
- type DeleteRecoveryPointInput
- type DeleteRecoveryPointOutput
- type DeleteReportPlanInput
- type DeleteReportPlanOutput
- type DescribeBackupJobInput
- type DescribeBackupJobOutput
- type DescribeBackupVaultInput
- type DescribeBackupVaultOutput
- type DescribeCopyJobInput
- type DescribeCopyJobOutput
- type DescribeFrameworkInput
- type DescribeFrameworkOutput
- type DescribeGlobalSettingsInput
- type DescribeGlobalSettingsOutput
- type DescribeProtectedResourceInput
- type DescribeProtectedResourceOutput
- type DescribeRecoveryPointInput
- type DescribeRecoveryPointOutput
- type DescribeRegionSettingsInput
- type DescribeRegionSettingsOutput
- type DescribeReportJobInput
- type DescribeReportJobOutput
- type DescribeReportPlanInput
- type DescribeReportPlanOutput
- type DescribeRestoreJobInput
- type DescribeRestoreJobOutput
- type DisassociateRecoveryPointInput
- type DisassociateRecoveryPointOutput
- type EndpointResolver
- type EndpointResolverFunc
- type EndpointResolverOptions
- type ExportBackupPlanTemplateInput
- type ExportBackupPlanTemplateOutput
- type GetBackupPlanFromJSONInput
- type GetBackupPlanFromJSONOutput
- type GetBackupPlanFromTemplateInput
- type GetBackupPlanFromTemplateOutput
- type GetBackupPlanInput
- type GetBackupPlanOutput
- type GetBackupSelectionInput
- type GetBackupSelectionOutput
- type GetBackupVaultAccessPolicyInput
- type GetBackupVaultAccessPolicyOutput
- type GetBackupVaultNotificationsInput
- type GetBackupVaultNotificationsOutput
- type GetRecoveryPointRestoreMetadataInput
- type GetRecoveryPointRestoreMetadataOutput
- type GetSupportedResourceTypesInput
- type GetSupportedResourceTypesOutput
- type HTTPClient
- type HTTPSignerV4
- type IdempotencyTokenProvider
- type ListBackupJobsAPIClient
- type ListBackupJobsInput
- type ListBackupJobsOutput
- type ListBackupJobsPaginator
- type ListBackupJobsPaginatorOptions
- type ListBackupPlanTemplatesAPIClient
- type ListBackupPlanTemplatesInput
- type ListBackupPlanTemplatesOutput
- type ListBackupPlanTemplatesPaginator
- type ListBackupPlanTemplatesPaginatorOptions
- type ListBackupPlanVersionsAPIClient
- type ListBackupPlanVersionsInput
- type ListBackupPlanVersionsOutput
- type ListBackupPlanVersionsPaginator
- type ListBackupPlanVersionsPaginatorOptions
- type ListBackupPlansAPIClient
- type ListBackupPlansInput
- type ListBackupPlansOutput
- type ListBackupPlansPaginator
- type ListBackupPlansPaginatorOptions
- type ListBackupSelectionsAPIClient
- type ListBackupSelectionsInput
- type ListBackupSelectionsOutput
- type ListBackupSelectionsPaginator
- type ListBackupSelectionsPaginatorOptions
- type ListBackupVaultsAPIClient
- type ListBackupVaultsInput
- type ListBackupVaultsOutput
- type ListBackupVaultsPaginator
- type ListBackupVaultsPaginatorOptions
- type ListCopyJobsAPIClient
- type ListCopyJobsInput
- type ListCopyJobsOutput
- type ListCopyJobsPaginator
- type ListCopyJobsPaginatorOptions
- type ListFrameworksAPIClient
- type ListFrameworksInput
- type ListFrameworksOutput
- type ListFrameworksPaginator
- type ListFrameworksPaginatorOptions
- type ListProtectedResourcesAPIClient
- type ListProtectedResourcesInput
- type ListProtectedResourcesOutput
- type ListProtectedResourcesPaginator
- type ListProtectedResourcesPaginatorOptions
- type ListRecoveryPointsByBackupVaultAPIClient
- type ListRecoveryPointsByBackupVaultInput
- type ListRecoveryPointsByBackupVaultOutput
- type ListRecoveryPointsByBackupVaultPaginator
- type ListRecoveryPointsByBackupVaultPaginatorOptions
- type ListRecoveryPointsByResourceAPIClient
- type ListRecoveryPointsByResourceInput
- type ListRecoveryPointsByResourceOutput
- type ListRecoveryPointsByResourcePaginator
- type ListRecoveryPointsByResourcePaginatorOptions
- type ListReportJobsAPIClient
- type ListReportJobsInput
- type ListReportJobsOutput
- type ListReportJobsPaginator
- type ListReportJobsPaginatorOptions
- type ListReportPlansAPIClient
- type ListReportPlansInput
- type ListReportPlansOutput
- type ListReportPlansPaginator
- type ListReportPlansPaginatorOptions
- type ListRestoreJobsAPIClient
- type ListRestoreJobsInput
- type ListRestoreJobsOutput
- type ListRestoreJobsPaginator
- type ListRestoreJobsPaginatorOptions
- type ListTagsAPIClient
- type ListTagsInput
- type ListTagsOutput
- type ListTagsPaginator
- type ListTagsPaginatorOptions
- type Options
- type PutBackupVaultAccessPolicyInput
- type PutBackupVaultAccessPolicyOutput
- type PutBackupVaultLockConfigurationInput
- type PutBackupVaultLockConfigurationOutput
- type PutBackupVaultNotificationsInput
- type PutBackupVaultNotificationsOutput
- type ResolveEndpoint
- type StartBackupJobInput
- type StartBackupJobOutput
- type StartCopyJobInput
- type StartCopyJobOutput
- type StartReportJobInput
- type StartReportJobOutput
- type StartRestoreJobInput
- type StartRestoreJobOutput
- type StopBackupJobInput
- type StopBackupJobOutput
- type TagResourceInput
- type TagResourceOutput
- type UntagResourceInput
- type UntagResourceOutput
- type UpdateBackupPlanInput
- type UpdateBackupPlanOutput
- type UpdateFrameworkInput
- type UpdateFrameworkOutput
- type UpdateGlobalSettingsInput
- type UpdateGlobalSettingsOutput
- type UpdateRecoveryPointLifecycleInput
- type UpdateRecoveryPointLifecycleOutput
- type UpdateRegionSettingsInput
- type UpdateRegionSettingsOutput
- type UpdateReportPlanInput
- type UpdateReportPlanOutput
Constants ¶
const ServiceAPIVersion = "2018-11-15"
const ServiceID = "Backup"
Variables ¶
This section is empty.
Functions ¶
func NewDefaultEndpointResolver ¶
func NewDefaultEndpointResolver() *internalendpoints.Resolver
NewDefaultEndpointResolver constructs a new service endpoint resolver
func WithAPIOptions ¶ added in v1.0.0
func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)
WithAPIOptions returns a functional option for setting the Client's APIOptions option.
func WithEndpointResolver ¶
func WithEndpointResolver(v EndpointResolver) func(*Options)
WithEndpointResolver returns a functional option for setting the Client's EndpointResolver option.
Types ¶
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client provides the API client to make operations call for AWS Backup.
func New ¶
New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.
func NewFromConfig ¶
NewFromConfig returns a new client from the provided config.
func (*Client) CreateBackupPlan ¶
func (c *Client) CreateBackupPlan(ctx context.Context, params *CreateBackupPlanInput, optFns ...func(*Options)) (*CreateBackupPlanOutput, error)
Creates a backup plan using a backup plan name and backup rules. A backup plan is a document that contains information that Backup uses to schedule tasks that create recovery points for resources. If you call CreateBackupPlan with a plan that already exists, you receive an AlreadyExistsException exception.
func (*Client) CreateBackupSelection ¶
func (c *Client) CreateBackupSelection(ctx context.Context, params *CreateBackupSelectionInput, optFns ...func(*Options)) (*CreateBackupSelectionOutput, error)
Creates a JSON document that specifies a set of resources to assign to a backup plan. For examples, see Assigning resources programmatically (https://docs.aws.amazon.com/aws-backup/latest/devguide/assigning-resources.html#assigning-resources-json).
func (*Client) CreateBackupVault ¶
func (c *Client) CreateBackupVault(ctx context.Context, params *CreateBackupVaultInput, optFns ...func(*Options)) (*CreateBackupVaultOutput, error)
Creates a logical container where backups are stored. A CreateBackupVault request includes a name, optionally one or more resource tags, an encryption key, and a request ID. Do not include sensitive data, such as passport numbers, in the name of a backup vault.
func (*Client) CreateFramework ¶ added in v1.5.0
func (c *Client) CreateFramework(ctx context.Context, params *CreateFrameworkInput, optFns ...func(*Options)) (*CreateFrameworkOutput, error)
Creates a framework with one or more controls. A framework is a collection of controls that you can use to evaluate your backup practices. By using pre-built customizable controls to define your policies, you can evaluate whether your backup practices comply with your policies and which resources are not yet in compliance.
func (*Client) CreateReportPlan ¶ added in v1.5.0
func (c *Client) CreateReportPlan(ctx context.Context, params *CreateReportPlanInput, optFns ...func(*Options)) (*CreateReportPlanOutput, error)
Creates a report plan. A report plan is a document that contains information about the contents of the report and where Backup will deliver it. If you call CreateReportPlan with a plan that already exists, you receive an AlreadyExistsException exception.
func (*Client) DeleteBackupPlan ¶
func (c *Client) DeleteBackupPlan(ctx context.Context, params *DeleteBackupPlanInput, optFns ...func(*Options)) (*DeleteBackupPlanOutput, error)
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.
func (*Client) DeleteBackupSelection ¶
func (c *Client) DeleteBackupSelection(ctx context.Context, params *DeleteBackupSelectionInput, optFns ...func(*Options)) (*DeleteBackupSelectionOutput, error)
Deletes the resource selection associated with a backup plan that is specified by the SelectionId.
func (*Client) DeleteBackupVault ¶
func (c *Client) DeleteBackupVault(ctx context.Context, params *DeleteBackupVaultInput, optFns ...func(*Options)) (*DeleteBackupVaultOutput, error)
Deletes the backup vault identified by its name. A vault can be deleted only if it is empty.
func (*Client) DeleteBackupVaultAccessPolicy ¶
func (c *Client) DeleteBackupVaultAccessPolicy(ctx context.Context, params *DeleteBackupVaultAccessPolicyInput, optFns ...func(*Options)) (*DeleteBackupVaultAccessPolicyOutput, error)
Deletes the policy document that manages permissions on a backup vault.
func (*Client) DeleteBackupVaultLockConfiguration ¶ added in v1.6.0
func (c *Client) DeleteBackupVaultLockConfiguration(ctx context.Context, params *DeleteBackupVaultLockConfigurationInput, optFns ...func(*Options)) (*DeleteBackupVaultLockConfigurationOutput, error)
Deletes Backup Vault Lock from a backup vault specified by a backup vault name. If the Vault Lock configuration is immutable, then you cannot delete Vault Lock using API operations, and you will receive an InvalidRequestException if you attempt to do so. For more information, see Vault Lock (https://docs.aws.amazon.com/aws-backup/latest/devguide/vault-lock.html) in the Backup Developer Guide.
func (*Client) DeleteBackupVaultNotifications ¶
func (c *Client) DeleteBackupVaultNotifications(ctx context.Context, params *DeleteBackupVaultNotificationsInput, optFns ...func(*Options)) (*DeleteBackupVaultNotificationsOutput, error)
Deletes event notifications for the specified backup vault.
func (*Client) DeleteFramework ¶ added in v1.5.0
func (c *Client) DeleteFramework(ctx context.Context, params *DeleteFrameworkInput, optFns ...func(*Options)) (*DeleteFrameworkOutput, error)
Deletes the framework specified by a framework name.
func (*Client) DeleteRecoveryPoint ¶
func (c *Client) DeleteRecoveryPoint(ctx context.Context, params *DeleteRecoveryPointInput, optFns ...func(*Options)) (*DeleteRecoveryPointOutput, error)
Deletes the recovery point specified by a recovery point ID. If the recovery point ID belongs to a continuous backup, calling this endpoint deletes the existing continuous backup and stops future continuous backup.
func (*Client) DeleteReportPlan ¶ added in v1.5.0
func (c *Client) DeleteReportPlan(ctx context.Context, params *DeleteReportPlanInput, optFns ...func(*Options)) (*DeleteReportPlanOutput, error)
Deletes the report plan specified by a report plan name.
func (*Client) DescribeBackupJob ¶
func (c *Client) DescribeBackupJob(ctx context.Context, params *DescribeBackupJobInput, optFns ...func(*Options)) (*DescribeBackupJobOutput, error)
Returns backup job details for the specified BackupJobId.
func (*Client) DescribeBackupVault ¶
func (c *Client) DescribeBackupVault(ctx context.Context, params *DescribeBackupVaultInput, optFns ...func(*Options)) (*DescribeBackupVaultOutput, error)
Returns metadata about a backup vault specified by its name.
func (*Client) DescribeCopyJob ¶
func (c *Client) DescribeCopyJob(ctx context.Context, params *DescribeCopyJobInput, optFns ...func(*Options)) (*DescribeCopyJobOutput, error)
Returns metadata associated with creating a copy of a resource.
func (*Client) DescribeFramework ¶ added in v1.5.0
func (c *Client) DescribeFramework(ctx context.Context, params *DescribeFrameworkInput, optFns ...func(*Options)) (*DescribeFrameworkOutput, error)
Returns the framework details for the specified FrameworkName.
func (*Client) DescribeGlobalSettings ¶ added in v0.30.0
func (c *Client) DescribeGlobalSettings(ctx context.Context, params *DescribeGlobalSettingsInput, optFns ...func(*Options)) (*DescribeGlobalSettingsOutput, error)
Describes whether the Amazon Web Services account is opted in to cross-account backup. Returns an error if the account is not a member of an Organizations organization. Example: describe-global-settings --region us-west-2
func (*Client) DescribeProtectedResource ¶
func (c *Client) DescribeProtectedResource(ctx context.Context, params *DescribeProtectedResourceInput, optFns ...func(*Options)) (*DescribeProtectedResourceOutput, error)
Returns information about a saved resource, including the last time it was backed up, its Amazon Resource Name (ARN), and the Amazon Web Services service type of the saved resource.
func (*Client) DescribeRecoveryPoint ¶
func (c *Client) DescribeRecoveryPoint(ctx context.Context, params *DescribeRecoveryPointInput, optFns ...func(*Options)) (*DescribeRecoveryPointOutput, error)
Returns metadata associated with a recovery point, including ID, status, encryption, and lifecycle.
func (*Client) DescribeRegionSettings ¶
func (c *Client) DescribeRegionSettings(ctx context.Context, params *DescribeRegionSettingsInput, optFns ...func(*Options)) (*DescribeRegionSettingsOutput, error)
Returns the current service opt-in settings for the Region. If service opt-in is enabled for a service, Backup tries to protect that service's resources in this Region, when the resource is included in an on-demand backup or scheduled backup plan. Otherwise, Backup does not try to protect that service's resources in this Region.
func (*Client) DescribeReportJob ¶ added in v1.5.0
func (c *Client) DescribeReportJob(ctx context.Context, params *DescribeReportJobInput, optFns ...func(*Options)) (*DescribeReportJobOutput, error)
Returns the details associated with creating a report as specified by its ReportJobId.
func (*Client) DescribeReportPlan ¶ added in v1.5.0
func (c *Client) DescribeReportPlan(ctx context.Context, params *DescribeReportPlanInput, optFns ...func(*Options)) (*DescribeReportPlanOutput, error)
Returns a list of all report plans for an Amazon Web Services account and Amazon Web Services Region.
func (*Client) DescribeRestoreJob ¶
func (c *Client) DescribeRestoreJob(ctx context.Context, params *DescribeRestoreJobInput, optFns ...func(*Options)) (*DescribeRestoreJobOutput, error)
Returns metadata associated with a restore job that is specified by a job ID.
func (*Client) DisassociateRecoveryPoint ¶ added in v1.2.0
func (c *Client) DisassociateRecoveryPoint(ctx context.Context, params *DisassociateRecoveryPointInput, optFns ...func(*Options)) (*DisassociateRecoveryPointOutput, error)
Deletes the specified continuous backup recovery point from Backup and releases control of that continuous backup to the source service, such as Amazon RDS. The source service will continue to create and retain continuous backups using the lifecycle that you specified in your original backup plan. Does not support snapshot backup recovery points.
func (*Client) ExportBackupPlanTemplate ¶
func (c *Client) ExportBackupPlanTemplate(ctx context.Context, params *ExportBackupPlanTemplateInput, optFns ...func(*Options)) (*ExportBackupPlanTemplateOutput, error)
Returns the backup plan that is specified by the plan ID as a backup template.
func (*Client) GetBackupPlan ¶
func (c *Client) GetBackupPlan(ctx context.Context, params *GetBackupPlanInput, optFns ...func(*Options)) (*GetBackupPlanOutput, error)
Returns BackupPlan details for the specified BackupPlanId. The details are the body of a backup plan in JSON format, in addition to plan metadata.
func (*Client) GetBackupPlanFromJSON ¶
func (c *Client) GetBackupPlanFromJSON(ctx context.Context, params *GetBackupPlanFromJSONInput, optFns ...func(*Options)) (*GetBackupPlanFromJSONOutput, error)
Returns a valid JSON document specifying a backup plan or an error.
func (*Client) GetBackupPlanFromTemplate ¶
func (c *Client) GetBackupPlanFromTemplate(ctx context.Context, params *GetBackupPlanFromTemplateInput, optFns ...func(*Options)) (*GetBackupPlanFromTemplateOutput, error)
Returns the template specified by its templateId as a backup plan.
func (*Client) GetBackupSelection ¶
func (c *Client) GetBackupSelection(ctx context.Context, params *GetBackupSelectionInput, optFns ...func(*Options)) (*GetBackupSelectionOutput, error)
Returns selection metadata and a document in JSON format that specifies a list of resources that are associated with a backup plan.
func (*Client) GetBackupVaultAccessPolicy ¶
func (c *Client) GetBackupVaultAccessPolicy(ctx context.Context, params *GetBackupVaultAccessPolicyInput, optFns ...func(*Options)) (*GetBackupVaultAccessPolicyOutput, error)
Returns the access policy document that is associated with the named backup vault.
func (*Client) GetBackupVaultNotifications ¶
func (c *Client) GetBackupVaultNotifications(ctx context.Context, params *GetBackupVaultNotificationsInput, optFns ...func(*Options)) (*GetBackupVaultNotificationsOutput, error)
Returns event notifications for the specified backup vault.
func (*Client) GetRecoveryPointRestoreMetadata ¶
func (c *Client) GetRecoveryPointRestoreMetadata(ctx context.Context, params *GetRecoveryPointRestoreMetadataInput, optFns ...func(*Options)) (*GetRecoveryPointRestoreMetadataOutput, error)
Returns a set of metadata key-value pairs that were used to create the backup.
func (*Client) GetSupportedResourceTypes ¶
func (c *Client) GetSupportedResourceTypes(ctx context.Context, params *GetSupportedResourceTypesInput, optFns ...func(*Options)) (*GetSupportedResourceTypesOutput, error)
Returns the Amazon Web Services resource types supported by Backup.
func (*Client) ListBackupJobs ¶
func (c *Client) ListBackupJobs(ctx context.Context, params *ListBackupJobsInput, optFns ...func(*Options)) (*ListBackupJobsOutput, error)
Returns a list of existing backup jobs for an authenticated account for the last 30 days. For a longer period of time, consider using these monitoring tools (https://docs.aws.amazon.com/aws-backup/latest/devguide/monitoring.html).
func (*Client) ListBackupPlanTemplates ¶
func (c *Client) ListBackupPlanTemplates(ctx context.Context, params *ListBackupPlanTemplatesInput, optFns ...func(*Options)) (*ListBackupPlanTemplatesOutput, error)
Returns metadata of your saved backup plan templates, including the template ID, name, and the creation and deletion dates.
func (*Client) ListBackupPlanVersions ¶
func (c *Client) ListBackupPlanVersions(ctx context.Context, params *ListBackupPlanVersionsInput, optFns ...func(*Options)) (*ListBackupPlanVersionsOutput, error)
Returns version metadata of your backup plans, including Amazon Resource Names (ARNs), backup plan IDs, creation and deletion dates, plan names, and version IDs.
func (*Client) ListBackupPlans ¶
func (c *Client) ListBackupPlans(ctx context.Context, params *ListBackupPlansInput, optFns ...func(*Options)) (*ListBackupPlansOutput, error)
Returns a list of all active backup plans for an authenticated account. The list contains information such as Amazon Resource Names (ARNs), plan IDs, creation and deletion dates, version IDs, plan names, and creator request IDs.
func (*Client) ListBackupSelections ¶
func (c *Client) ListBackupSelections(ctx context.Context, params *ListBackupSelectionsInput, optFns ...func(*Options)) (*ListBackupSelectionsOutput, error)
Returns an array containing metadata of the resources associated with the target backup plan.
func (*Client) ListBackupVaults ¶
func (c *Client) ListBackupVaults(ctx context.Context, params *ListBackupVaultsInput, optFns ...func(*Options)) (*ListBackupVaultsOutput, error)
Returns a list of recovery point storage containers along with information about them.
func (*Client) ListCopyJobs ¶
func (c *Client) ListCopyJobs(ctx context.Context, params *ListCopyJobsInput, optFns ...func(*Options)) (*ListCopyJobsOutput, error)
Returns metadata about your copy jobs.
func (*Client) ListFrameworks ¶ added in v1.5.0
func (c *Client) ListFrameworks(ctx context.Context, params *ListFrameworksInput, optFns ...func(*Options)) (*ListFrameworksOutput, error)
Returns a list of all frameworks for an Amazon Web Services account and Amazon Web Services Region.
func (*Client) ListProtectedResources ¶
func (c *Client) ListProtectedResources(ctx context.Context, params *ListProtectedResourcesInput, optFns ...func(*Options)) (*ListProtectedResourcesOutput, error)
Returns an array of resources successfully backed up by Backup, including the time the resource was saved, an Amazon Resource Name (ARN) of the resource, and a resource type.
func (*Client) ListRecoveryPointsByBackupVault ¶
func (c *Client) ListRecoveryPointsByBackupVault(ctx context.Context, params *ListRecoveryPointsByBackupVaultInput, optFns ...func(*Options)) (*ListRecoveryPointsByBackupVaultOutput, error)
Returns detailed information about the recovery points stored in a backup vault.
func (*Client) ListRecoveryPointsByResource ¶
func (c *Client) ListRecoveryPointsByResource(ctx context.Context, params *ListRecoveryPointsByResourceInput, optFns ...func(*Options)) (*ListRecoveryPointsByResourceOutput, error)
Returns detailed information about all the recovery points of the type specified by a resource Amazon Resource Name (ARN). For Amazon EFS and Amazon EC2, this action only lists recovery points created by Backup.
func (*Client) ListReportJobs ¶ added in v1.5.0
func (c *Client) ListReportJobs(ctx context.Context, params *ListReportJobsInput, optFns ...func(*Options)) (*ListReportJobsOutput, error)
Returns details about your report jobs.
func (*Client) ListReportPlans ¶ added in v1.5.0
func (c *Client) ListReportPlans(ctx context.Context, params *ListReportPlansInput, optFns ...func(*Options)) (*ListReportPlansOutput, error)
Returns a list of your report plans. For detailed information about a single report plan, use DescribeReportPlan.
func (*Client) ListRestoreJobs ¶
func (c *Client) ListRestoreJobs(ctx context.Context, params *ListRestoreJobsInput, optFns ...func(*Options)) (*ListRestoreJobsOutput, error)
Returns a list of jobs that Backup initiated to restore a saved resource, including details about the recovery process.
func (*Client) ListTags ¶
func (c *Client) ListTags(ctx context.Context, params *ListTagsInput, optFns ...func(*Options)) (*ListTagsOutput, error)
Returns a list of key-value pairs assigned to a target recovery point, backup plan, or backup vault. ListTags only works for resource types that support full Backup management of their backups. Those resource types are listed in the "Full Backup management" section of the Feature availability by resource (https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#features-by-resource) table.
func (*Client) PutBackupVaultAccessPolicy ¶
func (c *Client) PutBackupVaultAccessPolicy(ctx context.Context, params *PutBackupVaultAccessPolicyInput, optFns ...func(*Options)) (*PutBackupVaultAccessPolicyOutput, error)
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.
func (*Client) PutBackupVaultLockConfiguration ¶ added in v1.6.0
func (c *Client) PutBackupVaultLockConfiguration(ctx context.Context, params *PutBackupVaultLockConfigurationInput, optFns ...func(*Options)) (*PutBackupVaultLockConfigurationOutput, error)
Applies Backup Vault Lock to a backup vault, preventing attempts to delete any recovery point stored in or created in a backup vault. Vault Lock also prevents attempts to update the lifecycle policy that controls the retention period of any recovery point currently stored in a backup vault. If specified, Vault Lock enforces a minimum and maximum retention period for future backup and copy jobs that target a backup vault. Backup Vault Lock has yet to receive a third-party assessment for SEC 17a-4(f) and CFTC.
func (*Client) PutBackupVaultNotifications ¶
func (c *Client) PutBackupVaultNotifications(ctx context.Context, params *PutBackupVaultNotificationsInput, optFns ...func(*Options)) (*PutBackupVaultNotificationsOutput, error)
Turns on notifications on a backup vault for the specified topic and events.
func (*Client) StartBackupJob ¶
func (c *Client) StartBackupJob(ctx context.Context, params *StartBackupJobInput, optFns ...func(*Options)) (*StartBackupJobOutput, error)
Starts an on-demand backup job for the specified resource.
func (*Client) StartCopyJob ¶
func (c *Client) StartCopyJob(ctx context.Context, params *StartCopyJobInput, optFns ...func(*Options)) (*StartCopyJobOutput, error)
Starts a job to create a one-time copy of the specified resource. Does not support continuous backups.
func (*Client) StartReportJob ¶ added in v1.5.0
func (c *Client) StartReportJob(ctx context.Context, params *StartReportJobInput, optFns ...func(*Options)) (*StartReportJobOutput, error)
Starts an on-demand report job for the specified report plan.
func (*Client) StartRestoreJob ¶
func (c *Client) StartRestoreJob(ctx context.Context, params *StartRestoreJobInput, optFns ...func(*Options)) (*StartRestoreJobOutput, error)
Recovers the saved resource identified by an Amazon Resource Name (ARN).
func (*Client) StopBackupJob ¶
func (c *Client) StopBackupJob(ctx context.Context, params *StopBackupJobInput, optFns ...func(*Options)) (*StopBackupJobOutput, error)
Attempts to cancel a job to create a one-time backup of a resource.
func (*Client) TagResource ¶
func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)
Assigns a set of key-value pairs to a recovery point, backup plan, or backup vault identified by an Amazon Resource Name (ARN).
func (*Client) UntagResource ¶
func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)
Removes a set of key-value pairs from a recovery point, backup plan, or backup vault identified by an Amazon Resource Name (ARN)
func (*Client) UpdateBackupPlan ¶
func (c *Client) UpdateBackupPlan(ctx context.Context, params *UpdateBackupPlanInput, optFns ...func(*Options)) (*UpdateBackupPlanOutput, error)
Updates an existing backup plan identified by its backupPlanId with the input document in JSON format. The new version is uniquely identified by a VersionId.
func (*Client) UpdateFramework ¶ added in v1.5.0
func (c *Client) UpdateFramework(ctx context.Context, params *UpdateFrameworkInput, optFns ...func(*Options)) (*UpdateFrameworkOutput, error)
Updates an existing framework identified by its FrameworkName with the input document in JSON format.
func (*Client) UpdateGlobalSettings ¶ added in v0.30.0
func (c *Client) UpdateGlobalSettings(ctx context.Context, params *UpdateGlobalSettingsInput, optFns ...func(*Options)) (*UpdateGlobalSettingsOutput, error)
Updates whether the Amazon Web Services account is opted in to cross-account backup. Returns an error if the account is not an Organizations management account. Use the DescribeGlobalSettings API to determine the current settings.
func (*Client) UpdateRecoveryPointLifecycle ¶
func (c *Client) UpdateRecoveryPointLifecycle(ctx context.Context, params *UpdateRecoveryPointLifecycleInput, optFns ...func(*Options)) (*UpdateRecoveryPointLifecycleOutput, error)
Sets the transition lifecycle of a recovery point. The lifecycle defines when a protected resource is transitioned to cold storage and when it expires. Backup transitions and expires backups automatically according to the lifecycle that you define. Backups transitioned to cold storage must be stored in cold storage for a minimum of 90 days. Therefore, the “retention” setting must be 90 days greater than the “transition to cold after days” setting. The “transition to cold after days” setting cannot be changed after a backup has been transitioned to cold. Resource types that are able to be transitioned to cold storage are listed in the "Lifecycle to cold storage" section of the Feature availability by resource (https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#features-by-resource) table. Backup ignores this expression for other resource types. This operation does not support continuous backups.
func (*Client) UpdateRegionSettings ¶
func (c *Client) UpdateRegionSettings(ctx context.Context, params *UpdateRegionSettingsInput, optFns ...func(*Options)) (*UpdateRegionSettingsOutput, error)
Updates the current service opt-in settings for the Region. If service-opt-in is enabled for a service, Backup tries to protect that service's resources in this Region, when the resource is included in an on-demand backup or scheduled backup plan. Otherwise, Backup does not try to protect that service's resources in this Region. Use the DescribeRegionSettings API to determine the resource types that are supported.
func (*Client) UpdateReportPlan ¶ added in v1.5.0
func (c *Client) UpdateReportPlan(ctx context.Context, params *UpdateReportPlanInput, optFns ...func(*Options)) (*UpdateReportPlanOutput, error)
Updates an existing report plan identified by its ReportPlanName with the input document in JSON format.
type CreateBackupPlanInput ¶
type CreateBackupPlanInput struct { // Specifies the body of a backup plan. Includes a BackupPlanName and one or more // sets of Rules. // // This member is required. BackupPlan *types.BackupPlanInput // To help organize your resources, you can assign your own metadata to the // resources that you create. Each tag is a key-value pair. The specified tags are // assigned to all backups created with this plan. BackupPlanTags map[string]string // Identifies the request and allows failed requests to be retried without the risk // of running the operation twice. If the request includes a CreatorRequestId that // matches an existing backup plan, that plan is returned. This parameter is // optional. If used, this parameter must contain 1 to 50 alphanumeric or '-_.' // characters. CreatorRequestId *string // contains filtered or unexported fields }
type CreateBackupPlanOutput ¶
type CreateBackupPlanOutput struct { // A list of BackupOptions settings for a resource type. This option is only // available for Windows Volume Shadow Copy Service (VSS) backup jobs. AdvancedBackupSettings []types.AdvancedBackupSetting // An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for // example, // arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50. BackupPlanArn *string // Uniquely identifies a backup plan. BackupPlanId *string // The date and time that a backup plan is created, in Unix format and Coordinated // Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For // example, the value 1516925490.087 represents Friday, January 26, 2018 // 12:11:30.087 AM. CreationDate *time.Time // Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most // 1,024 bytes long. They cannot be edited. VersionId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type CreateBackupSelectionInput ¶
type CreateBackupSelectionInput struct { // Uniquely identifies the backup plan to be associated with the selection of // resources. // // This member is required. BackupPlanId *string // Specifies the body of a request to assign a set of resources to a backup plan. // // This member is required. BackupSelection *types.BackupSelection // A unique string that identifies the request and allows failed requests to be // retried without the risk of running the operation twice. This parameter is // optional. If used, this parameter must contain 1 to 50 alphanumeric or '-_.' // characters. CreatorRequestId *string // contains filtered or unexported fields }
type CreateBackupSelectionOutput ¶
type CreateBackupSelectionOutput struct { // Uniquely identifies a backup plan. BackupPlanId *string // The date and time a backup selection is created, in Unix format and Coordinated // Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For // example, the value 1516925490.087 represents Friday, January 26, 2018 // 12:11:30.087 AM. CreationDate *time.Time // Uniquely identifies the body of a request to assign a set of resources to a // backup plan. SelectionId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type CreateBackupVaultInput ¶
type CreateBackupVaultInput struct { // The name of a logical container where backups are stored. Backup vaults are // identified by names that are unique to the account used to create them and the // Amazon Web Services Region where they are created. They consist of letters, // numbers, and hyphens. // // This member is required. BackupVaultName *string // Metadata that you can assign to help organize the resources that you create. // Each tag is a key-value pair. BackupVaultTags map[string]string // A unique string that identifies the request and allows failed requests to be // retried without the risk of running the operation twice. This parameter is // optional. If used, this parameter must contain 1 to 50 alphanumeric or '-_.' // characters. CreatorRequestId *string // The server-side encryption key that is used to protect your backups; for // example, // arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab. EncryptionKeyArn *string // contains filtered or unexported fields }
type CreateBackupVaultOutput ¶
type CreateBackupVaultOutput struct { // An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for // example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault. BackupVaultArn *string // The name of a logical container where backups are stored. Backup vaults are // identified by names that are unique to the account used to create them and the // Region where they are created. They consist of lowercase letters, numbers, and // hyphens. BackupVaultName *string // The date and time a backup vault is created, in Unix format and Coordinated // Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For // example, the value 1516925490.087 represents Friday, January 26, 2018 // 12:11:30.087 AM. CreationDate *time.Time // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type CreateFrameworkInput ¶ added in v1.5.0
type CreateFrameworkInput struct { // A list of the controls that make up the framework. Each control in the list has // a name, input parameters, and scope. // // This member is required. FrameworkControls []types.FrameworkControl // The unique name of the framework. The name must be between 1 and 256 characters, // starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and // underscores (_). // // This member is required. FrameworkName *string // An optional description of the framework with a maximum of 1,024 characters. FrameworkDescription *string // Metadata that you can assign to help organize the frameworks that you create. // Each tag is a key-value pair. FrameworkTags map[string]string // A customer-chosen string that you can use to distinguish between otherwise // identical calls to CreateFrameworkInput. Retrying a successful request with the // same idempotency token results in a success message with no action taken. IdempotencyToken *string // contains filtered or unexported fields }
type CreateFrameworkOutput ¶ added in v1.5.0
type CreateFrameworkOutput struct { // An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of // the ARN depends on the resource type. FrameworkArn *string // The unique name of the framework. The name must be between 1 and 256 characters, // starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and // underscores (_). FrameworkName *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type CreateReportPlanInput ¶ added in v1.5.0
type CreateReportPlanInput struct { // A structure that contains information about where and how to deliver your // reports, specifically your Amazon S3 bucket name, S3 key prefix, and the formats // of your reports. // // This member is required. ReportDeliveryChannel *types.ReportDeliveryChannel // The unique name of the report plan. The name must be between 1 and 256 // characters, starting with a letter, and consisting of letters (a-z, A-Z), // numbers (0-9), and underscores (_). // // This member is required. ReportPlanName *string // Identifies the report template for the report. Reports are built using a report // template. The report templates are: RESOURCE_COMPLIANCE_REPORT | // CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | // RESTORE_JOB_REPORT If the report template is RESOURCE_COMPLIANCE_REPORT or // CONTROL_COMPLIANCE_REPORT, this API resource also describes the report coverage // by Amazon Web Services Regions and frameworks. // // This member is required. ReportSetting *types.ReportSetting // A customer-chosen string that you can use to distinguish between otherwise // identical calls to CreateReportPlanInput. Retrying a successful request with the // same idempotency token results in a success message with no action taken. IdempotencyToken *string // An optional description of the report plan with a maximum of 1,024 characters. ReportPlanDescription *string // Metadata that you can assign to help organize the report plans that you create. // Each tag is a key-value pair. ReportPlanTags map[string]string // contains filtered or unexported fields }
type CreateReportPlanOutput ¶ added in v1.5.0
type CreateReportPlanOutput struct { // The date and time a backup vault is created, in Unix format and Coordinated // Universal Time (UTC). The value of CreationTime is accurate to milliseconds. For // example, the value 1516925490.087 represents Friday, January 26, 2018 // 12:11:30.087 AM. CreationTime *time.Time // An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of // the ARN depends on the resource type. ReportPlanArn *string // The unique name of the report plan. ReportPlanName *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteBackupPlanInput ¶
type DeleteBackupPlanInput struct { // Uniquely identifies a backup plan. // // This member is required. BackupPlanId *string // contains filtered or unexported fields }
type DeleteBackupPlanOutput ¶
type DeleteBackupPlanOutput struct { // An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for // example, // arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50. BackupPlanArn *string // Uniquely identifies a backup plan. BackupPlanId *string // The date and time a backup plan is deleted, in Unix format and Coordinated // Universal Time (UTC). The value of DeletionDate is accurate to milliseconds. For // example, the value 1516925490.087 represents Friday, January 26, 2018 // 12:11:30.087 AM. DeletionDate *time.Time // Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most // 1,024 bytes long. Version IDs cannot be edited. VersionId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteBackupSelectionInput ¶
type DeleteBackupSelectionInput struct { // Uniquely identifies a backup plan. // // This member is required. BackupPlanId *string // Uniquely identifies the body of a request to assign a set of resources to a // backup plan. // // This member is required. SelectionId *string // contains filtered or unexported fields }
type DeleteBackupSelectionOutput ¶
type DeleteBackupSelectionOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteBackupVaultAccessPolicyInput ¶
type DeleteBackupVaultAccessPolicyInput struct { // The name of a logical container where backups are stored. Backup vaults are // identified by names that are unique to the account used to create them and the // Amazon Web Services Region where they are created. They consist of lowercase // letters, numbers, and hyphens. // // This member is required. BackupVaultName *string // contains filtered or unexported fields }
type DeleteBackupVaultAccessPolicyOutput ¶
type DeleteBackupVaultAccessPolicyOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteBackupVaultInput ¶
type DeleteBackupVaultInput struct { // The name of a logical container where backups are stored. Backup vaults are // identified by names that are unique to the account used to create them and the // Amazon Web Services Region where they are created. They consist of lowercase // letters, numbers, and hyphens. // // This member is required. BackupVaultName *string // contains filtered or unexported fields }
type DeleteBackupVaultLockConfigurationInput ¶ added in v1.6.0
type DeleteBackupVaultLockConfigurationInput struct { // The name of the backup vault from which to delete Backup Vault Lock. // // This member is required. BackupVaultName *string // contains filtered or unexported fields }
type DeleteBackupVaultLockConfigurationOutput ¶ added in v1.6.0
type DeleteBackupVaultLockConfigurationOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteBackupVaultNotificationsInput ¶
type DeleteBackupVaultNotificationsInput struct { // The name of a logical container where backups are stored. Backup vaults are // identified by names that are unique to the account used to create them and the // Region where they are created. They consist of lowercase letters, numbers, and // hyphens. // // This member is required. BackupVaultName *string // contains filtered or unexported fields }
type DeleteBackupVaultNotificationsOutput ¶
type DeleteBackupVaultNotificationsOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteBackupVaultOutput ¶
type DeleteBackupVaultOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteFrameworkInput ¶ added in v1.5.0
type DeleteFrameworkInput struct { // The unique name of a framework. // // This member is required. FrameworkName *string // contains filtered or unexported fields }
type DeleteFrameworkOutput ¶ added in v1.5.0
type DeleteFrameworkOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteRecoveryPointInput ¶
type DeleteRecoveryPointInput struct { // The name of a logical container where backups are stored. Backup vaults are // identified by names that are unique to the account used to create them and the // Amazon Web Services Region where they are created. They consist of lowercase // letters, numbers, and hyphens. // // This member is required. BackupVaultName *string // An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for // example, // arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45. // // This member is required. RecoveryPointArn *string // contains filtered or unexported fields }
type DeleteRecoveryPointOutput ¶
type DeleteRecoveryPointOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteReportPlanInput ¶ added in v1.5.0
type DeleteReportPlanInput struct { // The unique name of a report plan. // // This member is required. ReportPlanName *string // contains filtered or unexported fields }
type DeleteReportPlanOutput ¶ added in v1.5.0
type DeleteReportPlanOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DescribeBackupJobInput ¶
type DescribeBackupJobInput struct { // Uniquely identifies a request to Backup to back up a resource. // // This member is required. BackupJobId *string // contains filtered or unexported fields }
type DescribeBackupJobOutput ¶
type DescribeBackupJobOutput struct { // Returns the account ID that owns the backup job. AccountId *string // Uniquely identifies a request to Backup to back up a resource. BackupJobId *string // Represents the options specified as part of backup plan or on-demand backup job. BackupOptions map[string]string // The size, in bytes, of a backup. BackupSizeInBytes *int64 // Represents the actual backup type selected for a backup job. For example, if a // successful Windows Volume Shadow Copy Service (VSS) backup was taken, BackupType // returns "WindowsVSS". If BackupType is empty, then the backup type was a regular // backup. BackupType *string // An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for // example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault. BackupVaultArn *string // The name of a logical container where backups are stored. Backup vaults are // identified by names that are unique to the account used to create them and the // Amazon Web Services Region where they are created. They consist of lowercase // letters, numbers, and hyphens. BackupVaultName *string // The size in bytes transferred to a backup vault at the time that the job status // was queried. BytesTransferred *int64 // The date and time that a job to create a backup job is completed, in Unix format // and Coordinated Universal Time (UTC). The value of CompletionDate is accurate to // milliseconds. For example, the value 1516925490.087 represents Friday, January // 26, 2018 12:11:30.087 AM. CompletionDate *time.Time // Contains identifying information about the creation of a backup job, including // the BackupPlanArn, BackupPlanId, BackupPlanVersion, and BackupRuleId of the // backup plan that is used to create it. CreatedBy *types.RecoveryPointCreator // The date and time that a backup job is created, in Unix format and Coordinated // Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For // example, the value 1516925490.087 represents Friday, January 26, 2018 // 12:11:30.087 AM. CreationDate *time.Time // The date and time that a job to back up resources is expected to be completed, // in Unix format and Coordinated Universal Time (UTC). The value of // ExpectedCompletionDate is accurate to milliseconds. For example, the value // 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM. ExpectedCompletionDate *time.Time // Specifies the IAM role ARN used to create the target recovery point; for // example, arn:aws:iam::123456789012:role/S3Access. IamRoleArn *string // Contains an estimated percentage that is complete of a job at the time the job // status was queried. PercentDone *string // An ARN that uniquely identifies a recovery point; for example, // arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45. RecoveryPointArn *string // An ARN that uniquely identifies a saved resource. The format of the ARN depends // on the resource type. ResourceArn *string // The type of Amazon Web Services resource to be backed up; for example, an Amazon // Elastic Block Store (Amazon EBS) volume or an Amazon Relational Database Service // (Amazon RDS) database. ResourceType *string // Specifies the time in Unix format and Coordinated Universal Time (UTC) when a // backup job must be started before it is canceled. The value is calculated by // adding the start window to the scheduled time. So if the scheduled time were // 6:00 PM and the start window is 2 hours, the StartBy time would be 8:00 PM on // the date specified. The value of StartBy is accurate to milliseconds. For // example, the value 1516925490.087 represents Friday, January 26, 2018 // 12:11:30.087 AM. StartBy *time.Time // The current state of a resource recovery point. State types.BackupJobState // A detailed message explaining the status of the job to back up a resource. StatusMessage *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DescribeBackupVaultInput ¶
type DescribeBackupVaultInput struct { // The name of a logical container where backups are stored. Backup vaults are // identified by names that are unique to the account used to create them and the // Amazon Web Services Region where they are created. They consist of lowercase // letters, numbers, and hyphens. // // This member is required. BackupVaultName *string // contains filtered or unexported fields }
type DescribeBackupVaultOutput ¶
type DescribeBackupVaultOutput struct { // An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for // example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault. BackupVaultArn *string // The name of a logical container where backups are stored. Backup vaults are // identified by names that are unique to the account used to create them and the // Region where they are created. They consist of lowercase letters, numbers, and // hyphens. BackupVaultName *string // The date and time that a backup vault is created, in Unix format and Coordinated // Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For // example, the value 1516925490.087 represents Friday, January 26, 2018 // 12:11:30.087 AM. CreationDate *time.Time // A unique string that identifies the request and allows failed requests to be // retried without the risk of running the operation twice. CreatorRequestId *string // The server-side encryption key that is used to protect your backups; for // example, // arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab. EncryptionKeyArn *string // The date and time when Backup Vault Lock configuration cannot be changed or // deleted. If you applied Vault Lock to your vault without specifying a lock date, // you can change any of your Vault Lock settings, or delete Vault Lock from the // vault entirely, at any time. This value is in Unix format, Coordinated Universal // Time (UTC), and accurate to milliseconds. For example, the value 1516925490.087 // represents Friday, January 26, 2018 12:11:30.087 AM. LockDate *time.Time // A Boolean that indicates whether Backup Vault Lock is currently protecting the // backup vault. True means that Vault Lock causes delete or update operations on // the recovery points stored in the vault to fail. Locked *bool // The Backup Vault Lock setting that specifies the maximum retention period that // the vault retains its recovery points. If this parameter is not specified, Vault // Lock does not enforce a maximum retention period on the recovery points in the // vault (allowing indefinite storage). If specified, any backup or copy job to the // vault must have a lifecycle policy with a retention period equal to or shorter // than the maximum retention period. If the job's retention period is longer than // that maximum retention period, then the vault fails the backup or copy job, and // you should either modify your lifecycle settings or use a different vault. // Recovery points already stored in the vault prior to Vault Lock are not // affected. MaxRetentionDays *int64 // The Backup Vault Lock setting that specifies the minimum retention period that // the vault retains its recovery points. If this parameter is not specified, Vault // Lock does not enforce a minimum retention period. If specified, any backup or // copy job to the vault must have a lifecycle policy with a retention period equal // to or longer than the minimum retention period. If the job's retention period is // shorter than that minimum retention period, then the vault fails the backup or // copy job, and you should either modify your lifecycle settings or use a // different vault. Recovery points already stored in the vault prior to Vault Lock // are not affected. MinRetentionDays *int64 // The number of recovery points that are stored in a backup vault. NumberOfRecoveryPoints int64 // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DescribeCopyJobInput ¶
type DescribeCopyJobInput struct { // Uniquely identifies a copy job. // // This member is required. CopyJobId *string // contains filtered or unexported fields }
type DescribeCopyJobOutput ¶
type DescribeCopyJobOutput struct { // Contains detailed information about a copy job. CopyJob *types.CopyJob // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DescribeFrameworkInput ¶ added in v1.5.0
type DescribeFrameworkInput struct { // The unique name of a framework. // // This member is required. FrameworkName *string // contains filtered or unexported fields }
type DescribeFrameworkOutput ¶ added in v1.5.0
type DescribeFrameworkOutput struct { // The date and time that a framework is created, in Unix format and Coordinated // Universal Time (UTC). The value of CreationTime is accurate to milliseconds. For // example, the value 1516925490.087 represents Friday, January 26, 2018 // 12:11:30.087 AM. CreationTime *time.Time // The deployment status of a framework. The statuses are: CREATE_IN_PROGRESS | // UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED | FAILED DeploymentStatus *string // An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of // the ARN depends on the resource type. FrameworkArn *string // A list of the controls that make up the framework. Each control in the list has // a name, input parameters, and scope. FrameworkControls []types.FrameworkControl // An optional description of the framework. FrameworkDescription *string // The unique name of a framework. FrameworkName *string // A framework consists of one or more controls. Each control governs a resource, // such as backup plans, backup selections, backup vaults, or recovery points. You // can also turn Config recording on or off for each resource. The statuses are: // // * // ACTIVE when recording is turned on for all resources governed by the // framework. // // * PARTIALLY_ACTIVE when recording is turned off for at least one // resource governed by the framework. // // * INACTIVE when recording is turned off for // all resources governed by the framework. // // * UNAVAILABLE when Backup is unable to // validate recording status at this time. FrameworkStatus *string // A customer-chosen string that you can use to distinguish between otherwise // identical calls to DescribeFrameworkOutput. Retrying a successful request with // the same idempotency token results in a success message with no action taken. IdempotencyToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DescribeGlobalSettingsInput ¶ added in v0.30.0
type DescribeGlobalSettingsInput struct {
// contains filtered or unexported fields
}
type DescribeGlobalSettingsOutput ¶ added in v0.30.0
type DescribeGlobalSettingsOutput struct { // The status of the flag isCrossAccountBackupEnabled. GlobalSettings map[string]string // The date and time that the flag isCrossAccountBackupEnabled was last updated. // This update is in Unix format and Coordinated Universal Time (UTC). The value of // LastUpdateTime is accurate to milliseconds. For example, the value // 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM. LastUpdateTime *time.Time // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DescribeProtectedResourceInput ¶
type DescribeProtectedResourceInput struct { // An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of // the ARN depends on the resource type. // // This member is required. ResourceArn *string // contains filtered or unexported fields }
type DescribeProtectedResourceOutput ¶
type DescribeProtectedResourceOutput struct { // The date and time that a resource was last backed up, in Unix format and // Coordinated Universal Time (UTC). The value of LastBackupTime is accurate to // milliseconds. For example, the value 1516925490.087 represents Friday, January // 26, 2018 12:11:30.087 AM. LastBackupTime *time.Time // An ARN that uniquely identifies a resource. The format of the ARN depends on the // resource type. ResourceArn *string // The type of Amazon Web Services resource saved as a recovery point; for example, // an Amazon EBS volume or an Amazon RDS database. ResourceType *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DescribeRecoveryPointInput ¶
type DescribeRecoveryPointInput struct { // The name of a logical container where backups are stored. Backup vaults are // identified by names that are unique to the account used to create them and the // Amazon Web Services Region where they are created. They consist of lowercase // letters, numbers, and hyphens. // // This member is required. BackupVaultName *string // An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for // example, // arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45. // // This member is required. RecoveryPointArn *string // contains filtered or unexported fields }
type DescribeRecoveryPointOutput ¶
type DescribeRecoveryPointOutput struct { // The size, in bytes, of a backup. BackupSizeInBytes *int64 // An ARN that uniquely identifies a backup vault; for example, // arn:aws:backup:us-east-1:123456789012:vault:aBackupVault. BackupVaultArn *string // The name of a logical container where backups are stored. Backup vaults are // identified by names that are unique to the account used to create them and the // Region where they are created. They consist of lowercase letters, numbers, and // hyphens. BackupVaultName *string // A CalculatedLifecycle object containing DeleteAt and MoveToColdStorageAt // timestamps. CalculatedLifecycle *types.CalculatedLifecycle // The date and time that a job to create a recovery point is completed, in Unix // format and Coordinated Universal Time (UTC). The value of CompletionDate is // accurate to milliseconds. For example, the value 1516925490.087 represents // Friday, January 26, 2018 12:11:30.087 AM. CompletionDate *time.Time // Contains identifying information about the creation of a recovery point, // including the BackupPlanArn, BackupPlanId, BackupPlanVersion, and BackupRuleId // of the backup plan used to create it. CreatedBy *types.RecoveryPointCreator // The date and time that a recovery point is created, in Unix format and // Coordinated Universal Time (UTC). The value of CreationDate is accurate to // milliseconds. For example, the value 1516925490.087 represents Friday, January // 26, 2018 12:11:30.087 AM. CreationDate *time.Time // The server-side encryption key used to protect your backups; for example, // arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab. EncryptionKeyArn *string // Specifies the IAM role ARN used to create the target recovery point; for // example, arn:aws:iam::123456789012:role/S3Access. IamRoleArn *string // A Boolean value that is returned as TRUE if the specified recovery point is // encrypted, or FALSE if the recovery point is not encrypted. IsEncrypted bool // The date and time that a recovery point was last restored, in Unix format and // Coordinated Universal Time (UTC). The value of LastRestoreTime is accurate to // milliseconds. For example, the value 1516925490.087 represents Friday, January // 26, 2018 12:11:30.087 AM. LastRestoreTime *time.Time // The lifecycle defines when a protected resource is transitioned to cold storage // and when it expires. Backup transitions and expires backups automatically // according to the lifecycle that you define. Backups that are transitioned to // cold storage must be stored in cold storage for a minimum of 90 days. Therefore, // the “retention” setting must be 90 days greater than the “transition to cold // after days” setting. The “transition to cold after days” setting cannot be // changed after a backup has been transitioned to cold. Resource types that are // able to be transitioned to cold storage are listed in the "Lifecycle to cold // storage" section of the Feature availability by resource // (https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#features-by-resource) // table. Backup ignores this expression for other resource types. Lifecycle *types.Lifecycle // An ARN that uniquely identifies a recovery point; for example, // arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45. RecoveryPointArn *string // An ARN that uniquely identifies a saved resource. The format of the ARN depends // on the resource type. ResourceArn *string // The type of Amazon Web Services resource to save as a recovery point; for // example, an Amazon Elastic Block Store (Amazon EBS) volume or an Amazon // Relational Database Service (Amazon RDS) database. ResourceType *string // An Amazon Resource Name (ARN) that uniquely identifies the source vault where // the resource was originally backed up in; for example, // arn:aws:backup:us-east-1:123456789012:vault:BackupVault. If the recovery is // restored to the same Amazon Web Services account or Region, this value will be // null. SourceBackupVaultArn *string // A status code specifying the state of the recovery point. PARTIAL status // indicates Backup could not create the recovery point before the backup window // closed. To increase your backup plan window using the API, see UpdateBackupPlan // (https://docs.aws.amazon.com/aws-backup/latest/devguide/API_UpdateBackupPlan.html). // You can also increase your backup plan window using the Console by choosing and // editing your backup plan. EXPIRED status indicates that the recovery point has // exceeded its retention period, but Backup lacks permission or is otherwise // unable to delete it. To manually delete these recovery points, see Step 3: // Delete the recovery points // (https://docs.aws.amazon.com/aws-backup/latest/devguide/gs-cleanup-resources.html#cleanup-backups) // in the Clean up resources section of Getting started. Status types.RecoveryPointStatus // A status message explaining the reason for the recovery point deletion failure. StatusMessage *string // Specifies the storage class of the recovery point. Valid values are WARM or // COLD. StorageClass types.StorageClass // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DescribeRegionSettingsInput ¶
type DescribeRegionSettingsInput struct {
// contains filtered or unexported fields
}
type DescribeRegionSettingsOutput ¶
type DescribeRegionSettingsOutput struct { // Returns whether Backup fully manages the backups for a resource type. For the // benefits of full Backup management, see Full Backup management // (https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#full-management). // For a list of resource types and whether each supports full Backup management, // see the Feature availability by resource // (https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#features-by-resource) // table. If "DynamoDB":false, you can enable full Backup management for DynamoDB // backup by enabling Backup's advanced DynamoDB backup features // (https://docs.aws.amazon.com/aws-backup/latest/devguide/advanced-ddb-backup.html#advanced-ddb-backup-enable-cli). ResourceTypeManagementPreference map[string]bool // Returns a list of all services along with the opt-in preferences in the Region. ResourceTypeOptInPreference map[string]bool // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DescribeReportJobInput ¶ added in v1.5.0
type DescribeReportJobInput struct { // The identifier of the report job. A unique, randomly generated, Unicode, UTF-8 // encoded string that is at most 1,024 bytes long. The report job ID cannot be // edited. // // This member is required. ReportJobId *string // contains filtered or unexported fields }
type DescribeReportJobOutput ¶ added in v1.5.0
type DescribeReportJobOutput struct { // A list of information about a report job, including its completion and creation // times, report destination, unique report job ID, Amazon Resource Name (ARN), // report template, status, and status message. ReportJob *types.ReportJob // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DescribeReportPlanInput ¶ added in v1.5.0
type DescribeReportPlanInput struct { // The unique name of a report plan. // // This member is required. ReportPlanName *string // contains filtered or unexported fields }
type DescribeReportPlanOutput ¶ added in v1.5.0
type DescribeReportPlanOutput struct { // Returns details about the report plan that is specified by its name. These // details include the report plan's Amazon Resource Name (ARN), description, // settings, delivery channel, deployment status, creation time, and last attempted // and successful run times. ReportPlan *types.ReportPlan // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DescribeRestoreJobInput ¶
type DescribeRestoreJobInput struct { // Uniquely identifies the job that restores a recovery point. // // This member is required. RestoreJobId *string // contains filtered or unexported fields }
type DescribeRestoreJobOutput ¶
type DescribeRestoreJobOutput struct { // Returns the account ID that owns the restore job. AccountId *string // The size, in bytes, of the restored resource. BackupSizeInBytes *int64 // The date and time that a job to restore a recovery point is completed, in Unix // format and Coordinated Universal Time (UTC). The value of CompletionDate is // accurate to milliseconds. For example, the value 1516925490.087 represents // Friday, January 26, 2018 12:11:30.087 AM. CompletionDate *time.Time // An Amazon Resource Name (ARN) that uniquely identifies a resource whose recovery // point is being restored. The format of the ARN depends on the resource type of // the backed-up resource. CreatedResourceArn *string // The date and time that a restore job is created, in Unix format and Coordinated // Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For // example, the value 1516925490.087 represents Friday, January 26, 2018 // 12:11:30.087 AM. CreationDate *time.Time // The amount of time in minutes that a job restoring a recovery point is expected // to take. ExpectedCompletionTimeMinutes *int64 // Specifies the IAM role ARN used to create the target recovery point; for // example, arn:aws:iam::123456789012:role/S3Access. IamRoleArn *string // Contains an estimated percentage that is complete of a job at the time the job // status was queried. PercentDone *string // An ARN that uniquely identifies a recovery point; for example, // arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45. RecoveryPointArn *string // Returns metadata associated with a restore job listed by resource type. ResourceType *string // Uniquely identifies the job that restores a recovery point. RestoreJobId *string // Status code specifying the state of the job that is initiated by Backup to // restore a recovery point. Status types.RestoreJobStatus // A message showing the status of a job to restore a recovery point. StatusMessage *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DisassociateRecoveryPointInput ¶ added in v1.2.0
type DisassociateRecoveryPointInput struct { // The unique name of an Backup vault. // // This member is required. BackupVaultName *string // An Amazon Resource Name (ARN) that uniquely identifies an Backup recovery point. // // This member is required. RecoveryPointArn *string // contains filtered or unexported fields }
type DisassociateRecoveryPointOutput ¶ added in v1.2.0
type DisassociateRecoveryPointOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type EndpointResolver ¶
type EndpointResolver interface {
ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
}
EndpointResolver interface for resolving service endpoints.
func EndpointResolverFromURL ¶ added in v1.1.0
func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver
EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.
type EndpointResolverFunc ¶
type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)
EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.
func (EndpointResolverFunc) ResolveEndpoint ¶
func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)
type EndpointResolverOptions ¶ added in v0.29.0
type EndpointResolverOptions = internalendpoints.Options
EndpointResolverOptions is the service endpoint resolver options
type ExportBackupPlanTemplateInput ¶
type ExportBackupPlanTemplateInput struct { // Uniquely identifies a backup plan. // // This member is required. BackupPlanId *string // contains filtered or unexported fields }
type ExportBackupPlanTemplateOutput ¶
type ExportBackupPlanTemplateOutput struct { // The body of a backup plan template in JSON format. This is a signed JSON // document that cannot be modified before being passed to GetBackupPlanFromJSON. BackupPlanTemplateJson *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type GetBackupPlanFromJSONInput ¶
type GetBackupPlanFromJSONInput struct { // A customer-supplied backup plan document in JSON format. // // This member is required. BackupPlanTemplateJson *string // contains filtered or unexported fields }
type GetBackupPlanFromJSONOutput ¶
type GetBackupPlanFromJSONOutput struct { // Specifies the body of a backup plan. Includes a BackupPlanName and one or more // sets of Rules. BackupPlan *types.BackupPlan // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type GetBackupPlanFromTemplateInput ¶
type GetBackupPlanFromTemplateInput struct { // Uniquely identifies a stored backup plan template. // // This member is required. BackupPlanTemplateId *string // contains filtered or unexported fields }
type GetBackupPlanFromTemplateOutput ¶
type GetBackupPlanFromTemplateOutput struct { // Returns the body of a backup plan based on the target template, including the // name, rules, and backup vault of the plan. BackupPlanDocument *types.BackupPlan // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type GetBackupPlanInput ¶
type GetBackupPlanInput struct { // Uniquely identifies a backup plan. // // This member is required. BackupPlanId *string // Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most // 1,024 bytes long. Version IDs cannot be edited. VersionId *string // contains filtered or unexported fields }
type GetBackupPlanOutput ¶
type GetBackupPlanOutput struct { // Contains a list of BackupOptions for each resource type. The list is populated // only if the advanced option is set for the backup plan. AdvancedBackupSettings []types.AdvancedBackupSetting // Specifies the body of a backup plan. Includes a BackupPlanName and one or more // sets of Rules. BackupPlan *types.BackupPlan // An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for // example, // arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50. BackupPlanArn *string // Uniquely identifies a backup plan. BackupPlanId *string // The date and time that a backup plan is created, in Unix format and Coordinated // Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For // example, the value 1516925490.087 represents Friday, January 26, 2018 // 12:11:30.087 AM. CreationDate *time.Time // A unique string that identifies the request and allows failed requests to be // retried without the risk of running the operation twice. CreatorRequestId *string // The date and time that a backup plan is deleted, in Unix format and Coordinated // Universal Time (UTC). The value of DeletionDate is accurate to milliseconds. For // example, the value 1516925490.087 represents Friday, January 26, 2018 // 12:11:30.087 AM. DeletionDate *time.Time // The last time a job to back up resources was run with this backup plan. A date // and time, in Unix format and Coordinated Universal Time (UTC). The value of // LastExecutionDate is accurate to milliseconds. For example, the value // 1516925490.087 represents Friday, January 26, 2018 12:11:30.087 AM. LastExecutionDate *time.Time // Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most // 1,024 bytes long. Version IDs cannot be edited. VersionId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type GetBackupSelectionInput ¶
type GetBackupSelectionInput struct { // Uniquely identifies a backup plan. // // This member is required. BackupPlanId *string // Uniquely identifies the body of a request to assign a set of resources to a // backup plan. // // This member is required. SelectionId *string // contains filtered or unexported fields }
type GetBackupSelectionOutput ¶
type GetBackupSelectionOutput struct { // Uniquely identifies a backup plan. BackupPlanId *string // Specifies the body of a request to assign a set of resources to a backup plan. BackupSelection *types.BackupSelection // The date and time a backup selection is created, in Unix format and Coordinated // Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For // example, the value 1516925490.087 represents Friday, January 26, 2018 // 12:11:30.087 AM. CreationDate *time.Time // A unique string that identifies the request and allows failed requests to be // retried without the risk of running the operation twice. CreatorRequestId *string // Uniquely identifies the body of a request to assign a set of resources to a // backup plan. SelectionId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type GetBackupVaultAccessPolicyInput ¶
type GetBackupVaultAccessPolicyInput struct { // The name of a logical container where backups are stored. Backup vaults are // identified by names that are unique to the account used to create them and the // Amazon Web Services Region where they are created. They consist of lowercase // letters, numbers, and hyphens. // // This member is required. BackupVaultName *string // contains filtered or unexported fields }
type GetBackupVaultAccessPolicyOutput ¶
type GetBackupVaultAccessPolicyOutput struct { // An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for // example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault. BackupVaultArn *string // The name of a logical container where backups are stored. Backup vaults are // identified by names that are unique to the account used to create them and the // Region where they are created. They consist of lowercase letters, numbers, and // hyphens. BackupVaultName *string // The backup vault access policy document in JSON format. Policy *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type GetBackupVaultNotificationsInput ¶
type GetBackupVaultNotificationsInput struct { // The name of a logical container where backups are stored. Backup vaults are // identified by names that are unique to the account used to create them and the // Amazon Web Services Region where they are created. They consist of lowercase // letters, numbers, and hyphens. // // This member is required. BackupVaultName *string // contains filtered or unexported fields }
type GetBackupVaultNotificationsOutput ¶
type GetBackupVaultNotificationsOutput struct { // An Amazon Resource Name (ARN) that uniquely identifies a backup vault; for // example, arn:aws:backup:us-east-1:123456789012:vault:aBackupVault. BackupVaultArn *string // An array of events that indicate the status of jobs to back up resources to the // backup vault. BackupVaultEvents []types.BackupVaultEvent // The name of a logical container where backups are stored. Backup vaults are // identified by names that are unique to the account used to create them and the // Region where they are created. They consist of lowercase letters, numbers, and // hyphens. BackupVaultName *string // An ARN that uniquely identifies an Amazon Simple Notification Service (Amazon // SNS) topic; for example, arn:aws:sns:us-west-2:111122223333:MyTopic. SNSTopicArn *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type GetRecoveryPointRestoreMetadataInput ¶
type GetRecoveryPointRestoreMetadataInput struct { // The name of a logical container where backups are stored. Backup vaults are // identified by names that are unique to the account used to create them and the // Amazon Web Services Region where they are created. They consist of lowercase // letters, numbers, and hyphens. // // This member is required. BackupVaultName *string // An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for // example, // arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45. // // This member is required. RecoveryPointArn *string // contains filtered or unexported fields }
type GetRecoveryPointRestoreMetadataOutput ¶
type GetRecoveryPointRestoreMetadataOutput struct { // An ARN that uniquely identifies a backup vault; for example, // arn:aws:backup:us-east-1:123456789012:vault:aBackupVault. BackupVaultArn *string // An ARN that uniquely identifies a recovery point; for example, // arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45. RecoveryPointArn *string // The set of metadata key-value pairs that describe the original configuration of // the backed-up resource. These values vary depending on the service that is being // restored. RestoreMetadata map[string]string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type GetSupportedResourceTypesInput ¶
type GetSupportedResourceTypesInput struct {
// contains filtered or unexported fields
}
type GetSupportedResourceTypesOutput ¶
type GetSupportedResourceTypesOutput struct { // Contains a string with the supported Amazon Web Services resource types: // // * // Aurora for Amazon Aurora // // * DynamoDB for Amazon DynamoDB // // * EBS for Amazon // Elastic Block Store // // * EC2 for Amazon Elastic Compute Cloud // // * EFS for Amazon // Elastic File System // // * FSX for Amazon FSx // // * RDS for Amazon Relational Database // Service // // * Storage Gateway for Storage Gateway // // * DocDB for Amazon DocumentDB // (with MongoDB compatibility) // // * Neptune for Amazon Neptune ResourceTypes []string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type HTTPSignerV4 ¶
type IdempotencyTokenProvider ¶ added in v1.5.0
IdempotencyTokenProvider interface for providing idempotency token
type ListBackupJobsAPIClient ¶ added in v0.30.0
type ListBackupJobsAPIClient interface {
ListBackupJobs(context.Context, *ListBackupJobsInput, ...func(*Options)) (*ListBackupJobsOutput, error)
}
ListBackupJobsAPIClient is a client that implements the ListBackupJobs operation.
type ListBackupJobsInput ¶
type ListBackupJobsInput struct { // The account ID to list the jobs from. Returns only backup jobs associated with // the specified account ID. If used from an Organizations management account, // passing * returns all jobs across the organization. ByAccountId *string // Returns only backup jobs that will be stored in the specified backup vault. // Backup vaults are identified by names that are unique to the account used to // create them and the Amazon Web Services Region where they are created. They // consist of lowercase letters, numbers, and hyphens. ByBackupVaultName *string // Returns only backup jobs completed after a date expressed in Unix format and // Coordinated Universal Time (UTC). ByCompleteAfter *time.Time // Returns only backup jobs completed before a date expressed in Unix format and // Coordinated Universal Time (UTC). ByCompleteBefore *time.Time // Returns only backup jobs that were created after the specified date. ByCreatedAfter *time.Time // Returns only backup jobs that were created before the specified date. ByCreatedBefore *time.Time // Returns only backup jobs that match the specified resource Amazon Resource Name // (ARN). ByResourceArn *string // Returns only backup jobs for the specified resources: // // * Aurora for Amazon // Aurora // // * DocumentDB for Amazon DocumentDB (with MongoDB compatibility) // // * // DynamoDB for Amazon DynamoDB // // * EBS for Amazon Elastic Block Store // // * EC2 for // Amazon Elastic Compute Cloud // // * EFS for Amazon Elastic File System // // * FSx for // Amazon FSx // // * Neptune for Amazon Neptune // // * RDS for Amazon Relational Database // Service // // * Storage Gateway for Storage Gateway // // * S3 for Amazon S3 // // * // VirtualMachine for virtual machines ByResourceType *string // Returns only backup jobs that are in the specified state. ByState types.BackupJobState // The maximum number of items to be returned. MaxResults *int32 // The next item following a partial list of returned items. For example, if a // request is made to return maxResults number of items, NextToken allows you to // return more items in your list starting at the location pointed to by the next // token. NextToken *string // contains filtered or unexported fields }
type ListBackupJobsOutput ¶
type ListBackupJobsOutput struct { // An array of structures containing metadata about your backup jobs returned in // JSON format. BackupJobs []types.BackupJob // The next item following a partial list of returned items. For example, if a // request is made to return maxResults number of items, NextToken allows you to // return more items in your list starting at the location pointed to by the next // token. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListBackupJobsPaginator ¶ added in v0.30.0
type ListBackupJobsPaginator struct {
// contains filtered or unexported fields
}
ListBackupJobsPaginator is a paginator for ListBackupJobs
func NewListBackupJobsPaginator ¶ added in v0.30.0
func NewListBackupJobsPaginator(client ListBackupJobsAPIClient, params *ListBackupJobsInput, optFns ...func(*ListBackupJobsPaginatorOptions)) *ListBackupJobsPaginator
NewListBackupJobsPaginator returns a new ListBackupJobsPaginator
func (*ListBackupJobsPaginator) HasMorePages ¶ added in v0.30.0
func (p *ListBackupJobsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListBackupJobsPaginator) NextPage ¶ added in v0.30.0
func (p *ListBackupJobsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListBackupJobsOutput, error)
NextPage retrieves the next ListBackupJobs page.
type ListBackupJobsPaginatorOptions ¶ added in v0.30.0
type ListBackupJobsPaginatorOptions struct { // The maximum number of items to be returned. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListBackupJobsPaginatorOptions is the paginator options for ListBackupJobs
type ListBackupPlanTemplatesAPIClient ¶ added in v0.30.0
type ListBackupPlanTemplatesAPIClient interface {
ListBackupPlanTemplates(context.Context, *ListBackupPlanTemplatesInput, ...func(*Options)) (*ListBackupPlanTemplatesOutput, error)
}
ListBackupPlanTemplatesAPIClient is a client that implements the ListBackupPlanTemplates operation.
type ListBackupPlanTemplatesInput ¶
type ListBackupPlanTemplatesInput struct { // The maximum number of items to be returned. MaxResults *int32 // The next item following a partial list of returned items. For example, if a // request is made to return maxResults number of items, NextToken allows you to // return more items in your list starting at the location pointed to by the next // token. NextToken *string // contains filtered or unexported fields }
type ListBackupPlanTemplatesOutput ¶
type ListBackupPlanTemplatesOutput struct { // An array of template list items containing metadata about your saved templates. BackupPlanTemplatesList []types.BackupPlanTemplatesListMember // The next item following a partial list of returned items. For example, if a // request is made to return maxResults number of items, NextToken allows you to // return more items in your list starting at the location pointed to by the next // token. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListBackupPlanTemplatesPaginator ¶ added in v0.30.0
type ListBackupPlanTemplatesPaginator struct {
// contains filtered or unexported fields
}
ListBackupPlanTemplatesPaginator is a paginator for ListBackupPlanTemplates
func NewListBackupPlanTemplatesPaginator ¶ added in v0.30.0
func NewListBackupPlanTemplatesPaginator(client ListBackupPlanTemplatesAPIClient, params *ListBackupPlanTemplatesInput, optFns ...func(*ListBackupPlanTemplatesPaginatorOptions)) *ListBackupPlanTemplatesPaginator
NewListBackupPlanTemplatesPaginator returns a new ListBackupPlanTemplatesPaginator
func (*ListBackupPlanTemplatesPaginator) HasMorePages ¶ added in v0.30.0
func (p *ListBackupPlanTemplatesPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListBackupPlanTemplatesPaginator) NextPage ¶ added in v0.30.0
func (p *ListBackupPlanTemplatesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListBackupPlanTemplatesOutput, error)
NextPage retrieves the next ListBackupPlanTemplates page.
type ListBackupPlanTemplatesPaginatorOptions ¶ added in v0.30.0
type ListBackupPlanTemplatesPaginatorOptions struct { // The maximum number of items to be returned. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListBackupPlanTemplatesPaginatorOptions is the paginator options for ListBackupPlanTemplates
type ListBackupPlanVersionsAPIClient ¶ added in v0.30.0
type ListBackupPlanVersionsAPIClient interface {
ListBackupPlanVersions(context.Context, *ListBackupPlanVersionsInput, ...func(*Options)) (*ListBackupPlanVersionsOutput, error)
}
ListBackupPlanVersionsAPIClient is a client that implements the ListBackupPlanVersions operation.
type ListBackupPlanVersionsInput ¶
type ListBackupPlanVersionsInput struct { // Uniquely identifies a backup plan. // // This member is required. BackupPlanId *string // The maximum number of items to be returned. MaxResults *int32 // The next item following a partial list of returned items. For example, if a // request is made to return maxResults number of items, NextToken allows you to // return more items in your list starting at the location pointed to by the next // token. NextToken *string // contains filtered or unexported fields }
type ListBackupPlanVersionsOutput ¶
type ListBackupPlanVersionsOutput struct { // An array of version list items containing metadata about your backup plans. BackupPlanVersionsList []types.BackupPlansListMember // The next item following a partial list of returned items. For example, if a // request is made to return maxResults number of items, NextToken allows you to // return more items in your list starting at the location pointed to by the next // token. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListBackupPlanVersionsPaginator ¶ added in v0.30.0
type ListBackupPlanVersionsPaginator struct {
// contains filtered or unexported fields
}
ListBackupPlanVersionsPaginator is a paginator for ListBackupPlanVersions
func NewListBackupPlanVersionsPaginator ¶ added in v0.30.0
func NewListBackupPlanVersionsPaginator(client ListBackupPlanVersionsAPIClient, params *ListBackupPlanVersionsInput, optFns ...func(*ListBackupPlanVersionsPaginatorOptions)) *ListBackupPlanVersionsPaginator
NewListBackupPlanVersionsPaginator returns a new ListBackupPlanVersionsPaginator
func (*ListBackupPlanVersionsPaginator) HasMorePages ¶ added in v0.30.0
func (p *ListBackupPlanVersionsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListBackupPlanVersionsPaginator) NextPage ¶ added in v0.30.0
func (p *ListBackupPlanVersionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListBackupPlanVersionsOutput, error)
NextPage retrieves the next ListBackupPlanVersions page.
type ListBackupPlanVersionsPaginatorOptions ¶ added in v0.30.0
type ListBackupPlanVersionsPaginatorOptions struct { // The maximum number of items to be returned. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListBackupPlanVersionsPaginatorOptions is the paginator options for ListBackupPlanVersions
type ListBackupPlansAPIClient ¶ added in v0.30.0
type ListBackupPlansAPIClient interface {
ListBackupPlans(context.Context, *ListBackupPlansInput, ...func(*Options)) (*ListBackupPlansOutput, error)
}
ListBackupPlansAPIClient is a client that implements the ListBackupPlans operation.
type ListBackupPlansInput ¶
type ListBackupPlansInput struct { // A Boolean value with a default value of FALSE that returns deleted backup plans // when set to TRUE. IncludeDeleted *bool // The maximum number of items to be returned. MaxResults *int32 // The next item following a partial list of returned items. For example, if a // request is made to return maxResults number of items, NextToken allows you to // return more items in your list starting at the location pointed to by the next // token. NextToken *string // contains filtered or unexported fields }
type ListBackupPlansOutput ¶
type ListBackupPlansOutput struct { // An array of backup plan list items containing metadata about your saved backup // plans. BackupPlansList []types.BackupPlansListMember // The next item following a partial list of returned items. For example, if a // request is made to return maxResults number of items, NextToken allows you to // return more items in your list starting at the location pointed to by the next // token. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListBackupPlansPaginator ¶ added in v0.30.0
type ListBackupPlansPaginator struct {
// contains filtered or unexported fields
}
ListBackupPlansPaginator is a paginator for ListBackupPlans
func NewListBackupPlansPaginator ¶ added in v0.30.0
func NewListBackupPlansPaginator(client ListBackupPlansAPIClient, params *ListBackupPlansInput, optFns ...func(*ListBackupPlansPaginatorOptions)) *ListBackupPlansPaginator
NewListBackupPlansPaginator returns a new ListBackupPlansPaginator
func (*ListBackupPlansPaginator) HasMorePages ¶ added in v0.30.0
func (p *ListBackupPlansPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListBackupPlansPaginator) NextPage ¶ added in v0.30.0
func (p *ListBackupPlansPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListBackupPlansOutput, error)
NextPage retrieves the next ListBackupPlans page.
type ListBackupPlansPaginatorOptions ¶ added in v0.30.0
type ListBackupPlansPaginatorOptions struct { // The maximum number of items to be returned. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListBackupPlansPaginatorOptions is the paginator options for ListBackupPlans
type ListBackupSelectionsAPIClient ¶ added in v0.30.0
type ListBackupSelectionsAPIClient interface {
ListBackupSelections(context.Context, *ListBackupSelectionsInput, ...func(*Options)) (*ListBackupSelectionsOutput, error)
}
ListBackupSelectionsAPIClient is a client that implements the ListBackupSelections operation.
type ListBackupSelectionsInput ¶
type ListBackupSelectionsInput struct { // Uniquely identifies a backup plan. // // This member is required. BackupPlanId *string // The maximum number of items to be returned. MaxResults *int32 // The next item following a partial list of returned items. For example, if a // request is made to return maxResults number of items, NextToken allows you to // return more items in your list starting at the location pointed to by the next // token. NextToken *string // contains filtered or unexported fields }
type ListBackupSelectionsOutput ¶
type ListBackupSelectionsOutput struct { // An array of backup selection list items containing metadata about each resource // in the list. BackupSelectionsList []types.BackupSelectionsListMember // The next item following a partial list of returned items. For example, if a // request is made to return maxResults number of items, NextToken allows you to // return more items in your list starting at the location pointed to by the next // token. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListBackupSelectionsPaginator ¶ added in v0.30.0
type ListBackupSelectionsPaginator struct {
// contains filtered or unexported fields
}
ListBackupSelectionsPaginator is a paginator for ListBackupSelections
func NewListBackupSelectionsPaginator ¶ added in v0.30.0
func NewListBackupSelectionsPaginator(client ListBackupSelectionsAPIClient, params *ListBackupSelectionsInput, optFns ...func(*ListBackupSelectionsPaginatorOptions)) *ListBackupSelectionsPaginator
NewListBackupSelectionsPaginator returns a new ListBackupSelectionsPaginator
func (*ListBackupSelectionsPaginator) HasMorePages ¶ added in v0.30.0
func (p *ListBackupSelectionsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListBackupSelectionsPaginator) NextPage ¶ added in v0.30.0
func (p *ListBackupSelectionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListBackupSelectionsOutput, error)
NextPage retrieves the next ListBackupSelections page.
type ListBackupSelectionsPaginatorOptions ¶ added in v0.30.0
type ListBackupSelectionsPaginatorOptions struct { // The maximum number of items to be returned. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListBackupSelectionsPaginatorOptions is the paginator options for ListBackupSelections
type ListBackupVaultsAPIClient ¶ added in v0.30.0
type ListBackupVaultsAPIClient interface {
ListBackupVaults(context.Context, *ListBackupVaultsInput, ...func(*Options)) (*ListBackupVaultsOutput, error)
}
ListBackupVaultsAPIClient is a client that implements the ListBackupVaults operation.
type ListBackupVaultsInput ¶
type ListBackupVaultsInput struct { // The maximum number of items to be returned. MaxResults *int32 // The next item following a partial list of returned items. For example, if a // request is made to return maxResults number of items, NextToken allows you to // return more items in your list starting at the location pointed to by the next // token. NextToken *string // contains filtered or unexported fields }
type ListBackupVaultsOutput ¶
type ListBackupVaultsOutput struct { // An array of backup vault list members containing vault metadata, including // Amazon Resource Name (ARN), display name, creation date, number of saved // recovery points, and encryption information if the resources saved in the backup // vault are encrypted. BackupVaultList []types.BackupVaultListMember // The next item following a partial list of returned items. For example, if a // request is made to return maxResults number of items, NextToken allows you to // return more items in your list starting at the location pointed to by the next // token. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListBackupVaultsPaginator ¶ added in v0.30.0
type ListBackupVaultsPaginator struct {
// contains filtered or unexported fields
}
ListBackupVaultsPaginator is a paginator for ListBackupVaults
func NewListBackupVaultsPaginator ¶ added in v0.30.0
func NewListBackupVaultsPaginator(client ListBackupVaultsAPIClient, params *ListBackupVaultsInput, optFns ...func(*ListBackupVaultsPaginatorOptions)) *ListBackupVaultsPaginator
NewListBackupVaultsPaginator returns a new ListBackupVaultsPaginator
func (*ListBackupVaultsPaginator) HasMorePages ¶ added in v0.30.0
func (p *ListBackupVaultsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListBackupVaultsPaginator) NextPage ¶ added in v0.30.0
func (p *ListBackupVaultsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListBackupVaultsOutput, error)
NextPage retrieves the next ListBackupVaults page.
type ListBackupVaultsPaginatorOptions ¶ added in v0.30.0
type ListBackupVaultsPaginatorOptions struct { // The maximum number of items to be returned. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListBackupVaultsPaginatorOptions is the paginator options for ListBackupVaults
type ListCopyJobsAPIClient ¶ added in v0.30.0
type ListCopyJobsAPIClient interface {
ListCopyJobs(context.Context, *ListCopyJobsInput, ...func(*Options)) (*ListCopyJobsOutput, error)
}
ListCopyJobsAPIClient is a client that implements the ListCopyJobs operation.
type ListCopyJobsInput ¶
type ListCopyJobsInput struct { // The account ID to list the jobs from. Returns only copy jobs associated with the // specified account ID. ByAccountId *string // Returns only copy jobs completed after a date expressed in Unix format and // Coordinated Universal Time (UTC). ByCompleteAfter *time.Time // Returns only copy jobs completed before a date expressed in Unix format and // Coordinated Universal Time (UTC). ByCompleteBefore *time.Time // Returns only copy jobs that were created after the specified date. ByCreatedAfter *time.Time // Returns only copy jobs that were created before the specified date. ByCreatedBefore *time.Time // An Amazon Resource Name (ARN) that uniquely identifies a source backup vault to // copy from; for example, // arn:aws:backup:us-east-1:123456789012:vault:aBackupVault. ByDestinationVaultArn *string // Returns only copy jobs that match the specified resource Amazon Resource Name // (ARN). ByResourceArn *string // Returns only backup jobs for the specified resources: // // * Aurora for Amazon // Aurora // // * DocumentDB for Amazon DocumentDB (with MongoDB compatibility) // // * // DynamoDB for Amazon DynamoDB // // * EBS for Amazon Elastic Block Store // // * EC2 for // Amazon Elastic Compute Cloud // // * EFS for Amazon Elastic File System // // * FSx for // Amazon FSx // // * Neptune for Amazon Neptune // // * RDS for Amazon Relational Database // Service // // * Storage Gateway for Storage Gateway // // * S3 for Amazon S3 // // * // VirtualMachine for virtual machines ByResourceType *string // Returns only copy jobs that are in the specified state. ByState types.CopyJobState // The maximum number of items to be returned. MaxResults *int32 // The next item following a partial list of returned items. For example, if a // request is made to return maxResults number of items, NextToken allows you to // return more items in your list starting at the location pointed to by the next // token. NextToken *string // contains filtered or unexported fields }
type ListCopyJobsOutput ¶
type ListCopyJobsOutput struct { // An array of structures containing metadata about your copy jobs returned in JSON // format. CopyJobs []types.CopyJob // The next item following a partial list of returned items. For example, if a // request is made to return maxResults number of items, NextToken allows you to // return more items in your list starting at the location pointed to by the next // token. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListCopyJobsPaginator ¶ added in v0.30.0
type ListCopyJobsPaginator struct {
// contains filtered or unexported fields
}
ListCopyJobsPaginator is a paginator for ListCopyJobs
func NewListCopyJobsPaginator ¶ added in v0.30.0
func NewListCopyJobsPaginator(client ListCopyJobsAPIClient, params *ListCopyJobsInput, optFns ...func(*ListCopyJobsPaginatorOptions)) *ListCopyJobsPaginator
NewListCopyJobsPaginator returns a new ListCopyJobsPaginator
func (*ListCopyJobsPaginator) HasMorePages ¶ added in v0.30.0
func (p *ListCopyJobsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListCopyJobsPaginator) NextPage ¶ added in v0.30.0
func (p *ListCopyJobsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListCopyJobsOutput, error)
NextPage retrieves the next ListCopyJobs page.
type ListCopyJobsPaginatorOptions ¶ added in v0.30.0
type ListCopyJobsPaginatorOptions struct { // The maximum number of items to be returned. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListCopyJobsPaginatorOptions is the paginator options for ListCopyJobs
type ListFrameworksAPIClient ¶ added in v1.5.0
type ListFrameworksAPIClient interface {
ListFrameworks(context.Context, *ListFrameworksInput, ...func(*Options)) (*ListFrameworksOutput, error)
}
ListFrameworksAPIClient is a client that implements the ListFrameworks operation.
type ListFrameworksInput ¶ added in v1.5.0
type ListFrameworksInput struct { // The number of desired results from 1 to 1000. Optional. If unspecified, the // query will return 1 MB of data. MaxResults *int32 // An identifier that was returned from the previous call to this operation, which // can be used to return the next set of items in the list. NextToken *string // contains filtered or unexported fields }
type ListFrameworksOutput ¶ added in v1.5.0
type ListFrameworksOutput struct { // A list of frameworks with details for each framework, including the framework // name, Amazon Resource Name (ARN), description, number of controls, creation // time, and deployment status. Frameworks []types.Framework // An identifier that was returned from the previous call to this operation, which // can be used to return the next set of items in the list. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListFrameworksPaginator ¶ added in v1.5.0
type ListFrameworksPaginator struct {
// contains filtered or unexported fields
}
ListFrameworksPaginator is a paginator for ListFrameworks
func NewListFrameworksPaginator ¶ added in v1.5.0
func NewListFrameworksPaginator(client ListFrameworksAPIClient, params *ListFrameworksInput, optFns ...func(*ListFrameworksPaginatorOptions)) *ListFrameworksPaginator
NewListFrameworksPaginator returns a new ListFrameworksPaginator
func (*ListFrameworksPaginator) HasMorePages ¶ added in v1.5.0
func (p *ListFrameworksPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListFrameworksPaginator) NextPage ¶ added in v1.5.0
func (p *ListFrameworksPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListFrameworksOutput, error)
NextPage retrieves the next ListFrameworks page.
type ListFrameworksPaginatorOptions ¶ added in v1.5.0
type ListFrameworksPaginatorOptions struct { // The number of desired results from 1 to 1000. Optional. If unspecified, the // query will return 1 MB of data. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListFrameworksPaginatorOptions is the paginator options for ListFrameworks
type ListProtectedResourcesAPIClient ¶ added in v0.30.0
type ListProtectedResourcesAPIClient interface {
ListProtectedResources(context.Context, *ListProtectedResourcesInput, ...func(*Options)) (*ListProtectedResourcesOutput, error)
}
ListProtectedResourcesAPIClient is a client that implements the ListProtectedResources operation.
type ListProtectedResourcesInput ¶
type ListProtectedResourcesInput struct { // The maximum number of items to be returned. MaxResults *int32 // The next item following a partial list of returned items. For example, if a // request is made to return maxResults number of items, NextToken allows you to // return more items in your list starting at the location pointed to by the next // token. NextToken *string // contains filtered or unexported fields }
type ListProtectedResourcesOutput ¶
type ListProtectedResourcesOutput struct { // The next item following a partial list of returned items. For example, if a // request is made to return maxResults number of items, NextToken allows you to // return more items in your list starting at the location pointed to by the next // token. NextToken *string // An array of resources successfully backed up by Backup including the time the // resource was saved, an Amazon Resource Name (ARN) of the resource, and a // resource type. Results []types.ProtectedResource // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListProtectedResourcesPaginator ¶ added in v0.30.0
type ListProtectedResourcesPaginator struct {
// contains filtered or unexported fields
}
ListProtectedResourcesPaginator is a paginator for ListProtectedResources
func NewListProtectedResourcesPaginator ¶ added in v0.30.0
func NewListProtectedResourcesPaginator(client ListProtectedResourcesAPIClient, params *ListProtectedResourcesInput, optFns ...func(*ListProtectedResourcesPaginatorOptions)) *ListProtectedResourcesPaginator
NewListProtectedResourcesPaginator returns a new ListProtectedResourcesPaginator
func (*ListProtectedResourcesPaginator) HasMorePages ¶ added in v0.30.0
func (p *ListProtectedResourcesPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListProtectedResourcesPaginator) NextPage ¶ added in v0.30.0
func (p *ListProtectedResourcesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListProtectedResourcesOutput, error)
NextPage retrieves the next ListProtectedResources page.
type ListProtectedResourcesPaginatorOptions ¶ added in v0.30.0
type ListProtectedResourcesPaginatorOptions struct { // The maximum number of items to be returned. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListProtectedResourcesPaginatorOptions is the paginator options for ListProtectedResources
type ListRecoveryPointsByBackupVaultAPIClient ¶ added in v0.30.0
type ListRecoveryPointsByBackupVaultAPIClient interface {
ListRecoveryPointsByBackupVault(context.Context, *ListRecoveryPointsByBackupVaultInput, ...func(*Options)) (*ListRecoveryPointsByBackupVaultOutput, error)
}
ListRecoveryPointsByBackupVaultAPIClient is a client that implements the ListRecoveryPointsByBackupVault operation.
type ListRecoveryPointsByBackupVaultInput ¶
type ListRecoveryPointsByBackupVaultInput struct { // The name of a logical container where backups are stored. Backup vaults are // identified by names that are unique to the account used to create them and the // Amazon Web Services Region where they are created. They consist of lowercase // letters, numbers, and hyphens. Backup vault name might not be available when a // supported service creates the backup. // // This member is required. BackupVaultName *string // Returns only recovery points that match the specified backup plan ID. ByBackupPlanId *string // Returns only recovery points that were created after the specified timestamp. ByCreatedAfter *time.Time // Returns only recovery points that were created before the specified timestamp. ByCreatedBefore *time.Time // Returns only recovery points that match the specified resource Amazon Resource // Name (ARN). ByResourceArn *string // Returns only recovery points that match the specified resource type. ByResourceType *string // The maximum number of items to be returned. MaxResults *int32 // The next item following a partial list of returned items. For example, if a // request is made to return maxResults number of items, NextToken allows you to // return more items in your list starting at the location pointed to by the next // token. NextToken *string // contains filtered or unexported fields }
type ListRecoveryPointsByBackupVaultOutput ¶
type ListRecoveryPointsByBackupVaultOutput struct { // The next item following a partial list of returned items. For example, if a // request is made to return maxResults number of items, NextToken allows you to // return more items in your list starting at the location pointed to by the next // token. NextToken *string // An array of objects that contain detailed information about recovery points // saved in a backup vault. RecoveryPoints []types.RecoveryPointByBackupVault // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListRecoveryPointsByBackupVaultPaginator ¶ added in v0.30.0
type ListRecoveryPointsByBackupVaultPaginator struct {
// contains filtered or unexported fields
}
ListRecoveryPointsByBackupVaultPaginator is a paginator for ListRecoveryPointsByBackupVault
func NewListRecoveryPointsByBackupVaultPaginator ¶ added in v0.30.0
func NewListRecoveryPointsByBackupVaultPaginator(client ListRecoveryPointsByBackupVaultAPIClient, params *ListRecoveryPointsByBackupVaultInput, optFns ...func(*ListRecoveryPointsByBackupVaultPaginatorOptions)) *ListRecoveryPointsByBackupVaultPaginator
NewListRecoveryPointsByBackupVaultPaginator returns a new ListRecoveryPointsByBackupVaultPaginator
func (*ListRecoveryPointsByBackupVaultPaginator) HasMorePages ¶ added in v0.30.0
func (p *ListRecoveryPointsByBackupVaultPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListRecoveryPointsByBackupVaultPaginator) NextPage ¶ added in v0.30.0
func (p *ListRecoveryPointsByBackupVaultPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListRecoveryPointsByBackupVaultOutput, error)
NextPage retrieves the next ListRecoveryPointsByBackupVault page.
type ListRecoveryPointsByBackupVaultPaginatorOptions ¶ added in v0.30.0
type ListRecoveryPointsByBackupVaultPaginatorOptions struct { // The maximum number of items to be returned. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListRecoveryPointsByBackupVaultPaginatorOptions is the paginator options for ListRecoveryPointsByBackupVault
type ListRecoveryPointsByResourceAPIClient ¶ added in v0.30.0
type ListRecoveryPointsByResourceAPIClient interface {
ListRecoveryPointsByResource(context.Context, *ListRecoveryPointsByResourceInput, ...func(*Options)) (*ListRecoveryPointsByResourceOutput, error)
}
ListRecoveryPointsByResourceAPIClient is a client that implements the ListRecoveryPointsByResource operation.
type ListRecoveryPointsByResourceInput ¶
type ListRecoveryPointsByResourceInput struct { // An ARN that uniquely identifies a resource. The format of the ARN depends on the // resource type. // // This member is required. ResourceArn *string // The maximum number of items to be returned. Amazon RDS requires a value of at // least 20. MaxResults *int32 // The next item following a partial list of returned items. For example, if a // request is made to return maxResults number of items, NextToken allows you to // return more items in your list starting at the location pointed to by the next // token. NextToken *string // contains filtered or unexported fields }
type ListRecoveryPointsByResourceOutput ¶
type ListRecoveryPointsByResourceOutput struct { // The next item following a partial list of returned items. For example, if a // request is made to return maxResults number of items, NextToken allows you to // return more items in your list starting at the location pointed to by the next // token. NextToken *string // An array of objects that contain detailed information about recovery points of // the specified resource type. Only Amazon EFS and Amazon EC2 recovery points // return BackupVaultName. RecoveryPoints []types.RecoveryPointByResource // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListRecoveryPointsByResourcePaginator ¶ added in v0.30.0
type ListRecoveryPointsByResourcePaginator struct {
// contains filtered or unexported fields
}
ListRecoveryPointsByResourcePaginator is a paginator for ListRecoveryPointsByResource
func NewListRecoveryPointsByResourcePaginator ¶ added in v0.30.0
func NewListRecoveryPointsByResourcePaginator(client ListRecoveryPointsByResourceAPIClient, params *ListRecoveryPointsByResourceInput, optFns ...func(*ListRecoveryPointsByResourcePaginatorOptions)) *ListRecoveryPointsByResourcePaginator
NewListRecoveryPointsByResourcePaginator returns a new ListRecoveryPointsByResourcePaginator
func (*ListRecoveryPointsByResourcePaginator) HasMorePages ¶ added in v0.30.0
func (p *ListRecoveryPointsByResourcePaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListRecoveryPointsByResourcePaginator) NextPage ¶ added in v0.30.0
func (p *ListRecoveryPointsByResourcePaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListRecoveryPointsByResourceOutput, error)
NextPage retrieves the next ListRecoveryPointsByResource page.
type ListRecoveryPointsByResourcePaginatorOptions ¶ added in v0.30.0
type ListRecoveryPointsByResourcePaginatorOptions struct { // The maximum number of items to be returned. Amazon RDS requires a value of at // least 20. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListRecoveryPointsByResourcePaginatorOptions is the paginator options for ListRecoveryPointsByResource
type ListReportJobsAPIClient ¶ added in v1.5.0
type ListReportJobsAPIClient interface {
ListReportJobs(context.Context, *ListReportJobsInput, ...func(*Options)) (*ListReportJobsOutput, error)
}
ListReportJobsAPIClient is a client that implements the ListReportJobs operation.
type ListReportJobsInput ¶ added in v1.5.0
type ListReportJobsInput struct { // Returns only report jobs that were created after the date and time specified in // Unix format and Coordinated Universal Time (UTC). For example, the value // 1516925490 represents Friday, January 26, 2018 12:11:30 AM. ByCreationAfter *time.Time // Returns only report jobs that were created before the date and time specified in // Unix format and Coordinated Universal Time (UTC). For example, the value // 1516925490 represents Friday, January 26, 2018 12:11:30 AM. ByCreationBefore *time.Time // Returns only report jobs with the specified report plan name. ByReportPlanName *string // Returns only report jobs that are in the specified status. The statuses are: // CREATED | RUNNING | COMPLETED | FAILED ByStatus *string // The number of desired results from 1 to 1000. Optional. If unspecified, the // query will return 1 MB of data. MaxResults *int32 // An identifier that was returned from the previous call to this operation, which // can be used to return the next set of items in the list. NextToken *string // contains filtered or unexported fields }
type ListReportJobsOutput ¶ added in v1.5.0
type ListReportJobsOutput struct { // An identifier that was returned from the previous call to this operation, which // can be used to return the next set of items in the list. NextToken *string // Details about your report jobs in JSON format. ReportJobs []types.ReportJob // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListReportJobsPaginator ¶ added in v1.5.0
type ListReportJobsPaginator struct {
// contains filtered or unexported fields
}
ListReportJobsPaginator is a paginator for ListReportJobs
func NewListReportJobsPaginator ¶ added in v1.5.0
func NewListReportJobsPaginator(client ListReportJobsAPIClient, params *ListReportJobsInput, optFns ...func(*ListReportJobsPaginatorOptions)) *ListReportJobsPaginator
NewListReportJobsPaginator returns a new ListReportJobsPaginator
func (*ListReportJobsPaginator) HasMorePages ¶ added in v1.5.0
func (p *ListReportJobsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListReportJobsPaginator) NextPage ¶ added in v1.5.0
func (p *ListReportJobsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListReportJobsOutput, error)
NextPage retrieves the next ListReportJobs page.
type ListReportJobsPaginatorOptions ¶ added in v1.5.0
type ListReportJobsPaginatorOptions struct { // The number of desired results from 1 to 1000. Optional. If unspecified, the // query will return 1 MB of data. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListReportJobsPaginatorOptions is the paginator options for ListReportJobs
type ListReportPlansAPIClient ¶ added in v1.5.0
type ListReportPlansAPIClient interface {
ListReportPlans(context.Context, *ListReportPlansInput, ...func(*Options)) (*ListReportPlansOutput, error)
}
ListReportPlansAPIClient is a client that implements the ListReportPlans operation.
type ListReportPlansInput ¶ added in v1.5.0
type ListReportPlansInput struct { // The number of desired results from 1 to 1000. Optional. If unspecified, the // query will return 1 MB of data. MaxResults *int32 // An identifier that was returned from the previous call to this operation, which // can be used to return the next set of items in the list. NextToken *string // contains filtered or unexported fields }
type ListReportPlansOutput ¶ added in v1.5.0
type ListReportPlansOutput struct { // An identifier that was returned from the previous call to this operation, which // can be used to return the next set of items in the list. NextToken *string // A list of your report plans with detailed information for each plan. This // information includes the Amazon Resource Name (ARN), report plan name, // description, settings, delivery channel, deployment status, creation time, and // last times the report plan attempted to and successfully ran. ReportPlans []types.ReportPlan // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListReportPlansPaginator ¶ added in v1.5.0
type ListReportPlansPaginator struct {
// contains filtered or unexported fields
}
ListReportPlansPaginator is a paginator for ListReportPlans
func NewListReportPlansPaginator ¶ added in v1.5.0
func NewListReportPlansPaginator(client ListReportPlansAPIClient, params *ListReportPlansInput, optFns ...func(*ListReportPlansPaginatorOptions)) *ListReportPlansPaginator
NewListReportPlansPaginator returns a new ListReportPlansPaginator
func (*ListReportPlansPaginator) HasMorePages ¶ added in v1.5.0
func (p *ListReportPlansPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListReportPlansPaginator) NextPage ¶ added in v1.5.0
func (p *ListReportPlansPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListReportPlansOutput, error)
NextPage retrieves the next ListReportPlans page.
type ListReportPlansPaginatorOptions ¶ added in v1.5.0
type ListReportPlansPaginatorOptions struct { // The number of desired results from 1 to 1000. Optional. If unspecified, the // query will return 1 MB of data. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListReportPlansPaginatorOptions is the paginator options for ListReportPlans
type ListRestoreJobsAPIClient ¶ added in v0.30.0
type ListRestoreJobsAPIClient interface {
ListRestoreJobs(context.Context, *ListRestoreJobsInput, ...func(*Options)) (*ListRestoreJobsOutput, error)
}
ListRestoreJobsAPIClient is a client that implements the ListRestoreJobs operation.
type ListRestoreJobsInput ¶
type ListRestoreJobsInput struct { // The account ID to list the jobs from. Returns only restore jobs associated with // the specified account ID. ByAccountId *string // Returns only copy jobs completed after a date expressed in Unix format and // Coordinated Universal Time (UTC). ByCompleteAfter *time.Time // Returns only copy jobs completed before a date expressed in Unix format and // Coordinated Universal Time (UTC). ByCompleteBefore *time.Time // Returns only restore jobs that were created after the specified date. ByCreatedAfter *time.Time // Returns only restore jobs that were created before the specified date. ByCreatedBefore *time.Time // Returns only restore jobs associated with the specified job status. ByStatus types.RestoreJobStatus // The maximum number of items to be returned. MaxResults *int32 // The next item following a partial list of returned items. For example, if a // request is made to return maxResults number of items, NextToken allows you to // return more items in your list starting at the location pointed to by the next // token. NextToken *string // contains filtered or unexported fields }
type ListRestoreJobsOutput ¶
type ListRestoreJobsOutput struct { // The next item following a partial list of returned items. For example, if a // request is made to return maxResults number of items, NextToken allows you to // return more items in your list starting at the location pointed to by the next // token. NextToken *string // An array of objects that contain detailed information about jobs to restore // saved resources. RestoreJobs []types.RestoreJobsListMember // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListRestoreJobsPaginator ¶ added in v0.30.0
type ListRestoreJobsPaginator struct {
// contains filtered or unexported fields
}
ListRestoreJobsPaginator is a paginator for ListRestoreJobs
func NewListRestoreJobsPaginator ¶ added in v0.30.0
func NewListRestoreJobsPaginator(client ListRestoreJobsAPIClient, params *ListRestoreJobsInput, optFns ...func(*ListRestoreJobsPaginatorOptions)) *ListRestoreJobsPaginator
NewListRestoreJobsPaginator returns a new ListRestoreJobsPaginator
func (*ListRestoreJobsPaginator) HasMorePages ¶ added in v0.30.0
func (p *ListRestoreJobsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListRestoreJobsPaginator) NextPage ¶ added in v0.30.0
func (p *ListRestoreJobsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListRestoreJobsOutput, error)
NextPage retrieves the next ListRestoreJobs page.
type ListRestoreJobsPaginatorOptions ¶ added in v0.30.0
type ListRestoreJobsPaginatorOptions struct { // The maximum number of items to be returned. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListRestoreJobsPaginatorOptions is the paginator options for ListRestoreJobs
type ListTagsAPIClient ¶ added in v0.30.0
type ListTagsAPIClient interface {
ListTags(context.Context, *ListTagsInput, ...func(*Options)) (*ListTagsOutput, error)
}
ListTagsAPIClient is a client that implements the ListTags operation.
type ListTagsInput ¶
type ListTagsInput struct { // An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of // the ARN depends on the type of resource. Valid targets for ListTags are recovery // points, backup plans, and backup vaults. // // This member is required. ResourceArn *string // The maximum number of items to be returned. MaxResults *int32 // The next item following a partial list of returned items. For example, if a // request is made to return maxResults number of items, NextToken allows you to // return more items in your list starting at the location pointed to by the next // token. NextToken *string // contains filtered or unexported fields }
type ListTagsOutput ¶
type ListTagsOutput struct { // The next item following a partial list of returned items. For example, if a // request is made to return maxResults number of items, NextToken allows you to // return more items in your list starting at the location pointed to by the next // token. NextToken *string // To help organize your resources, you can assign your own metadata to the // resources you create. Each tag is a key-value pair. Tags map[string]string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListTagsPaginator ¶ added in v0.30.0
type ListTagsPaginator struct {
// contains filtered or unexported fields
}
ListTagsPaginator is a paginator for ListTags
func NewListTagsPaginator ¶ added in v0.30.0
func NewListTagsPaginator(client ListTagsAPIClient, params *ListTagsInput, optFns ...func(*ListTagsPaginatorOptions)) *ListTagsPaginator
NewListTagsPaginator returns a new ListTagsPaginator
func (*ListTagsPaginator) HasMorePages ¶ added in v0.30.0
func (p *ListTagsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListTagsPaginator) NextPage ¶ added in v0.30.0
func (p *ListTagsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListTagsOutput, error)
NextPage retrieves the next ListTags page.
type ListTagsPaginatorOptions ¶ added in v0.30.0
type ListTagsPaginatorOptions struct { // The maximum number of items to be returned. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListTagsPaginatorOptions is the paginator options for ListTags
type Options ¶
type Options struct { // Set of options to modify how an operation is invoked. These apply to all // operations invoked for this client. Use functional options on operation call to // modify this list for per operation behavior. APIOptions []func(*middleware.Stack) error // Configures the events that will be sent to the configured logger. ClientLogMode aws.ClientLogMode // The credentials object to use when signing requests. Credentials aws.CredentialsProvider // The configuration DefaultsMode that the SDK should use when constructing the // clients initial default settings. DefaultsMode aws.DefaultsMode // The endpoint options to be used when attempting to resolve an endpoint. EndpointOptions EndpointResolverOptions // The service endpoint resolver. EndpointResolver EndpointResolver // Signature Version 4 (SigV4) Signer HTTPSignerV4 HTTPSignerV4 // Provides idempotency tokens values that will be automatically populated into // idempotent API operations. IdempotencyTokenProvider IdempotencyTokenProvider // The logger writer interface to write logging messages to. Logger logging.Logger // The region to send requests to. (Required) Region string // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify // per operation call's retry max attempts. When creating a new API Clients this // member will only be used if the Retryer Options member is nil. This value will // be ignored if Retryer is not nil. If specified in an operation call's functional // options with a value that is different than the constructed client's Options, // the Client's Retryer will be wrapped to use the operation's specific // RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if // Retryer option is not also specified. When creating a new API Clients this // member will only be used if the Retryer Options member is nil. This value will // be ignored if Retryer is not nil. Currently does not support per operation call // overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable // failures. When nil the API client will use a default retryer. The kind of // default retry created by the API client can be changed with the RetryMode // option. Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment // The HTTP client to invoke API calls with. Defaults to client's default HTTP // implementation if nil. HTTPClient HTTPClient // contains filtered or unexported fields }
type PutBackupVaultAccessPolicyInput ¶
type PutBackupVaultAccessPolicyInput struct { // The name of a logical container where backups are stored. Backup vaults are // identified by names that are unique to the account used to create them and the // Amazon Web Services Region where they are created. They consist of lowercase // letters, numbers, and hyphens. // // This member is required. BackupVaultName *string // The backup vault access policy document in JSON format. Policy *string // contains filtered or unexported fields }
type PutBackupVaultAccessPolicyOutput ¶
type PutBackupVaultAccessPolicyOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type PutBackupVaultLockConfigurationInput ¶ added in v1.6.0
type PutBackupVaultLockConfigurationInput struct { // The Backup Vault Lock configuration that specifies the name of the backup vault // it protects. // // This member is required. BackupVaultName *string // The Backup Vault Lock configuration that specifies the number of days before the // lock date. For example, setting ChangeableForDays to 30 on Jan. 1, 2022 at 8pm // UTC will set the lock date to Jan. 31, 2022 at 8pm UTC. Backup enforces a // 72-hour cooling-off period before Vault Lock takes effect and becomes immutable. // Therefore, you must set ChangeableForDays to 3 or greater. Before the lock date, // you can delete Vault Lock from the vault using // DeleteBackupVaultLockConfiguration or change the Vault Lock configuration using // PutBackupVaultLockConfiguration. On and after the lock date, the Vault Lock // becomes immutable and cannot be changed or deleted. If this parameter is not // specified, you can delete Vault Lock from the vault using // DeleteBackupVaultLockConfiguration or change the Vault Lock configuration using // PutBackupVaultLockConfiguration at any time. ChangeableForDays *int64 // The Backup Vault Lock configuration that specifies the maximum retention period // that the vault retains its recovery points. This setting can be useful if, for // example, your organization's policies require you to destroy certain data after // retaining it for four years (1460 days). If this parameter is not included, // Vault Lock does not enforce a maximum retention period on the recovery points in // the vault. If this parameter is included without a value, Vault Lock will not // enforce a maximum retention period. If this parameter is specified, any backup // or copy job to the vault must have a lifecycle policy with a retention period // equal to or shorter than the maximum retention period. If the job's retention // period is longer than that maximum retention period, then the vault fails the // backup or copy job, and you should either modify your lifecycle settings or use // a different vault. The longest maximum retention period you can specify is 36500 // days (approximately 100 years). Recovery points already saved in the vault prior // to Vault Lock are not affected. MaxRetentionDays *int64 // The Backup Vault Lock configuration that specifies the minimum retention period // that the vault retains its recovery points. This setting can be useful if, for // example, your organization's policies require you to retain certain data for at // least seven years (2555 days). If this parameter is not specified, Vault Lock // will not enforce a minimum retention period. If this parameter is specified, any // backup or copy job to the vault must have a lifecycle policy with a retention // period equal to or longer than the minimum retention period. If the job's // retention period is shorter than that minimum retention period, then the vault // fails that backup or copy job, and you should either modify your lifecycle // settings or use a different vault. The shortest minimum retention period you can // specify is 1 day. Recovery points already saved in the vault prior to Vault Lock // are not affected. MinRetentionDays *int64 // contains filtered or unexported fields }
type PutBackupVaultLockConfigurationOutput ¶ added in v1.6.0
type PutBackupVaultLockConfigurationOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type PutBackupVaultNotificationsInput ¶
type PutBackupVaultNotificationsInput struct { // An array of events that indicate the status of jobs to back up resources to the // backup vault. For common use cases and code samples, see Using Amazon SNS to // track Backup events // (https://docs.aws.amazon.com/aws-backup/latest/devguide/sns-notifications.html). // The following events are supported: // // * BACKUP_JOB_STARTED | // BACKUP_JOB_COMPLETED // // * COPY_JOB_STARTED | COPY_JOB_SUCCESSFUL | // COPY_JOB_FAILED // // * RESTORE_JOB_STARTED | RESTORE_JOB_COMPLETED | // RECOVERY_POINT_MODIFIED // // * S3_BACKUP_OBJECT_FAILED | // S3_RESTORE_OBJECT_FAILED // // Ignore the list below because it includes deprecated // events. Refer to the list above. // // This member is required. BackupVaultEvents []types.BackupVaultEvent // The name of a logical container where backups are stored. Backup vaults are // identified by names that are unique to the account used to create them and the // Amazon Web Services Region where they are created. They consist of lowercase // letters, numbers, and hyphens. // // This member is required. BackupVaultName *string // The Amazon Resource Name (ARN) that specifies the topic for a backup vault’s // events; for example, arn:aws:sns:us-west-2:111122223333:MyVaultTopic. // // This member is required. SNSTopicArn *string // contains filtered or unexported fields }
type PutBackupVaultNotificationsOutput ¶
type PutBackupVaultNotificationsOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ResolveEndpoint ¶
type ResolveEndpoint struct { Resolver EndpointResolver Options EndpointResolverOptions }
func (*ResolveEndpoint) HandleSerialize ¶
func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) ( out middleware.SerializeOutput, metadata middleware.Metadata, err error, )
func (*ResolveEndpoint) ID ¶
func (*ResolveEndpoint) ID() string
type StartBackupJobInput ¶
type StartBackupJobInput struct { // The name of a logical container where backups are stored. Backup vaults are // identified by names that are unique to the account used to create them and the // Amazon Web Services Region where they are created. They consist of lowercase // letters, numbers, and hyphens. // // This member is required. BackupVaultName *string // Specifies the IAM role ARN used to create the target recovery point; for // example, arn:aws:iam::123456789012:role/S3Access. // // This member is required. IamRoleArn *string // An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of // the ARN depends on the resource type. // // This member is required. ResourceArn *string // Specifies the backup option for a selected resource. This option is only // available for Windows Volume Shadow Copy Service (VSS) backup jobs. Valid // values: Set to "WindowsVSS":"enabled" to enable the WindowsVSS backup option and // create a Windows VSS backup. Set to "WindowsVSS""disabled" to create a regular // backup. The WindowsVSS option is not enabled by default. BackupOptions map[string]string // A value in minutes during which a successfully started backup must complete, or // else Backup will cancel the job. This value is optional. This value begins // counting down from when the backup was scheduled. It does not add additional // time for StartWindowMinutes, or if the backup started later than scheduled. CompleteWindowMinutes *int64 // A customer-chosen string that you can use to distinguish between otherwise // identical calls to StartBackupJob. Retrying a successful request with the same // idempotency token results in a success message with no action taken. IdempotencyToken *string // The lifecycle defines when a protected resource is transitioned to cold storage // and when it expires. Backup will transition and expire backups automatically // according to the lifecycle that you define. Backups transitioned to cold storage // must be stored in cold storage for a minimum of 90 days. Therefore, the // “retention” setting must be 90 days greater than the “transition to cold after // days” setting. The “transition to cold after days” setting cannot be changed // after a backup has been transitioned to cold. Resource types that are able to be // transitioned to cold storage are listed in the "Lifecycle to cold storage" // section of the Feature availability by resource // (https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#features-by-resource) // table. Backup ignores this expression for other resource types. Lifecycle *types.Lifecycle // To help organize your resources, you can assign your own metadata to the // resources that you create. Each tag is a key-value pair. RecoveryPointTags map[string]string // A value in minutes after a backup is scheduled before a job will be canceled if // it doesn't start successfully. This value is optional, and the default is 8 // hours. StartWindowMinutes *int64 // contains filtered or unexported fields }
type StartBackupJobOutput ¶
type StartBackupJobOutput struct { // Uniquely identifies a request to Backup to back up a resource. BackupJobId *string // The date and time that a backup job is created, in Unix format and Coordinated // Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For // example, the value 1516925490.087 represents Friday, January 26, 2018 // 12:11:30.087 AM. CreationDate *time.Time // An ARN that uniquely identifies a recovery point; for example, // arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45. RecoveryPointArn *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type StartCopyJobInput ¶
type StartCopyJobInput struct { // An Amazon Resource Name (ARN) that uniquely identifies a destination backup // vault to copy to; for example, // arn:aws:backup:us-east-1:123456789012:vault:aBackupVault. // // This member is required. DestinationBackupVaultArn *string // Specifies the IAM role ARN used to copy the target recovery point; for example, // arn:aws:iam::123456789012:role/S3Access. // // This member is required. IamRoleArn *string // An ARN that uniquely identifies a recovery point to use for the copy job; for // example, // arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45. // // This member is required. RecoveryPointArn *string // The name of a logical source container where backups are stored. Backup vaults // are identified by names that are unique to the account used to create them and // the Amazon Web Services Region where they are created. They consist of lowercase // letters, numbers, and hyphens. // // This member is required. SourceBackupVaultName *string // A customer-chosen string that you can use to distinguish between otherwise // identical calls to StartCopyJob. Retrying a successful request with the same // idempotency token results in a success message with no action taken. IdempotencyToken *string // Contains an array of Transition objects specifying how long in days before a // recovery point transitions to cold storage or is deleted. Backups transitioned // to cold storage must be stored in cold storage for a minimum of 90 days. // Therefore, on the console, the “retention” setting must be 90 days greater than // the “transition to cold after days” setting. The “transition to cold after days” // setting cannot be changed after a backup has been transitioned to cold. Resource // types that are able to be transitioned to cold storage are listed in the // "Lifecycle to cold storage" section of the Feature availability by resource // (https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#features-by-resource) // table. Backup ignores this expression for other resource types. Lifecycle *types.Lifecycle // contains filtered or unexported fields }
type StartCopyJobOutput ¶
type StartCopyJobOutput struct { // Uniquely identifies a copy job. CopyJobId *string // The date and time that a copy job is created, in Unix format and Coordinated // Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For // example, the value 1516925490.087 represents Friday, January 26, 2018 // 12:11:30.087 AM. CreationDate *time.Time // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type StartReportJobInput ¶ added in v1.5.0
type StartReportJobInput struct { // The unique name of a report plan. // // This member is required. ReportPlanName *string // A customer-chosen string that you can use to distinguish between otherwise // identical calls to StartReportJobInput. Retrying a successful request with the // same idempotency token results in a success message with no action taken. IdempotencyToken *string // contains filtered or unexported fields }
type StartReportJobOutput ¶ added in v1.5.0
type StartReportJobOutput struct { // The identifier of the report job. A unique, randomly generated, Unicode, UTF-8 // encoded string that is at most 1,024 bytes long. The report job ID cannot be // edited. ReportJobId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type StartRestoreJobInput ¶
type StartRestoreJobInput struct { // A set of metadata key-value pairs. Contains information, such as a resource // name, required to restore a recovery point. You can get configuration metadata // about a resource at the time it was backed up by calling // GetRecoveryPointRestoreMetadata. However, values in addition to those provided // by GetRecoveryPointRestoreMetadata might be required to restore a resource. For // example, you might need to provide a new resource name if the original already // exists. You need to specify specific metadata to restore an Amazon Elastic File // System (Amazon EFS) instance: // // * file-system-id: The ID of the Amazon EFS file // system that is backed up by Backup. Returned in // GetRecoveryPointRestoreMetadata. // // * Encrypted: A Boolean value that, if true, // specifies that the file system is encrypted. If KmsKeyId is specified, Encrypted // must be set to true. // // * KmsKeyId: Specifies the Amazon Web Services KMS key that // is used to encrypt the restored file system. You can specify a key from another // Amazon Web Services account provided that key it is properly shared with your // account via Amazon Web Services KMS. // // * PerformanceMode: Specifies the // throughput mode of the file system. // // * CreationToken: A user-supplied value that // ensures the uniqueness (idempotency) of the request. // // * newFileSystem: A Boolean // value that, if true, specifies that the recovery point is restored to a new // Amazon EFS file system. // // * ItemsToRestore: An array of one to five strings where // each string is a file path. Use ItemsToRestore to restore specific files or // directories rather than the entire file system. This parameter is optional. For // example, "itemsToRestore":"[\"/my.test\"]". // // This member is required. Metadata map[string]string // An ARN that uniquely identifies a recovery point; for example, // arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45. // // This member is required. RecoveryPointArn *string // The Amazon Resource Name (ARN) of the IAM role that Backup uses to create the // target recovery point; for example, arn:aws:iam::123456789012:role/S3Access. IamRoleArn *string // A customer-chosen string that you can use to distinguish between otherwise // identical calls to StartRestoreJob. Retrying a successful request with the same // idempotency token results in a success message with no action taken. IdempotencyToken *string // Starts a job to restore a recovery point for one of the following resources: // // * // Aurora for Amazon Aurora // // * DocumentDB for Amazon DocumentDB (with MongoDB // compatibility) // // * DynamoDB for Amazon DynamoDB // // * EBS for Amazon Elastic Block // Store // // * EC2 for Amazon Elastic Compute Cloud // // * EFS for Amazon Elastic File // System // // * FSx for Amazon FSx // // * Neptune for Amazon Neptune // // * RDS for Amazon // Relational Database Service // // * Storage Gateway for Storage Gateway // // * S3 for // Amazon S3 // // * VirtualMachine for virtual machines ResourceType *string // contains filtered or unexported fields }
type StartRestoreJobOutput ¶
type StartRestoreJobOutput struct { // Uniquely identifies the job that restores a recovery point. RestoreJobId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type StopBackupJobInput ¶
type StopBackupJobInput struct { // Uniquely identifies a request to Backup to back up a resource. // // This member is required. BackupJobId *string // contains filtered or unexported fields }
type StopBackupJobOutput ¶
type StopBackupJobOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type TagResourceInput ¶
type TagResourceInput struct { // An ARN that uniquely identifies a resource. The format of the ARN depends on the // type of the tagged resource. // // This member is required. ResourceArn *string // Key-value pairs that are used to help organize your resources. You can assign // your own metadata to the resources you create. For clarity, this is the // structure to assign tags: [{"Key":"string","Value":"string"}]. // // This member is required. Tags map[string]string // contains filtered or unexported fields }
type TagResourceOutput ¶
type TagResourceOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type UntagResourceInput ¶
type UntagResourceInput struct { // An ARN that uniquely identifies a resource. The format of the ARN depends on the // type of the tagged resource. // // This member is required. ResourceArn *string // A list of keys to identify which key-value tags to remove from a resource. // // This member is required. TagKeyList []string // contains filtered or unexported fields }
type UntagResourceOutput ¶
type UntagResourceOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type UpdateBackupPlanInput ¶
type UpdateBackupPlanInput struct { // Specifies the body of a backup plan. Includes a BackupPlanName and one or more // sets of Rules. // // This member is required. BackupPlan *types.BackupPlanInput // Uniquely identifies a backup plan. // // This member is required. BackupPlanId *string // contains filtered or unexported fields }
type UpdateBackupPlanOutput ¶
type UpdateBackupPlanOutput struct { // Contains a list of BackupOptions for each resource type. AdvancedBackupSettings []types.AdvancedBackupSetting // An Amazon Resource Name (ARN) that uniquely identifies a backup plan; for // example, // arn:aws:backup:us-east-1:123456789012:plan:8F81F553-3A74-4A3F-B93D-B3360DC80C50. BackupPlanArn *string // Uniquely identifies a backup plan. BackupPlanId *string // The date and time a backup plan is created, in Unix format and Coordinated // Universal Time (UTC). The value of CreationDate is accurate to milliseconds. For // example, the value 1516925490.087 represents Friday, January 26, 2018 // 12:11:30.087 AM. CreationDate *time.Time // Unique, randomly generated, Unicode, UTF-8 encoded strings that are at most // 1,024 bytes long. Version Ids cannot be edited. VersionId *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type UpdateFrameworkInput ¶ added in v1.5.0
type UpdateFrameworkInput struct { // The unique name of a framework. This name is between 1 and 256 characters, // starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and // underscores (_). // // This member is required. FrameworkName *string // A list of the controls that make up the framework. Each control in the list has // a name, input parameters, and scope. FrameworkControls []types.FrameworkControl // An optional description of the framework with a maximum 1,024 characters. FrameworkDescription *string // A customer-chosen string that you can use to distinguish between otherwise // identical calls to UpdateFrameworkInput. Retrying a successful request with the // same idempotency token results in a success message with no action taken. IdempotencyToken *string // contains filtered or unexported fields }
type UpdateFrameworkOutput ¶ added in v1.5.0
type UpdateFrameworkOutput struct { // The date and time that a framework is created, in Unix format and Coordinated // Universal Time (UTC). The value of CreationTime is accurate to milliseconds. For // example, the value 1516925490.087 represents Friday, January 26, 2018 // 12:11:30.087 AM. CreationTime *time.Time // An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of // the ARN depends on the resource type. FrameworkArn *string // The unique name of a framework. This name is between 1 and 256 characters, // starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and // underscores (_). FrameworkName *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type UpdateGlobalSettingsInput ¶ added in v0.30.0
type UpdateGlobalSettingsOutput ¶ added in v0.30.0
type UpdateGlobalSettingsOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type UpdateRecoveryPointLifecycleInput ¶
type UpdateRecoveryPointLifecycleInput struct { // The name of a logical container where backups are stored. Backup vaults are // identified by names that are unique to the account used to create them and the // Amazon Web Services Region where they are created. They consist of lowercase // letters, numbers, and hyphens. // // This member is required. BackupVaultName *string // An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for // example, // arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45. // // This member is required. RecoveryPointArn *string // The lifecycle defines when a protected resource is transitioned to cold storage // and when it expires. Backup transitions and expires backups automatically // according to the lifecycle that you define. Backups transitioned to cold storage // must be stored in cold storage for a minimum of 90 days. Therefore, the // “retention” setting must be 90 days greater than the “transition to cold after // days” setting. The “transition to cold after days” setting cannot be changed // after a backup has been transitioned to cold. Lifecycle *types.Lifecycle // contains filtered or unexported fields }
type UpdateRecoveryPointLifecycleOutput ¶
type UpdateRecoveryPointLifecycleOutput struct { // An ARN that uniquely identifies a backup vault; for example, // arn:aws:backup:us-east-1:123456789012:vault:aBackupVault. BackupVaultArn *string // A CalculatedLifecycle object containing DeleteAt and MoveToColdStorageAt // timestamps. CalculatedLifecycle *types.CalculatedLifecycle // The lifecycle defines when a protected resource is transitioned to cold storage // and when it expires. Backup transitions and expires backups automatically // according to the lifecycle that you define. Backups transitioned to cold storage // must be stored in cold storage for a minimum of 90 days. Therefore, the // “retention” setting must be 90 days greater than the “transition to cold after // days” setting. The “transition to cold after days” setting cannot be changed // after a backup has been transitioned to cold. Resource types that are able to be // transitioned to cold storage are listed in the "Lifecycle to cold storage" // section of the Feature availability by resource // (https://docs.aws.amazon.com/aws-backup/latest/devguide/whatisbackup.html#features-by-resource) // table. Backup ignores this expression for other resource types. Lifecycle *types.Lifecycle // An Amazon Resource Name (ARN) that uniquely identifies a recovery point; for // example, // arn:aws:backup:us-east-1:123456789012:recovery-point:1EB3B5E7-9EB0-435A-A80B-108B488B0D45. RecoveryPointArn *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type UpdateRegionSettingsInput ¶
type UpdateRegionSettingsInput struct { // Enables or disables full Backup management of backups for a resource type. To // enable full Backup management for DynamoDB along with Backup's advanced // DynamoDB backup features // (https://docs.aws.amazon.com/aws-backup/latest/devguide/advanced-ddb-backup.html), // follow the procedure to enable advanced DynamoDB backup programmatically // (https://docs.aws.amazon.com/aws-backup/latest/devguide/advanced-ddb-backup.html#advanced-ddb-backup-enable-cli). ResourceTypeManagementPreference map[string]bool // Updates the list of services along with the opt-in preferences for the Region. ResourceTypeOptInPreference map[string]bool // contains filtered or unexported fields }
type UpdateRegionSettingsOutput ¶
type UpdateRegionSettingsOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type UpdateReportPlanInput ¶ added in v1.5.0
type UpdateReportPlanInput struct { // The unique name of the report plan. This name is between 1 and 256 characters, // starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and // underscores (_). // // This member is required. ReportPlanName *string // A customer-chosen string that you can use to distinguish between otherwise // identical calls to UpdateReportPlanInput. Retrying a successful request with the // same idempotency token results in a success message with no action taken. IdempotencyToken *string // A structure that contains information about where to deliver your reports, // specifically your Amazon S3 bucket name, S3 key prefix, and the formats of your // reports. ReportDeliveryChannel *types.ReportDeliveryChannel // An optional description of the report plan with a maximum 1,024 characters. ReportPlanDescription *string // Identifies the report template for the report. Reports are built using a report // template. The report templates are: RESOURCE_COMPLIANCE_REPORT | // CONTROL_COMPLIANCE_REPORT | BACKUP_JOB_REPORT | COPY_JOB_REPORT | // RESTORE_JOB_REPORT If the report template is RESOURCE_COMPLIANCE_REPORT or // CONTROL_COMPLIANCE_REPORT, this API resource also describes the report coverage // by Amazon Web Services Regions and frameworks. ReportSetting *types.ReportSetting // contains filtered or unexported fields }
type UpdateReportPlanOutput ¶ added in v1.5.0
type UpdateReportPlanOutput struct { // The date and time that a report plan is created, in Unix format and Coordinated // Universal Time (UTC). The value of CreationTime is accurate to milliseconds. For // example, the value 1516925490.087 represents Friday, January 26, 2018 // 12:11:30.087 AM. CreationTime *time.Time // An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of // the ARN depends on the resource type. ReportPlanArn *string // The unique name of the report plan. ReportPlanName *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
Source Files ¶
- api_client.go
- api_op_CreateBackupPlan.go
- api_op_CreateBackupSelection.go
- api_op_CreateBackupVault.go
- api_op_CreateFramework.go
- api_op_CreateReportPlan.go
- api_op_DeleteBackupPlan.go
- api_op_DeleteBackupSelection.go
- api_op_DeleteBackupVault.go
- api_op_DeleteBackupVaultAccessPolicy.go
- api_op_DeleteBackupVaultLockConfiguration.go
- api_op_DeleteBackupVaultNotifications.go
- api_op_DeleteFramework.go
- api_op_DeleteRecoveryPoint.go
- api_op_DeleteReportPlan.go
- api_op_DescribeBackupJob.go
- api_op_DescribeBackupVault.go
- api_op_DescribeCopyJob.go
- api_op_DescribeFramework.go
- api_op_DescribeGlobalSettings.go
- api_op_DescribeProtectedResource.go
- api_op_DescribeRecoveryPoint.go
- api_op_DescribeRegionSettings.go
- api_op_DescribeReportJob.go
- api_op_DescribeReportPlan.go
- api_op_DescribeRestoreJob.go
- api_op_DisassociateRecoveryPoint.go
- api_op_ExportBackupPlanTemplate.go
- api_op_GetBackupPlan.go
- api_op_GetBackupPlanFromJSON.go
- api_op_GetBackupPlanFromTemplate.go
- api_op_GetBackupSelection.go
- api_op_GetBackupVaultAccessPolicy.go
- api_op_GetBackupVaultNotifications.go
- api_op_GetRecoveryPointRestoreMetadata.go
- api_op_GetSupportedResourceTypes.go
- api_op_ListBackupJobs.go
- api_op_ListBackupPlanTemplates.go
- api_op_ListBackupPlanVersions.go
- api_op_ListBackupPlans.go
- api_op_ListBackupSelections.go
- api_op_ListBackupVaults.go
- api_op_ListCopyJobs.go
- api_op_ListFrameworks.go
- api_op_ListProtectedResources.go
- api_op_ListRecoveryPointsByBackupVault.go
- api_op_ListRecoveryPointsByResource.go
- api_op_ListReportJobs.go
- api_op_ListReportPlans.go
- api_op_ListRestoreJobs.go
- api_op_ListTags.go
- api_op_PutBackupVaultAccessPolicy.go
- api_op_PutBackupVaultLockConfiguration.go
- api_op_PutBackupVaultNotifications.go
- api_op_StartBackupJob.go
- api_op_StartCopyJob.go
- api_op_StartReportJob.go
- api_op_StartRestoreJob.go
- api_op_StopBackupJob.go
- api_op_TagResource.go
- api_op_UntagResource.go
- api_op_UpdateBackupPlan.go
- api_op_UpdateFramework.go
- api_op_UpdateGlobalSettings.go
- api_op_UpdateRecoveryPointLifecycle.go
- api_op_UpdateRegionSettings.go
- api_op_UpdateReportPlan.go
- deserializers.go
- doc.go
- endpoints.go
- go_module_metadata.go
- serializers.go
- validators.go