backupsearch

package module
v1.1.1 Latest Latest
Warning

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

 Go to latest Published: Mar 4, 2025 License: Apache-2.0 Imports: 43 Imported by: 2

Documentation

Overview

Package backupsearch provides the API client, operations, and parameter types for AWS Backup Search.

Backup Search is the recovery point and item level search for Backup.

For additional information, see:

Backup API Reference

Backup Developer Guide

Index

Constants

View Source 
const ServiceAPIVersion = "2018-05-10"
View Source 
const ServiceID = "BackupSearch"

Variables

This section is empty.

Functions

func NewDefaultEndpointResolver 

func NewDefaultEndpointResolver() *internalendpoints.Resolver

NewDefaultEndpointResolver constructs a new service endpoint resolver

func WithAPIOptions 

func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)

WithAPIOptions returns a functional option for setting the Client's APIOptions option.

func WithEndpointResolver deprecated 

func WithEndpointResolver(v EndpointResolver) func(*Options)

Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for this field will likely prevent you from using any endpoint-related service features released after the introduction of EndpointResolverV2 and BaseEndpoint.

To migrate an EndpointResolver implementation that uses a custom endpoint, set the client option BaseEndpoint instead.

func WithEndpointResolverV2 

func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)

WithEndpointResolverV2 returns a functional option for setting the Client's EndpointResolverV2 option.

func WithSigV4SigningName 

func WithSigV4SigningName(name string) func(*Options)

WithSigV4SigningName applies an override to the authentication workflow to use the given signing name for SigV4-authenticated operations.

This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing name from both auth scheme resolution and endpoint resolution.

func WithSigV4SigningRegion 

func WithSigV4SigningRegion(region string) func(*Options)

WithSigV4SigningRegion applies an override to the authentication workflow to use the given signing region for SigV4-authenticated operations.

This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing region from both auth scheme resolution and endpoint resolution.

Types

type AuthResolverParameters 

type AuthResolverParameters struct {
	// The name of the operation being invoked.
	Operation string

	// The region in which the operation is being invoked.
	Region string
}

AuthResolverParameters contains the set of inputs necessary for auth scheme resolution.

type AuthSchemeResolver 

type AuthSchemeResolver interface {
	ResolveAuthSchemes(context.Context, *AuthResolverParameters) ([]*smithyauth.Option, error)
}

AuthSchemeResolver returns a set of possible authentication options for an operation.

type Client 

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

Client provides the API client to make operations call for AWS Backup Search.

func New 

func New(options Options, optFns ...func(*Options)) *Client

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 

func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client

NewFromConfig returns a new client from the provided config.

func (*Client) GetSearchJob 

func (c *Client) GetSearchJob(ctx context.Context, params *GetSearchJobInput, optFns ...func(*Options)) (*GetSearchJobOutput, error)

This operation retrieves metadata of a search job, including its progress.

func (*Client) GetSearchResultExportJob 

func (c *Client) GetSearchResultExportJob(ctx context.Context, params *GetSearchResultExportJobInput, optFns ...func(*Options)) (*GetSearchResultExportJobOutput, error)

This operation retrieves the metadata of an export job.

An export job is an operation that transmits the results of a search job to a specified S3 bucket in a .csv file.

An export job allows you to retain results of a search beyond the search job's scheduled retention of 7 days.

func (*Client) ListSearchJobBackups 

func (c *Client) ListSearchJobBackups(ctx context.Context, params *ListSearchJobBackupsInput, optFns ...func(*Options)) (*ListSearchJobBackupsOutput, error)

This operation returns a list of all backups (recovery points) in a paginated format that were included in the search job.

If a search does not display an expected backup in the results, you can call this operation to display each backup included in the search. Any backups that were not included because they have a FAILED status from a permissions issue will be displayed, along with a status message.

Only recovery points with a backup index that has a status of ACTIVE will be included in search results. If the index has any other status, its status will be displayed along with a status message.

func (*Client) ListSearchJobResults 

func (c *Client) ListSearchJobResults(ctx context.Context, params *ListSearchJobResultsInput, optFns ...func(*Options)) (*ListSearchJobResultsOutput, error)

This operation returns a list of a specified search job.

