types

package
v1.6.16 Latest Latest
Warning

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

 Go to latest Published: Nov 25, 2025 License: Apache-2.0 Imports: 4 Imported by: 0

Documentation

Index

Examples

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AccessDeniedException 

type AccessDeniedException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

You do not have sufficient access to perform this action.

func (*AccessDeniedException) Error 

func (e *AccessDeniedException) Error() string

func (*AccessDeniedException) ErrorCode 

func (e *AccessDeniedException) ErrorCode() string

func (*AccessDeniedException) ErrorFault 

func (e *AccessDeniedException) ErrorFault() smithy.ErrorFault

func (*AccessDeniedException) ErrorMessage 

func (e *AccessDeniedException) ErrorMessage() string

type BackupCreationTimeFilter 

type BackupCreationTimeFilter struct {

	// This timestamp includes recovery points only created after the specified time.
	CreatedAfter *time.Time

	// This timestamp includes recovery points only created before the specified time.
	CreatedBefore *time.Time
	// contains filtered or unexported fields
}

This filters by recovery points within the CreatedAfter and CreatedBefore timestamps.

type ConflictException 

type ConflictException struct {
	Message *string

	ErrorCodeOverride *string

	ResourceId   *string
	ResourceType *string
	// contains filtered or unexported fields
}

This exception occurs when a conflict with a previous successful operation is detected. This generally occurs when the previous operation did not have time to propagate to the host serving the current request.

A retry (with appropriate backoff logic) is the recommended response to this exception.

func (*ConflictException) Error 

func (e *ConflictException) Error() string

func (*ConflictException) ErrorCode 

func (e *ConflictException) ErrorCode() string

func (*ConflictException) ErrorFault 

func (e *ConflictException) ErrorFault() smithy.ErrorFault

func (*ConflictException) ErrorMessage 

func (e *ConflictException) ErrorMessage() string

type CurrentSearchProgress 

type CurrentSearchProgress struct {

	// This number is the sum of all items that match the item filters in a search job
	// in progress.
	ItemsMatchedCount *int64

	// This number is the sum of all items that have been scanned so far during a
	// search job.
	ItemsScannedCount *int64

	// This number is the sum of all backups that have been scanned so far during a
	// search job.
	RecoveryPointsScannedCount *int32
	// contains filtered or unexported fields
}

This contains information results retrieved from a search job that may not have completed.

type EBSItemFilter 

type EBSItemFilter struct {

	// You can include 1 to 10 values.
	//
	// If one is included, the results will return only items that match.
	//
	// If more than one is included, the results will return all items that match any
	// of the included values.
	CreationTimes []TimeCondition

	// You can include 1 to 10 values.
	//
	// If one file path is included, the results will return only items that match the
	// file path.
	//
	// If more than one file path is included, the results will return all items that
	// match any of the file paths.
	FilePaths []StringCondition

	// You can include 1 to 10 values.
	//
	// If one is included, the results will return only items that match.
	//
	// If more than one is included, the results will return all items that match any
	// of the included values.
	LastModificationTimes []TimeCondition

	// You can include 1 to 10 values.
	//
	// If one is included, the results will return only items that match.
	//
	// If more than one is included, the results will return all items that match any
	// of the included values.
	Sizes []LongCondition
	// contains filtered or unexported fields
}

This contains arrays of objects, which may include CreationTimes time condition objects, FilePaths string objects, LastModificationTimes time condition objects,

type EBSResultItem 

type EBSResultItem struct {

	// These are one or more items in the results that match values for the Amazon
	// Resource Name (ARN) of recovery points returned in a search of Amazon EBS backup
	// metadata.
	BackupResourceArn *string

	// The name of the backup vault.
	BackupVaultName *string

	// These are one or more items in the results that match values for creation times
	// returned in a search of Amazon EBS backup metadata.
	CreationTime *time.Time

	// These are one or more items in the results that match values for file paths
	// returned in a search of Amazon EBS backup metadata.
	FilePath *string

	// These are one or more items in the results that match values for file sizes
	// returned in a search of Amazon EBS backup metadata.
	FileSize *int64

	// These are one or more items in the results that match values for file systems
	// returned in a search of Amazon EBS backup metadata.
	FileSystemIdentifier *string

	// These are one or more items in the results that match values for Last Modified
	// Time returned in a search of Amazon EBS backup metadata.
	LastModifiedTime *time.Time

	// These are one or more items in the results that match values for the Amazon
	// Resource Name (ARN) of source resources returned in a search of Amazon EBS
	// backup metadata.
	SourceResourceArn *string
	// contains filtered or unexported fields
}

