Documentation ¶
Overview ¶
Package datasync provides the client and types for making API requests to AWS DataSync.
AWS DataSync is a managed data transfer service that makes it simpler for you to automate moving data between on-premises storage and Amazon Simple Storage Service (Amazon S3) or Amazon Elastic File System (Amazon EFS).
This API interface reference for AWS DataSync contains documentation for a programming interface that you can use to manage AWS DataSync.
See https://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09 for more information on this service.
See datasync package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/datasync/
Using the Client ¶
To contact AWS DataSync with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.
See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/
See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config
See the AWS DataSync client DataSync for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/datasync/#New
Index ¶
- Constants
- type AgentListEntry
- type CancelTaskExecutionInput
- type CancelTaskExecutionOutput
- type CreateAgentInput
- func (s CreateAgentInput) GoString() string
- func (s *CreateAgentInput) SetActivationKey(v string) *CreateAgentInput
- func (s *CreateAgentInput) SetAgentName(v string) *CreateAgentInput
- func (s *CreateAgentInput) SetSecurityGroupArns(v []*string) *CreateAgentInput
- func (s *CreateAgentInput) SetSubnetArns(v []*string) *CreateAgentInput
- func (s *CreateAgentInput) SetTags(v []*TagListEntry) *CreateAgentInput
- func (s *CreateAgentInput) SetVpcEndpointId(v string) *CreateAgentInput
- func (s CreateAgentInput) String() string
- func (s *CreateAgentInput) Validate() error
- type CreateAgentOutput
- type CreateLocationEfsInput
- func (s CreateLocationEfsInput) GoString() string
- func (s *CreateLocationEfsInput) SetEc2Config(v *Ec2Config) *CreateLocationEfsInput
- func (s *CreateLocationEfsInput) SetEfsFilesystemArn(v string) *CreateLocationEfsInput
- func (s *CreateLocationEfsInput) SetSubdirectory(v string) *CreateLocationEfsInput
- func (s *CreateLocationEfsInput) SetTags(v []*TagListEntry) *CreateLocationEfsInput
- func (s CreateLocationEfsInput) String() string
- func (s *CreateLocationEfsInput) Validate() error
- type CreateLocationEfsOutput
- type CreateLocationNfsInput
- func (s CreateLocationNfsInput) GoString() string
- func (s *CreateLocationNfsInput) SetMountOptions(v *NfsMountOptions) *CreateLocationNfsInput
- func (s *CreateLocationNfsInput) SetOnPremConfig(v *OnPremConfig) *CreateLocationNfsInput
- func (s *CreateLocationNfsInput) SetServerHostname(v string) *CreateLocationNfsInput
- func (s *CreateLocationNfsInput) SetSubdirectory(v string) *CreateLocationNfsInput
- func (s *CreateLocationNfsInput) SetTags(v []*TagListEntry) *CreateLocationNfsInput
- func (s CreateLocationNfsInput) String() string
- func (s *CreateLocationNfsInput) Validate() error
- type CreateLocationNfsOutput
- type CreateLocationS3Input
- func (s CreateLocationS3Input) GoString() string
- func (s *CreateLocationS3Input) SetS3BucketArn(v string) *CreateLocationS3Input
- func (s *CreateLocationS3Input) SetS3Config(v *S3Config) *CreateLocationS3Input
- func (s *CreateLocationS3Input) SetS3StorageClass(v string) *CreateLocationS3Input
- func (s *CreateLocationS3Input) SetSubdirectory(v string) *CreateLocationS3Input
- func (s *CreateLocationS3Input) SetTags(v []*TagListEntry) *CreateLocationS3Input
- func (s CreateLocationS3Input) String() string
- func (s *CreateLocationS3Input) Validate() error
- type CreateLocationS3Output
- type CreateLocationSmbInput
- func (s CreateLocationSmbInput) GoString() string
- func (s *CreateLocationSmbInput) SetAgentArns(v []*string) *CreateLocationSmbInput
- func (s *CreateLocationSmbInput) SetDomain(v string) *CreateLocationSmbInput
- func (s *CreateLocationSmbInput) SetMountOptions(v *SmbMountOptions) *CreateLocationSmbInput
- func (s *CreateLocationSmbInput) SetPassword(v string) *CreateLocationSmbInput
- func (s *CreateLocationSmbInput) SetServerHostname(v string) *CreateLocationSmbInput
- func (s *CreateLocationSmbInput) SetSubdirectory(v string) *CreateLocationSmbInput
- func (s *CreateLocationSmbInput) SetTags(v []*TagListEntry) *CreateLocationSmbInput
- func (s *CreateLocationSmbInput) SetUser(v string) *CreateLocationSmbInput
- func (s CreateLocationSmbInput) String() string
- func (s *CreateLocationSmbInput) Validate() error
- type CreateLocationSmbOutput
- type CreateTaskInput
- func (s CreateTaskInput) GoString() string
- func (s *CreateTaskInput) SetCloudWatchLogGroupArn(v string) *CreateTaskInput
- func (s *CreateTaskInput) SetDestinationLocationArn(v string) *CreateTaskInput
- func (s *CreateTaskInput) SetExcludes(v []*FilterRule) *CreateTaskInput
- func (s *CreateTaskInput) SetName(v string) *CreateTaskInput
- func (s *CreateTaskInput) SetOptions(v *Options) *CreateTaskInput
- func (s *CreateTaskInput) SetSourceLocationArn(v string) *CreateTaskInput
- func (s *CreateTaskInput) SetTags(v []*TagListEntry) *CreateTaskInput
- func (s CreateTaskInput) String() string
- func (s *CreateTaskInput) Validate() error
- type CreateTaskOutput
- type DataSync
- func (c *DataSync) CancelTaskExecution(input *CancelTaskExecutionInput) (*CancelTaskExecutionOutput, error)
- func (c *DataSync) CancelTaskExecutionRequest(input *CancelTaskExecutionInput) (req *request.Request, output *CancelTaskExecutionOutput)
- func (c *DataSync) CancelTaskExecutionWithContext(ctx aws.Context, input *CancelTaskExecutionInput, opts ...request.Option) (*CancelTaskExecutionOutput, error)
- func (c *DataSync) CreateAgent(input *CreateAgentInput) (*CreateAgentOutput, error)
- func (c *DataSync) CreateAgentRequest(input *CreateAgentInput) (req *request.Request, output *CreateAgentOutput)
- func (c *DataSync) CreateAgentWithContext(ctx aws.Context, input *CreateAgentInput, opts ...request.Option) (*CreateAgentOutput, error)
- func (c *DataSync) CreateLocationEfs(input *CreateLocationEfsInput) (*CreateLocationEfsOutput, error)
- func (c *DataSync) CreateLocationEfsRequest(input *CreateLocationEfsInput) (req *request.Request, output *CreateLocationEfsOutput)
- func (c *DataSync) CreateLocationEfsWithContext(ctx aws.Context, input *CreateLocationEfsInput, opts ...request.Option) (*CreateLocationEfsOutput, error)
- func (c *DataSync) CreateLocationNfs(input *CreateLocationNfsInput) (*CreateLocationNfsOutput, error)
- func (c *DataSync) CreateLocationNfsRequest(input *CreateLocationNfsInput) (req *request.Request, output *CreateLocationNfsOutput)
- func (c *DataSync) CreateLocationNfsWithContext(ctx aws.Context, input *CreateLocationNfsInput, opts ...request.Option) (*CreateLocationNfsOutput, error)
- func (c *DataSync) CreateLocationS3(input *CreateLocationS3Input) (*CreateLocationS3Output, error)
- func (c *DataSync) CreateLocationS3Request(input *CreateLocationS3Input) (req *request.Request, output *CreateLocationS3Output)
- func (c *DataSync) CreateLocationS3WithContext(ctx aws.Context, input *CreateLocationS3Input, opts ...request.Option) (*CreateLocationS3Output, error)
- func (c *DataSync) CreateLocationSmb(input *CreateLocationSmbInput) (*CreateLocationSmbOutput, error)
- func (c *DataSync) CreateLocationSmbRequest(input *CreateLocationSmbInput) (req *request.Request, output *CreateLocationSmbOutput)
- func (c *DataSync) CreateLocationSmbWithContext(ctx aws.Context, input *CreateLocationSmbInput, opts ...request.Option) (*CreateLocationSmbOutput, error)
- func (c *DataSync) CreateTask(input *CreateTaskInput) (*CreateTaskOutput, error)
- func (c *DataSync) CreateTaskRequest(input *CreateTaskInput) (req *request.Request, output *CreateTaskOutput)
- func (c *DataSync) CreateTaskWithContext(ctx aws.Context, input *CreateTaskInput, opts ...request.Option) (*CreateTaskOutput, error)
- func (c *DataSync) DeleteAgent(input *DeleteAgentInput) (*DeleteAgentOutput, error)
- func (c *DataSync) DeleteAgentRequest(input *DeleteAgentInput) (req *request.Request, output *DeleteAgentOutput)
- func (c *DataSync) DeleteAgentWithContext(ctx aws.Context, input *DeleteAgentInput, opts ...request.Option) (*DeleteAgentOutput, error)
- func (c *DataSync) DeleteLocation(input *DeleteLocationInput) (*DeleteLocationOutput, error)
- func (c *DataSync) DeleteLocationRequest(input *DeleteLocationInput) (req *request.Request, output *DeleteLocationOutput)
- func (c *DataSync) DeleteLocationWithContext(ctx aws.Context, input *DeleteLocationInput, opts ...request.Option) (*DeleteLocationOutput, error)
- func (c *DataSync) DeleteTask(input *DeleteTaskInput) (*DeleteTaskOutput, error)
- func (c *DataSync) DeleteTaskRequest(input *DeleteTaskInput) (req *request.Request, output *DeleteTaskOutput)
- func (c *DataSync) DeleteTaskWithContext(ctx aws.Context, input *DeleteTaskInput, opts ...request.Option) (*DeleteTaskOutput, error)
- func (c *DataSync) DescribeAgent(input *DescribeAgentInput) (*DescribeAgentOutput, error)
- func (c *DataSync) DescribeAgentRequest(input *DescribeAgentInput) (req *request.Request, output *DescribeAgentOutput)
- func (c *DataSync) DescribeAgentWithContext(ctx aws.Context, input *DescribeAgentInput, opts ...request.Option) (*DescribeAgentOutput, error)
- func (c *DataSync) DescribeLocationEfs(input *DescribeLocationEfsInput) (*DescribeLocationEfsOutput, error)
- func (c *DataSync) DescribeLocationEfsRequest(input *DescribeLocationEfsInput) (req *request.Request, output *DescribeLocationEfsOutput)
- func (c *DataSync) DescribeLocationEfsWithContext(ctx aws.Context, input *DescribeLocationEfsInput, opts ...request.Option) (*DescribeLocationEfsOutput, error)
- func (c *DataSync) DescribeLocationNfs(input *DescribeLocationNfsInput) (*DescribeLocationNfsOutput, error)
- func (c *DataSync) DescribeLocationNfsRequest(input *DescribeLocationNfsInput) (req *request.Request, output *DescribeLocationNfsOutput)
- func (c *DataSync) DescribeLocationNfsWithContext(ctx aws.Context, input *DescribeLocationNfsInput, opts ...request.Option) (*DescribeLocationNfsOutput, error)
- func (c *DataSync) DescribeLocationS3(input *DescribeLocationS3Input) (*DescribeLocationS3Output, error)
- func (c *DataSync) DescribeLocationS3Request(input *DescribeLocationS3Input) (req *request.Request, output *DescribeLocationS3Output)
- func (c *DataSync) DescribeLocationS3WithContext(ctx aws.Context, input *DescribeLocationS3Input, opts ...request.Option) (*DescribeLocationS3Output, error)
- func (c *DataSync) DescribeLocationSmb(input *DescribeLocationSmbInput) (*DescribeLocationSmbOutput, error)
- func (c *DataSync) DescribeLocationSmbRequest(input *DescribeLocationSmbInput) (req *request.Request, output *DescribeLocationSmbOutput)
- func (c *DataSync) DescribeLocationSmbWithContext(ctx aws.Context, input *DescribeLocationSmbInput, opts ...request.Option) (*DescribeLocationSmbOutput, error)
- func (c *DataSync) DescribeTask(input *DescribeTaskInput) (*DescribeTaskOutput, error)
- func (c *DataSync) DescribeTaskExecution(input *DescribeTaskExecutionInput) (*DescribeTaskExecutionOutput, error)
- func (c *DataSync) DescribeTaskExecutionRequest(input *DescribeTaskExecutionInput) (req *request.Request, output *DescribeTaskExecutionOutput)
- func (c *DataSync) DescribeTaskExecutionWithContext(ctx aws.Context, input *DescribeTaskExecutionInput, opts ...request.Option) (*DescribeTaskExecutionOutput, error)
- func (c *DataSync) DescribeTaskRequest(input *DescribeTaskInput) (req *request.Request, output *DescribeTaskOutput)
- func (c *DataSync) DescribeTaskWithContext(ctx aws.Context, input *DescribeTaskInput, opts ...request.Option) (*DescribeTaskOutput, error)
- func (c *DataSync) ListAgents(input *ListAgentsInput) (*ListAgentsOutput, error)
- func (c *DataSync) ListAgentsPages(input *ListAgentsInput, fn func(*ListAgentsOutput, bool) bool) error
- func (c *DataSync) ListAgentsPagesWithContext(ctx aws.Context, input *ListAgentsInput, fn func(*ListAgentsOutput, bool) bool, ...) error
- func (c *DataSync) ListAgentsRequest(input *ListAgentsInput) (req *request.Request, output *ListAgentsOutput)
- func (c *DataSync) ListAgentsWithContext(ctx aws.Context, input *ListAgentsInput, opts ...request.Option) (*ListAgentsOutput, error)
- func (c *DataSync) ListLocations(input *ListLocationsInput) (*ListLocationsOutput, error)
- func (c *DataSync) ListLocationsPages(input *ListLocationsInput, fn func(*ListLocationsOutput, bool) bool) error
- func (c *DataSync) ListLocationsPagesWithContext(ctx aws.Context, input *ListLocationsInput, ...) error
- func (c *DataSync) ListLocationsRequest(input *ListLocationsInput) (req *request.Request, output *ListLocationsOutput)
- func (c *DataSync) ListLocationsWithContext(ctx aws.Context, input *ListLocationsInput, opts ...request.Option) (*ListLocationsOutput, error)
- func (c *DataSync) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error)
- func (c *DataSync) ListTagsForResourcePages(input *ListTagsForResourceInput, ...) error
- func (c *DataSync) ListTagsForResourcePagesWithContext(ctx aws.Context, input *ListTagsForResourceInput, ...) error
- func (c *DataSync) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req *request.Request, output *ListTagsForResourceOutput)
- func (c *DataSync) ListTagsForResourceWithContext(ctx aws.Context, input *ListTagsForResourceInput, opts ...request.Option) (*ListTagsForResourceOutput, error)
- func (c *DataSync) ListTaskExecutions(input *ListTaskExecutionsInput) (*ListTaskExecutionsOutput, error)
- func (c *DataSync) ListTaskExecutionsPages(input *ListTaskExecutionsInput, fn func(*ListTaskExecutionsOutput, bool) bool) error
- func (c *DataSync) ListTaskExecutionsPagesWithContext(ctx aws.Context, input *ListTaskExecutionsInput, ...) error
- func (c *DataSync) ListTaskExecutionsRequest(input *ListTaskExecutionsInput) (req *request.Request, output *ListTaskExecutionsOutput)
- func (c *DataSync) ListTaskExecutionsWithContext(ctx aws.Context, input *ListTaskExecutionsInput, opts ...request.Option) (*ListTaskExecutionsOutput, error)
- func (c *DataSync) ListTasks(input *ListTasksInput) (*ListTasksOutput, error)
- func (c *DataSync) ListTasksPages(input *ListTasksInput, fn func(*ListTasksOutput, bool) bool) error
- func (c *DataSync) ListTasksPagesWithContext(ctx aws.Context, input *ListTasksInput, fn func(*ListTasksOutput, bool) bool, ...) error
- func (c *DataSync) ListTasksRequest(input *ListTasksInput) (req *request.Request, output *ListTasksOutput)
- func (c *DataSync) ListTasksWithContext(ctx aws.Context, input *ListTasksInput, opts ...request.Option) (*ListTasksOutput, error)
- func (c *DataSync) StartTaskExecution(input *StartTaskExecutionInput) (*StartTaskExecutionOutput, error)
- func (c *DataSync) StartTaskExecutionRequest(input *StartTaskExecutionInput) (req *request.Request, output *StartTaskExecutionOutput)
- func (c *DataSync) StartTaskExecutionWithContext(ctx aws.Context, input *StartTaskExecutionInput, opts ...request.Option) (*StartTaskExecutionOutput, error)
- func (c *DataSync) TagResource(input *TagResourceInput) (*TagResourceOutput, error)
- func (c *DataSync) TagResourceRequest(input *TagResourceInput) (req *request.Request, output *TagResourceOutput)
- func (c *DataSync) TagResourceWithContext(ctx aws.Context, input *TagResourceInput, opts ...request.Option) (*TagResourceOutput, error)
- func (c *DataSync) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error)
- func (c *DataSync) UntagResourceRequest(input *UntagResourceInput) (req *request.Request, output *UntagResourceOutput)
- func (c *DataSync) UntagResourceWithContext(ctx aws.Context, input *UntagResourceInput, opts ...request.Option) (*UntagResourceOutput, error)
- func (c *DataSync) UpdateAgent(input *UpdateAgentInput) (*UpdateAgentOutput, error)
- func (c *DataSync) UpdateAgentRequest(input *UpdateAgentInput) (req *request.Request, output *UpdateAgentOutput)
- func (c *DataSync) UpdateAgentWithContext(ctx aws.Context, input *UpdateAgentInput, opts ...request.Option) (*UpdateAgentOutput, error)
- func (c *DataSync) UpdateTask(input *UpdateTaskInput) (*UpdateTaskOutput, error)
- func (c *DataSync) UpdateTaskRequest(input *UpdateTaskInput) (req *request.Request, output *UpdateTaskOutput)
- func (c *DataSync) UpdateTaskWithContext(ctx aws.Context, input *UpdateTaskInput, opts ...request.Option) (*UpdateTaskOutput, error)
- type DeleteAgentInput
- type DeleteAgentOutput
- type DeleteLocationInput
- type DeleteLocationOutput
- type DeleteTaskInput
- type DeleteTaskOutput
- type DescribeAgentInput
- type DescribeAgentOutput
- func (s DescribeAgentOutput) GoString() string
- func (s *DescribeAgentOutput) SetAgentArn(v string) *DescribeAgentOutput
- func (s *DescribeAgentOutput) SetCreationTime(v time.Time) *DescribeAgentOutput
- func (s *DescribeAgentOutput) SetEndpointType(v string) *DescribeAgentOutput
- func (s *DescribeAgentOutput) SetLastConnectionTime(v time.Time) *DescribeAgentOutput
- func (s *DescribeAgentOutput) SetName(v string) *DescribeAgentOutput
- func (s *DescribeAgentOutput) SetPrivateLinkConfig(v *PrivateLinkConfig) *DescribeAgentOutput
- func (s *DescribeAgentOutput) SetStatus(v string) *DescribeAgentOutput
- func (s DescribeAgentOutput) String() string
- type DescribeLocationEfsInput
- type DescribeLocationEfsOutput
- func (s DescribeLocationEfsOutput) GoString() string
- func (s *DescribeLocationEfsOutput) SetCreationTime(v time.Time) *DescribeLocationEfsOutput
- func (s *DescribeLocationEfsOutput) SetEc2Config(v *Ec2Config) *DescribeLocationEfsOutput
- func (s *DescribeLocationEfsOutput) SetLocationArn(v string) *DescribeLocationEfsOutput
- func (s *DescribeLocationEfsOutput) SetLocationUri(v string) *DescribeLocationEfsOutput
- func (s DescribeLocationEfsOutput) String() string
- type DescribeLocationNfsInput
- type DescribeLocationNfsOutput
- func (s DescribeLocationNfsOutput) GoString() string
- func (s *DescribeLocationNfsOutput) SetCreationTime(v time.Time) *DescribeLocationNfsOutput
- func (s *DescribeLocationNfsOutput) SetLocationArn(v string) *DescribeLocationNfsOutput
- func (s *DescribeLocationNfsOutput) SetLocationUri(v string) *DescribeLocationNfsOutput
- func (s *DescribeLocationNfsOutput) SetMountOptions(v *NfsMountOptions) *DescribeLocationNfsOutput
- func (s *DescribeLocationNfsOutput) SetOnPremConfig(v *OnPremConfig) *DescribeLocationNfsOutput
- func (s DescribeLocationNfsOutput) String() string
- type DescribeLocationS3Input
- type DescribeLocationS3Output
- func (s DescribeLocationS3Output) GoString() string
- func (s *DescribeLocationS3Output) SetCreationTime(v time.Time) *DescribeLocationS3Output
- func (s *DescribeLocationS3Output) SetLocationArn(v string) *DescribeLocationS3Output
- func (s *DescribeLocationS3Output) SetLocationUri(v string) *DescribeLocationS3Output
- func (s *DescribeLocationS3Output) SetS3Config(v *S3Config) *DescribeLocationS3Output
- func (s *DescribeLocationS3Output) SetS3StorageClass(v string) *DescribeLocationS3Output
- func (s DescribeLocationS3Output) String() string
- type DescribeLocationSmbInput
- type DescribeLocationSmbOutput
- func (s DescribeLocationSmbOutput) GoString() string
- func (s *DescribeLocationSmbOutput) SetAgentArns(v []*string) *DescribeLocationSmbOutput
- func (s *DescribeLocationSmbOutput) SetCreationTime(v time.Time) *DescribeLocationSmbOutput
- func (s *DescribeLocationSmbOutput) SetDomain(v string) *DescribeLocationSmbOutput
- func (s *DescribeLocationSmbOutput) SetLocationArn(v string) *DescribeLocationSmbOutput
- func (s *DescribeLocationSmbOutput) SetLocationUri(v string) *DescribeLocationSmbOutput
- func (s *DescribeLocationSmbOutput) SetMountOptions(v *SmbMountOptions) *DescribeLocationSmbOutput
- func (s *DescribeLocationSmbOutput) SetUser(v string) *DescribeLocationSmbOutput
- func (s DescribeLocationSmbOutput) String() string
- type DescribeTaskExecutionInput
- type DescribeTaskExecutionOutput
- func (s DescribeTaskExecutionOutput) GoString() string
- func (s *DescribeTaskExecutionOutput) SetBytesTransferred(v int64) *DescribeTaskExecutionOutput
- func (s *DescribeTaskExecutionOutput) SetBytesWritten(v int64) *DescribeTaskExecutionOutput
- func (s *DescribeTaskExecutionOutput) SetEstimatedBytesToTransfer(v int64) *DescribeTaskExecutionOutput
- func (s *DescribeTaskExecutionOutput) SetEstimatedFilesToTransfer(v int64) *DescribeTaskExecutionOutput
- func (s *DescribeTaskExecutionOutput) SetExcludes(v []*FilterRule) *DescribeTaskExecutionOutput
- func (s *DescribeTaskExecutionOutput) SetFilesTransferred(v int64) *DescribeTaskExecutionOutput
- func (s *DescribeTaskExecutionOutput) SetIncludes(v []*FilterRule) *DescribeTaskExecutionOutput
- func (s *DescribeTaskExecutionOutput) SetOptions(v *Options) *DescribeTaskExecutionOutput
- func (s *DescribeTaskExecutionOutput) SetResult(v *TaskExecutionResultDetail) *DescribeTaskExecutionOutput
- func (s *DescribeTaskExecutionOutput) SetStartTime(v time.Time) *DescribeTaskExecutionOutput
- func (s *DescribeTaskExecutionOutput) SetStatus(v string) *DescribeTaskExecutionOutput
- func (s *DescribeTaskExecutionOutput) SetTaskExecutionArn(v string) *DescribeTaskExecutionOutput
- func (s DescribeTaskExecutionOutput) String() string
- type DescribeTaskInput
- type DescribeTaskOutput
- func (s DescribeTaskOutput) GoString() string
- func (s *DescribeTaskOutput) SetCloudWatchLogGroupArn(v string) *DescribeTaskOutput
- func (s *DescribeTaskOutput) SetCreationTime(v time.Time) *DescribeTaskOutput
- func (s *DescribeTaskOutput) SetCurrentTaskExecutionArn(v string) *DescribeTaskOutput
- func (s *DescribeTaskOutput) SetDestinationLocationArn(v string) *DescribeTaskOutput
- func (s *DescribeTaskOutput) SetDestinationNetworkInterfaceArns(v []*string) *DescribeTaskOutput
- func (s *DescribeTaskOutput) SetErrorCode(v string) *DescribeTaskOutput
- func (s *DescribeTaskOutput) SetErrorDetail(v string) *DescribeTaskOutput
- func (s *DescribeTaskOutput) SetExcludes(v []*FilterRule) *DescribeTaskOutput
- func (s *DescribeTaskOutput) SetName(v string) *DescribeTaskOutput
- func (s *DescribeTaskOutput) SetOptions(v *Options) *DescribeTaskOutput
- func (s *DescribeTaskOutput) SetSourceLocationArn(v string) *DescribeTaskOutput
- func (s *DescribeTaskOutput) SetSourceNetworkInterfaceArns(v []*string) *DescribeTaskOutput
- func (s *DescribeTaskOutput) SetStatus(v string) *DescribeTaskOutput
- func (s *DescribeTaskOutput) SetTaskArn(v string) *DescribeTaskOutput
- func (s DescribeTaskOutput) String() string
- type Ec2Config
- type FilterRule
- type ListAgentsInput
- type ListAgentsOutput
- type ListLocationsInput
- type ListLocationsOutput
- type ListTagsForResourceInput
- func (s ListTagsForResourceInput) GoString() string
- func (s *ListTagsForResourceInput) SetMaxResults(v int64) *ListTagsForResourceInput
- func (s *ListTagsForResourceInput) SetNextToken(v string) *ListTagsForResourceInput
- func (s *ListTagsForResourceInput) SetResourceArn(v string) *ListTagsForResourceInput
- func (s ListTagsForResourceInput) String() string
- func (s *ListTagsForResourceInput) Validate() error
- type ListTagsForResourceOutput
- type ListTaskExecutionsInput
- func (s ListTaskExecutionsInput) GoString() string
- func (s *ListTaskExecutionsInput) SetMaxResults(v int64) *ListTaskExecutionsInput
- func (s *ListTaskExecutionsInput) SetNextToken(v string) *ListTaskExecutionsInput
- func (s *ListTaskExecutionsInput) SetTaskArn(v string) *ListTaskExecutionsInput
- func (s ListTaskExecutionsInput) String() string
- type ListTaskExecutionsOutput
- type ListTasksInput
- type ListTasksOutput
- type LocationListEntry
- type NfsMountOptions
- type OnPremConfig
- type Options
- func (s Options) GoString() string
- func (s *Options) SetAtime(v string) *Options
- func (s *Options) SetBytesPerSecond(v int64) *Options
- func (s *Options) SetGid(v string) *Options
- func (s *Options) SetMtime(v string) *Options
- func (s *Options) SetOverwriteMode(v string) *Options
- func (s *Options) SetPosixPermissions(v string) *Options
- func (s *Options) SetPreserveDeletedFiles(v string) *Options
- func (s *Options) SetPreserveDevices(v string) *Options
- func (s *Options) SetUid(v string) *Options
- func (s *Options) SetVerifyMode(v string) *Options
- func (s Options) String() string
- func (s *Options) Validate() error
- type PrivateLinkConfig
- func (s PrivateLinkConfig) GoString() string
- func (s *PrivateLinkConfig) SetPrivateLinkEndpoint(v string) *PrivateLinkConfig
- func (s *PrivateLinkConfig) SetSecurityGroupArns(v []*string) *PrivateLinkConfig
- func (s *PrivateLinkConfig) SetSubnetArns(v []*string) *PrivateLinkConfig
- func (s *PrivateLinkConfig) SetVpcEndpointId(v string) *PrivateLinkConfig
- func (s PrivateLinkConfig) String() string
- type S3Config
- type SmbMountOptions
- type StartTaskExecutionInput
- func (s StartTaskExecutionInput) GoString() string
- func (s *StartTaskExecutionInput) SetIncludes(v []*FilterRule) *StartTaskExecutionInput
- func (s *StartTaskExecutionInput) SetOverrideOptions(v *Options) *StartTaskExecutionInput
- func (s *StartTaskExecutionInput) SetTaskArn(v string) *StartTaskExecutionInput
- func (s StartTaskExecutionInput) String() string
- func (s *StartTaskExecutionInput) Validate() error
- type StartTaskExecutionOutput
- type TagListEntry
- type TagResourceInput
- type TagResourceOutput
- type TaskExecutionListEntry
- type TaskExecutionResultDetail
- func (s TaskExecutionResultDetail) GoString() string
- func (s *TaskExecutionResultDetail) SetErrorCode(v string) *TaskExecutionResultDetail
- func (s *TaskExecutionResultDetail) SetErrorDetail(v string) *TaskExecutionResultDetail
- func (s *TaskExecutionResultDetail) SetPrepareDuration(v int64) *TaskExecutionResultDetail
- func (s *TaskExecutionResultDetail) SetPrepareStatus(v string) *TaskExecutionResultDetail
- func (s *TaskExecutionResultDetail) SetTransferDuration(v int64) *TaskExecutionResultDetail
- func (s *TaskExecutionResultDetail) SetTransferStatus(v string) *TaskExecutionResultDetail
- func (s *TaskExecutionResultDetail) SetVerifyDuration(v int64) *TaskExecutionResultDetail
- func (s *TaskExecutionResultDetail) SetVerifyStatus(v string) *TaskExecutionResultDetail
- func (s TaskExecutionResultDetail) String() string
- type TaskListEntry
- type UntagResourceInput
- type UntagResourceOutput
- type UpdateAgentInput
- type UpdateAgentOutput
- type UpdateTaskInput
- func (s UpdateTaskInput) GoString() string
- func (s *UpdateTaskInput) SetCloudWatchLogGroupArn(v string) *UpdateTaskInput
- func (s *UpdateTaskInput) SetExcludes(v []*FilterRule) *UpdateTaskInput
- func (s *UpdateTaskInput) SetName(v string) *UpdateTaskInput
- func (s *UpdateTaskInput) SetOptions(v *Options) *UpdateTaskInput
- func (s *UpdateTaskInput) SetTaskArn(v string) *UpdateTaskInput
- func (s UpdateTaskInput) String() string
- func (s *UpdateTaskInput) Validate() error
- type UpdateTaskOutput
Constants ¶
const ( // AgentStatusOnline is a AgentStatus enum value AgentStatusOnline = "ONLINE" // AgentStatusOffline is a AgentStatus enum value AgentStatusOffline = "OFFLINE" )
const ( // AtimeNone is a Atime enum value AtimeNone = "NONE" // AtimeBestEffort is a Atime enum value AtimeBestEffort = "BEST_EFFORT" )
const ( // EndpointTypePublic is a EndpointType enum value EndpointTypePublic = "PUBLIC" // EndpointTypePrivateLink is a EndpointType enum value EndpointTypePrivateLink = "PRIVATE_LINK" )
const ( // GidNone is a Gid enum value GidNone = "NONE" // GidIntValue is a Gid enum value GidIntValue = "INT_VALUE" // GidName is a Gid enum value GidName = "NAME" // GidBoth is a Gid enum value GidBoth = "BOTH" )
const ( // MtimeNone is a Mtime enum value MtimeNone = "NONE" // MtimePreserve is a Mtime enum value MtimePreserve = "PRESERVE" )
const ( // NfsVersionAutomatic is a NfsVersion enum value NfsVersionAutomatic = "AUTOMATIC" // NfsVersionNfs3 is a NfsVersion enum value NfsVersionNfs3 = "NFS3" // NfsVersionNfs40 is a NfsVersion enum value NfsVersionNfs40 = "NFS4_0" // NfsVersionNfs41 is a NfsVersion enum value NfsVersionNfs41 = "NFS4_1" )
const ( // OverwriteModeAlways is a OverwriteMode enum value OverwriteModeAlways = "ALWAYS" // OverwriteModeNever is a OverwriteMode enum value OverwriteModeNever = "NEVER" )
const ( // PhaseStatusPending is a PhaseStatus enum value PhaseStatusPending = "PENDING" // PhaseStatusSuccess is a PhaseStatus enum value PhaseStatusSuccess = "SUCCESS" // PhaseStatusError is a PhaseStatus enum value PhaseStatusError = "ERROR" )
const ( // PosixPermissionsNone is a PosixPermissions enum value PosixPermissionsNone = "NONE" // PosixPermissionsBestEffort is a PosixPermissions enum value PosixPermissionsBestEffort = "BEST_EFFORT" // PosixPermissionsPreserve is a PosixPermissions enum value PosixPermissionsPreserve = "PRESERVE" )
const ( // PreserveDeletedFilesPreserve is a PreserveDeletedFiles enum value PreserveDeletedFilesPreserve = "PRESERVE" // PreserveDeletedFilesRemove is a PreserveDeletedFiles enum value PreserveDeletedFilesRemove = "REMOVE" )
const ( // PreserveDevicesNone is a PreserveDevices enum value PreserveDevicesNone = "NONE" // PreserveDevicesPreserve is a PreserveDevices enum value PreserveDevicesPreserve = "PRESERVE" )
const ( // S3StorageClassStandard is a S3StorageClass enum value S3StorageClassStandard = "STANDARD" // S3StorageClassStandardIa is a S3StorageClass enum value S3StorageClassStandardIa = "STANDARD_IA" // S3StorageClassOnezoneIa is a S3StorageClass enum value S3StorageClassOnezoneIa = "ONEZONE_IA" // S3StorageClassIntelligentTiering is a S3StorageClass enum value S3StorageClassIntelligentTiering = "INTELLIGENT_TIERING" // S3StorageClassGlacier is a S3StorageClass enum value S3StorageClassGlacier = "GLACIER" // S3StorageClassDeepArchive is a S3StorageClass enum value S3StorageClassDeepArchive = "DEEP_ARCHIVE" )
const ( // SmbVersionAutomatic is a SmbVersion enum value SmbVersionAutomatic = "AUTOMATIC" // SmbVersionSmb2 is a SmbVersion enum value SmbVersionSmb2 = "SMB2" // SmbVersionSmb3 is a SmbVersion enum value SmbVersionSmb3 = "SMB3" )
const ( // TaskExecutionStatusLaunching is a TaskExecutionStatus enum value TaskExecutionStatusLaunching = "LAUNCHING" // TaskExecutionStatusPreparing is a TaskExecutionStatus enum value TaskExecutionStatusPreparing = "PREPARING" // TaskExecutionStatusTransferring is a TaskExecutionStatus enum value TaskExecutionStatusTransferring = "TRANSFERRING" // TaskExecutionStatusVerifying is a TaskExecutionStatus enum value TaskExecutionStatusVerifying = "VERIFYING" // TaskExecutionStatusSuccess is a TaskExecutionStatus enum value TaskExecutionStatusSuccess = "SUCCESS" // TaskExecutionStatusError is a TaskExecutionStatus enum value TaskExecutionStatusError = "ERROR" )
const ( // TaskStatusAvailable is a TaskStatus enum value TaskStatusAvailable = "AVAILABLE" // TaskStatusCreating is a TaskStatus enum value TaskStatusCreating = "CREATING" // TaskStatusRunning is a TaskStatus enum value TaskStatusRunning = "RUNNING" TaskStatusUnavailable = "UNAVAILABLE" )
const ( // UidNone is a Uid enum value UidNone = "NONE" // UidIntValue is a Uid enum value UidIntValue = "INT_VALUE" // UidName is a Uid enum value UidName = "NAME" // UidBoth is a Uid enum value UidBoth = "BOTH" )
const ( // VerifyModePointInTimeConsistent is a VerifyMode enum value VerifyModePointInTimeConsistent = "POINT_IN_TIME_CONSISTENT" // VerifyModeOnlyFilesTransferred is a VerifyMode enum value VerifyModeOnlyFilesTransferred = "ONLY_FILES_TRANSFERRED" // VerifyModeNone is a VerifyMode enum value VerifyModeNone = "NONE" )
const ( // ErrCodeInternalException for service response error code // "InternalException". // // This exception is thrown when an error occurs in the AWS DataSync service. ErrCodeInternalException = "InternalException" // ErrCodeInvalidRequestException for service response error code // "InvalidRequestException". // // This exception is thrown when the client submits a malformed request. ErrCodeInvalidRequestException = "InvalidRequestException" )
const ( ServiceName = "DataSync" // Name of service. EndpointsID = "datasync" // ID to lookup a service endpoint with. ServiceID = "DataSync" // ServiceID is a unique identifer of a specific service. )
Service information constants
const (
// FilterTypeSimplePattern is a FilterType enum value
FilterTypeSimplePattern = "SIMPLE_PATTERN"
)
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AgentListEntry ¶
type AgentListEntry struct { // The Amazon Resource Name (ARN) of the agent. AgentArn *string `type:"string"` // The name of the agent. Name *string `min:"1" type:"string"` // The status of the agent. Status *string `type:"string" enum:"AgentStatus"` // contains filtered or unexported fields }
Represents a single entry in a list of agents. AgentListEntry returns an array that contains a list of agents when the ListAgents operation is called.
func (AgentListEntry) GoString ¶
func (s AgentListEntry) GoString() string
GoString returns the string representation
func (*AgentListEntry) SetAgentArn ¶
func (s *AgentListEntry) SetAgentArn(v string) *AgentListEntry
SetAgentArn sets the AgentArn field's value.
func (*AgentListEntry) SetName ¶
func (s *AgentListEntry) SetName(v string) *AgentListEntry
SetName sets the Name field's value.
func (*AgentListEntry) SetStatus ¶
func (s *AgentListEntry) SetStatus(v string) *AgentListEntry
SetStatus sets the Status field's value.
func (AgentListEntry) String ¶
func (s AgentListEntry) String() string
String returns the string representation
type CancelTaskExecutionInput ¶
type CancelTaskExecutionInput struct { // The Amazon Resource Name (ARN) of the task execution to cancel. // // TaskExecutionArn is a required field TaskExecutionArn *string `type:"string" required:"true"` // contains filtered or unexported fields }
CancelTaskExecutionRequest
func (CancelTaskExecutionInput) GoString ¶
func (s CancelTaskExecutionInput) GoString() string
GoString returns the string representation
func (*CancelTaskExecutionInput) SetTaskExecutionArn ¶
func (s *CancelTaskExecutionInput) SetTaskExecutionArn(v string) *CancelTaskExecutionInput
SetTaskExecutionArn sets the TaskExecutionArn field's value.
func (CancelTaskExecutionInput) String ¶
func (s CancelTaskExecutionInput) String() string
String returns the string representation
func (*CancelTaskExecutionInput) Validate ¶
func (s *CancelTaskExecutionInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CancelTaskExecutionOutput ¶
type CancelTaskExecutionOutput struct {
// contains filtered or unexported fields
}
func (CancelTaskExecutionOutput) GoString ¶
func (s CancelTaskExecutionOutput) GoString() string
GoString returns the string representation
func (CancelTaskExecutionOutput) String ¶
func (s CancelTaskExecutionOutput) String() string
String returns the string representation
type CreateAgentInput ¶
type CreateAgentInput struct { // Your agent activation key. You can get the activation key either by sending // an HTTP GET request with redirects that enable you to get the agent IP address // (port 80). Alternatively, you can get it from the AWS DataSync console. // // The redirect URL returned in the response provides you the activation key // for your agent in the query string parameter activationKey. It might also // include other activation-related parameters; however, these are merely defaults. // The arguments you pass to this API call determine the actual configuration // of your agent. // // For more information, see Activating an Agent in the AWS DataSync User Guide. // // ActivationKey is a required field ActivationKey *string `type:"string" required:"true"` // The name you configured for your agent. This value is a text reference that // is used to identify the agent in the console. AgentName *string `min:"1" type:"string"` // The ARNs of the security groups used to protect your data transfer task subnets. // See CreateAgentRequest$SubnetArns. SecurityGroupArns []*string `min:"1" type:"list"` // The Amazon Resource Names (ARNs) of the subnets in which DataSync will create // elastic network interfaces for each data transfer task. The agent that runs // a task must be private. When you start a task that is associated with an // agent created in a VPC, or one that has access to an IP address in a VPC, // then the task is also private. In this case, DataSync creates four network // interfaces for each task in your subnet. For a data transfer to work, the // agent must be able to route to all these four network interfaces. SubnetArns []*string `min:"1" type:"list"` // The key-value pair that represents the tag that you want to associate with // the agent. The value can be an empty string. This value helps you manage, // filter, and search for your agents. // // Valid characters for key and value are letters, spaces, and numbers representable // in UTF-8 format, and the following special characters: + - = . _ : / @. Tags []*TagListEntry `type:"list"` // The ID of the VPC (Virtual Private Cloud) endpoint that the agent has access // to. This is the client-side VPC endpoint, also called a PrivateLink. If you // don't have a PrivateLink VPC endpoint, see Creating a VPC Endpoint Service // Configuration (https://docs.aws.amazon.com/vpc/latest/userguide/endpoint-service.html#create-endpoint-service) // in the AWS VPC User Guide. // // VPC endpoint ID looks like this: vpce-01234d5aff67890e1. VpcEndpointId *string `type:"string"` // contains filtered or unexported fields }
CreateAgentRequest
func (CreateAgentInput) GoString ¶
func (s CreateAgentInput) GoString() string
GoString returns the string representation
func (*CreateAgentInput) SetActivationKey ¶
func (s *CreateAgentInput) SetActivationKey(v string) *CreateAgentInput
SetActivationKey sets the ActivationKey field's value.
func (*CreateAgentInput) SetAgentName ¶
func (s *CreateAgentInput) SetAgentName(v string) *CreateAgentInput
SetAgentName sets the AgentName field's value.
func (*CreateAgentInput) SetSecurityGroupArns ¶ added in v1.21.10
func (s *CreateAgentInput) SetSecurityGroupArns(v []*string) *CreateAgentInput
SetSecurityGroupArns sets the SecurityGroupArns field's value.
func (*CreateAgentInput) SetSubnetArns ¶ added in v1.21.10
func (s *CreateAgentInput) SetSubnetArns(v []*string) *CreateAgentInput
SetSubnetArns sets the SubnetArns field's value.
func (*CreateAgentInput) SetTags ¶
func (s *CreateAgentInput) SetTags(v []*TagListEntry) *CreateAgentInput
SetTags sets the Tags field's value.
func (*CreateAgentInput) SetVpcEndpointId ¶ added in v1.21.10
func (s *CreateAgentInput) SetVpcEndpointId(v string) *CreateAgentInput
SetVpcEndpointId sets the VpcEndpointId field's value.
func (CreateAgentInput) String ¶
func (s CreateAgentInput) String() string
String returns the string representation
func (*CreateAgentInput) Validate ¶
func (s *CreateAgentInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateAgentOutput ¶
type CreateAgentOutput struct { // The Amazon Resource Name (ARN) of the agent. Use the ListAgents operation // to return a list of agents for your account and AWS Region. AgentArn *string `type:"string"` // contains filtered or unexported fields }
CreateAgentResponse
func (CreateAgentOutput) GoString ¶
func (s CreateAgentOutput) GoString() string
GoString returns the string representation
func (*CreateAgentOutput) SetAgentArn ¶
func (s *CreateAgentOutput) SetAgentArn(v string) *CreateAgentOutput
SetAgentArn sets the AgentArn field's value.
func (CreateAgentOutput) String ¶
func (s CreateAgentOutput) String() string
String returns the string representation
type CreateLocationEfsInput ¶
type CreateLocationEfsInput struct { // The subnet and security group that the Amazon EFS file system uses. The security // group that you provide needs to be able to communicate with the security // group on the mount target in the subnet specified. // // The exact relationship between security group M (of the mount target) and // security group S (which you provide for DataSync to use at this stage) is // as follows: // // * Security group M (which you associate with the mount target) must allow // inbound access for the Transmission Control Protocol (TCP) on the NFS // port (2049) from security group S. You can enable inbound connections // either by IP address (CIDR range) or security group. // // * Security group S (provided to DataSync to access EFS) should have a // rule that enables outbound connections to the NFS port on one of the file // system’s mount targets. You can enable outbound connections either by // IP address (CIDR range) or security group. For information about security // groups and mount targets, see Security Groups for Amazon EC2 Instances // and Mount Targets in the Amazon EFS User Guide. // // Ec2Config is a required field Ec2Config *Ec2Config `type:"structure" required:"true"` // The Amazon Resource Name (ARN) for the Amazon EFS file system. // // EfsFilesystemArn is a required field EfsFilesystemArn *string `type:"string" required:"true"` // A subdirectory in the location’s path. This subdirectory in the EFS file // system is used to read data from the EFS source location or write data to // the EFS destination. By default, AWS DataSync uses the root directory. Subdirectory *string `type:"string"` // The key-value pair that represents a tag that you want to add to the resource. // The value can be an empty string. This value helps you manage, filter, and // search for your resources. We recommend that you create a name tag for your // location. Tags []*TagListEntry `type:"list"` // contains filtered or unexported fields }
CreateLocationEfsRequest
func (CreateLocationEfsInput) GoString ¶
func (s CreateLocationEfsInput) GoString() string
GoString returns the string representation
func (*CreateLocationEfsInput) SetEc2Config ¶
func (s *CreateLocationEfsInput) SetEc2Config(v *Ec2Config) *CreateLocationEfsInput
SetEc2Config sets the Ec2Config field's value.
func (*CreateLocationEfsInput) SetEfsFilesystemArn ¶
func (s *CreateLocationEfsInput) SetEfsFilesystemArn(v string) *CreateLocationEfsInput
SetEfsFilesystemArn sets the EfsFilesystemArn field's value.
func (*CreateLocationEfsInput) SetSubdirectory ¶
func (s *CreateLocationEfsInput) SetSubdirectory(v string) *CreateLocationEfsInput
SetSubdirectory sets the Subdirectory field's value.
func (*CreateLocationEfsInput) SetTags ¶
func (s *CreateLocationEfsInput) SetTags(v []*TagListEntry) *CreateLocationEfsInput
SetTags sets the Tags field's value.
func (CreateLocationEfsInput) String ¶
func (s CreateLocationEfsInput) String() string
String returns the string representation
func (*CreateLocationEfsInput) Validate ¶
func (s *CreateLocationEfsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateLocationEfsOutput ¶
type CreateLocationEfsOutput struct { // The Amazon Resource Name (ARN) of the Amazon EFS file system location that // is created. LocationArn *string `type:"string"` // contains filtered or unexported fields }
CreateLocationEfs
func (CreateLocationEfsOutput) GoString ¶
func (s CreateLocationEfsOutput) GoString() string
GoString returns the string representation
func (*CreateLocationEfsOutput) SetLocationArn ¶
func (s *CreateLocationEfsOutput) SetLocationArn(v string) *CreateLocationEfsOutput
SetLocationArn sets the LocationArn field's value.
func (CreateLocationEfsOutput) String ¶
func (s CreateLocationEfsOutput) String() string
String returns the string representation
type CreateLocationNfsInput ¶
type CreateLocationNfsInput struct { // The NFS mount options that DataSync can use to mount your NFS share. MountOptions *NfsMountOptions `type:"structure"` // Contains a list of Amazon Resource Names (ARNs) of agents that are used to // connect to an NFS server. // // OnPremConfig is a required field OnPremConfig *OnPremConfig `type:"structure" required:"true"` // The name of the NFS server. This value is the IP address or Domain Name Service // (DNS) name of the NFS server. An agent that is installed on-premises uses // this host name to mount the NFS server in a network. // // This name must either be DNS-compliant or must be an IP version 4 (IPv4) // address. // // ServerHostname is a required field ServerHostname *string `type:"string" required:"true"` // The subdirectory in the NFS file system that is used to read data from the // NFS source location or write data to the NFS destination. The NFS path should // be a path that's exported by the NFS server, or a subdirectory of that path. // The path should be such that it can be mounted by other NFS clients in your // network. // // To see all the paths exported by your NFS server. run "showmount -e nfs-server-name" // from an NFS client that has access to your server. You can specify any directory // that appears in the results, and any subdirectory of that directory. Ensure // that the NFS export is accessible without Kerberos authentication. // // To transfer all the data in the folder you specified, DataSync needs to have // permissions to read all the data. To ensure this, either configure the NFS // export with no_root_squash, or ensure that the permissions for all of the // files that you want DataSync allow read access for all users. Doing either // enables the agent to read the files. For the agent to access directories, // you must additionally enable all execute access. // // For information about NFS export configuration, see 18.7. The /etc/exports // Configuration File in the Red Hat Enterprise Linux documentation. // // Subdirectory is a required field Subdirectory *string `type:"string" required:"true"` // The key-value pair that represents the tag that you want to add to the location. // The value can be an empty string. We recommend using tags to name your resources. Tags []*TagListEntry `type:"list"` // contains filtered or unexported fields }
CreateLocationNfsRequest
func (CreateLocationNfsInput) GoString ¶
func (s CreateLocationNfsInput) GoString() string
GoString returns the string representation
func (*CreateLocationNfsInput) SetMountOptions ¶ added in v1.19.29
func (s *CreateLocationNfsInput) SetMountOptions(v *NfsMountOptions) *CreateLocationNfsInput
SetMountOptions sets the MountOptions field's value.
func (*CreateLocationNfsInput) SetOnPremConfig ¶
func (s *CreateLocationNfsInput) SetOnPremConfig(v *OnPremConfig) *CreateLocationNfsInput
SetOnPremConfig sets the OnPremConfig field's value.
func (*CreateLocationNfsInput) SetServerHostname ¶
func (s *CreateLocationNfsInput) SetServerHostname(v string) *CreateLocationNfsInput
SetServerHostname sets the ServerHostname field's value.
func (*CreateLocationNfsInput) SetSubdirectory ¶
func (s *CreateLocationNfsInput) SetSubdirectory(v string) *CreateLocationNfsInput
SetSubdirectory sets the Subdirectory field's value.
func (*CreateLocationNfsInput) SetTags ¶
func (s *CreateLocationNfsInput) SetTags(v []*TagListEntry) *CreateLocationNfsInput
SetTags sets the Tags field's value.
func (CreateLocationNfsInput) String ¶
func (s CreateLocationNfsInput) String() string
String returns the string representation
func (*CreateLocationNfsInput) Validate ¶
func (s *CreateLocationNfsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateLocationNfsOutput ¶
type CreateLocationNfsOutput struct { // The Amazon Resource Name (ARN) of the source NFS file system location that // is created. LocationArn *string `type:"string"` // contains filtered or unexported fields }
CreateLocationNfsResponse
func (CreateLocationNfsOutput) GoString ¶
func (s CreateLocationNfsOutput) GoString() string
GoString returns the string representation
func (*CreateLocationNfsOutput) SetLocationArn ¶
func (s *CreateLocationNfsOutput) SetLocationArn(v string) *CreateLocationNfsOutput
SetLocationArn sets the LocationArn field's value.
func (CreateLocationNfsOutput) String ¶
func (s CreateLocationNfsOutput) String() string
String returns the string representation
type CreateLocationS3Input ¶
type CreateLocationS3Input struct { // The Amazon Resource Name (ARN) of the Amazon S3 bucket. // // S3BucketArn is a required field S3BucketArn *string `type:"string" required:"true"` // The Amazon Resource Name (ARN) of the AWS Identity and Access Management // (IAM) role that is used to access an Amazon S3 bucket. // // For detailed information about using such a role, see Creating a Location // for Amazon S3 in the AWS DataSync User Guide. // // S3Config is a required field S3Config *S3Config `type:"structure" required:"true"` // The Amazon S3 storage class that you want to store your files in when this // location is used as a task destination. For more information about S3 storage // classes, see Amazon S3 Storage Classes (https://aws.amazon.com/s3/storage-classes/) // in the Amazon Simple Storage Service Developer Guide. Some storage classes // have behaviors that can affect your S3 storage cost. For detailed information, // see using-storage-classes. S3StorageClass *string `type:"string" enum:"S3StorageClass"` // A subdirectory in the Amazon S3 bucket. This subdirectory in Amazon S3 is // used to read data from the S3 source location or write data to the S3 destination. Subdirectory *string `type:"string"` // The key-value pair that represents the tag that you want to add to the location. // The value can be an empty string. We recommend using tags to name your resources. Tags []*TagListEntry `type:"list"` // contains filtered or unexported fields }
CreateLocationS3Request
func (CreateLocationS3Input) GoString ¶
func (s CreateLocationS3Input) GoString() string
GoString returns the string representation
func (*CreateLocationS3Input) SetS3BucketArn ¶
func (s *CreateLocationS3Input) SetS3BucketArn(v string) *CreateLocationS3Input
SetS3BucketArn sets the S3BucketArn field's value.
func (*CreateLocationS3Input) SetS3Config ¶
func (s *CreateLocationS3Input) SetS3Config(v *S3Config) *CreateLocationS3Input
SetS3Config sets the S3Config field's value.
func (*CreateLocationS3Input) SetS3StorageClass ¶ added in v1.24.5
func (s *CreateLocationS3Input) SetS3StorageClass(v string) *CreateLocationS3Input
SetS3StorageClass sets the S3StorageClass field's value.
func (*CreateLocationS3Input) SetSubdirectory ¶
func (s *CreateLocationS3Input) SetSubdirectory(v string) *CreateLocationS3Input
SetSubdirectory sets the Subdirectory field's value.
func (*CreateLocationS3Input) SetTags ¶
func (s *CreateLocationS3Input) SetTags(v []*TagListEntry) *CreateLocationS3Input
SetTags sets the Tags field's value.
func (CreateLocationS3Input) String ¶
func (s CreateLocationS3Input) String() string
String returns the string representation
func (*CreateLocationS3Input) Validate ¶
func (s *CreateLocationS3Input) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateLocationS3Output ¶
type CreateLocationS3Output struct { // The Amazon Resource Name (ARN) of the source Amazon S3 bucket location that // is created. LocationArn *string `type:"string"` // contains filtered or unexported fields }
CreateLocationS3Response
func (CreateLocationS3Output) GoString ¶
func (s CreateLocationS3Output) GoString() string
GoString returns the string representation
func (*CreateLocationS3Output) SetLocationArn ¶
func (s *CreateLocationS3Output) SetLocationArn(v string) *CreateLocationS3Output
SetLocationArn sets the LocationArn field's value.
func (CreateLocationS3Output) String ¶
func (s CreateLocationS3Output) String() string
String returns the string representation
type CreateLocationSmbInput ¶ added in v1.23.7
type CreateLocationSmbInput struct { // The Amazon Resource Names (ARNs) of agents to use for a Simple Message Block // (SMB) location. // // AgentArns is a required field AgentArns []*string `min:"1" type:"list" required:"true"` // The name of the Windows domain that the SMB server belongs to. Domain *string `type:"string"` // The mount options used by DataSync to access the SMB server. MountOptions *SmbMountOptions `type:"structure"` // The password of the user who can mount the share, has the permissions to // access files and folders in the SMB share. // // Password is a required field Password *string `type:"string" required:"true"` // The name of the SMB server. This value is the IP address or Domain Name Service // (DNS) name of the SMB server. An agent that is installed on-premises uses // this hostname to mount the SMB server in a network. // // This name must either be DNS-compliant or must be an IP version 4 (IPv4) // address. // // ServerHostname is a required field ServerHostname *string `type:"string" required:"true"` // The subdirectory in the SMB file system that is used to read data from the // SMB source location or write data to the SMB destination. The SMB path should // be a path that's exported by the SMB server, or a subdirectory of that path. // The path should be such that it can be mounted by other SMB clients in your // network. // // To transfer all the data in the folder you specified, DataSync needs to have // permissions to mount the SMB share, as well as to access all the data in // that share. To ensure this, either ensure that the user/password specified // belongs to the user who can mount the share, and who has the appropriate // permissions for all of the files and directories that you want DataSync to // access, or use credentials of a member of the Backup Operators group to mount // the share. Doing either enables the agent to access the data. For the agent // to access directories, you must additionally enable all execute access. // // Subdirectory is a required field Subdirectory *string `type:"string" required:"true"` // The key-value pair that represents the tag that you want to add to the location. // The value can be an empty string. We recommend using tags to name your resources. Tags []*TagListEntry `type:"list"` // The user who can mount the share, has the permissions to access files and // folders in the SMB share. // // User is a required field User *string `type:"string" required:"true"` // contains filtered or unexported fields }
CreateLocationSmbRequest
func (CreateLocationSmbInput) GoString ¶ added in v1.23.7
func (s CreateLocationSmbInput) GoString() string
GoString returns the string representation
func (*CreateLocationSmbInput) SetAgentArns ¶ added in v1.23.7
func (s *CreateLocationSmbInput) SetAgentArns(v []*string) *CreateLocationSmbInput
SetAgentArns sets the AgentArns field's value.
func (*CreateLocationSmbInput) SetDomain ¶ added in v1.23.7
func (s *CreateLocationSmbInput) SetDomain(v string) *CreateLocationSmbInput
SetDomain sets the Domain field's value.
func (*CreateLocationSmbInput) SetMountOptions ¶ added in v1.23.7
func (s *CreateLocationSmbInput) SetMountOptions(v *SmbMountOptions) *CreateLocationSmbInput
SetMountOptions sets the MountOptions field's value.
func (*CreateLocationSmbInput) SetPassword ¶ added in v1.23.7
func (s *CreateLocationSmbInput) SetPassword(v string) *CreateLocationSmbInput
SetPassword sets the Password field's value.
func (*CreateLocationSmbInput) SetServerHostname ¶ added in v1.23.7
func (s *CreateLocationSmbInput) SetServerHostname(v string) *CreateLocationSmbInput
SetServerHostname sets the ServerHostname field's value.
func (*CreateLocationSmbInput) SetSubdirectory ¶ added in v1.23.7
func (s *CreateLocationSmbInput) SetSubdirectory(v string) *CreateLocationSmbInput
SetSubdirectory sets the Subdirectory field's value.
func (*CreateLocationSmbInput) SetTags ¶ added in v1.23.7
func (s *CreateLocationSmbInput) SetTags(v []*TagListEntry) *CreateLocationSmbInput
SetTags sets the Tags field's value.
func (*CreateLocationSmbInput) SetUser ¶ added in v1.23.7
func (s *CreateLocationSmbInput) SetUser(v string) *CreateLocationSmbInput
SetUser sets the User field's value.
func (CreateLocationSmbInput) String ¶ added in v1.23.7
func (s CreateLocationSmbInput) String() string
String returns the string representation
func (*CreateLocationSmbInput) Validate ¶ added in v1.23.7
func (s *CreateLocationSmbInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateLocationSmbOutput ¶ added in v1.23.7
type CreateLocationSmbOutput struct { // The Amazon Resource Name (ARN) of the source SMB file system location that // is created. LocationArn *string `type:"string"` // contains filtered or unexported fields }
CreateLocationSmbResponse
func (CreateLocationSmbOutput) GoString ¶ added in v1.23.7
func (s CreateLocationSmbOutput) GoString() string
GoString returns the string representation
func (*CreateLocationSmbOutput) SetLocationArn ¶ added in v1.23.7
func (s *CreateLocationSmbOutput) SetLocationArn(v string) *CreateLocationSmbOutput
SetLocationArn sets the LocationArn field's value.
func (CreateLocationSmbOutput) String ¶ added in v1.23.7
func (s CreateLocationSmbOutput) String() string
String returns the string representation
type CreateTaskInput ¶
type CreateTaskInput struct { // The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that is // used to monitor and log events in the task. // // For more information on these groups, see Working with Log Groups and Log // Streams in the Amazon CloudWatch User Guide. // // For more information about how to use CloudWatch Logs with DataSync, see // Monitoring Your Task in the AWS DataSync User Guide. CloudWatchLogGroupArn *string `type:"string"` // The Amazon Resource Name (ARN) of an AWS storage resource's location. // // DestinationLocationArn is a required field DestinationLocationArn *string `type:"string" required:"true"` // A list of filter rules that determines which files to exclude from a task. // The list should contain a single filter string that consists of the patterns // to exclude. The patterns are delimited by "|" (that is, a pipe), for example, // "/folder1|/folder2" Excludes []*FilterRule `type:"list"` // The name of a task. This value is a text reference that is used to identify // the task in the console. Name *string `min:"1" type:"string"` // The set of configuration options that control the behavior of a single execution // of the task that occurs when you call StartTaskExecution. You can configure // these options to preserve metadata such as user ID (UID) and group ID (GID), // file permissions, data integrity verification, and so on. // // For each individual task execution, you can override these options by specifying // the OverrideOptions before starting a the task execution. For more information, // see the operation. Options *Options `type:"structure"` // The Amazon Resource Name (ARN) of the source location for the task. // // SourceLocationArn is a required field SourceLocationArn *string `type:"string" required:"true"` // The key-value pair that represents the tag that you want to add to the resource. // The value can be an empty string. Tags []*TagListEntry `type:"list"` // contains filtered or unexported fields }
CreateTaskRequest
func (CreateTaskInput) GoString ¶
func (s CreateTaskInput) GoString() string
GoString returns the string representation
func (*CreateTaskInput) SetCloudWatchLogGroupArn ¶
func (s *CreateTaskInput) SetCloudWatchLogGroupArn(v string) *CreateTaskInput
SetCloudWatchLogGroupArn sets the CloudWatchLogGroupArn field's value.
func (*CreateTaskInput) SetDestinationLocationArn ¶
func (s *CreateTaskInput) SetDestinationLocationArn(v string) *CreateTaskInput
SetDestinationLocationArn sets the DestinationLocationArn field's value.
func (*CreateTaskInput) SetExcludes ¶ added in v1.19.29
func (s *CreateTaskInput) SetExcludes(v []*FilterRule) *CreateTaskInput
SetExcludes sets the Excludes field's value.
func (*CreateTaskInput) SetName ¶
func (s *CreateTaskInput) SetName(v string) *CreateTaskInput
SetName sets the Name field's value.
func (*CreateTaskInput) SetOptions ¶
func (s *CreateTaskInput) SetOptions(v *Options) *CreateTaskInput
SetOptions sets the Options field's value.
func (*CreateTaskInput) SetSourceLocationArn ¶
func (s *CreateTaskInput) SetSourceLocationArn(v string) *CreateTaskInput
SetSourceLocationArn sets the SourceLocationArn field's value.
func (*CreateTaskInput) SetTags ¶
func (s *CreateTaskInput) SetTags(v []*TagListEntry) *CreateTaskInput
SetTags sets the Tags field's value.
func (CreateTaskInput) String ¶
func (s CreateTaskInput) String() string
String returns the string representation
func (*CreateTaskInput) Validate ¶
func (s *CreateTaskInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type CreateTaskOutput ¶
type CreateTaskOutput struct { // The Amazon Resource Name (ARN) of the task. TaskArn *string `type:"string"` // contains filtered or unexported fields }
CreateTaskResponse
func (CreateTaskOutput) GoString ¶
func (s CreateTaskOutput) GoString() string
GoString returns the string representation
func (*CreateTaskOutput) SetTaskArn ¶
func (s *CreateTaskOutput) SetTaskArn(v string) *CreateTaskOutput
SetTaskArn sets the TaskArn field's value.
func (CreateTaskOutput) String ¶
func (s CreateTaskOutput) String() string
String returns the string representation
type DataSync ¶
DataSync provides the API operation methods for making requests to AWS DataSync. See this package's package overview docs for details on the service.
DataSync methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.
func New ¶
func New(p client.ConfigProvider, cfgs ...*aws.Config) *DataSync
New creates a new instance of the DataSync client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.
Example:
// Create a DataSync client from just a session. svc := datasync.New(mySession) // Create a DataSync client with additional configuration svc := datasync.New(mySession, aws.NewConfig().WithRegion("us-west-2"))
func (*DataSync) CancelTaskExecution ¶
func (c *DataSync) CancelTaskExecution(input *CancelTaskExecutionInput) (*CancelTaskExecutionOutput, error)
CancelTaskExecution API operation for AWS DataSync.
Cancels execution of a task.
When you cancel a task execution, the transfer of some files are abruptly interrupted. The contents of files that are transferred to the destination might be incomplete or inconsistent with the source files. However, if you start a new task execution on the same task and you allow the task execution to complete, file content on the destination is complete and consistent. This applies to other unexpected failures that interrupt a task execution. In all of these cases, AWS DataSync successfully complete the transfer when you start the next task execution.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS DataSync's API operation CancelTaskExecution for usage and error information.
Returned Error Codes:
ErrCodeInvalidRequestException "InvalidRequestException" This exception is thrown when the client submits a malformed request.
ErrCodeInternalException "InternalException" This exception is thrown when an error occurs in the AWS DataSync service.
See also, https://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/CancelTaskExecution
func (*DataSync) CancelTaskExecutionRequest ¶
func (c *DataSync) CancelTaskExecutionRequest(input *CancelTaskExecutionInput) (req *request.Request, output *CancelTaskExecutionOutput)
CancelTaskExecutionRequest generates a "aws/request.Request" representing the client's request for the CancelTaskExecution operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See CancelTaskExecution for more information on using the CancelTaskExecution API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the CancelTaskExecutionRequest method. req, resp := client.CancelTaskExecutionRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/CancelTaskExecution
func (*DataSync) CancelTaskExecutionWithContext ¶
func (c *DataSync) CancelTaskExecutionWithContext(ctx aws.Context, input *CancelTaskExecutionInput, opts ...request.Option) (*CancelTaskExecutionOutput, error)
CancelTaskExecutionWithContext is the same as CancelTaskExecution with the addition of the ability to pass a context and additional request options.
See CancelTaskExecution for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*DataSync) CreateAgent ¶
func (c *DataSync) CreateAgent(input *CreateAgentInput) (*CreateAgentOutput, error)
CreateAgent API operation for AWS DataSync.
Activates an AWS DataSync agent that you have deployed on your host. The activation process associates your agent with your account. In the activation process, you specify information such as the AWS Region that you want to activate the agent in. You activate the agent in the AWS Region where your target locations (in Amazon S3 or Amazon EFS) reside. Your tasks are created in this AWS Region.
You can activate the agent in a VPC (Virtual private Cloud) or provide the agent access to a VPC endpoint so you can run tasks without going over the public Internet.
You can use an agent for more than one location. If a task uses multiple agents, all of them need to have status AVAILABLE for the task to run. If you use multiple agents for a source location, the status of all the agents must be AVAILABLE for the task to run.
Agents are automatically updated by AWS on a regular basis, using a mechanism that ensures minimal interruption to your tasks.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS DataSync's API operation CreateAgent for usage and error information.
Returned Error Codes:
ErrCodeInvalidRequestException "InvalidRequestException" This exception is thrown when the client submits a malformed request.
ErrCodeInternalException "InternalException" This exception is thrown when an error occurs in the AWS DataSync service.
See also, https://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/CreateAgent
func (*DataSync) CreateAgentRequest ¶
func (c *DataSync) CreateAgentRequest(input *CreateAgentInput) (req *request.Request, output *CreateAgentOutput)
CreateAgentRequest generates a "aws/request.Request" representing the client's request for the CreateAgent operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See CreateAgent for more information on using the CreateAgent API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the CreateAgentRequest method. req, resp := client.CreateAgentRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/CreateAgent
func (*DataSync) CreateAgentWithContext ¶
func (c *DataSync) CreateAgentWithContext(ctx aws.Context, input *CreateAgentInput, opts ...request.Option) (*CreateAgentOutput, error)
CreateAgentWithContext is the same as CreateAgent with the addition of the ability to pass a context and additional request options.
See CreateAgent for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*DataSync) CreateLocationEfs ¶
func (c *DataSync) CreateLocationEfs(input *CreateLocationEfsInput) (*CreateLocationEfsOutput, error)
CreateLocationEfs API operation for AWS DataSync.
Creates an endpoint for an Amazon EFS file system.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS DataSync's API operation CreateLocationEfs for usage and error information.
Returned Error Codes:
ErrCodeInvalidRequestException "InvalidRequestException" This exception is thrown when the client submits a malformed request.
ErrCodeInternalException "InternalException" This exception is thrown when an error occurs in the AWS DataSync service.
See also, https://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/CreateLocationEfs
func (*DataSync) CreateLocationEfsRequest ¶
func (c *DataSync) CreateLocationEfsRequest(input *CreateLocationEfsInput) (req *request.Request, output *CreateLocationEfsOutput)
CreateLocationEfsRequest generates a "aws/request.Request" representing the client's request for the CreateLocationEfs operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See CreateLocationEfs for more information on using the CreateLocationEfs API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the CreateLocationEfsRequest method. req, resp := client.CreateLocationEfsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/CreateLocationEfs
func (*DataSync) CreateLocationEfsWithContext ¶
func (c *DataSync) CreateLocationEfsWithContext(ctx aws.Context, input *CreateLocationEfsInput, opts ...request.Option) (*CreateLocationEfsOutput, error)
CreateLocationEfsWithContext is the same as CreateLocationEfs with the addition of the ability to pass a context and additional request options.
See CreateLocationEfs for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*DataSync) CreateLocationNfs ¶
func (c *DataSync) CreateLocationNfs(input *CreateLocationNfsInput) (*CreateLocationNfsOutput, error)
CreateLocationNfs API operation for AWS DataSync.
Creates an endpoint for a Network File System (NFS) file system.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS DataSync's API operation CreateLocationNfs for usage and error information.
Returned Error Codes:
ErrCodeInvalidRequestException "InvalidRequestException" This exception is thrown when the client submits a malformed request.
ErrCodeInternalException "InternalException" This exception is thrown when an error occurs in the AWS DataSync service.
See also, https://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/CreateLocationNfs
func (*DataSync) CreateLocationNfsRequest ¶
func (c *DataSync) CreateLocationNfsRequest(input *CreateLocationNfsInput) (req *request.Request, output *CreateLocationNfsOutput)
CreateLocationNfsRequest generates a "aws/request.Request" representing the client's request for the CreateLocationNfs operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See CreateLocationNfs for more information on using the CreateLocationNfs API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the CreateLocationNfsRequest method. req, resp := client.CreateLocationNfsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/CreateLocationNfs
func (*DataSync) CreateLocationNfsWithContext ¶
func (c *DataSync) CreateLocationNfsWithContext(ctx aws.Context, input *CreateLocationNfsInput, opts ...request.Option) (*CreateLocationNfsOutput, error)
CreateLocationNfsWithContext is the same as CreateLocationNfs with the addition of the ability to pass a context and additional request options.
See CreateLocationNfs for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*DataSync) CreateLocationS3 ¶
func (c *DataSync) CreateLocationS3(input *CreateLocationS3Input) (*CreateLocationS3Output, error)
CreateLocationS3 API operation for AWS DataSync.
Creates an endpoint for an Amazon S3 bucket.
For AWS DataSync to access a destination S3 bucket, it needs an AWS Identity and Access Management (IAM) role that has the required permissions. You can set up the required permissions by creating an IAM policy that grants the required permissions and attaching the policy to the role. An example of such a policy is shown in the examples section.
For more information, see https://docs.aws.amazon.com/datasync/latest/userguide/working-with-locations.html#create-s3-location in the AWS DataSync User Guide.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS DataSync's API operation CreateLocationS3 for usage and error information.
Returned Error Codes:
ErrCodeInvalidRequestException "InvalidRequestException" This exception is thrown when the client submits a malformed request.
ErrCodeInternalException "InternalException" This exception is thrown when an error occurs in the AWS DataSync service.
See also, https://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/CreateLocationS3
func (*DataSync) CreateLocationS3Request ¶
func (c *DataSync) CreateLocationS3Request(input *CreateLocationS3Input) (req *request.Request, output *CreateLocationS3Output)
CreateLocationS3Request generates a "aws/request.Request" representing the client's request for the CreateLocationS3 operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See CreateLocationS3 for more information on using the CreateLocationS3 API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the CreateLocationS3Request method. req, resp := client.CreateLocationS3Request(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/CreateLocationS3
func (*DataSync) CreateLocationS3WithContext ¶
func (c *DataSync) CreateLocationS3WithContext(ctx aws.Context, input *CreateLocationS3Input, opts ...request.Option) (*CreateLocationS3Output, error)
CreateLocationS3WithContext is the same as CreateLocationS3 with the addition of the ability to pass a context and additional request options.
See CreateLocationS3 for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*DataSync) CreateLocationSmb ¶ added in v1.23.7
func (c *DataSync) CreateLocationSmb(input *CreateLocationSmbInput) (*CreateLocationSmbOutput, error)
CreateLocationSmb API operation for AWS DataSync.
Creates an endpoint for a Server Message Block (SMB) file system.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS DataSync's API operation CreateLocationSmb for usage and error information.
Returned Error Codes:
ErrCodeInvalidRequestException "InvalidRequestException" This exception is thrown when the client submits a malformed request.
ErrCodeInternalException "InternalException" This exception is thrown when an error occurs in the AWS DataSync service.
See also, https://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/CreateLocationSmb
func (*DataSync) CreateLocationSmbRequest ¶ added in v1.23.7
func (c *DataSync) CreateLocationSmbRequest(input *CreateLocationSmbInput) (req *request.Request, output *CreateLocationSmbOutput)
CreateLocationSmbRequest generates a "aws/request.Request" representing the client's request for the CreateLocationSmb operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See CreateLocationSmb for more information on using the CreateLocationSmb API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the CreateLocationSmbRequest method. req, resp := client.CreateLocationSmbRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/CreateLocationSmb
func (*DataSync) CreateLocationSmbWithContext ¶ added in v1.23.7
func (c *DataSync) CreateLocationSmbWithContext(ctx aws.Context, input *CreateLocationSmbInput, opts ...request.Option) (*CreateLocationSmbOutput, error)
CreateLocationSmbWithContext is the same as CreateLocationSmb with the addition of the ability to pass a context and additional request options.
See CreateLocationSmb for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*DataSync) CreateTask ¶
func (c *DataSync) CreateTask(input *CreateTaskInput) (*CreateTaskOutput, error)
CreateTask API operation for AWS DataSync.
Creates a task. A task is a set of two locations (source and destination) and a set of Options that you use to control the behavior of a task. If you don't specify Options when you create a task, AWS DataSync populates them with service defaults.
When you create a task, it first enters the CREATING state. During CREATING AWS DataSync attempts to mount the on-premises Network File System (NFS) location. The task transitions to the AVAILABLE state without waiting for the AWS location to become mounted. If required, AWS DataSync mounts the AWS location before each task execution.
If an agent that is associated with a source (NFS) location goes offline, the task transitions to the UNAVAILABLE status. If the status of the task remains in the CREATING status for more than a few minutes, it means that your agent might be having trouble mounting the source NFS file system. Check the task's ErrorCode and ErrorDetail. Mount issues are often caused by either a misconfigured firewall or a mistyped NFS server host name.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS DataSync's API operation CreateTask for usage and error information.
Returned Error Codes:
ErrCodeInvalidRequestException "InvalidRequestException" This exception is thrown when the client submits a malformed request.
ErrCodeInternalException "InternalException" This exception is thrown when an error occurs in the AWS DataSync service.
See also, https://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/CreateTask
func (*DataSync) CreateTaskRequest ¶
func (c *DataSync) CreateTaskRequest(input *CreateTaskInput) (req *request.Request, output *CreateTaskOutput)
CreateTaskRequest generates a "aws/request.Request" representing the client's request for the CreateTask operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See CreateTask for more information on using the CreateTask API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the CreateTaskRequest method. req, resp := client.CreateTaskRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/CreateTask
func (*DataSync) CreateTaskWithContext ¶
func (c *DataSync) CreateTaskWithContext(ctx aws.Context, input *CreateTaskInput, opts ...request.Option) (*CreateTaskOutput, error)
CreateTaskWithContext is the same as CreateTask with the addition of the ability to pass a context and additional request options.
See CreateTask for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*DataSync) DeleteAgent ¶
func (c *DataSync) DeleteAgent(input *DeleteAgentInput) (*DeleteAgentOutput, error)
DeleteAgent API operation for AWS DataSync.
Deletes an agent. To specify which agent to delete, use the Amazon Resource Name (ARN) of the agent in your request. The operation disassociates the agent from your AWS account. However, it doesn't delete the agent virtual machine (VM) from your on-premises environment.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS DataSync's API operation DeleteAgent for usage and error information.
Returned Error Codes:
ErrCodeInvalidRequestException "InvalidRequestException" This exception is thrown when the client submits a malformed request.
ErrCodeInternalException "InternalException" This exception is thrown when an error occurs in the AWS DataSync service.
See also, https://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/DeleteAgent
func (*DataSync) DeleteAgentRequest ¶
func (c *DataSync) DeleteAgentRequest(input *DeleteAgentInput) (req *request.Request, output *DeleteAgentOutput)
DeleteAgentRequest generates a "aws/request.Request" representing the client's request for the DeleteAgent operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DeleteAgent for more information on using the DeleteAgent API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DeleteAgentRequest method. req, resp := client.DeleteAgentRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/DeleteAgent
func (*DataSync) DeleteAgentWithContext ¶
func (c *DataSync) DeleteAgentWithContext(ctx aws.Context, input *DeleteAgentInput, opts ...request.Option) (*DeleteAgentOutput, error)
DeleteAgentWithContext is the same as DeleteAgent with the addition of the ability to pass a context and additional request options.
See DeleteAgent for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*DataSync) DeleteLocation ¶
func (c *DataSync) DeleteLocation(input *DeleteLocationInput) (*DeleteLocationOutput, error)
DeleteLocation API operation for AWS DataSync.
Deletes the configuration of a location used by AWS DataSync.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS DataSync's API operation DeleteLocation for usage and error information.
Returned Error Codes:
ErrCodeInvalidRequestException "InvalidRequestException" This exception is thrown when the client submits a malformed request.
ErrCodeInternalException "InternalException" This exception is thrown when an error occurs in the AWS DataSync service.
See also, https://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/DeleteLocation
func (*DataSync) DeleteLocationRequest ¶
func (c *DataSync) DeleteLocationRequest(input *DeleteLocationInput) (req *request.Request, output *DeleteLocationOutput)
DeleteLocationRequest generates a "aws/request.Request" representing the client's request for the DeleteLocation operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DeleteLocation for more information on using the DeleteLocation API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DeleteLocationRequest method. req, resp := client.DeleteLocationRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/DeleteLocation
func (*DataSync) DeleteLocationWithContext ¶
func (c *DataSync) DeleteLocationWithContext(ctx aws.Context, input *DeleteLocationInput, opts ...request.Option) (*DeleteLocationOutput, error)
DeleteLocationWithContext is the same as DeleteLocation with the addition of the ability to pass a context and additional request options.
See DeleteLocation for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*DataSync) DeleteTask ¶
func (c *DataSync) DeleteTask(input *DeleteTaskInput) (*DeleteTaskOutput, error)
DeleteTask API operation for AWS DataSync.
Deletes a task.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS DataSync's API operation DeleteTask for usage and error information.
Returned Error Codes:
ErrCodeInvalidRequestException "InvalidRequestException" This exception is thrown when the client submits a malformed request.
ErrCodeInternalException "InternalException" This exception is thrown when an error occurs in the AWS DataSync service.
See also, https://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/DeleteTask
func (*DataSync) DeleteTaskRequest ¶
func (c *DataSync) DeleteTaskRequest(input *DeleteTaskInput) (req *request.Request, output *DeleteTaskOutput)
DeleteTaskRequest generates a "aws/request.Request" representing the client's request for the DeleteTask operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DeleteTask for more information on using the DeleteTask API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DeleteTaskRequest method. req, resp := client.DeleteTaskRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/DeleteTask
func (*DataSync) DeleteTaskWithContext ¶
func (c *DataSync) DeleteTaskWithContext(ctx aws.Context, input *DeleteTaskInput, opts ...request.Option) (*DeleteTaskOutput, error)
DeleteTaskWithContext is the same as DeleteTask with the addition of the ability to pass a context and additional request options.
See DeleteTask for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*DataSync) DescribeAgent ¶
func (c *DataSync) DescribeAgent(input *DescribeAgentInput) (*DescribeAgentOutput, error)
DescribeAgent API operation for AWS DataSync.
Returns metadata such as the name, the network interfaces, and the status (that is, whether the agent is running or not) for an agent. To specify which agent to describe, use the Amazon Resource Name (ARN) of the agent in your request.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS DataSync's API operation DescribeAgent for usage and error information.
Returned Error Codes:
ErrCodeInvalidRequestException "InvalidRequestException" This exception is thrown when the client submits a malformed request.
ErrCodeInternalException "InternalException" This exception is thrown when an error occurs in the AWS DataSync service.
See also, https://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/DescribeAgent
func (*DataSync) DescribeAgentRequest ¶
func (c *DataSync) DescribeAgentRequest(input *DescribeAgentInput) (req *request.Request, output *DescribeAgentOutput)
DescribeAgentRequest generates a "aws/request.Request" representing the client's request for the DescribeAgent operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DescribeAgent for more information on using the DescribeAgent API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DescribeAgentRequest method. req, resp := client.DescribeAgentRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/DescribeAgent
func (*DataSync) DescribeAgentWithContext ¶
func (c *DataSync) DescribeAgentWithContext(ctx aws.Context, input *DescribeAgentInput, opts ...request.Option) (*DescribeAgentOutput, error)
DescribeAgentWithContext is the same as DescribeAgent with the addition of the ability to pass a context and additional request options.
See DescribeAgent for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*DataSync) DescribeLocationEfs ¶
func (c *DataSync) DescribeLocationEfs(input *DescribeLocationEfsInput) (*DescribeLocationEfsOutput, error)
DescribeLocationEfs API operation for AWS DataSync.
Returns metadata, such as the path information about an Amazon EFS location.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS DataSync's API operation DescribeLocationEfs for usage and error information.
Returned Error Codes:
ErrCodeInvalidRequestException "InvalidRequestException" This exception is thrown when the client submits a malformed request.
ErrCodeInternalException "InternalException" This exception is thrown when an error occurs in the AWS DataSync service.
See also, https://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/DescribeLocationEfs
func (*DataSync) DescribeLocationEfsRequest ¶
func (c *DataSync) DescribeLocationEfsRequest(input *DescribeLocationEfsInput) (req *request.Request, output *DescribeLocationEfsOutput)
DescribeLocationEfsRequest generates a "aws/request.Request" representing the client's request for the DescribeLocationEfs operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DescribeLocationEfs for more information on using the DescribeLocationEfs API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DescribeLocationEfsRequest method. req, resp := client.DescribeLocationEfsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/DescribeLocationEfs
func (*DataSync) DescribeLocationEfsWithContext ¶
func (c *DataSync) DescribeLocationEfsWithContext(ctx aws.Context, input *DescribeLocationEfsInput, opts ...request.Option) (*DescribeLocationEfsOutput, error)
DescribeLocationEfsWithContext is the same as DescribeLocationEfs with the addition of the ability to pass a context and additional request options.
See DescribeLocationEfs for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*DataSync) DescribeLocationNfs ¶
func (c *DataSync) DescribeLocationNfs(input *DescribeLocationNfsInput) (*DescribeLocationNfsOutput, error)
DescribeLocationNfs API operation for AWS DataSync.
Returns metadata, such as the path information, about a NFS location.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS DataSync's API operation DescribeLocationNfs for usage and error information.
Returned Error Codes:
ErrCodeInvalidRequestException "InvalidRequestException" This exception is thrown when the client submits a malformed request.
ErrCodeInternalException "InternalException" This exception is thrown when an error occurs in the AWS DataSync service.
See also, https://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/DescribeLocationNfs
func (*DataSync) DescribeLocationNfsRequest ¶
func (c *DataSync) DescribeLocationNfsRequest(input *DescribeLocationNfsInput) (req *request.Request, output *DescribeLocationNfsOutput)
DescribeLocationNfsRequest generates a "aws/request.Request" representing the client's request for the DescribeLocationNfs operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DescribeLocationNfs for more information on using the DescribeLocationNfs API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DescribeLocationNfsRequest method. req, resp := client.DescribeLocationNfsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/DescribeLocationNfs
func (*DataSync) DescribeLocationNfsWithContext ¶
func (c *DataSync) DescribeLocationNfsWithContext(ctx aws.Context, input *DescribeLocationNfsInput, opts ...request.Option) (*DescribeLocationNfsOutput, error)
DescribeLocationNfsWithContext is the same as DescribeLocationNfs with the addition of the ability to pass a context and additional request options.
See DescribeLocationNfs for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*DataSync) DescribeLocationS3 ¶
func (c *DataSync) DescribeLocationS3(input *DescribeLocationS3Input) (*DescribeLocationS3Output, error)
DescribeLocationS3 API operation for AWS DataSync.
Returns metadata, such as bucket name, about an Amazon S3 bucket location.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS DataSync's API operation DescribeLocationS3 for usage and error information.
Returned Error Codes:
ErrCodeInvalidRequestException "InvalidRequestException" This exception is thrown when the client submits a malformed request.
ErrCodeInternalException "InternalException" This exception is thrown when an error occurs in the AWS DataSync service.
See also, https://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/DescribeLocationS3
func (*DataSync) DescribeLocationS3Request ¶
func (c *DataSync) DescribeLocationS3Request(input *DescribeLocationS3Input) (req *request.Request, output *DescribeLocationS3Output)
DescribeLocationS3Request generates a "aws/request.Request" representing the client's request for the DescribeLocationS3 operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DescribeLocationS3 for more information on using the DescribeLocationS3 API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DescribeLocationS3Request method. req, resp := client.DescribeLocationS3Request(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/DescribeLocationS3
func (*DataSync) DescribeLocationS3WithContext ¶
func (c *DataSync) DescribeLocationS3WithContext(ctx aws.Context, input *DescribeLocationS3Input, opts ...request.Option) (*DescribeLocationS3Output, error)
DescribeLocationS3WithContext is the same as DescribeLocationS3 with the addition of the ability to pass a context and additional request options.
See DescribeLocationS3 for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*DataSync) DescribeLocationSmb ¶ added in v1.23.7
func (c *DataSync) DescribeLocationSmb(input *DescribeLocationSmbInput) (*DescribeLocationSmbOutput, error)
DescribeLocationSmb API operation for AWS DataSync.
Returns metadata, such as the path and user information about a SMB location.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS DataSync's API operation DescribeLocationSmb for usage and error information.
Returned Error Codes:
ErrCodeInvalidRequestException "InvalidRequestException" This exception is thrown when the client submits a malformed request.
ErrCodeInternalException "InternalException" This exception is thrown when an error occurs in the AWS DataSync service.
See also, https://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/DescribeLocationSmb
func (*DataSync) DescribeLocationSmbRequest ¶ added in v1.23.7
func (c *DataSync) DescribeLocationSmbRequest(input *DescribeLocationSmbInput) (req *request.Request, output *DescribeLocationSmbOutput)
DescribeLocationSmbRequest generates a "aws/request.Request" representing the client's request for the DescribeLocationSmb operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DescribeLocationSmb for more information on using the DescribeLocationSmb API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DescribeLocationSmbRequest method. req, resp := client.DescribeLocationSmbRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/DescribeLocationSmb
func (*DataSync) DescribeLocationSmbWithContext ¶ added in v1.23.7
func (c *DataSync) DescribeLocationSmbWithContext(ctx aws.Context, input *DescribeLocationSmbInput, opts ...request.Option) (*DescribeLocationSmbOutput, error)
DescribeLocationSmbWithContext is the same as DescribeLocationSmb with the addition of the ability to pass a context and additional request options.
See DescribeLocationSmb for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*DataSync) DescribeTask ¶
func (c *DataSync) DescribeTask(input *DescribeTaskInput) (*DescribeTaskOutput, error)
DescribeTask API operation for AWS DataSync.
Returns metadata about a task.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS DataSync's API operation DescribeTask for usage and error information.
Returned Error Codes:
ErrCodeInvalidRequestException "InvalidRequestException" This exception is thrown when the client submits a malformed request.
ErrCodeInternalException "InternalException" This exception is thrown when an error occurs in the AWS DataSync service.
See also, https://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/DescribeTask
func (*DataSync) DescribeTaskExecution ¶
func (c *DataSync) DescribeTaskExecution(input *DescribeTaskExecutionInput) (*DescribeTaskExecutionOutput, error)
DescribeTaskExecution API operation for AWS DataSync.
Returns detailed metadata about a task that is being executed.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS DataSync's API operation DescribeTaskExecution for usage and error information.
Returned Error Codes:
ErrCodeInvalidRequestException "InvalidRequestException" This exception is thrown when the client submits a malformed request.
ErrCodeInternalException "InternalException" This exception is thrown when an error occurs in the AWS DataSync service.
See also, https://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/DescribeTaskExecution
func (*DataSync) DescribeTaskExecutionRequest ¶
func (c *DataSync) DescribeTaskExecutionRequest(input *DescribeTaskExecutionInput) (req *request.Request, output *DescribeTaskExecutionOutput)
DescribeTaskExecutionRequest generates a "aws/request.Request" representing the client's request for the DescribeTaskExecution operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DescribeTaskExecution for more information on using the DescribeTaskExecution API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DescribeTaskExecutionRequest method. req, resp := client.DescribeTaskExecutionRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/DescribeTaskExecution
func (*DataSync) DescribeTaskExecutionWithContext ¶
func (c *DataSync) DescribeTaskExecutionWithContext(ctx aws.Context, input *DescribeTaskExecutionInput, opts ...request.Option) (*DescribeTaskExecutionOutput, error)
DescribeTaskExecutionWithContext is the same as DescribeTaskExecution with the addition of the ability to pass a context and additional request options.
See DescribeTaskExecution for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*DataSync) DescribeTaskRequest ¶
func (c *DataSync) DescribeTaskRequest(input *DescribeTaskInput) (req *request.Request, output *DescribeTaskOutput)
DescribeTaskRequest generates a "aws/request.Request" representing the client's request for the DescribeTask operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See DescribeTask for more information on using the DescribeTask API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the DescribeTaskRequest method. req, resp := client.DescribeTaskRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/DescribeTask
func (*DataSync) DescribeTaskWithContext ¶
func (c *DataSync) DescribeTaskWithContext(ctx aws.Context, input *DescribeTaskInput, opts ...request.Option) (*DescribeTaskOutput, error)
DescribeTaskWithContext is the same as DescribeTask with the addition of the ability to pass a context and additional request options.
See DescribeTask for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*DataSync) ListAgents ¶
func (c *DataSync) ListAgents(input *ListAgentsInput) (*ListAgentsOutput, error)
ListAgents API operation for AWS DataSync.
Returns a list of agents owned by an AWS account in the AWS Region specified in the request. The returned list is ordered by agent Amazon Resource Name (ARN).
By default, this operation returns a maximum of 100 agents. This operation supports pagination that enables you to optionally reduce the number of agents returned in a response.
If you have more agents than are returned in a response (that is, the response returns only a truncated list of your agents), the response contains a marker that you can specify in your next request to fetch the next page of agents.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS DataSync's API operation ListAgents for usage and error information.
Returned Error Codes:
ErrCodeInvalidRequestException "InvalidRequestException" This exception is thrown when the client submits a malformed request.
ErrCodeInternalException "InternalException" This exception is thrown when an error occurs in the AWS DataSync service.
See also, https://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/ListAgents
func (*DataSync) ListAgentsPages ¶
func (c *DataSync) ListAgentsPages(input *ListAgentsInput, fn func(*ListAgentsOutput, bool) bool) error
ListAgentsPages iterates over the pages of a ListAgents operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.
See ListAgents method for more information on how to use this operation.
Note: This operation can generate multiple requests to a service.
// Example iterating over at most 3 pages of a ListAgents operation. pageNum := 0 err := client.ListAgentsPages(params, func(page *datasync.ListAgentsOutput, lastPage bool) bool { pageNum++ fmt.Println(page) return pageNum <= 3 })
func (*DataSync) ListAgentsPagesWithContext ¶
func (c *DataSync) ListAgentsPagesWithContext(ctx aws.Context, input *ListAgentsInput, fn func(*ListAgentsOutput, bool) bool, opts ...request.Option) error
ListAgentsPagesWithContext same as ListAgentsPages except it takes a Context and allows setting request options on the pages.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*DataSync) ListAgentsRequest ¶
func (c *DataSync) ListAgentsRequest(input *ListAgentsInput) (req *request.Request, output *ListAgentsOutput)
ListAgentsRequest generates a "aws/request.Request" representing the client's request for the ListAgents operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See ListAgents for more information on using the ListAgents API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the ListAgentsRequest method. req, resp := client.ListAgentsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/ListAgents
func (*DataSync) ListAgentsWithContext ¶
func (c *DataSync) ListAgentsWithContext(ctx aws.Context, input *ListAgentsInput, opts ...request.Option) (*ListAgentsOutput, error)
ListAgentsWithContext is the same as ListAgents with the addition of the ability to pass a context and additional request options.
See ListAgents for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*DataSync) ListLocations ¶
func (c *DataSync) ListLocations(input *ListLocationsInput) (*ListLocationsOutput, error)
ListLocations API operation for AWS DataSync.
Returns a lists of source and destination locations.
If you have more locations than are returned in a response (that is, the response returns only a truncated list of your agents), the response contains a token that you can specify in your next request to fetch the next page of locations.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS DataSync's API operation ListLocations for usage and error information.
Returned Error Codes:
ErrCodeInvalidRequestException "InvalidRequestException" This exception is thrown when the client submits a malformed request.
ErrCodeInternalException "InternalException" This exception is thrown when an error occurs in the AWS DataSync service.
See also, https://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/ListLocations
func (*DataSync) ListLocationsPages ¶
func (c *DataSync) ListLocationsPages(input *ListLocationsInput, fn func(*ListLocationsOutput, bool) bool) error
ListLocationsPages iterates over the pages of a ListLocations operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.
See ListLocations method for more information on how to use this operation.
Note: This operation can generate multiple requests to a service.
// Example iterating over at most 3 pages of a ListLocations operation. pageNum := 0 err := client.ListLocationsPages(params, func(page *datasync.ListLocationsOutput, lastPage bool) bool { pageNum++ fmt.Println(page) return pageNum <= 3 })
func (*DataSync) ListLocationsPagesWithContext ¶
func (c *DataSync) ListLocationsPagesWithContext(ctx aws.Context, input *ListLocationsInput, fn func(*ListLocationsOutput, bool) bool, opts ...request.Option) error
ListLocationsPagesWithContext same as ListLocationsPages except it takes a Context and allows setting request options on the pages.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*DataSync) ListLocationsRequest ¶
func (c *DataSync) ListLocationsRequest(input *ListLocationsInput) (req *request.Request, output *ListLocationsOutput)
ListLocationsRequest generates a "aws/request.Request" representing the client's request for the ListLocations operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See ListLocations for more information on using the ListLocations API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the ListLocationsRequest method. req, resp := client.ListLocationsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/ListLocations
func (*DataSync) ListLocationsWithContext ¶
func (c *DataSync) ListLocationsWithContext(ctx aws.Context, input *ListLocationsInput, opts ...request.Option) (*ListLocationsOutput, error)
ListLocationsWithContext is the same as ListLocations with the addition of the ability to pass a context and additional request options.
See ListLocations for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*DataSync) ListTagsForResource ¶
func (c *DataSync) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error)
ListTagsForResource API operation for AWS DataSync.
Returns all the tags associated with a specified resources.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS DataSync's API operation ListTagsForResource for usage and error information.
Returned Error Codes:
ErrCodeInvalidRequestException "InvalidRequestException" This exception is thrown when the client submits a malformed request.
ErrCodeInternalException "InternalException" This exception is thrown when an error occurs in the AWS DataSync service.
See also, https://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/ListTagsForResource
func (*DataSync) ListTagsForResourcePages ¶
func (c *DataSync) ListTagsForResourcePages(input *ListTagsForResourceInput, fn func(*ListTagsForResourceOutput, bool) bool) error
ListTagsForResourcePages iterates over the pages of a ListTagsForResource operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.
See ListTagsForResource method for more information on how to use this operation.
Note: This operation can generate multiple requests to a service.
// Example iterating over at most 3 pages of a ListTagsForResource operation. pageNum := 0 err := client.ListTagsForResourcePages(params, func(page *datasync.ListTagsForResourceOutput, lastPage bool) bool { pageNum++ fmt.Println(page) return pageNum <= 3 })
func (*DataSync) ListTagsForResourcePagesWithContext ¶
func (c *DataSync) ListTagsForResourcePagesWithContext(ctx aws.Context, input *ListTagsForResourceInput, fn func(*ListTagsForResourceOutput, bool) bool, opts ...request.Option) error
ListTagsForResourcePagesWithContext same as ListTagsForResourcePages except it takes a Context and allows setting request options on the pages.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*DataSync) ListTagsForResourceRequest ¶
func (c *DataSync) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req *request.Request, output *ListTagsForResourceOutput)
ListTagsForResourceRequest generates a "aws/request.Request" representing the client's request for the ListTagsForResource operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See ListTagsForResource for more information on using the ListTagsForResource API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the ListTagsForResourceRequest method. req, resp := client.ListTagsForResourceRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/ListTagsForResource
func (*DataSync) ListTagsForResourceWithContext ¶
func (c *DataSync) ListTagsForResourceWithContext(ctx aws.Context, input *ListTagsForResourceInput, opts ...request.Option) (*ListTagsForResourceOutput, error)
ListTagsForResourceWithContext is the same as ListTagsForResource with the addition of the ability to pass a context and additional request options.
See ListTagsForResource for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*DataSync) ListTaskExecutions ¶
func (c *DataSync) ListTaskExecutions(input *ListTaskExecutionsInput) (*ListTaskExecutionsOutput, error)
ListTaskExecutions API operation for AWS DataSync.
Returns a list of executed tasks.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS DataSync's API operation ListTaskExecutions for usage and error information.
Returned Error Codes:
ErrCodeInvalidRequestException "InvalidRequestException" This exception is thrown when the client submits a malformed request.
ErrCodeInternalException "InternalException" This exception is thrown when an error occurs in the AWS DataSync service.
See also, https://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/ListTaskExecutions
func (*DataSync) ListTaskExecutionsPages ¶
func (c *DataSync) ListTaskExecutionsPages(input *ListTaskExecutionsInput, fn func(*ListTaskExecutionsOutput, bool) bool) error
ListTaskExecutionsPages iterates over the pages of a ListTaskExecutions operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.
See ListTaskExecutions method for more information on how to use this operation.
Note: This operation can generate multiple requests to a service.
// Example iterating over at most 3 pages of a ListTaskExecutions operation. pageNum := 0 err := client.ListTaskExecutionsPages(params, func(page *datasync.ListTaskExecutionsOutput, lastPage bool) bool { pageNum++ fmt.Println(page) return pageNum <= 3 })
func (*DataSync) ListTaskExecutionsPagesWithContext ¶
func (c *DataSync) ListTaskExecutionsPagesWithContext(ctx aws.Context, input *ListTaskExecutionsInput, fn func(*ListTaskExecutionsOutput, bool) bool, opts ...request.Option) error
ListTaskExecutionsPagesWithContext same as ListTaskExecutionsPages except it takes a Context and allows setting request options on the pages.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*DataSync) ListTaskExecutionsRequest ¶
func (c *DataSync) ListTaskExecutionsRequest(input *ListTaskExecutionsInput) (req *request.Request, output *ListTaskExecutionsOutput)
ListTaskExecutionsRequest generates a "aws/request.Request" representing the client's request for the ListTaskExecutions operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See ListTaskExecutions for more information on using the ListTaskExecutions API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the ListTaskExecutionsRequest method. req, resp := client.ListTaskExecutionsRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/ListTaskExecutions
func (*DataSync) ListTaskExecutionsWithContext ¶
func (c *DataSync) ListTaskExecutionsWithContext(ctx aws.Context, input *ListTaskExecutionsInput, opts ...request.Option) (*ListTaskExecutionsOutput, error)
ListTaskExecutionsWithContext is the same as ListTaskExecutions with the addition of the ability to pass a context and additional request options.
See ListTaskExecutions for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*DataSync) ListTasks ¶
func (c *DataSync) ListTasks(input *ListTasksInput) (*ListTasksOutput, error)
ListTasks API operation for AWS DataSync.
Returns a list of all the tasks.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS DataSync's API operation ListTasks for usage and error information.
Returned Error Codes:
ErrCodeInvalidRequestException "InvalidRequestException" This exception is thrown when the client submits a malformed request.
ErrCodeInternalException "InternalException" This exception is thrown when an error occurs in the AWS DataSync service.
See also, https://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/ListTasks
func (*DataSync) ListTasksPages ¶
func (c *DataSync) ListTasksPages(input *ListTasksInput, fn func(*ListTasksOutput, bool) bool) error
ListTasksPages iterates over the pages of a ListTasks operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.
See ListTasks method for more information on how to use this operation.
Note: This operation can generate multiple requests to a service.
// Example iterating over at most 3 pages of a ListTasks operation. pageNum := 0 err := client.ListTasksPages(params, func(page *datasync.ListTasksOutput, lastPage bool) bool { pageNum++ fmt.Println(page) return pageNum <= 3 })
func (*DataSync) ListTasksPagesWithContext ¶
func (c *DataSync) ListTasksPagesWithContext(ctx aws.Context, input *ListTasksInput, fn func(*ListTasksOutput, bool) bool, opts ...request.Option) error
ListTasksPagesWithContext same as ListTasksPages except it takes a Context and allows setting request options on the pages.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*DataSync) ListTasksRequest ¶
func (c *DataSync) ListTasksRequest(input *ListTasksInput) (req *request.Request, output *ListTasksOutput)
ListTasksRequest generates a "aws/request.Request" representing the client's request for the ListTasks operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See ListTasks for more information on using the ListTasks API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the ListTasksRequest method. req, resp := client.ListTasksRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/ListTasks
func (*DataSync) ListTasksWithContext ¶
func (c *DataSync) ListTasksWithContext(ctx aws.Context, input *ListTasksInput, opts ...request.Option) (*ListTasksOutput, error)
ListTasksWithContext is the same as ListTasks with the addition of the ability to pass a context and additional request options.
See ListTasks for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*DataSync) StartTaskExecution ¶
func (c *DataSync) StartTaskExecution(input *StartTaskExecutionInput) (*StartTaskExecutionOutput, error)
StartTaskExecution API operation for AWS DataSync.
Starts a specific invocation of a task. A TaskExecution value represents an individual run of a task. Each task can have at most one TaskExecution at a time.
TaskExecution has the following transition phases: INITIALIZING | PREPARING | TRANSFERRING | VERIFYING | SUCCESS/FAILURE.
For detailed information, see the Task Execution section in the Components and Terminology topic in the AWS DataSync User Guide.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS DataSync's API operation StartTaskExecution for usage and error information.
Returned Error Codes:
ErrCodeInvalidRequestException "InvalidRequestException" This exception is thrown when the client submits a malformed request.
ErrCodeInternalException "InternalException" This exception is thrown when an error occurs in the AWS DataSync service.
See also, https://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/StartTaskExecution
func (*DataSync) StartTaskExecutionRequest ¶
func (c *DataSync) StartTaskExecutionRequest(input *StartTaskExecutionInput) (req *request.Request, output *StartTaskExecutionOutput)
StartTaskExecutionRequest generates a "aws/request.Request" representing the client's request for the StartTaskExecution operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See StartTaskExecution for more information on using the StartTaskExecution API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the StartTaskExecutionRequest method. req, resp := client.StartTaskExecutionRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/StartTaskExecution
func (*DataSync) StartTaskExecutionWithContext ¶
func (c *DataSync) StartTaskExecutionWithContext(ctx aws.Context, input *StartTaskExecutionInput, opts ...request.Option) (*StartTaskExecutionOutput, error)
StartTaskExecutionWithContext is the same as StartTaskExecution with the addition of the ability to pass a context and additional request options.
See StartTaskExecution for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*DataSync) TagResource ¶
func (c *DataSync) TagResource(input *TagResourceInput) (*TagResourceOutput, error)
TagResource API operation for AWS DataSync.
Applies a key-value pair to an AWS resource.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS DataSync's API operation TagResource for usage and error information.
Returned Error Codes:
ErrCodeInvalidRequestException "InvalidRequestException" This exception is thrown when the client submits a malformed request.
ErrCodeInternalException "InternalException" This exception is thrown when an error occurs in the AWS DataSync service.
See also, https://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/TagResource
func (*DataSync) TagResourceRequest ¶
func (c *DataSync) TagResourceRequest(input *TagResourceInput) (req *request.Request, output *TagResourceOutput)
TagResourceRequest generates a "aws/request.Request" representing the client's request for the TagResource operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See TagResource for more information on using the TagResource API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the TagResourceRequest method. req, resp := client.TagResourceRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/TagResource
func (*DataSync) TagResourceWithContext ¶
func (c *DataSync) TagResourceWithContext(ctx aws.Context, input *TagResourceInput, opts ...request.Option) (*TagResourceOutput, error)
TagResourceWithContext is the same as TagResource with the addition of the ability to pass a context and additional request options.
See TagResource for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*DataSync) UntagResource ¶
func (c *DataSync) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error)
UntagResource API operation for AWS DataSync.
Removes a tag from an AWS resource.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS DataSync's API operation UntagResource for usage and error information.
Returned Error Codes:
ErrCodeInvalidRequestException "InvalidRequestException" This exception is thrown when the client submits a malformed request.
ErrCodeInternalException "InternalException" This exception is thrown when an error occurs in the AWS DataSync service.
See also, https://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/UntagResource
func (*DataSync) UntagResourceRequest ¶
func (c *DataSync) UntagResourceRequest(input *UntagResourceInput) (req *request.Request, output *UntagResourceOutput)
UntagResourceRequest generates a "aws/request.Request" representing the client's request for the UntagResource operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See UntagResource for more information on using the UntagResource API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the UntagResourceRequest method. req, resp := client.UntagResourceRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/UntagResource
func (*DataSync) UntagResourceWithContext ¶
func (c *DataSync) UntagResourceWithContext(ctx aws.Context, input *UntagResourceInput, opts ...request.Option) (*UntagResourceOutput, error)
UntagResourceWithContext is the same as UntagResource with the addition of the ability to pass a context and additional request options.
See UntagResource for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*DataSync) UpdateAgent ¶
func (c *DataSync) UpdateAgent(input *UpdateAgentInput) (*UpdateAgentOutput, error)
UpdateAgent API operation for AWS DataSync.
Updates the name of an agent.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS DataSync's API operation UpdateAgent for usage and error information.
Returned Error Codes:
ErrCodeInvalidRequestException "InvalidRequestException" This exception is thrown when the client submits a malformed request.
ErrCodeInternalException "InternalException" This exception is thrown when an error occurs in the AWS DataSync service.
See also, https://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/UpdateAgent
func (*DataSync) UpdateAgentRequest ¶
func (c *DataSync) UpdateAgentRequest(input *UpdateAgentInput) (req *request.Request, output *UpdateAgentOutput)
UpdateAgentRequest generates a "aws/request.Request" representing the client's request for the UpdateAgent operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See UpdateAgent for more information on using the UpdateAgent API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the UpdateAgentRequest method. req, resp := client.UpdateAgentRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/UpdateAgent
func (*DataSync) UpdateAgentWithContext ¶
func (c *DataSync) UpdateAgentWithContext(ctx aws.Context, input *UpdateAgentInput, opts ...request.Option) (*UpdateAgentOutput, error)
UpdateAgentWithContext is the same as UpdateAgent with the addition of the ability to pass a context and additional request options.
See UpdateAgent for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
func (*DataSync) UpdateTask ¶
func (c *DataSync) UpdateTask(input *UpdateTaskInput) (*UpdateTaskOutput, error)
UpdateTask API operation for AWS DataSync.
Updates the metadata associated with a task.
Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.
See the AWS API reference guide for AWS DataSync's API operation UpdateTask for usage and error information.
Returned Error Codes:
ErrCodeInvalidRequestException "InvalidRequestException" This exception is thrown when the client submits a malformed request.
ErrCodeInternalException "InternalException" This exception is thrown when an error occurs in the AWS DataSync service.
See also, https://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/UpdateTask
func (*DataSync) UpdateTaskRequest ¶
func (c *DataSync) UpdateTaskRequest(input *UpdateTaskInput) (req *request.Request, output *UpdateTaskOutput)
UpdateTaskRequest generates a "aws/request.Request" representing the client's request for the UpdateTask operation. The "output" return value will be populated with the request's response once the request completes successfully.
Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.
See UpdateTask for more information on using the UpdateTask API call, and error handling.
This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.
// Example sending a request using the UpdateTaskRequest method. req, resp := client.UpdateTaskRequest(params) err := req.Send() if err == nil { // resp is now filled fmt.Println(resp) }
See also, https://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/UpdateTask
func (*DataSync) UpdateTaskWithContext ¶
func (c *DataSync) UpdateTaskWithContext(ctx aws.Context, input *UpdateTaskInput, opts ...request.Option) (*UpdateTaskOutput, error)
UpdateTaskWithContext is the same as UpdateTask with the addition of the ability to pass a context and additional request options.
See UpdateTask for details on how to use this API operation.
The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.
type DeleteAgentInput ¶
type DeleteAgentInput struct { // The Amazon Resource Name (ARN) of the agent to delete. Use the ListAgents // operation to return a list of agents for your account and AWS Region. // // AgentArn is a required field AgentArn *string `type:"string" required:"true"` // contains filtered or unexported fields }
DeleteAgentRequest
func (DeleteAgentInput) GoString ¶
func (s DeleteAgentInput) GoString() string
GoString returns the string representation
func (*DeleteAgentInput) SetAgentArn ¶
func (s *DeleteAgentInput) SetAgentArn(v string) *DeleteAgentInput
SetAgentArn sets the AgentArn field's value.
func (DeleteAgentInput) String ¶
func (s DeleteAgentInput) String() string
String returns the string representation
func (*DeleteAgentInput) Validate ¶
func (s *DeleteAgentInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteAgentOutput ¶
type DeleteAgentOutput struct {
// contains filtered or unexported fields
}
func (DeleteAgentOutput) GoString ¶
func (s DeleteAgentOutput) GoString() string
GoString returns the string representation
func (DeleteAgentOutput) String ¶
func (s DeleteAgentOutput) String() string
String returns the string representation
type DeleteLocationInput ¶
type DeleteLocationInput struct { // The Amazon Resource Name (ARN) of the location to delete. // // LocationArn is a required field LocationArn *string `type:"string" required:"true"` // contains filtered or unexported fields }
DeleteLocation
func (DeleteLocationInput) GoString ¶
func (s DeleteLocationInput) GoString() string
GoString returns the string representation
func (*DeleteLocationInput) SetLocationArn ¶
func (s *DeleteLocationInput) SetLocationArn(v string) *DeleteLocationInput
SetLocationArn sets the LocationArn field's value.
func (DeleteLocationInput) String ¶
func (s DeleteLocationInput) String() string
String returns the string representation
func (*DeleteLocationInput) Validate ¶
func (s *DeleteLocationInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteLocationOutput ¶
type DeleteLocationOutput struct {
// contains filtered or unexported fields
}
func (DeleteLocationOutput) GoString ¶
func (s DeleteLocationOutput) GoString() string
GoString returns the string representation
func (DeleteLocationOutput) String ¶
func (s DeleteLocationOutput) String() string
String returns the string representation
type DeleteTaskInput ¶
type DeleteTaskInput struct { // The Amazon Resource Name (ARN) of the task to delete. // // TaskArn is a required field TaskArn *string `type:"string" required:"true"` // contains filtered or unexported fields }
DeleteTask
func (DeleteTaskInput) GoString ¶
func (s DeleteTaskInput) GoString() string
GoString returns the string representation
func (*DeleteTaskInput) SetTaskArn ¶
func (s *DeleteTaskInput) SetTaskArn(v string) *DeleteTaskInput
SetTaskArn sets the TaskArn field's value.
func (DeleteTaskInput) String ¶
func (s DeleteTaskInput) String() string
String returns the string representation
func (*DeleteTaskInput) Validate ¶
func (s *DeleteTaskInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DeleteTaskOutput ¶
type DeleteTaskOutput struct {
// contains filtered or unexported fields
}
func (DeleteTaskOutput) GoString ¶
func (s DeleteTaskOutput) GoString() string
GoString returns the string representation
func (DeleteTaskOutput) String ¶
func (s DeleteTaskOutput) String() string
String returns the string representation
type DescribeAgentInput ¶
type DescribeAgentInput struct { // The Amazon Resource Name (ARN) of the agent to describe. // // AgentArn is a required field AgentArn *string `type:"string" required:"true"` // contains filtered or unexported fields }
DescribeAgent
func (DescribeAgentInput) GoString ¶
func (s DescribeAgentInput) GoString() string
GoString returns the string representation
func (*DescribeAgentInput) SetAgentArn ¶
func (s *DescribeAgentInput) SetAgentArn(v string) *DescribeAgentInput
SetAgentArn sets the AgentArn field's value.
func (DescribeAgentInput) String ¶
func (s DescribeAgentInput) String() string
String returns the string representation
func (*DescribeAgentInput) Validate ¶
func (s *DescribeAgentInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeAgentOutput ¶
type DescribeAgentOutput struct { // The Amazon Resource Name (ARN) of the agent. AgentArn *string `type:"string"` // The time that the agent was activated (that is, created in your account). CreationTime *time.Time `type:"timestamp"` // The type of endpoint that your agent is connected to. If the endpoint is // a VPC endpoint, the agent is not accessible over the public Internet. EndpointType *string `type:"string" enum:"EndpointType"` // The time that the agent last connected to DataSyc. LastConnectionTime *time.Time `type:"timestamp"` // The name of the agent. Name *string `min:"1" type:"string"` // The subnet and the security group that DataSync used to access a VPC endpoint. PrivateLinkConfig *PrivateLinkConfig `type:"structure"` // The status of the agent. If the status is ONLINE, then the agent is configured // properly and is available to use. The Running status is the normal running // status for an agent. If the status is OFFLINE, the agent's VM is turned off // or the agent is in an unhealthy state. When the issue that caused the unhealthy // state is resolved, the agent returns to ONLINE status. Status *string `type:"string" enum:"AgentStatus"` // contains filtered or unexported fields }
DescribeAgentResponse
func (DescribeAgentOutput) GoString ¶
func (s DescribeAgentOutput) GoString() string
GoString returns the string representation
func (*DescribeAgentOutput) SetAgentArn ¶
func (s *DescribeAgentOutput) SetAgentArn(v string) *DescribeAgentOutput
SetAgentArn sets the AgentArn field's value.
func (*DescribeAgentOutput) SetCreationTime ¶
func (s *DescribeAgentOutput) SetCreationTime(v time.Time) *DescribeAgentOutput
SetCreationTime sets the CreationTime field's value.
func (*DescribeAgentOutput) SetEndpointType ¶ added in v1.21.10
func (s *DescribeAgentOutput) SetEndpointType(v string) *DescribeAgentOutput
SetEndpointType sets the EndpointType field's value.
func (*DescribeAgentOutput) SetLastConnectionTime ¶
func (s *DescribeAgentOutput) SetLastConnectionTime(v time.Time) *DescribeAgentOutput
SetLastConnectionTime sets the LastConnectionTime field's value.
func (*DescribeAgentOutput) SetName ¶
func (s *DescribeAgentOutput) SetName(v string) *DescribeAgentOutput
SetName sets the Name field's value.
func (*DescribeAgentOutput) SetPrivateLinkConfig ¶ added in v1.19.35
func (s *DescribeAgentOutput) SetPrivateLinkConfig(v *PrivateLinkConfig) *DescribeAgentOutput
SetPrivateLinkConfig sets the PrivateLinkConfig field's value.
func (*DescribeAgentOutput) SetStatus ¶
func (s *DescribeAgentOutput) SetStatus(v string) *DescribeAgentOutput
SetStatus sets the Status field's value.
func (DescribeAgentOutput) String ¶
func (s DescribeAgentOutput) String() string
String returns the string representation
type DescribeLocationEfsInput ¶
type DescribeLocationEfsInput struct { // The Amazon Resource Name (ARN) of the EFS location to describe. // // LocationArn is a required field LocationArn *string `type:"string" required:"true"` // contains filtered or unexported fields }
DescribeLocationEfsRequest
func (DescribeLocationEfsInput) GoString ¶
func (s DescribeLocationEfsInput) GoString() string
GoString returns the string representation
func (*DescribeLocationEfsInput) SetLocationArn ¶
func (s *DescribeLocationEfsInput) SetLocationArn(v string) *DescribeLocationEfsInput
SetLocationArn sets the LocationArn field's value.
func (DescribeLocationEfsInput) String ¶
func (s DescribeLocationEfsInput) String() string
String returns the string representation
func (*DescribeLocationEfsInput) Validate ¶
func (s *DescribeLocationEfsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeLocationEfsOutput ¶
type DescribeLocationEfsOutput struct { // The time that the EFS location was created. CreationTime *time.Time `type:"timestamp"` // The subnet and the security group that DataSync uses to access target EFS // file system. The subnet must have at least one mount target for that file // system. The security group that you provide needs to be able to communicate // with the security group on the mount target in the subnet specified. Ec2Config *Ec2Config `type:"structure"` // The Amazon resource Name (ARN) of the EFS location that was described. LocationArn *string `type:"string"` // The URL of the EFS location that was described. LocationUri *string `type:"string"` // contains filtered or unexported fields }
DescribeLocationEfsResponse
func (DescribeLocationEfsOutput) GoString ¶
func (s DescribeLocationEfsOutput) GoString() string
GoString returns the string representation
func (*DescribeLocationEfsOutput) SetCreationTime ¶
func (s *DescribeLocationEfsOutput) SetCreationTime(v time.Time) *DescribeLocationEfsOutput
SetCreationTime sets the CreationTime field's value.
func (*DescribeLocationEfsOutput) SetEc2Config ¶
func (s *DescribeLocationEfsOutput) SetEc2Config(v *Ec2Config) *DescribeLocationEfsOutput
SetEc2Config sets the Ec2Config field's value.
func (*DescribeLocationEfsOutput) SetLocationArn ¶
func (s *DescribeLocationEfsOutput) SetLocationArn(v string) *DescribeLocationEfsOutput
SetLocationArn sets the LocationArn field's value.
func (*DescribeLocationEfsOutput) SetLocationUri ¶
func (s *DescribeLocationEfsOutput) SetLocationUri(v string) *DescribeLocationEfsOutput
SetLocationUri sets the LocationUri field's value.
func (DescribeLocationEfsOutput) String ¶
func (s DescribeLocationEfsOutput) String() string
String returns the string representation
type DescribeLocationNfsInput ¶
type DescribeLocationNfsInput struct { // The Amazon resource Name (ARN) of the NFS location to describe. // // LocationArn is a required field LocationArn *string `type:"string" required:"true"` // contains filtered or unexported fields }
DescribeLocationNfsRequest
func (DescribeLocationNfsInput) GoString ¶
func (s DescribeLocationNfsInput) GoString() string
GoString returns the string representation
func (*DescribeLocationNfsInput) SetLocationArn ¶
func (s *DescribeLocationNfsInput) SetLocationArn(v string) *DescribeLocationNfsInput
SetLocationArn sets the LocationArn field's value.
func (DescribeLocationNfsInput) String ¶
func (s DescribeLocationNfsInput) String() string
String returns the string representation
func (*DescribeLocationNfsInput) Validate ¶
func (s *DescribeLocationNfsInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeLocationNfsOutput ¶
type DescribeLocationNfsOutput struct { // The time that the NFS location was created. CreationTime *time.Time `type:"timestamp"` // The Amazon resource Name (ARN) of the NFS location that was described. LocationArn *string `type:"string"` // The URL of the source NFS location that was described. LocationUri *string `type:"string"` // The NFS mount options that DataSync used to mount your NFS share. MountOptions *NfsMountOptions `type:"structure"` // A list of Amazon Resource Names (ARNs) of agents to use for a Network File // System (NFS) location. OnPremConfig *OnPremConfig `type:"structure"` // contains filtered or unexported fields }
DescribeLocationNfsResponse
func (DescribeLocationNfsOutput) GoString ¶
func (s DescribeLocationNfsOutput) GoString() string
GoString returns the string representation
func (*DescribeLocationNfsOutput) SetCreationTime ¶
func (s *DescribeLocationNfsOutput) SetCreationTime(v time.Time) *DescribeLocationNfsOutput
SetCreationTime sets the CreationTime field's value.
func (*DescribeLocationNfsOutput) SetLocationArn ¶
func (s *DescribeLocationNfsOutput) SetLocationArn(v string) *DescribeLocationNfsOutput
SetLocationArn sets the LocationArn field's value.
func (*DescribeLocationNfsOutput) SetLocationUri ¶
func (s *DescribeLocationNfsOutput) SetLocationUri(v string) *DescribeLocationNfsOutput
SetLocationUri sets the LocationUri field's value.
func (*DescribeLocationNfsOutput) SetMountOptions ¶ added in v1.19.29
func (s *DescribeLocationNfsOutput) SetMountOptions(v *NfsMountOptions) *DescribeLocationNfsOutput
SetMountOptions sets the MountOptions field's value.
func (*DescribeLocationNfsOutput) SetOnPremConfig ¶
func (s *DescribeLocationNfsOutput) SetOnPremConfig(v *OnPremConfig) *DescribeLocationNfsOutput
SetOnPremConfig sets the OnPremConfig field's value.
func (DescribeLocationNfsOutput) String ¶
func (s DescribeLocationNfsOutput) String() string
String returns the string representation
type DescribeLocationS3Input ¶
type DescribeLocationS3Input struct { // The Amazon Resource Name (ARN) of the Amazon S3 bucket location to describe. // // LocationArn is a required field LocationArn *string `type:"string" required:"true"` // contains filtered or unexported fields }
DescribeLocationS3Request
func (DescribeLocationS3Input) GoString ¶
func (s DescribeLocationS3Input) GoString() string
GoString returns the string representation
func (*DescribeLocationS3Input) SetLocationArn ¶
func (s *DescribeLocationS3Input) SetLocationArn(v string) *DescribeLocationS3Input
SetLocationArn sets the LocationArn field's value.
func (DescribeLocationS3Input) String ¶
func (s DescribeLocationS3Input) String() string
String returns the string representation
func (*DescribeLocationS3Input) Validate ¶
func (s *DescribeLocationS3Input) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeLocationS3Output ¶
type DescribeLocationS3Output struct { // The time that the Amazon S3 bucket location was created. CreationTime *time.Time `type:"timestamp"` // The Amazon Resource Name (ARN) of the Amazon S3 bucket location. LocationArn *string `type:"string"` // The URL of the Amazon S3 location that was described. LocationUri *string `type:"string"` // The Amazon Resource Name (ARN) of the AWS Identity and Access Management // (IAM) role that is used to access an Amazon S3 bucket. // // For detailed information about using such a role, see Creating a Location // for Amazon S3 in the AWS DataSync User Guide. S3Config *S3Config `type:"structure"` // The Amazon S3 storage class that you chose to store your files in when this // location is used as a task destination. For more information about S3 storage // classes, see Amazon S3 Storage Classes (https://aws.amazon.com/s3/storage-classes/) // in the Amazon Simple Storage Service Developer Guide. Some storage classes // have behaviors that can affect your S3 storage cost. For detailed information, // see using-storage-classes. S3StorageClass *string `type:"string" enum:"S3StorageClass"` // contains filtered or unexported fields }
DescribeLocationS3Response
func (DescribeLocationS3Output) GoString ¶
func (s DescribeLocationS3Output) GoString() string
GoString returns the string representation
func (*DescribeLocationS3Output) SetCreationTime ¶
func (s *DescribeLocationS3Output) SetCreationTime(v time.Time) *DescribeLocationS3Output
SetCreationTime sets the CreationTime field's value.
func (*DescribeLocationS3Output) SetLocationArn ¶
func (s *DescribeLocationS3Output) SetLocationArn(v string) *DescribeLocationS3Output
SetLocationArn sets the LocationArn field's value.
func (*DescribeLocationS3Output) SetLocationUri ¶
func (s *DescribeLocationS3Output) SetLocationUri(v string) *DescribeLocationS3Output
SetLocationUri sets the LocationUri field's value.
func (*DescribeLocationS3Output) SetS3Config ¶
func (s *DescribeLocationS3Output) SetS3Config(v *S3Config) *DescribeLocationS3Output
SetS3Config sets the S3Config field's value.
func (*DescribeLocationS3Output) SetS3StorageClass ¶ added in v1.24.5
func (s *DescribeLocationS3Output) SetS3StorageClass(v string) *DescribeLocationS3Output
SetS3StorageClass sets the S3StorageClass field's value.
func (DescribeLocationS3Output) String ¶
func (s DescribeLocationS3Output) String() string
String returns the string representation
type DescribeLocationSmbInput ¶ added in v1.23.7
type DescribeLocationSmbInput struct { // The Amazon resource Name (ARN) of the SMB location to describe. // // LocationArn is a required field LocationArn *string `type:"string" required:"true"` // contains filtered or unexported fields }
DescribeLocationSmbRequest
func (DescribeLocationSmbInput) GoString ¶ added in v1.23.7
func (s DescribeLocationSmbInput) GoString() string
GoString returns the string representation
func (*DescribeLocationSmbInput) SetLocationArn ¶ added in v1.23.7
func (s *DescribeLocationSmbInput) SetLocationArn(v string) *DescribeLocationSmbInput
SetLocationArn sets the LocationArn field's value.
func (DescribeLocationSmbInput) String ¶ added in v1.23.7
func (s DescribeLocationSmbInput) String() string
String returns the string representation
func (*DescribeLocationSmbInput) Validate ¶ added in v1.23.7
func (s *DescribeLocationSmbInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeLocationSmbOutput ¶ added in v1.23.7
type DescribeLocationSmbOutput struct { // The Amazon Resource Name (ARN) of the source SMB file system location that // is created. AgentArns []*string `min:"1" type:"list"` // The time that the SMB location was created. CreationTime *time.Time `type:"timestamp"` // The name of the Windows domain that the SMB server belongs to. Domain *string `type:"string"` // The Amazon resource Name (ARN) of the SMB location that was described. LocationArn *string `type:"string"` // The URL of the source SBM location that was described. LocationUri *string `type:"string"` // The mount options that are available for DataSync to use to access an SMB // location. MountOptions *SmbMountOptions `type:"structure"` // The user who can mount the share, has the permissions to access files and // folders in the SMB share. User *string `type:"string"` // contains filtered or unexported fields }
DescribeLocationSmbResponse
func (DescribeLocationSmbOutput) GoString ¶ added in v1.23.7
func (s DescribeLocationSmbOutput) GoString() string
GoString returns the string representation
func (*DescribeLocationSmbOutput) SetAgentArns ¶ added in v1.23.7
func (s *DescribeLocationSmbOutput) SetAgentArns(v []*string) *DescribeLocationSmbOutput
SetAgentArns sets the AgentArns field's value.
func (*DescribeLocationSmbOutput) SetCreationTime ¶ added in v1.23.7
func (s *DescribeLocationSmbOutput) SetCreationTime(v time.Time) *DescribeLocationSmbOutput
SetCreationTime sets the CreationTime field's value.
func (*DescribeLocationSmbOutput) SetDomain ¶ added in v1.23.7
func (s *DescribeLocationSmbOutput) SetDomain(v string) *DescribeLocationSmbOutput
SetDomain sets the Domain field's value.
func (*DescribeLocationSmbOutput) SetLocationArn ¶ added in v1.23.7
func (s *DescribeLocationSmbOutput) SetLocationArn(v string) *DescribeLocationSmbOutput
SetLocationArn sets the LocationArn field's value.
func (*DescribeLocationSmbOutput) SetLocationUri ¶ added in v1.23.7
func (s *DescribeLocationSmbOutput) SetLocationUri(v string) *DescribeLocationSmbOutput
SetLocationUri sets the LocationUri field's value.
func (*DescribeLocationSmbOutput) SetMountOptions ¶ added in v1.23.7
func (s *DescribeLocationSmbOutput) SetMountOptions(v *SmbMountOptions) *DescribeLocationSmbOutput
SetMountOptions sets the MountOptions field's value.
func (*DescribeLocationSmbOutput) SetUser ¶ added in v1.23.7
func (s *DescribeLocationSmbOutput) SetUser(v string) *DescribeLocationSmbOutput
SetUser sets the User field's value.
func (DescribeLocationSmbOutput) String ¶ added in v1.23.7
func (s DescribeLocationSmbOutput) String() string
String returns the string representation
type DescribeTaskExecutionInput ¶
type DescribeTaskExecutionInput struct { // The Amazon Resource Name (ARN) of the task that is being executed. // // TaskExecutionArn is a required field TaskExecutionArn *string `type:"string" required:"true"` // contains filtered or unexported fields }
DescribeTaskExecutionRequest
func (DescribeTaskExecutionInput) GoString ¶
func (s DescribeTaskExecutionInput) GoString() string
GoString returns the string representation
func (*DescribeTaskExecutionInput) SetTaskExecutionArn ¶
func (s *DescribeTaskExecutionInput) SetTaskExecutionArn(v string) *DescribeTaskExecutionInput
SetTaskExecutionArn sets the TaskExecutionArn field's value.
func (DescribeTaskExecutionInput) String ¶
func (s DescribeTaskExecutionInput) String() string
String returns the string representation
func (*DescribeTaskExecutionInput) Validate ¶
func (s *DescribeTaskExecutionInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeTaskExecutionOutput ¶
type DescribeTaskExecutionOutput struct { // The physical number of bytes transferred over the network. BytesTransferred *int64 `type:"long"` // The number of logical bytes written to the destination AWS storage resource. BytesWritten *int64 `type:"long"` // The estimated physical number of bytes that is to be transferred over the // network. EstimatedBytesToTransfer *int64 `type:"long"` // The expected number of files that is to be transferred over the network. // This value is calculated during the PREPARING phase, before the TRANSFERRING // phase. This value is the expected number of files to be transferred. It's // calculated based on comparing the content of the source and destination locations // and finding the delta that needs to be transferred. EstimatedFilesToTransfer *int64 `type:"long"` // A list of filter rules that determines which files to exclude from a task. // The list should contain a single filter string that consists of the patterns // to exclude. The patterns are delimited by "|" (that is, a pipe), for example: // "/folder1|/folder2" Excludes []*FilterRule `type:"list"` // The actual number of files that was transferred over the network. This value // is calculated and updated on an ongoing basis during the TRANSFERRING phase. // It's updated periodically when each file is read from the source and sent // over the network. // // If failures occur during a transfer, this value can be less than EstimatedFilesToTransfer. // This value can also be greater than EstimatedFilesTransferred in some cases. // This element is implementation-specific for some location types, so don't // use it as an indicator for a correct file number or to monitor your task // execution. FilesTransferred *int64 `type:"long"` // A list of filter rules that determines which files to include when running // a task. The list should contain a single filter string that consists of the // patterns to include. The patterns are delimited by "|" (that is, a pipe), // for example: "/folder1|/folder2" Includes []*FilterRule `type:"list"` // Represents the options that are available to control the behavior of a StartTaskExecution // operation. Behavior includes preserving metadata such as user ID (UID), group // ID (GID), and file permissions, and also overwriting files in the destination, // data integrity verification, and so on. // // A task has a set of default options associated with it. If you don't specify // an option in StartTaskExecution, the default value is used. You can override // the defaults options on each task execution by specifying an overriding Options // value to StartTaskExecution. Options *Options `type:"structure"` // The result of the task execution. Result *TaskExecutionResultDetail `type:"structure"` // The time that the task execution was started. StartTime *time.Time `type:"timestamp"` // The status of the task execution. // // For detailed information about task execution statuses, see Understanding // Task Statuses in the AWS DataSync User Guide. Status *string `type:"string" enum:"TaskExecutionStatus"` // The Amazon Resource Name (ARN) of the task execution that was described. // TaskExecutionArn is hierarchical and includes TaskArn for the task that was // executed. // // For example, a TaskExecution value with the ARN arn:aws:datasync:us-east-1:111222333444:task/task-0208075f79cedf4a2/execution/exec-08ef1e88ec491019b // executed the task with the ARN arn:aws:datasync:us-east-1:111222333444:task/task-0208075f79cedf4a2. TaskExecutionArn *string `type:"string"` // contains filtered or unexported fields }
DescribeTaskExecutionResponse
func (DescribeTaskExecutionOutput) GoString ¶
func (s DescribeTaskExecutionOutput) GoString() string
GoString returns the string representation
func (*DescribeTaskExecutionOutput) SetBytesTransferred ¶
func (s *DescribeTaskExecutionOutput) SetBytesTransferred(v int64) *DescribeTaskExecutionOutput
SetBytesTransferred sets the BytesTransferred field's value.
func (*DescribeTaskExecutionOutput) SetBytesWritten ¶
func (s *DescribeTaskExecutionOutput) SetBytesWritten(v int64) *DescribeTaskExecutionOutput
SetBytesWritten sets the BytesWritten field's value.
func (*DescribeTaskExecutionOutput) SetEstimatedBytesToTransfer ¶
func (s *DescribeTaskExecutionOutput) SetEstimatedBytesToTransfer(v int64) *DescribeTaskExecutionOutput
SetEstimatedBytesToTransfer sets the EstimatedBytesToTransfer field's value.
func (*DescribeTaskExecutionOutput) SetEstimatedFilesToTransfer ¶
func (s *DescribeTaskExecutionOutput) SetEstimatedFilesToTransfer(v int64) *DescribeTaskExecutionOutput
SetEstimatedFilesToTransfer sets the EstimatedFilesToTransfer field's value.
func (*DescribeTaskExecutionOutput) SetExcludes ¶ added in v1.19.29
func (s *DescribeTaskExecutionOutput) SetExcludes(v []*FilterRule) *DescribeTaskExecutionOutput
SetExcludes sets the Excludes field's value.
func (*DescribeTaskExecutionOutput) SetFilesTransferred ¶
func (s *DescribeTaskExecutionOutput) SetFilesTransferred(v int64) *DescribeTaskExecutionOutput
SetFilesTransferred sets the FilesTransferred field's value.
func (*DescribeTaskExecutionOutput) SetIncludes ¶ added in v1.19.29
func (s *DescribeTaskExecutionOutput) SetIncludes(v []*FilterRule) *DescribeTaskExecutionOutput
SetIncludes sets the Includes field's value.
func (*DescribeTaskExecutionOutput) SetOptions ¶
func (s *DescribeTaskExecutionOutput) SetOptions(v *Options) *DescribeTaskExecutionOutput
SetOptions sets the Options field's value.
func (*DescribeTaskExecutionOutput) SetResult ¶
func (s *DescribeTaskExecutionOutput) SetResult(v *TaskExecutionResultDetail) *DescribeTaskExecutionOutput
SetResult sets the Result field's value.
func (*DescribeTaskExecutionOutput) SetStartTime ¶
func (s *DescribeTaskExecutionOutput) SetStartTime(v time.Time) *DescribeTaskExecutionOutput
SetStartTime sets the StartTime field's value.
func (*DescribeTaskExecutionOutput) SetStatus ¶
func (s *DescribeTaskExecutionOutput) SetStatus(v string) *DescribeTaskExecutionOutput
SetStatus sets the Status field's value.
func (*DescribeTaskExecutionOutput) SetTaskExecutionArn ¶
func (s *DescribeTaskExecutionOutput) SetTaskExecutionArn(v string) *DescribeTaskExecutionOutput
SetTaskExecutionArn sets the TaskExecutionArn field's value.
func (DescribeTaskExecutionOutput) String ¶
func (s DescribeTaskExecutionOutput) String() string
String returns the string representation
type DescribeTaskInput ¶
type DescribeTaskInput struct { // The Amazon Resource Name (ARN) of the task to describe. // // TaskArn is a required field TaskArn *string `type:"string" required:"true"` // contains filtered or unexported fields }
DescribeTaskRequest
func (DescribeTaskInput) GoString ¶
func (s DescribeTaskInput) GoString() string
GoString returns the string representation
func (*DescribeTaskInput) SetTaskArn ¶
func (s *DescribeTaskInput) SetTaskArn(v string) *DescribeTaskInput
SetTaskArn sets the TaskArn field's value.
func (DescribeTaskInput) String ¶
func (s DescribeTaskInput) String() string
String returns the string representation
func (*DescribeTaskInput) Validate ¶
func (s *DescribeTaskInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type DescribeTaskOutput ¶
type DescribeTaskOutput struct { // The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that was // used to monitor and log events in the task. // // For more information on these groups, see Working with Log Groups and Log // Streams in the Amazon CloudWatch User Guide. CloudWatchLogGroupArn *string `type:"string"` // The time that the task was created. CreationTime *time.Time `type:"timestamp"` // The Amazon Resource Name (ARN) of the task execution that is syncing files. CurrentTaskExecutionArn *string `type:"string"` // The Amazon Resource Name (ARN) of the AWS storage resource's location. DestinationLocationArn *string `type:"string"` // The Amazon Resource Name (ARN) of the destination ENIs (Elastic Network Interface) // that was created for your subnet. DestinationNetworkInterfaceArns []*string `type:"list"` // Errors that AWS DataSync encountered during execution of the task. You can // use this error code to help troubleshoot issues. ErrorCode *string `type:"string"` // Detailed description of an error that was encountered during the task execution. // You can use this information to help troubleshoot issues. ErrorDetail *string `type:"string"` // A list of filter rules that determines which files to exclude from a task. // The list should contain a single filter string that consists of the patterns // to exclude. The patterns are delimited by "|" (that is, a pipe), for example: // "/folder1|/folder2" Excludes []*FilterRule `type:"list"` // The name of the task that was described. Name *string `min:"1" type:"string"` // The set of configuration options that control the behavior of a single execution // of the task that occurs when you call StartTaskExecution. You can configure // these options to preserve metadata such as user ID (UID) and group (GID), // file permissions, data integrity verification, and so on. // // For each individual task execution, you can override these options by specifying // the overriding OverrideOptions value to operation. Options *Options `type:"structure"` // The Amazon Resource Name (ARN) of the source file system's location. SourceLocationArn *string `type:"string"` // The Amazon Resource Name (ARN) of the source ENIs (Elastic Network Interface) // that was created for your subnet. SourceNetworkInterfaceArns []*string `type:"list"` // The status of the task that was described. // // For detailed information about task execution statuses, see Understanding // Task Statuses in the AWS DataSync User Guide. Status *string `type:"string" enum:"TaskStatus"` // The Amazon Resource Name (ARN) of the task that was described. TaskArn *string `type:"string"` // contains filtered or unexported fields }
DescribeTaskResponse
func (DescribeTaskOutput) GoString ¶
func (s DescribeTaskOutput) GoString() string
GoString returns the string representation
func (*DescribeTaskOutput) SetCloudWatchLogGroupArn ¶
func (s *DescribeTaskOutput) SetCloudWatchLogGroupArn(v string) *DescribeTaskOutput
SetCloudWatchLogGroupArn sets the CloudWatchLogGroupArn field's value.
func (*DescribeTaskOutput) SetCreationTime ¶
func (s *DescribeTaskOutput) SetCreationTime(v time.Time) *DescribeTaskOutput
SetCreationTime sets the CreationTime field's value.
func (*DescribeTaskOutput) SetCurrentTaskExecutionArn ¶
func (s *DescribeTaskOutput) SetCurrentTaskExecutionArn(v string) *DescribeTaskOutput
SetCurrentTaskExecutionArn sets the CurrentTaskExecutionArn field's value.
func (*DescribeTaskOutput) SetDestinationLocationArn ¶
func (s *DescribeTaskOutput) SetDestinationLocationArn(v string) *DescribeTaskOutput
SetDestinationLocationArn sets the DestinationLocationArn field's value.
func (*DescribeTaskOutput) SetDestinationNetworkInterfaceArns ¶ added in v1.21.10
func (s *DescribeTaskOutput) SetDestinationNetworkInterfaceArns(v []*string) *DescribeTaskOutput
SetDestinationNetworkInterfaceArns sets the DestinationNetworkInterfaceArns field's value.
func (*DescribeTaskOutput) SetErrorCode ¶
func (s *DescribeTaskOutput) SetErrorCode(v string) *DescribeTaskOutput
SetErrorCode sets the ErrorCode field's value.
func (*DescribeTaskOutput) SetErrorDetail ¶
func (s *DescribeTaskOutput) SetErrorDetail(v string) *DescribeTaskOutput
SetErrorDetail sets the ErrorDetail field's value.
func (*DescribeTaskOutput) SetExcludes ¶ added in v1.19.29
func (s *DescribeTaskOutput) SetExcludes(v []*FilterRule) *DescribeTaskOutput
SetExcludes sets the Excludes field's value.
func (*DescribeTaskOutput) SetName ¶
func (s *DescribeTaskOutput) SetName(v string) *DescribeTaskOutput
SetName sets the Name field's value.
func (*DescribeTaskOutput) SetOptions ¶
func (s *DescribeTaskOutput) SetOptions(v *Options) *DescribeTaskOutput
SetOptions sets the Options field's value.
func (*DescribeTaskOutput) SetSourceLocationArn ¶
func (s *DescribeTaskOutput) SetSourceLocationArn(v string) *DescribeTaskOutput
SetSourceLocationArn sets the SourceLocationArn field's value.
func (*DescribeTaskOutput) SetSourceNetworkInterfaceArns ¶ added in v1.21.10
func (s *DescribeTaskOutput) SetSourceNetworkInterfaceArns(v []*string) *DescribeTaskOutput
SetSourceNetworkInterfaceArns sets the SourceNetworkInterfaceArns field's value.
func (*DescribeTaskOutput) SetStatus ¶
func (s *DescribeTaskOutput) SetStatus(v string) *DescribeTaskOutput
SetStatus sets the Status field's value.
func (*DescribeTaskOutput) SetTaskArn ¶
func (s *DescribeTaskOutput) SetTaskArn(v string) *DescribeTaskOutput
SetTaskArn sets the TaskArn field's value.
func (DescribeTaskOutput) String ¶
func (s DescribeTaskOutput) String() string
String returns the string representation
type Ec2Config ¶
type Ec2Config struct { // The Amazon Resource Names (ARNs) of the security groups that are configured // for the Amazon EC2 resource. // // SecurityGroupArns is a required field SecurityGroupArns []*string `min:"1" type:"list" required:"true"` // The ARN of the subnet and the security group that DataSync uses to access // the target EFS file system. // // SubnetArn is a required field SubnetArn *string `type:"string" required:"true"` // contains filtered or unexported fields }
The subnet and the security group that DataSync uses to access target EFS file system. The subnet must have at least one mount target for that file system. The security group that you provide needs to be able to communicate with the security group on the mount target in the subnet specified.
func (*Ec2Config) SetSecurityGroupArns ¶
SetSecurityGroupArns sets the SecurityGroupArns field's value.
func (*Ec2Config) SetSubnetArn ¶
SetSubnetArn sets the SubnetArn field's value.
type FilterRule ¶ added in v1.19.29
type FilterRule struct { // The type of filter rule to apply. AWS DataSync only supports the SIMPLE_PATTERN // rule type. FilterType *string `type:"string" enum:"FilterType"` // A single filter string that consists of the patterns to include or exclude. // The patterns are delimited by "|" (that is, a pipe), for example: /folder1|/folder2 Value *string `type:"string"` // contains filtered or unexported fields }
Specifies which files, folders and objects to include or exclude when transferring files from source to destination.
func (FilterRule) GoString ¶ added in v1.19.29
func (s FilterRule) GoString() string
GoString returns the string representation
func (*FilterRule) SetFilterType ¶ added in v1.19.29
func (s *FilterRule) SetFilterType(v string) *FilterRule
SetFilterType sets the FilterType field's value.
func (*FilterRule) SetValue ¶ added in v1.19.29
func (s *FilterRule) SetValue(v string) *FilterRule
SetValue sets the Value field's value.
func (FilterRule) String ¶ added in v1.19.29
func (s FilterRule) String() string
String returns the string representation
type ListAgentsInput ¶
type ListAgentsInput struct { // The maximum number of agents to list. MaxResults *int64 `type:"integer"` // An opaque string that indicates the position at which to begin the next list // of agents. NextToken *string `type:"string"` // contains filtered or unexported fields }
ListAgentsRequest
func (ListAgentsInput) GoString ¶
func (s ListAgentsInput) GoString() string
GoString returns the string representation
func (*ListAgentsInput) SetMaxResults ¶
func (s *ListAgentsInput) SetMaxResults(v int64) *ListAgentsInput
SetMaxResults sets the MaxResults field's value.
func (*ListAgentsInput) SetNextToken ¶
func (s *ListAgentsInput) SetNextToken(v string) *ListAgentsInput
SetNextToken sets the NextToken field's value.
func (ListAgentsInput) String ¶
func (s ListAgentsInput) String() string
String returns the string representation
type ListAgentsOutput ¶
type ListAgentsOutput struct { // A list of agents in your account. Agents []*AgentListEntry `type:"list"` // An opaque string that indicates the position at which to begin returning // the next list of agents. NextToken *string `type:"string"` // contains filtered or unexported fields }
ListAgentsResponse
func (ListAgentsOutput) GoString ¶
func (s ListAgentsOutput) GoString() string
GoString returns the string representation
func (*ListAgentsOutput) SetAgents ¶
func (s *ListAgentsOutput) SetAgents(v []*AgentListEntry) *ListAgentsOutput
SetAgents sets the Agents field's value.
func (*ListAgentsOutput) SetNextToken ¶
func (s *ListAgentsOutput) SetNextToken(v string) *ListAgentsOutput
SetNextToken sets the NextToken field's value.
func (ListAgentsOutput) String ¶
func (s ListAgentsOutput) String() string
String returns the string representation
type ListLocationsInput ¶
type ListLocationsInput struct { // The maximum number of locations to return. MaxResults *int64 `type:"integer"` // An opaque string that indicates the position at which to begin the next list // of locations. NextToken *string `type:"string"` // contains filtered or unexported fields }
ListLocationsRequest
func (ListLocationsInput) GoString ¶
func (s ListLocationsInput) GoString() string
GoString returns the string representation
func (*ListLocationsInput) SetMaxResults ¶
func (s *ListLocationsInput) SetMaxResults(v int64) *ListLocationsInput
SetMaxResults sets the MaxResults field's value.
func (*ListLocationsInput) SetNextToken ¶
func (s *ListLocationsInput) SetNextToken(v string) *ListLocationsInput
SetNextToken sets the NextToken field's value.
func (ListLocationsInput) String ¶
func (s ListLocationsInput) String() string
String returns the string representation
type ListLocationsOutput ¶
type ListLocationsOutput struct { // An array that contains a list of locations. Locations []*LocationListEntry `type:"list"` // An opaque string that indicates the position at which to begin returning // the next list of locations. NextToken *string `type:"string"` // contains filtered or unexported fields }
ListLocationsResponse
func (ListLocationsOutput) GoString ¶
func (s ListLocationsOutput) GoString() string
GoString returns the string representation
func (*ListLocationsOutput) SetLocations ¶
func (s *ListLocationsOutput) SetLocations(v []*LocationListEntry) *ListLocationsOutput
SetLocations sets the Locations field's value.
func (*ListLocationsOutput) SetNextToken ¶
func (s *ListLocationsOutput) SetNextToken(v string) *ListLocationsOutput
SetNextToken sets the NextToken field's value.
func (ListLocationsOutput) String ¶
func (s ListLocationsOutput) String() string
String returns the string representation
type ListTagsForResourceInput ¶
type ListTagsForResourceInput struct { // The maximum number of locations to return. MaxResults *int64 `type:"integer"` // An opaque string that indicates the position at which to begin the next list // of locations. NextToken *string `type:"string"` // The Amazon Resource Name (ARN) of the resource whose tags to list. // // ResourceArn is a required field ResourceArn *string `type:"string" required:"true"` // contains filtered or unexported fields }
ListTagsForResourceRequest
func (ListTagsForResourceInput) GoString ¶
func (s ListTagsForResourceInput) GoString() string
GoString returns the string representation
func (*ListTagsForResourceInput) SetMaxResults ¶
func (s *ListTagsForResourceInput) SetMaxResults(v int64) *ListTagsForResourceInput
SetMaxResults sets the MaxResults field's value.
func (*ListTagsForResourceInput) SetNextToken ¶
func (s *ListTagsForResourceInput) SetNextToken(v string) *ListTagsForResourceInput
SetNextToken sets the NextToken field's value.
func (*ListTagsForResourceInput) SetResourceArn ¶
func (s *ListTagsForResourceInput) SetResourceArn(v string) *ListTagsForResourceInput
SetResourceArn sets the ResourceArn field's value.
func (ListTagsForResourceInput) String ¶
func (s ListTagsForResourceInput) String() string
String returns the string representation
func (*ListTagsForResourceInput) Validate ¶
func (s *ListTagsForResourceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type ListTagsForResourceOutput ¶
type ListTagsForResourceOutput struct { // An opaque string that indicates the position at which to begin returning // the next list of resource tags. NextToken *string `type:"string"` // Array of resource tags. Tags []*TagListEntry `type:"list"` // contains filtered or unexported fields }
ListTagsForResourceResponse
func (ListTagsForResourceOutput) GoString ¶
func (s ListTagsForResourceOutput) GoString() string
GoString returns the string representation
func (*ListTagsForResourceOutput) SetNextToken ¶
func (s *ListTagsForResourceOutput) SetNextToken(v string) *ListTagsForResourceOutput
SetNextToken sets the NextToken field's value.
func (*ListTagsForResourceOutput) SetTags ¶
func (s *ListTagsForResourceOutput) SetTags(v []*TagListEntry) *ListTagsForResourceOutput
SetTags sets the Tags field's value.
func (ListTagsForResourceOutput) String ¶
func (s ListTagsForResourceOutput) String() string
String returns the string representation
type ListTaskExecutionsInput ¶
type ListTaskExecutionsInput struct { // The maximum number of executed tasks to list. MaxResults *int64 `type:"integer"` // An opaque string that indicates the position at which to begin the next list // of the executed tasks. NextToken *string `type:"string"` // The Amazon Resource Name (ARN) of the task whose tasks you want to list. TaskArn *string `type:"string"` // contains filtered or unexported fields }
ListTaskExecutions
func (ListTaskExecutionsInput) GoString ¶
func (s ListTaskExecutionsInput) GoString() string
GoString returns the string representation
func (*ListTaskExecutionsInput) SetMaxResults ¶
func (s *ListTaskExecutionsInput) SetMaxResults(v int64) *ListTaskExecutionsInput
SetMaxResults sets the MaxResults field's value.
func (*ListTaskExecutionsInput) SetNextToken ¶
func (s *ListTaskExecutionsInput) SetNextToken(v string) *ListTaskExecutionsInput
SetNextToken sets the NextToken field's value.
func (*ListTaskExecutionsInput) SetTaskArn ¶
func (s *ListTaskExecutionsInput) SetTaskArn(v string) *ListTaskExecutionsInput
SetTaskArn sets the TaskArn field's value.
func (ListTaskExecutionsInput) String ¶
func (s ListTaskExecutionsInput) String() string
String returns the string representation
type ListTaskExecutionsOutput ¶
type ListTaskExecutionsOutput struct { // An opaque string that indicates the position at which to begin returning // the next list of executed tasks. NextToken *string `type:"string"` // A list of executed tasks. TaskExecutions []*TaskExecutionListEntry `type:"list"` // contains filtered or unexported fields }
ListTaskExecutionsResponse
func (ListTaskExecutionsOutput) GoString ¶
func (s ListTaskExecutionsOutput) GoString() string
GoString returns the string representation
func (*ListTaskExecutionsOutput) SetNextToken ¶
func (s *ListTaskExecutionsOutput) SetNextToken(v string) *ListTaskExecutionsOutput
SetNextToken sets the NextToken field's value.
func (*ListTaskExecutionsOutput) SetTaskExecutions ¶
func (s *ListTaskExecutionsOutput) SetTaskExecutions(v []*TaskExecutionListEntry) *ListTaskExecutionsOutput
SetTaskExecutions sets the TaskExecutions field's value.
func (ListTaskExecutionsOutput) String ¶
func (s ListTaskExecutionsOutput) String() string
String returns the string representation
type ListTasksInput ¶
type ListTasksInput struct { // The maximum number of tasks to return. MaxResults *int64 `type:"integer"` // An opaque string that indicates the position at which to begin the next list // of tasks. NextToken *string `type:"string"` // contains filtered or unexported fields }
ListTasksRequest
func (ListTasksInput) GoString ¶
func (s ListTasksInput) GoString() string
GoString returns the string representation
func (*ListTasksInput) SetMaxResults ¶
func (s *ListTasksInput) SetMaxResults(v int64) *ListTasksInput
SetMaxResults sets the MaxResults field's value.
func (*ListTasksInput) SetNextToken ¶
func (s *ListTasksInput) SetNextToken(v string) *ListTasksInput
SetNextToken sets the NextToken field's value.
func (ListTasksInput) String ¶
func (s ListTasksInput) String() string
String returns the string representation
type ListTasksOutput ¶
type ListTasksOutput struct { // An opaque string that indicates the position at which to begin returning // the next list of tasks. NextToken *string `type:"string"` // A list of all the tasks that are returned. Tasks []*TaskListEntry `type:"list"` // contains filtered or unexported fields }
ListTasksResponse
func (ListTasksOutput) GoString ¶
func (s ListTasksOutput) GoString() string
GoString returns the string representation
func (*ListTasksOutput) SetNextToken ¶
func (s *ListTasksOutput) SetNextToken(v string) *ListTasksOutput
SetNextToken sets the NextToken field's value.
func (*ListTasksOutput) SetTasks ¶
func (s *ListTasksOutput) SetTasks(v []*TaskListEntry) *ListTasksOutput
SetTasks sets the Tasks field's value.
func (ListTasksOutput) String ¶
func (s ListTasksOutput) String() string
String returns the string representation
type LocationListEntry ¶
type LocationListEntry struct { // The Amazon Resource Name (ARN) of the location. For Network File System (NFS) // or Amazon EFS, the location is the export path. For Amazon S3, the location // is the prefix path that you want to mount and use as the root of the location. LocationArn *string `type:"string"` // Represents a list of URLs of a location. LocationUri returns an array that // contains a list of locations when the ListLocations operation is called. // // Format: TYPE://GLOBAL_ID/SUBDIR. // // TYPE designates the type of location. Valid values: NFS | EFS | S3. // // GLOBAL_ID is the globally unique identifier of the resource that backs the // location. An example for EFS is us-east-2.fs-abcd1234. An example for Amazon // S3 is the bucket name, such as myBucket. An example for NFS is a valid IPv4 // address or a host name compliant with Domain Name Service (DNS). // // SUBDIR is a valid file system path, delimited by forward slashes as is the // *nix convention. For NFS and Amazon EFS, it's the export path to mount the // location. For Amazon S3, it's the prefix path that you mount to and treat // as the root of the location. LocationUri *string `type:"string"` // contains filtered or unexported fields }
Represents a single entry in a list of locations. LocationListEntry returns an array that contains a list of locations when the ListLocations operation is called.
func (LocationListEntry) GoString ¶
func (s LocationListEntry) GoString() string
GoString returns the string representation
func (*LocationListEntry) SetLocationArn ¶
func (s *LocationListEntry) SetLocationArn(v string) *LocationListEntry
SetLocationArn sets the LocationArn field's value.
func (*LocationListEntry) SetLocationUri ¶
func (s *LocationListEntry) SetLocationUri(v string) *LocationListEntry
SetLocationUri sets the LocationUri field's value.
func (LocationListEntry) String ¶
func (s LocationListEntry) String() string
String returns the string representation
type NfsMountOptions ¶ added in v1.19.29
type NfsMountOptions struct { // The specific NFS version that you want DataSync to use to mount your NFS // share. If the server refuses to use the version specified, the sync will // fail. If you don't specify a version, DataSync defaults to AUTOMATIC. That // is, DataSync automatically selects a version based on negotiation with the // NFS server. // // You can specify the following NFS versions: // // * NFSv3 (https://tools.ietf.org/html/rfc1813) - stateless protocol version // that allows for asynchronous writes on the server. // // * NFSv4.0 (https://tools.ietf.org/html/rfc3530) - stateful, firewall-friendly // protocol version that supports delegations and pseudo filesystems. // // * NFSv4.1 (https://tools.ietf.org/html/rfc5661) - stateful protocol version // that supports sessions, directory delegations, and parallel data processing. // Version 4.1 also includes all features available in version 4.0. Version *string `type:"string" enum:"NfsVersion"` // contains filtered or unexported fields }
Represents the mount options that are available for DataSync to access an NFS location.
func (NfsMountOptions) GoString ¶ added in v1.19.29
func (s NfsMountOptions) GoString() string
GoString returns the string representation
func (*NfsMountOptions) SetVersion ¶ added in v1.19.29
func (s *NfsMountOptions) SetVersion(v string) *NfsMountOptions
SetVersion sets the Version field's value.
func (NfsMountOptions) String ¶ added in v1.19.29
func (s NfsMountOptions) String() string
String returns the string representation
type OnPremConfig ¶
type OnPremConfig struct { // ARNs)of the agents to use for an NFS location. // // AgentArns is a required field AgentArns []*string `min:"1" type:"list" required:"true"` // contains filtered or unexported fields }
A list of Amazon Resource Names (ARNs) of agents to use for a Network File System (NFS) location.
func (OnPremConfig) GoString ¶
func (s OnPremConfig) GoString() string
GoString returns the string representation
func (*OnPremConfig) SetAgentArns ¶
func (s *OnPremConfig) SetAgentArns(v []*string) *OnPremConfig
SetAgentArns sets the AgentArns field's value.
func (OnPremConfig) String ¶
func (s OnPremConfig) String() string
String returns the string representation
func (*OnPremConfig) Validate ¶
func (s *OnPremConfig) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type Options ¶
type Options struct { // A file metadata value that shows the last time a file was accessed (that // is, when the file was read or written to). If you set Atime to BEST_EFFORT, // DataSync attempts to preserve the original Atime attribute on all source // files (that is, the version before the PREPARING phase). However, Atime's // behavior is not fully standard across platforms, so AWS DataSync can only // do this on a best-effort basis. // // Default value: BEST_EFFORT. // // BEST_EFFORT: Attempt to preserve the per-file Atime value (recommended). // // NONE: Ignore Atime. // // If Atime is set to BEST_EFFORT, Mtime must be set to PRESERVE. // // If Atime is set to NONE, Mtime must also be NONE. Atime *string `type:"string" enum:"Atime"` // A value that limits the bandwidth used by AWS DataSync. For example, if you // want AWS DataSync to use a maximum of 1 MB, set this value to 1048576 (=1024*1024). BytesPerSecond *int64 `type:"long"` // The group ID (GID) of the file's owners. // // Default value: INT_VALUE. This preserves the integer value of the ID. // // INT_VALUE: Preserve the integer value of user ID (UID) and GID (recommended). // // NONE: Ignore UID and GID. Gid *string `type:"string" enum:"Gid"` // A value that indicates the last time that a file was modified (that is, a // file was written to) before the PREPARING phase. // // Default value: PRESERVE. // // PRESERVE: Preserve original Mtime (recommended) // // NONE: Ignore Mtime. // // If Mtime is set to PRESERVE, Atime must be set to BEST_EFFORT. // // If Mtime is set to NONE, Atime must also be set to NONE. Mtime *string `type:"string" enum:"Mtime"` // A value that determines whether files at the destination should be overwritten // or preserved when copying files. If set to NEVER a destination file will // not be replaced by a source file, even if the destination file differs from // the source file. If you modify files in the destination and you sync the // files, you can use this value to protect against overwriting those changes. // // Some storage classes have specific behaviors that can affect your S3 storage // cost. For detailed information, see using-storage-classes in the AWS DataSync // User Guide. OverwriteMode *string `type:"string" enum:"OverwriteMode"` // A value that determines which users or groups can access a file for a specific // purpose such as reading, writing, or execution of the file. // // Default value: PRESERVE. // // PRESERVE: Preserve POSIX-style permissions (recommended). // // NONE: Ignore permissions. // // AWS DataSync can preserve extant permissions of a source location. PosixPermissions *string `type:"string" enum:"PosixPermissions"` // A value that specifies whether files in the destination that don't exist // in the source file system should be preserved. This option can affect your // storage cost. If your task deletes objects, you might incur minimum storage // duration charges for certain storage classes. For detailed information, see // using-storage-classes in the AWS DataSync User Guide. // // Default value: PRESERVE. // // PRESERVE: Ignore such destination files (recommended). // // REMOVE: Delete destination files that aren’t present in the source. PreserveDeletedFiles *string `type:"string" enum:"PreserveDeletedFiles"` // A value that determines whether AWS DataSync should preserve the metadata // of block and character devices in the source file system, and recreate the // files with that device name and metadata on the destination. // // AWS DataSync can't sync the actual contents of such devices, because they // are nonterminal and don't return an end-of-file (EOF) marker. // // Default value: NONE. // // NONE: Ignore special devices (recommended). // // PRESERVE: Preserve character and block device metadata. This option isn't // currently supported for Amazon EFS. PreserveDevices *string `type:"string" enum:"PreserveDevices"` // The user ID (UID) of the file's owner. // // Default value: INT_VALUE. This preserves the integer value of the ID. // // INT_VALUE: Preserve the integer value of UID and group ID (GID) (recommended). // // NONE: Ignore UID and GID. Uid *string `type:"string" enum:"Uid"` // A value that determines whether a data integrity verification should be performed // at the end of a task execution after all data and metadata have been transferred. // // Default value: POINT_IN_TIME_CONSISTENT. // // POINT_IN_TIME_CONSISTENT: Perform verification (recommended). // // ONLY_FILES_TRANSFERRED: Perform verification on only files that were transferred. // // NONE: Skip verification. VerifyMode *string `type:"string" enum:"VerifyMode"` // contains filtered or unexported fields }
Represents the options that are available to control the behavior of a StartTaskExecution operation. Behavior includes preserving metadata such as user ID (UID), group ID (GID), and file permissions, and also overwriting files in the destination, data integrity verification, and so on.
A task has a set of default options associated with it. If you don't specify an option in StartTaskExecution, the default value is used. You can override the defaults options on each task execution by specifying an overriding Options value to StartTaskExecution.
func (*Options) SetBytesPerSecond ¶
SetBytesPerSecond sets the BytesPerSecond field's value.
func (*Options) SetOverwriteMode ¶ added in v1.24.5
SetOverwriteMode sets the OverwriteMode field's value.
func (*Options) SetPosixPermissions ¶
SetPosixPermissions sets the PosixPermissions field's value.
func (*Options) SetPreserveDeletedFiles ¶
SetPreserveDeletedFiles sets the PreserveDeletedFiles field's value.
func (*Options) SetPreserveDevices ¶
SetPreserveDevices sets the PreserveDevices field's value.
func (*Options) SetVerifyMode ¶
SetVerifyMode sets the VerifyMode field's value.
type PrivateLinkConfig ¶ added in v1.19.35
type PrivateLinkConfig struct { // The private endpoint that is configured for an agent that has access to IP // addresses in a PrivateLink (https://docs.aws.amazon.com/vpc/latest/userguide/endpoint-service.html). // An agent that is configured with this endpoint will not be accessible over // the public Internet. PrivateLinkEndpoint *string `min:"7" type:"string"` // The Amazon Resource Names (ARNs) of the security groups that are configured // for the EC2 resource that hosts an agent activated in a VPC or an agent that // has access to a VPC endpoint. SecurityGroupArns []*string `min:"1" type:"list"` // The Amazon Resource Names (ARNs) of the subnets that are configured for an // agent activated in a VPC or an agent that has access to a VPC endpoint. SubnetArns []*string `min:"1" type:"list"` // The ID of the VPC endpoint that is configured for an agent. An agent that // is configured with a VPC endpoint will not be accessible over the public // Internet. VpcEndpointId *string `type:"string"` // contains filtered or unexported fields }
The VPC endpoint, subnet and security group that an agent uses to access IP addresses in a VPC (Virtual Private Cloud).
func (PrivateLinkConfig) GoString ¶ added in v1.19.35
func (s PrivateLinkConfig) GoString() string
GoString returns the string representation
func (*PrivateLinkConfig) SetPrivateLinkEndpoint ¶ added in v1.19.35
func (s *PrivateLinkConfig) SetPrivateLinkEndpoint(v string) *PrivateLinkConfig
SetPrivateLinkEndpoint sets the PrivateLinkEndpoint field's value.
func (*PrivateLinkConfig) SetSecurityGroupArns ¶ added in v1.19.35
func (s *PrivateLinkConfig) SetSecurityGroupArns(v []*string) *PrivateLinkConfig
SetSecurityGroupArns sets the SecurityGroupArns field's value.
func (*PrivateLinkConfig) SetSubnetArns ¶ added in v1.19.35
func (s *PrivateLinkConfig) SetSubnetArns(v []*string) *PrivateLinkConfig
SetSubnetArns sets the SubnetArns field's value.
func (*PrivateLinkConfig) SetVpcEndpointId ¶ added in v1.21.10
func (s *PrivateLinkConfig) SetVpcEndpointId(v string) *PrivateLinkConfig
SetVpcEndpointId sets the VpcEndpointId field's value.
func (PrivateLinkConfig) String ¶ added in v1.19.35
func (s PrivateLinkConfig) String() string
String returns the string representation
type S3Config ¶
type S3Config struct { // The Amazon S3 bucket to access. This bucket is used as a parameter in the // CreateLocationS3 operation. // // BucketAccessRoleArn is a required field BucketAccessRoleArn *string `type:"string" required:"true"` // contains filtered or unexported fields }
The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that is used to access an Amazon S3 bucket.
For detailed information about using such a role, see Creating a Location for Amazon S3 in the AWS DataSync User Guide.
func (*S3Config) SetBucketAccessRoleArn ¶
SetBucketAccessRoleArn sets the BucketAccessRoleArn field's value.
type SmbMountOptions ¶ added in v1.23.7
type SmbMountOptions struct { // The specific SMB version that you want DataSync to use to mount your SMB // share. If you don't specify a version, DataSync defaults to AUTOMATIC. That // is, DataSync automatically selects a version based on negotiation with the // SMB server. Version *string `type:"string" enum:"SmbVersion"` // contains filtered or unexported fields }
Represents the mount options that are available for DataSync to access an SMB location.
func (SmbMountOptions) GoString ¶ added in v1.23.7
func (s SmbMountOptions) GoString() string
GoString returns the string representation
func (*SmbMountOptions) SetVersion ¶ added in v1.23.7
func (s *SmbMountOptions) SetVersion(v string) *SmbMountOptions
SetVersion sets the Version field's value.
func (SmbMountOptions) String ¶ added in v1.23.7
func (s SmbMountOptions) String() string
String returns the string representation
type StartTaskExecutionInput ¶
type StartTaskExecutionInput struct { // A list of filter rules that determines which files to include when running // a task. The pattern should contain a single filter string that consists of // the patterns to include. The patterns are delimited by "|" (that is, a pipe). // For example: "/folder1|/folder2" Includes []*FilterRule `type:"list"` // Represents the options that are available to control the behavior of a StartTaskExecution // operation. Behavior includes preserving metadata such as user ID (UID), group // ID (GID), and file permissions, and also overwriting files in the destination, // data integrity verification, and so on. // // A task has a set of default options associated with it. If you don't specify // an option in StartTaskExecution, the default value is used. You can override // the defaults options on each task execution by specifying an overriding Options // value to StartTaskExecution. OverrideOptions *Options `type:"structure"` // The Amazon Resource Name (ARN) of the task to start. // // TaskArn is a required field TaskArn *string `type:"string" required:"true"` // contains filtered or unexported fields }
StartTaskExecutionRequest
func (StartTaskExecutionInput) GoString ¶
func (s StartTaskExecutionInput) GoString() string
GoString returns the string representation
func (*StartTaskExecutionInput) SetIncludes ¶ added in v1.19.29
func (s *StartTaskExecutionInput) SetIncludes(v []*FilterRule) *StartTaskExecutionInput
SetIncludes sets the Includes field's value.
func (*StartTaskExecutionInput) SetOverrideOptions ¶
func (s *StartTaskExecutionInput) SetOverrideOptions(v *Options) *StartTaskExecutionInput
SetOverrideOptions sets the OverrideOptions field's value.
func (*StartTaskExecutionInput) SetTaskArn ¶
func (s *StartTaskExecutionInput) SetTaskArn(v string) *StartTaskExecutionInput
SetTaskArn sets the TaskArn field's value.
func (StartTaskExecutionInput) String ¶
func (s StartTaskExecutionInput) String() string
String returns the string representation
func (*StartTaskExecutionInput) Validate ¶
func (s *StartTaskExecutionInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type StartTaskExecutionOutput ¶
type StartTaskExecutionOutput struct { // The Amazon Resource Name (ARN) of the specific task execution that was started. TaskExecutionArn *string `type:"string"` // contains filtered or unexported fields }
StartTaskExecutionResponse
func (StartTaskExecutionOutput) GoString ¶
func (s StartTaskExecutionOutput) GoString() string
GoString returns the string representation
func (*StartTaskExecutionOutput) SetTaskExecutionArn ¶
func (s *StartTaskExecutionOutput) SetTaskExecutionArn(v string) *StartTaskExecutionOutput
SetTaskExecutionArn sets the TaskExecutionArn field's value.
func (StartTaskExecutionOutput) String ¶
func (s StartTaskExecutionOutput) String() string
String returns the string representation
type TagListEntry ¶
type TagListEntry struct { // The key for an AWS resource tag. // // Key is a required field Key *string `min:"1" type:"string" required:"true"` // The value for an AWS resource tag. Value *string `min:"1" type:"string"` // contains filtered or unexported fields }
Represents a single entry in a list of AWS resource tags. TagListEntry returns an array that contains a list of tasks when the ListTagsForResource operation is called.
func (TagListEntry) GoString ¶
func (s TagListEntry) GoString() string
GoString returns the string representation
func (*TagListEntry) SetKey ¶
func (s *TagListEntry) SetKey(v string) *TagListEntry
SetKey sets the Key field's value.
func (*TagListEntry) SetValue ¶
func (s *TagListEntry) SetValue(v string) *TagListEntry
SetValue sets the Value field's value.
func (TagListEntry) String ¶
func (s TagListEntry) String() string
String returns the string representation
func (*TagListEntry) Validate ¶
func (s *TagListEntry) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type TagResourceInput ¶
type TagResourceInput struct { // The Amazon Resource Name (ARN) of the resource to apply the tag to. // // ResourceArn is a required field ResourceArn *string `type:"string" required:"true"` // The tags to apply. // // Tags is a required field Tags []*TagListEntry `type:"list" required:"true"` // contains filtered or unexported fields }
TagResourceRequest
func (TagResourceInput) GoString ¶
func (s TagResourceInput) GoString() string
GoString returns the string representation
func (*TagResourceInput) SetResourceArn ¶
func (s *TagResourceInput) SetResourceArn(v string) *TagResourceInput
SetResourceArn sets the ResourceArn field's value.
func (*TagResourceInput) SetTags ¶
func (s *TagResourceInput) SetTags(v []*TagListEntry) *TagResourceInput
SetTags sets the Tags field's value.
func (TagResourceInput) String ¶
func (s TagResourceInput) String() string
String returns the string representation
func (*TagResourceInput) Validate ¶
func (s *TagResourceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type TagResourceOutput ¶
type TagResourceOutput struct {
// contains filtered or unexported fields
}
func (TagResourceOutput) GoString ¶
func (s TagResourceOutput) GoString() string
GoString returns the string representation
func (TagResourceOutput) String ¶
func (s TagResourceOutput) String() string
String returns the string representation
type TaskExecutionListEntry ¶
type TaskExecutionListEntry struct { // The status of a task execution. Status *string `type:"string" enum:"TaskExecutionStatus"` // The Amazon Resource Name (ARN) of the task that was executed. TaskExecutionArn *string `type:"string"` // contains filtered or unexported fields }
Represents a single entry in a list of task executions. TaskExecutionListEntry returns an array that contains a list of specific invocations of a task when ListTaskExecutions operation is called.
func (TaskExecutionListEntry) GoString ¶
func (s TaskExecutionListEntry) GoString() string
GoString returns the string representation
func (*TaskExecutionListEntry) SetStatus ¶
func (s *TaskExecutionListEntry) SetStatus(v string) *TaskExecutionListEntry
SetStatus sets the Status field's value.
func (*TaskExecutionListEntry) SetTaskExecutionArn ¶
func (s *TaskExecutionListEntry) SetTaskExecutionArn(v string) *TaskExecutionListEntry
SetTaskExecutionArn sets the TaskExecutionArn field's value.
func (TaskExecutionListEntry) String ¶
func (s TaskExecutionListEntry) String() string
String returns the string representation
type TaskExecutionResultDetail ¶
type TaskExecutionResultDetail struct { // Errors that AWS DataSync encountered during execution of the task. You can // use this error code to help troubleshoot issues. ErrorCode *string `type:"string"` // Detailed description of an error that was encountered during the task execution. // You can use this information to help troubleshoot issues. ErrorDetail *string `type:"string"` // The total time in milliseconds that AWS DataSync spent in the PREPARING phase. PrepareDuration *int64 `type:"long"` // The status of the PREPARING phase. PrepareStatus *string `type:"string" enum:"PhaseStatus"` // The total time in milliseconds that AWS DataSync spent in the TRANSFERRING // phase. TransferDuration *int64 `type:"long"` // The status of the TRANSFERRING Phase. TransferStatus *string `type:"string" enum:"PhaseStatus"` // The total time in milliseconds that AWS DataSync spent in the VERIFYING phase. VerifyDuration *int64 `type:"long"` // The status of the VERIFYING Phase. VerifyStatus *string `type:"string" enum:"PhaseStatus"` // contains filtered or unexported fields }
Describes the detailed result of a TaskExecution operation. This result includes the time in milliseconds spent in each phase, the status of the task execution, and the errors encountered.
func (TaskExecutionResultDetail) GoString ¶
func (s TaskExecutionResultDetail) GoString() string
GoString returns the string representation
func (*TaskExecutionResultDetail) SetErrorCode ¶
func (s *TaskExecutionResultDetail) SetErrorCode(v string) *TaskExecutionResultDetail
SetErrorCode sets the ErrorCode field's value.
func (*TaskExecutionResultDetail) SetErrorDetail ¶
func (s *TaskExecutionResultDetail) SetErrorDetail(v string) *TaskExecutionResultDetail
SetErrorDetail sets the ErrorDetail field's value.
func (*TaskExecutionResultDetail) SetPrepareDuration ¶
func (s *TaskExecutionResultDetail) SetPrepareDuration(v int64) *TaskExecutionResultDetail
SetPrepareDuration sets the PrepareDuration field's value.
func (*TaskExecutionResultDetail) SetPrepareStatus ¶
func (s *TaskExecutionResultDetail) SetPrepareStatus(v string) *TaskExecutionResultDetail
SetPrepareStatus sets the PrepareStatus field's value.
func (*TaskExecutionResultDetail) SetTransferDuration ¶
func (s *TaskExecutionResultDetail) SetTransferDuration(v int64) *TaskExecutionResultDetail
SetTransferDuration sets the TransferDuration field's value.
func (*TaskExecutionResultDetail) SetTransferStatus ¶
func (s *TaskExecutionResultDetail) SetTransferStatus(v string) *TaskExecutionResultDetail
SetTransferStatus sets the TransferStatus field's value.
func (*TaskExecutionResultDetail) SetVerifyDuration ¶
func (s *TaskExecutionResultDetail) SetVerifyDuration(v int64) *TaskExecutionResultDetail
SetVerifyDuration sets the VerifyDuration field's value.
func (*TaskExecutionResultDetail) SetVerifyStatus ¶
func (s *TaskExecutionResultDetail) SetVerifyStatus(v string) *TaskExecutionResultDetail
SetVerifyStatus sets the VerifyStatus field's value.
func (TaskExecutionResultDetail) String ¶
func (s TaskExecutionResultDetail) String() string
String returns the string representation
type TaskListEntry ¶
type TaskListEntry struct { // The name of the task. Name *string `min:"1" type:"string"` // The status of the task. Status *string `type:"string" enum:"TaskStatus"` // The Amazon Resource Name (ARN) of the task. TaskArn *string `type:"string"` // contains filtered or unexported fields }
Represents a single entry in a list of tasks. TaskListEntry returns an array that contains a list of tasks when the ListTasks operation is called. A task includes the source and destination file systems to sync and the options to use for the tasks.
func (TaskListEntry) GoString ¶
func (s TaskListEntry) GoString() string
GoString returns the string representation
func (*TaskListEntry) SetName ¶
func (s *TaskListEntry) SetName(v string) *TaskListEntry
SetName sets the Name field's value.
func (*TaskListEntry) SetStatus ¶
func (s *TaskListEntry) SetStatus(v string) *TaskListEntry
SetStatus sets the Status field's value.
func (*TaskListEntry) SetTaskArn ¶
func (s *TaskListEntry) SetTaskArn(v string) *TaskListEntry
SetTaskArn sets the TaskArn field's value.
func (TaskListEntry) String ¶
func (s TaskListEntry) String() string
String returns the string representation
type UntagResourceInput ¶
type UntagResourceInput struct { // The keys in the key-value pair in the tag to remove. // // Keys is a required field Keys []*string `min:"1" type:"list" required:"true"` // The Amazon Resource Name (ARN) of the resource to remove the tag from. // // ResourceArn is a required field ResourceArn *string `type:"string" required:"true"` // contains filtered or unexported fields }
UntagResourceRequest
func (UntagResourceInput) GoString ¶
func (s UntagResourceInput) GoString() string
GoString returns the string representation
func (*UntagResourceInput) SetKeys ¶
func (s *UntagResourceInput) SetKeys(v []*string) *UntagResourceInput
SetKeys sets the Keys field's value.
func (*UntagResourceInput) SetResourceArn ¶
func (s *UntagResourceInput) SetResourceArn(v string) *UntagResourceInput
SetResourceArn sets the ResourceArn field's value.
func (UntagResourceInput) String ¶
func (s UntagResourceInput) String() string
String returns the string representation
func (*UntagResourceInput) Validate ¶
func (s *UntagResourceInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UntagResourceOutput ¶
type UntagResourceOutput struct {
// contains filtered or unexported fields
}
func (UntagResourceOutput) GoString ¶
func (s UntagResourceOutput) GoString() string
GoString returns the string representation
func (UntagResourceOutput) String ¶
func (s UntagResourceOutput) String() string
String returns the string representation
type UpdateAgentInput ¶
type UpdateAgentInput struct { // The Amazon Resource Name (ARN) of the agent to update. // // AgentArn is a required field AgentArn *string `type:"string" required:"true"` // The name that you want to use to configure the agent. Name *string `min:"1" type:"string"` // contains filtered or unexported fields }
UpdateAgentRequest
func (UpdateAgentInput) GoString ¶
func (s UpdateAgentInput) GoString() string
GoString returns the string representation
func (*UpdateAgentInput) SetAgentArn ¶
func (s *UpdateAgentInput) SetAgentArn(v string) *UpdateAgentInput
SetAgentArn sets the AgentArn field's value.
func (*UpdateAgentInput) SetName ¶
func (s *UpdateAgentInput) SetName(v string) *UpdateAgentInput
SetName sets the Name field's value.
func (UpdateAgentInput) String ¶
func (s UpdateAgentInput) String() string
String returns the string representation
func (*UpdateAgentInput) Validate ¶
func (s *UpdateAgentInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UpdateAgentOutput ¶
type UpdateAgentOutput struct {
// contains filtered or unexported fields
}
func (UpdateAgentOutput) GoString ¶
func (s UpdateAgentOutput) GoString() string
GoString returns the string representation
func (UpdateAgentOutput) String ¶
func (s UpdateAgentOutput) String() string
String returns the string representation
type UpdateTaskInput ¶
type UpdateTaskInput struct { // The Amazon Resource Name (ARN) of the resource name of the CloudWatch LogGroup. CloudWatchLogGroupArn *string `type:"string"` // A list of filter rules that determines which files to exclude from a task. // The list should contain a single filter string that consists of the patterns // to exclude. The patterns are delimited by "|" (that is, a pipe), for example: // "/folder1|/folder2" Excludes []*FilterRule `type:"list"` // The name of the task to update. Name *string `min:"1" type:"string"` // Represents the options that are available to control the behavior of a StartTaskExecution // operation. Behavior includes preserving metadata such as user ID (UID), group // ID (GID), and file permissions, and also overwriting files in the destination, // data integrity verification, and so on. // // A task has a set of default options associated with it. If you don't specify // an option in StartTaskExecution, the default value is used. You can override // the defaults options on each task execution by specifying an overriding Options // value to StartTaskExecution. Options *Options `type:"structure"` // The Amazon Resource Name (ARN) of the resource name of the task to update. // // TaskArn is a required field TaskArn *string `type:"string" required:"true"` // contains filtered or unexported fields }
UpdateTaskResponse
func (UpdateTaskInput) GoString ¶
func (s UpdateTaskInput) GoString() string
GoString returns the string representation
func (*UpdateTaskInput) SetCloudWatchLogGroupArn ¶ added in v1.19.29
func (s *UpdateTaskInput) SetCloudWatchLogGroupArn(v string) *UpdateTaskInput
SetCloudWatchLogGroupArn sets the CloudWatchLogGroupArn field's value.
func (*UpdateTaskInput) SetExcludes ¶ added in v1.19.29
func (s *UpdateTaskInput) SetExcludes(v []*FilterRule) *UpdateTaskInput
SetExcludes sets the Excludes field's value.
func (*UpdateTaskInput) SetName ¶
func (s *UpdateTaskInput) SetName(v string) *UpdateTaskInput
SetName sets the Name field's value.
func (*UpdateTaskInput) SetOptions ¶
func (s *UpdateTaskInput) SetOptions(v *Options) *UpdateTaskInput
SetOptions sets the Options field's value.
func (*UpdateTaskInput) SetTaskArn ¶
func (s *UpdateTaskInput) SetTaskArn(v string) *UpdateTaskInput
SetTaskArn sets the TaskArn field's value.
func (UpdateTaskInput) String ¶
func (s UpdateTaskInput) String() string
String returns the string representation
func (*UpdateTaskInput) Validate ¶
func (s *UpdateTaskInput) Validate() error
Validate inspects the fields of the type to determine if they are valid.
type UpdateTaskOutput ¶
type UpdateTaskOutput struct {
// contains filtered or unexported fields
}
func (UpdateTaskOutput) GoString ¶
func (s UpdateTaskOutput) GoString() string
GoString returns the string representation
func (UpdateTaskOutput) String ¶
func (s UpdateTaskOutput) String() string
String returns the string representation
Directories ¶
Path | Synopsis |
---|---|
Package datasynciface provides an interface to enable mocking the AWS DataSync service client for testing your code.
|
Package datasynciface provides an interface to enable mocking the AWS DataSync service client for testing your code. |