func (*Client) ListSearchJobs 

func (c *Client) ListSearchJobs(ctx context.Context, params *ListSearchJobsInput, optFns ...func(*Options)) (*ListSearchJobsOutput, error)

This operation returns a list of search jobs belonging to an account.

func (*Client) ListSearchResultExportJobs 

func (c *Client) ListSearchResultExportJobs(ctx context.Context, params *ListSearchResultExportJobsInput, optFns ...func(*Options)) (*ListSearchResultExportJobsOutput, error)

This operation exports search results of a search job to a specified destination S3 bucket.

func (*Client) ListTagsForResource 

func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)

This operation returns the tags for a resource type.

func (*Client) Options 

func (c *Client) Options() Options

Options returns a copy of the client configuration.

Callers SHOULD NOT perform mutations on any inner structures within client config. Config overrides should instead be made on a per-operation basis through functional options.

func (*Client) StartSearchJob 

func (c *Client) StartSearchJob(ctx context.Context, params *StartSearchJobInput, optFns ...func(*Options)) (*StartSearchJobOutput, error)

This operation creates a search job which returns recovery points filtered by SearchScope and items filtered by ItemFilters.

You can optionally include ClientToken, EncryptionKeyArn, Name, and/or Tags.

func (*Client) StartSearchResultExportJob 

func (c *Client) StartSearchResultExportJob(ctx context.Context, params *StartSearchResultExportJobInput, optFns ...func(*Options)) (*StartSearchResultExportJobOutput, error)

This operations starts a job to export the results of search job to a designated S3 bucket.

func (*Client) StopSearchJob 

func (c *Client) StopSearchJob(ctx context.Context, params *StopSearchJobInput, optFns ...func(*Options)) (*StopSearchJobOutput, error)

This operations ends a search job.

Only a search job with a status of RUNNING can be stopped.

func (*Client) TagResource 

func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)

This operation puts tags on the resource you indicate.

func (*Client) UntagResource 

func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)

This operation removes tags from the specified resource.

type EndpointParameters 

type EndpointParameters struct {
	// When true, send this request to the FIPS-compliant regional endpoint. If the
	// configured endpoint does not have a FIPS compliant endpoint, dispatching the
	// request will return an error.
	//
	// Defaults to false if no value is
	// provided.
	//
	// AWS::UseFIPS
	UseFIPS *bool

	// Override the endpoint used to send this request
	//
	// Parameter is
	// required.
	//
	// SDK::Endpoint
	Endpoint *string

	// The AWS region used to dispatch the request.
	//
	// Parameter is
	// required.
	//
	// AWS::Region
	Region *string
}

EndpointParameters provides the parameters that influence how endpoints are resolved.

func (EndpointParameters) ValidateRequired 

func (p EndpointParameters) ValidateRequired() error

ValidateRequired validates required parameters are set.

func (EndpointParameters) WithDefaults 

func (p EndpointParameters) WithDefaults() EndpointParameters

WithDefaults returns a shallow copy of EndpointParameterswith default values applied to members where applicable.

type EndpointResolver 

type EndpointResolver interface {
	ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
}

EndpointResolver interface for resolving service endpoints.

func EndpointResolverFromURL 

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 

type EndpointResolverOptions = internalendpoints.Options

EndpointResolverOptions is the service endpoint resolver options

type EndpointResolverV2 

type EndpointResolverV2 interface {
	// ResolveEndpoint attempts to resolve the endpoint with the provided options,
	// returning the endpoint if found. Otherwise an error is returned.
	ResolveEndpoint(ctx context.Context, params EndpointParameters) (
		smithyendpoints.Endpoint, error,
	)
}

EndpointResolverV2 provides the interface for resolving service endpoints.

func NewDefaultEndpointResolverV2 

func NewDefaultEndpointResolverV2() EndpointResolverV2

type GetSearchJobInput 

type GetSearchJobInput struct {

	// Required unique string that specifies the search job.
	//
	// This member is required.
	SearchJobIdentifier *string
	// contains filtered or unexported fields
}

type GetSearchJobOutput 