These are the items returned in the results of a search of Amazon EBS backup metadata.

type ExportJobStatus 

type ExportJobStatus string
const (
	ExportJobStatusRunning   ExportJobStatus = "RUNNING"
	ExportJobStatusFailed    ExportJobStatus = "FAILED"
	ExportJobStatusCompleted ExportJobStatus = "COMPLETED"
)

Enum values for ExportJobStatus

func (ExportJobStatus) Values 

func (ExportJobStatus) Values() []ExportJobStatus

Values returns all known values for ExportJobStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ExportJobSummary 

type ExportJobSummary struct {

	// This is the unique string that identifies a specific export job.
	//
	// This member is required.
	ExportJobIdentifier *string

	// This is a timestamp of the time the export job compeleted.
	CompletionTime *time.Time

	// This is a timestamp of the time the export job was created.
	CreationTime *time.Time

	// This is the unique ARN (Amazon Resource Name) that belongs to the new export
	// job.
	ExportJobArn *string

	// The unique string that identifies the Amazon Resource Name (ARN) of the
	// specified search job.
	SearchJobArn *string

	// The status of the export job is one of the following:
	//
	// CREATED ; RUNNING ; FAILED ; or COMPLETED .
	Status ExportJobStatus

	// A status message is a string that is returned for an export job.
	//
	// A status message is included for any status other than COMPLETED without issues.
	StatusMessage *string
	// contains filtered or unexported fields
}

This is the summary of an export job.

type ExportSpecification 

type ExportSpecification interface {
	// contains filtered or unexported methods
}

This contains the export specification object.

The following types satisfy this interface: 

ExportSpecificationMemberS3ExportSpecification
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/backupsearch/types"
)