type GetSearchJobOutput struct {

	// The date and time that a search job was created, in Unix format and Coordinated
	// Universal Time (UTC). The value of CompletionTime is accurate to milliseconds.
	// For example, the value 1516925490.087 represents Friday, January 26, 2018
	// 12:11:30.087 AM.
	//
	// This member is required.
	CreationTime *time.Time

	// Item Filters represent all input item properties specified when the search was
	// created.
	//
	// This member is required.
	ItemFilters *types.ItemFilters

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

	// The unique string that identifies the specified search job.
	//
	// This member is required.
	SearchJobIdentifier *string

	// The search scope is all backup properties input into a search.
	//
	// This member is required.
	SearchScope *types.SearchScope

	// The current status of the specified search job.
	//
	// A search job may have one of the following statuses: RUNNING ; COMPLETED ;
	// STOPPED ; FAILED ; TIMED_OUT ; or EXPIRED .
	//
	// This member is required.
	Status types.SearchJobState

	// The date and time that a search job completed, in Unix format and Coordinated
	// Universal Time (UTC). The value of CompletionTime is accurate to milliseconds.
	// For example, the value 1516925490.087 represents Friday, January 26, 2018
	// 12:11:30.087 AM.
	CompletionTime *time.Time

	// Returns numbers representing BackupsScannedCount, ItemsScanned, and
	// ItemsMatched.
	CurrentSearchProgress *types.CurrentSearchProgress

	// The encryption key for the specified search job.
	//
	// Example:
	// arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab .
	EncryptionKeyArn *string

	// Returned name of the specified search job.
	Name *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 *types.SearchScopeSummary

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetSearchResultExportJobInput 

type GetSearchResultExportJobInput struct {

	// This is the unique string that identifies a specific export job.
	//
	// Required for this operation.
	//
	// This member is required.
	ExportJobIdentifier *string
	// contains filtered or unexported fields
}

type GetSearchResultExportJobOutput 

type GetSearchResultExportJobOutput struct {

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

	// The date and time that an export job completed, 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.
	CompletionTime *time.Time

	// The date and time that an export job was 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 unique Amazon Resource Name (ARN) that uniquely identifies the export job.
	ExportJobArn *string

	// The export specification consists of the destination S3 bucket to which the
	// search results were exported, along with the destination prefix.
	ExportSpecification types.ExportSpecification

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

	// This is the current status of the export job.
	Status types.ExportJobStatus

	// A status message is a string that is returned for search job with a status of
	// FAILED , along with steps to remedy and retry the operation.
	StatusMessage *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type HTTPClient 

type HTTPClient interface {
	Do(*http.Request) (*http.Response, error)
}

type HTTPSignerV4 

type HTTPSignerV4 interface {
	SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time, optFns ...func(*v4.SignerOptions)) error
}

type ListSearchJobBackupsAPIClient 

type ListSearchJobBackupsAPIClient interface {
	ListSearchJobBackups(context.Context, *ListSearchJobBackupsInput, ...func(*Options)) (*ListSearchJobBackupsOutput, error)
}

ListSearchJobBackupsAPIClient is a client that implements the ListSearchJobBackups operation.

type ListSearchJobBackupsInput 

type ListSearchJobBackupsInput struct {

	// The unique string that specifies the search job.
	//
	// This member is required.
	SearchJobIdentifier *string

	// The maximum number of resource list items to be returned.
	MaxResults *int32

	// The next item following a partial list of returned backups included in a search
	// job.
	//
	// For example, if a request is made to return MaxResults number of backups,
	// 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 ListSearchJobBackupsOutput 

type ListSearchJobBackupsOutput struct {

	// The recovery points returned the results of a search job
	//
	// This member is required.
	Results []types.SearchJobBackupsResult

	// The next item following a partial list of returned backups included in a search
	// job.
	//
	// For example, if a request is made to return MaxResults number of backups,
	// 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 ListSearchJobBackupsPaginator 

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

ListSearchJobBackupsPaginator is a paginator for ListSearchJobBackups

func NewListSearchJobBackupsPaginator 

func NewListSearchJobBackupsPaginator(client ListSearchJobBackupsAPIClient, params *ListSearchJobBackupsInput, optFns ...func(*ListSearchJobBackupsPaginatorOptions)) *ListSearchJobBackupsPaginator

NewListSearchJobBackupsPaginator returns a new ListSearchJobBackupsPaginator

func (*ListSearchJobBackupsPaginator) HasMorePages 

func (p *ListSearchJobBackupsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListSearchJobBackupsPaginator) NextPage 

func (p *ListSearchJobBackupsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListSearchJobBackupsOutput, error)

NextPage retrieves the next ListSearchJobBackups page.

type ListSearchJobBackupsPaginatorOptions 

type ListSearchJobBackupsPaginatorOptions struct {
	// The maximum number of resource list 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
}

ListSearchJobBackupsPaginatorOptions is the paginator options for ListSearchJobBackups

type ListSearchJobResultsAPIClient 

type ListSearchJobResultsAPIClient interface {
	ListSearchJobResults(context.Context, *ListSearchJobResultsInput, ...func(*Options)) (*ListSearchJobResultsOutput, error)
}

ListSearchJobResultsAPIClient is a client that implements the ListSearchJobResults operation.

type ListSearchJobResultsInput 

type ListSearchJobResultsInput struct {

	// The unique string that specifies the search job.
	//
	// This member is required.
	SearchJobIdentifier *string

	// The maximum number of resource list items to be returned.
	MaxResults *int32

	// The next item following a partial list of returned search job results.
	//
	// For example, if a request is made to return MaxResults number of search job
	// results, 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 ListSearchJobResultsOutput 

type ListSearchJobResultsOutput struct {

	// The results consist of either EBSResultItem or S3ResultItem.
	//
	// This member is required.
	Results []types.ResultItem

	// The next item following a partial list of search job results.
	//
	// For example, if a request is made to return MaxResults number of backups,
	// 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 ListSearchJobResultsPaginator 

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

ListSearchJobResultsPaginator is a paginator for ListSearchJobResults

func NewListSearchJobResultsPaginator 

func NewListSearchJobResultsPaginator(client ListSearchJobResultsAPIClient, params *ListSearchJobResultsInput, optFns ...func(*ListSearchJobResultsPaginatorOptions)) *ListSearchJobResultsPaginator

NewListSearchJobResultsPaginator returns a new ListSearchJobResultsPaginator

func (*ListSearchJobResultsPaginator) HasMorePages 

func (p *ListSearchJobResultsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListSearchJobResultsPaginator) NextPage 

func (p *ListSearchJobResultsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListSearchJobResultsOutput, error)

NextPage retrieves the next ListSearchJobResults page.

type ListSearchJobResultsPaginatorOptions 

type ListSearchJobResultsPaginatorOptions struct {
	// The maximum number of resource list 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
}

ListSearchJobResultsPaginatorOptions is the paginator options for ListSearchJobResults

type ListSearchJobsAPIClient 

type ListSearchJobsAPIClient interface {
	ListSearchJobs(context.Context, *ListSearchJobsInput, ...func(*Options)) (*ListSearchJobsOutput, error)
}

ListSearchJobsAPIClient is a client that implements the ListSearchJobs operation.

type ListSearchJobsInput 

type ListSearchJobsInput struct {

	// Include this parameter to filter list by search job status.
	ByStatus types.SearchJobState

	// The maximum number of resource list items to be returned.
	MaxResults *int32

	// The next item following a partial list of returned search jobs.
	//
	// For example, if a request is made to return MaxResults number of backups,
	// 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 ListSearchJobsOutput 

type ListSearchJobsOutput struct {

	// The search jobs among the list, with details of the returned search jobs.
	//
	// This member is required.
	SearchJobs []types.SearchJobSummary

	// The next item following a partial list of returned backups included in a search
	// job.
	//
	// For example, if a request is made to return MaxResults number of backups,
	// 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 ListSearchJobsPaginator 

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

ListSearchJobsPaginator is a paginator for ListSearchJobs

func NewListSearchJobsPaginator 

func NewListSearchJobsPaginator(client ListSearchJobsAPIClient, params *ListSearchJobsInput, optFns ...func(*ListSearchJobsPaginatorOptions)) *ListSearchJobsPaginator

NewListSearchJobsPaginator returns a new ListSearchJobsPaginator

func (*ListSearchJobsPaginator) HasMorePages 

func (p *ListSearchJobsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListSearchJobsPaginator) NextPage 

func (p *ListSearchJobsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListSearchJobsOutput, error)

NextPage retrieves the next ListSearchJobs page.

type ListSearchJobsPaginatorOptions 

type ListSearchJobsPaginatorOptions struct {
	// The maximum number of resource list 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
}

ListSearchJobsPaginatorOptions is the paginator options for ListSearchJobs

type ListSearchResultExportJobsAPIClient 

type ListSearchResultExportJobsAPIClient interface {
	ListSearchResultExportJobs(context.Context, *ListSearchResultExportJobsInput, ...func(*Options)) (*ListSearchResultExportJobsOutput, error)
}

ListSearchResultExportJobsAPIClient is a client that implements the ListSearchResultExportJobs operation.

type ListSearchResultExportJobsInput 

type ListSearchResultExportJobsInput struct {

	// The maximum number of resource list items to be returned.
	MaxResults *int32

	// The next item following a partial list of returned backups included in a search
	// job.
	//
	// For example, if a request is made to return MaxResults number of backups,
	// NextToken allows you to return more items in your list starting at the location
	// pointed to by the next token.
	NextToken *string

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

	// The search jobs to be included in the export job can be filtered by including
	// this parameter.
	Status types.ExportJobStatus
	// contains filtered or unexported fields
}

type ListSearchResultExportJobsOutput 

type ListSearchResultExportJobsOutput struct {

	// The operation returns the included export jobs.
	//
	// This member is required.
	ExportJobs []types.ExportJobSummary

	// The next item following a partial list of returned backups included in a search
	// job.
	//
	// For example, if a request is made to return MaxResults number of backups,
	// 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 ListSearchResultExportJobsPaginator 

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

ListSearchResultExportJobsPaginator is a paginator for ListSearchResultExportJobs

func NewListSearchResultExportJobsPaginator 

func NewListSearchResultExportJobsPaginator(client ListSearchResultExportJobsAPIClient, params *ListSearchResultExportJobsInput, optFns ...func(*ListSearchResultExportJobsPaginatorOptions)) *ListSearchResultExportJobsPaginator

NewListSearchResultExportJobsPaginator returns a new ListSearchResultExportJobsPaginator

func (*ListSearchResultExportJobsPaginator) HasMorePages 

func (p *ListSearchResultExportJobsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListSearchResultExportJobsPaginator) NextPage 

func (p *ListSearchResultExportJobsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListSearchResultExportJobsOutput, error)

NextPage retrieves the next ListSearchResultExportJobs page.

type ListSearchResultExportJobsPaginatorOptions 

type ListSearchResultExportJobsPaginatorOptions struct {
	// The maximum number of resource list 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
}

ListSearchResultExportJobsPaginatorOptions is the paginator options for ListSearchResultExportJobs

type ListTagsForResourceInput 

type ListTagsForResourceInput struct {

	// The Amazon Resource Name (ARN) that uniquely identifies the resource.>
	//
	// This member is required.
	ResourceArn *string
	// contains filtered or unexported fields
}

type ListTagsForResourceOutput 

type ListTagsForResourceOutput struct {

	// List of tags returned by the operation.
	Tags map[string]*string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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

	// The optional application specific identifier appended to the User-Agent header.
	AppID string

	// This endpoint will be given as input to an EndpointResolverV2. It is used for
	// providing a custom base endpoint that is subject to modifications by the
	// processing EndpointResolverV2.
	BaseEndpoint *string

	// 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.
	//
	// Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a
	// value for this field will likely prevent you from using any endpoint-related
	// service features released after the introduction of EndpointResolverV2 and
	// BaseEndpoint.
	//
	// To migrate an EndpointResolver implementation that uses a custom endpoint, set
	// the client option BaseEndpoint instead.
	EndpointResolver EndpointResolver

	// Resolves the endpoint used for a particular service operation. This should be
	// used over the deprecated EndpointResolver.
	EndpointResolverV2 EndpointResolverV2

	// Signature Version 4 (SigV4) Signer
	HTTPSignerV4 HTTPSignerV4

	// The logger writer interface to write logging messages to.
	Logger logging.Logger

	// The client meter provider.
	MeterProvider metrics.MeterProvider

	// 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.
	//
	// 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 client tracer provider.
	TracerProvider tracing.TracerProvider

	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
	// implementation if nil.
	HTTPClient HTTPClient

	// The auth scheme resolver which determines how to authenticate for each
	// operation.
	AuthSchemeResolver AuthSchemeResolver

	// The list of auth schemes supported by the client.
	AuthSchemes []smithyhttp.AuthScheme
	// contains filtered or unexported fields
}

func (Options) Copy 

func (o Options) Copy() Options

Copy creates a clone where the APIOptions list is deep copied.

func (Options) GetIdentityResolver 

func (o Options) GetIdentityResolver(schemeID string) smithyauth.IdentityResolver

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 StartSearchJobInput 

type StartSearchJobInput struct {

	// This object can contain BackupResourceTypes, BackupResourceArns,
	// BackupResourceCreationTime, BackupResourceTags, and SourceResourceArns to filter
	// the recovery points returned by the search job.
	//
	// This member is required.
	SearchScope *types.SearchScope

	// Include this parameter to allow multiple identical calls for idempotency.
	//
	// A client token is valid for 8 hours after the first request that uses it is
	// completed. After this time, any request with the same token is treated as a new
	// request.
	ClientToken *string

	// The encryption key for the specified search job.
	EncryptionKeyArn *string

	// Item Filters represent all input item properties specified when the search was
	// created.
	//
	// Contains either EBSItemFilters or S3ItemFilters
	ItemFilters *types.ItemFilters

	// Include alphanumeric characters to create a name for this search job.
	Name *string

	// List of tags returned by the operation.
	Tags map[string]*string
	// contains filtered or unexported fields
}

type StartSearchJobOutput 

type StartSearchJobOutput struct {

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

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type StartSearchResultExportJobInput 

type StartSearchResultExportJobInput struct {

	// This specification contains a required string of the destination bucket;
	// optionally, you can include the destination prefix.
	//
	// This member is required.
	ExportSpecification types.ExportSpecification

	// The unique string that specifies the search job.
	//
	// This member is required.
	SearchJobIdentifier *string

	// Include this parameter to allow multiple identical calls for idempotency.
	//
	// A client token is valid for 8 hours after the first request that uses it is
	// completed. After this time, any request with the same token is treated as a new
	// request.
	ClientToken *string

	// This parameter specifies the role ARN used to start the search results export
	// jobs.
	RoleArn *string

	// Optional tags to include. A tag is a key-value pair you can use to manage,
	// filter, and search for your resources. Allowed characters include UTF-8 letters,
	// numbers, spaces, and the following characters: + - = . _ : /.
	Tags map[string]*string
	// contains filtered or unexported fields
}

type StartSearchResultExportJobOutput 

type StartSearchResultExportJobOutput struct {

	// This is the unique identifier that specifies the new export job.
	//
	// This member is required.
	ExportJobIdentifier *string

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type StopSearchJobInput 

type StopSearchJobInput struct {

	// The unique string that specifies the search job.
	//
	// This member is required.
	SearchJobIdentifier *string
	// contains filtered or unexported fields
}

type StopSearchJobOutput 

type StopSearchJobOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type TagResourceInput 

type TagResourceInput struct {

	// The Amazon Resource Name (ARN) that uniquely identifies the resource.
	//
	// This is the resource that will have the indicated tags.
	//
	// This member is required.
	ResourceArn *string

	// Required tags to include. A tag is a key-value pair you can use to manage,
	// filter, and search for your resources. Allowed characters include UTF-8 letters,
	// numbers, spaces, and the following characters: + - = . _ : /.
	//
	// 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 {

	// The Amazon Resource Name (ARN) that uniquely identifies the resource where you
	// want to remove tags.
	//
	// This member is required.
	ResourceArn *string

	// This required parameter contains the tag keys you want to remove from the
	// source.
	//
	// This member is required.
	TagKeys []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
}

Source Files

View all Source files

Directories

Path Synopsis
internal
endpoints

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.