func main() {
	var union types.ExportSpecification
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.ExportSpecificationMemberS3ExportSpecification:
		_ = v.Value // Value is types.S3ExportSpecification

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

type ExportSpecificationMemberS3ExportSpecification 

type ExportSpecificationMemberS3ExportSpecification struct {
	Value S3ExportSpecification
	// contains filtered or unexported fields
}

This specifies the destination Amazon S3 bucket for the export job. And, if included, it also specifies the destination prefix.

type InternalServerException 

type InternalServerException struct {
	Message *string

	ErrorCodeOverride *string

	RetryAfterSeconds *int32
	// contains filtered or unexported fields
}

An internal server error occurred. Retry your request.

func (*InternalServerException) Error 

func (e *InternalServerException) Error() string

func (*InternalServerException) ErrorCode 

func (e *InternalServerException) ErrorCode() string

func (*InternalServerException) ErrorFault 

func (e *InternalServerException) ErrorFault() smithy.ErrorFault

func (*InternalServerException) ErrorMessage 

func (e *InternalServerException) ErrorMessage() string

type ItemFilters 

type ItemFilters struct {

	// This array can contain CreationTimes, FilePaths, LastModificationTimes, or
	// Sizes objects.
	EBSItemFilters []EBSItemFilter

	// This array can contain CreationTimes, ETags, ObjectKeys, Sizes, or VersionIds
	// objects.
	S3ItemFilters []S3ItemFilter
	// contains filtered or unexported fields
}

Item Filters represent all input item properties specified when the search was created.

Contains either EBSItemFilters or S3ItemFilters

type LongCondition 

type LongCondition struct {

	// The value of an item included in one of the search item filters.
	//
	// This member is required.
	Value *int64

	// A string that defines what values will be returned.
	//
	// If this is included, avoid combinations of operators that will return all
	// possible values. For example, including both EQUALS_TO and NOT_EQUALS_TO with a
	// value of 4 will return all values.
	Operator LongConditionOperator
	// contains filtered or unexported fields
}

The long condition contains a Value and can optionally contain an Operator .

type LongConditionOperator 

type LongConditionOperator string
const (
	LongConditionOperatorEqualsTo           LongConditionOperator = "EQUALS_TO"
	LongConditionOperatorNotEqualsTo        LongConditionOperator = "NOT_EQUALS_TO"
	LongConditionOperatorLessThanEqualTo    LongConditionOperator = "LESS_THAN_EQUAL_TO"
	LongConditionOperatorGreaterThanEqualTo LongConditionOperator = "GREATER_THAN_EQUAL_TO"
)

Enum values for LongConditionOperator

func (LongConditionOperator) Values 

func (LongConditionOperator) Values() []LongConditionOperator

Values returns all known values for LongConditionOperator. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ResourceNotFoundException 

type ResourceNotFoundException struct {
	Message *string

	ErrorCodeOverride *string

	ResourceId   *string
	ResourceType *string
	// contains filtered or unexported fields
}

The resource was not found for this request.

Confirm the resource information, such as the ARN or type is correct and exists, then retry the request.

func (*ResourceNotFoundException) Error 

func (e *ResourceNotFoundException) Error() string

func (*ResourceNotFoundException) ErrorCode 

func (e *ResourceNotFoundException) ErrorCode() string

func (*ResourceNotFoundException) ErrorFault 

func (e *ResourceNotFoundException) ErrorFault() smithy.ErrorFault

func (*ResourceNotFoundException) ErrorMessage 

func (e *ResourceNotFoundException) ErrorMessage() string

type ResourceType 

type ResourceType string
const (
	ResourceTypeS3  ResourceType = "S3"
	ResourceTypeEbs ResourceType = "EBS"
)

Enum values for ResourceType

func (ResourceType) Values 

func (ResourceType) Values() []ResourceType

Values returns all known values for ResourceType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ResultItem 

type ResultItem interface {
	// contains filtered or unexported methods
}

This is an object representing the item returned in the results of a search for a specific resource type.

The following types satisfy this interface: 

ResultItemMemberEBSResultItem
ResultItemMemberS3ResultItem
Example (OutputUsage) 
package main

import (
	"fmt"
	"github.com/aws/aws-sdk-go-v2/service/backupsearch/types"
)

func main() {
	var union types.ResultItem
	// type switches can be used to check the union value
	switch v := union.(type) {
	case *types.ResultItemMemberEBSResultItem:
		_ = v.Value // Value is types.EBSResultItem

	case *types.ResultItemMemberS3ResultItem:
		_ = v.Value // Value is types.S3ResultItem

	case *types.UnknownUnionMember:
		fmt.Println("unknown tag:", v.Tag)

	default:
		fmt.Println("union is nil or unknown type")

	}
}

type ResultItemMemberEBSResultItem 

type ResultItemMemberEBSResultItem struct {
	Value EBSResultItem
	// contains filtered or unexported fields
}

These are items returned in the search results of an Amazon EBS search.

type ResultItemMemberS3ResultItem 

type ResultItemMemberS3ResultItem struct {
	Value S3ResultItem
	// contains filtered or unexported fields
}

These are items returned in the search results of an Amazon S3 search.

type S3ExportSpecification 

type S3ExportSpecification struct {

	// This specifies the destination Amazon S3 bucket for the export job.
	//
	// This member is required.
	DestinationBucket *string

	// This specifies the prefix for the destination Amazon S3 bucket for the export
	// job.
	DestinationPrefix *string
	// contains filtered or unexported fields
}

This specification contains a required string of the destination bucket; optionally, you can include the destination prefix.

type S3ItemFilter 

type S3ItemFilter struct {

	// You can include 1 to 10 values.
	//
	// If one value is included, the results will return only items that match the
	// value.
	//
	// If more than one value is included, the results will return all items that
	// match any of the values.
	CreationTimes []TimeCondition

	// You can include 1 to 10 values.
	//
	// If one value is included, the results will return only items that match the
	// value.
	//
	// If more than one value is included, the results will return all items that
	// match any of the values.
	ETags []StringCondition

	// You can include 1 to 10 values.
	//
	// If one value is included, the results will return only items that match the
	// value.
	//
	// If more than one value is included, the results will return all items that
	// match any of the values.
	ObjectKeys []StringCondition

	// You can include 1 to 10 values.
	//
	// If one value is included, the results will return only items that match the
	// value.
	//
	// If more than one value is included, the results will return all items that
	// match any of the values.
	Sizes []LongCondition

	// You can include 1 to 10 values.
	//
	// If one value is included, the results will return only items that match the
	// value.
	//
	// If more than one value is included, the results will return all items that
	// match any of the values.
	VersionIds []StringCondition
	// contains filtered or unexported fields
}

This contains arrays of objects, which may include ObjectKeys, Sizes, CreationTimes, VersionIds, and/or Etags.

type S3ResultItem 

type S3ResultItem struct {

	// These are items in the returned results that match recovery point Amazon
	// Resource Names (ARN) input during a search of Amazon S3 backup metadata.
	BackupResourceArn *string

	// The name of the backup vault.
	BackupVaultName *string

	// These are one or more items in the returned results that match values for item
	// creation time input during a search of Amazon S3 backup metadata.
	CreationTime *time.Time

	// These are one or more items in the returned results that match values for ETags
	// input during a search of Amazon S3 backup metadata.
	ETag *string

	// This is one or more items returned in the results of a search of Amazon S3
	// backup metadata that match the values input for object key.
	ObjectKey *string

	// These are items in the returned results that match values for object size(s)
	// input during a search of Amazon S3 backup metadata.
	ObjectSize *int64

	// These are items in the returned results that match source Amazon Resource Names
	// (ARN) input during a search of Amazon S3 backup metadata.
	SourceResourceArn *string

	// These are one or more items in the returned results that match values for
	// version IDs input during a search of Amazon S3 backup metadata.
	VersionId *string
	// contains filtered or unexported fields
}

These are the items returned in the results of a search of Amazon S3 backup metadata.

type SearchJobBackupsResult 

type SearchJobBackupsResult struct {

	// This is the creation time of the backup (recovery point).
	BackupCreationTime *time.Time

	// The Amazon Resource Name (ARN) that uniquely identifies the backup resources.
	BackupResourceArn *string

	// This is the creation time of the backup index.
	IndexCreationTime *time.Time

	// This is the resource type of the search.
	ResourceType ResourceType

	// The Amazon Resource Name (ARN) that uniquely identifies the source resources.
	SourceResourceArn *string

	// This is the status of the search job backup result.
	Status SearchJobState

	// This is the status message included with the results.
	StatusMessage *string
	// contains filtered or unexported fields
}

This contains the information about recovery points returned in results of a search job.

type SearchJobState 

type SearchJobState string
const (
	SearchJobStateRunning   SearchJobState = "RUNNING"
	SearchJobStateCompleted SearchJobState = "COMPLETED"
	SearchJobStateStopping  SearchJobState = "STOPPING"
	SearchJobStateStopped   SearchJobState = "STOPPED"
	SearchJobStateFailed    SearchJobState = "FAILED"
)

Enum values for SearchJobState

func (SearchJobState) Values 

func (SearchJobState) Values() []SearchJobState

Values returns all known values for SearchJobState. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type SearchJobSummary 

type SearchJobSummary struct {

	// This is the completion time of the search job.
	CompletionTime *time.Time

	// This is the creation time of the search job.
	CreationTime *time.Time

	// This is the name of the search job.
	Name *string

	// The unique string that identifies the Amazon Resource Name (ARN) of the
	// specified search job.
	SearchJobArn *string

	// The unique string that specifies the search job.
	SearchJobIdentifier *string

	// Returned summary of the specified search job scope, including:
	//
	//   - TotalBackupsToScanCount, the number of recovery points returned by the
	//   search.
	//
	//   - TotalItemsToScanCount, the number of items returned by the search.
	SearchScopeSummary *SearchScopeSummary

	// This is the status of the search job.
	Status SearchJobState

	// A status message will be returned for either a earch job with a status of
	// ERRORED or a status of COMPLETED jobs with issues.
	//
	// For example, a message may say that a search contained recovery points unable
	// to be scanned because of a permissions issue.
	StatusMessage *string
	// contains filtered or unexported fields
}

This is information pertaining to a search job.

type SearchScope 

type SearchScope struct {

	// The resource types included in a search.
	//
	// Eligible resource types include S3 and EBS.
	//
	// This member is required.
	BackupResourceTypes []ResourceType

	// The Amazon Resource Name (ARN) that uniquely identifies the backup resources.
	BackupResourceArns []string

	// This is the time a backup resource was created.
	BackupResourceCreationTime *BackupCreationTimeFilter

	// These are one or more tags on the backup (recovery point).
	BackupResourceTags map[string]*string

	// The Amazon Resource Name (ARN) that uniquely identifies the source resources.
	SourceResourceArns []string
	// contains filtered or unexported fields
}

The search scope is all backup properties input into a search.

type SearchScopeSummary 

type SearchScopeSummary struct {

	// This is the count of the total number of items that will be scanned in a search.
	TotalItemsToScanCount *int64

	// This is the count of the total number of backups that will be scanned in a
	// search.
	TotalRecoveryPointsToScanCount *int32
	// contains filtered or unexported fields
}

The summary of the specified search job scope, including:

  • TotalBackupsToScanCount, the number of recovery points returned by the search.

  • TotalItemsToScanCount, the number of items returned by the search.

type ServiceQuotaExceededException 

type ServiceQuotaExceededException struct {
	Message *string

	ErrorCodeOverride *string

	ResourceId   *string
	ResourceType *string
	ServiceCode  *string
	QuotaCode    *string
	// contains filtered or unexported fields
}

The request denied due to exceeding the quota limits permitted.

func (*ServiceQuotaExceededException) Error 

func (e *ServiceQuotaExceededException) Error() string

func (*ServiceQuotaExceededException) ErrorCode 

func (e *ServiceQuotaExceededException) ErrorCode() string

func (*ServiceQuotaExceededException) ErrorFault 

func (e *ServiceQuotaExceededException) ErrorFault() smithy.ErrorFault

func (*ServiceQuotaExceededException) ErrorMessage 

func (e *ServiceQuotaExceededException) ErrorMessage() string

type StringCondition 

type StringCondition struct {

	// The value of the string.
	//
	// This member is required.
	Value *string

	// A string that defines what values will be returned.
	//
	// If this is included, avoid combinations of operators that will return all
	// possible values. For example, including both EQUALS_TO and NOT_EQUALS_TO with a
	// value of 4 will return all values.
	Operator StringConditionOperator
	// contains filtered or unexported fields
}

This contains the value of the string and can contain one or more operators.

type StringConditionOperator 

type StringConditionOperator string
const (
	StringConditionOperatorEqualsTo         StringConditionOperator = "EQUALS_TO"
	StringConditionOperatorNotEqualsTo      StringConditionOperator = "NOT_EQUALS_TO"
	StringConditionOperatorContains         StringConditionOperator = "CONTAINS"
	StringConditionOperatorDoesNotContain   StringConditionOperator = "DOES_NOT_CONTAIN"
	StringConditionOperatorBeginsWith       StringConditionOperator = "BEGINS_WITH"
	StringConditionOperatorEndsWith         StringConditionOperator = "ENDS_WITH"
	StringConditionOperatorDoesNotBeginWith StringConditionOperator = "DOES_NOT_BEGIN_WITH"
	StringConditionOperatorDoesNotEndWith   StringConditionOperator = "DOES_NOT_END_WITH"
)

Enum values for StringConditionOperator

func (StringConditionOperator) Values 

func (StringConditionOperator) Values() []StringConditionOperator

Values returns all known values for StringConditionOperator. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ThrottlingException 

type ThrottlingException struct {
	Message *string

	ErrorCodeOverride *string

	ServiceCode       *string
	QuotaCode         *string
	RetryAfterSeconds *int32
	// contains filtered or unexported fields
}

The request was denied due to request throttling.

func (*ThrottlingException) Error 

func (e *ThrottlingException) Error() string

func (*ThrottlingException) ErrorCode 

func (e *ThrottlingException) ErrorCode() string

func (*ThrottlingException) ErrorFault 

func (e *ThrottlingException) ErrorFault() smithy.ErrorFault

func (*ThrottlingException) ErrorMessage 

func (e *ThrottlingException) ErrorMessage() string

type TimeCondition 

type TimeCondition struct {

	// This is the timestamp value of the time condition.
	//
	// This member is required.
	Value *time.Time

	// A string that defines what values will be returned.
	//
	// If this is included, avoid combinations of operators that will return all
	// possible values. For example, including both EQUALS_TO and NOT_EQUALS_TO with a
	// value of 4 will return all values.
	Operator TimeConditionOperator
	// contains filtered or unexported fields
}

A time condition denotes a creation time, last modification time, or other time.

type TimeConditionOperator 

type TimeConditionOperator string
const (
	TimeConditionOperatorEqualsTo           TimeConditionOperator = "EQUALS_TO"
	TimeConditionOperatorNotEqualsTo        TimeConditionOperator = "NOT_EQUALS_TO"
	TimeConditionOperatorLessThanEqualTo    TimeConditionOperator = "LESS_THAN_EQUAL_TO"
	TimeConditionOperatorGreaterThanEqualTo TimeConditionOperator = "GREATER_THAN_EQUAL_TO"
)

Enum values for TimeConditionOperator

func (TimeConditionOperator) Values 

func (TimeConditionOperator) Values() []TimeConditionOperator

Values returns all known values for TimeConditionOperator. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type UnknownUnionMember 

type UnknownUnionMember struct {
	Tag   string
	Value []byte
	// contains filtered or unexported fields
}

UnknownUnionMember is returned when a union member is returned over the wire, but has an unknown tag.

type ValidationException 

type ValidationException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

The input fails to satisfy the constraints specified by a service.

func (*ValidationException) Error 

func (e *ValidationException) Error() string

func (*ValidationException) ErrorCode 

func (e *ValidationException) ErrorCode() string

func (*ValidationException) ErrorFault 

func (e *ValidationException) ErrorFault() smithy.ErrorFault

func (*ValidationException) ErrorMessage 

func (e *ValidationException) ErrorMessage() string

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.