datasync

package
v1.40.49 Latest Latest
Warning

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

 Go to latest Published: Sep 24, 2021 License: Apache-2.0 Imports: 10 Imported by: 42

Documentation

Overview

Package datasync provides the client and types for making API requests to AWS DataSync.

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 DataSync contains documentation for a programming interface that you can use to manage 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

View Source 
const (
	// AgentStatusOnline is a AgentStatus enum value
	AgentStatusOnline = "ONLINE"

	// AgentStatusOffline is a AgentStatus enum value
	AgentStatusOffline = "OFFLINE"
)
View Source 
const (
	// AtimeNone is a Atime enum value
	AtimeNone = "NONE"

	// AtimeBestEffort is a Atime enum value
	AtimeBestEffort = "BEST_EFFORT"
)
View Source 
const (
	// EndpointTypePublic is a EndpointType enum value
	EndpointTypePublic = "PUBLIC"

	// EndpointTypePrivateLink is a EndpointType enum value
	EndpointTypePrivateLink = "PRIVATE_LINK"

	// EndpointTypeFips is a EndpointType enum value
	EndpointTypeFips = "FIPS"
)
View Source 
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"
)
View Source 
const (
	// LocationFilterNameLocationUri is a LocationFilterName enum value
	LocationFilterNameLocationUri = "LocationUri"

	// LocationFilterNameLocationType is a LocationFilterName enum value
	LocationFilterNameLocationType = "LocationType"

	// LocationFilterNameCreationTime is a LocationFilterName enum value
	LocationFilterNameCreationTime = "CreationTime"
)
View Source 
const (
	// LogLevelOff is a LogLevel enum value
	LogLevelOff = "OFF"

	// LogLevelBasic is a LogLevel enum value
	LogLevelBasic = "BASIC"

	// LogLevelTransfer is a LogLevel enum value
	LogLevelTransfer = "TRANSFER"
)
View Source 
const (
	// MtimeNone is a Mtime enum value
	MtimeNone = "NONE"

	// MtimePreserve is a Mtime enum value
	MtimePreserve = "PRESERVE"
)
View Source 
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"
)
View Source 
const (
	// ObjectStorageServerProtocolHttps is a ObjectStorageServerProtocol enum value
	ObjectStorageServerProtocolHttps = "HTTPS"

	// ObjectStorageServerProtocolHttp is a ObjectStorageServerProtocol enum value
	ObjectStorageServerProtocolHttp = "HTTP"
)
View Source 
const (
	// OperatorEquals is a Operator enum value
	OperatorEquals = "Equals"

	// OperatorNotEquals is a Operator enum value
	OperatorNotEquals = "NotEquals"

	// OperatorIn is a Operator enum value
	OperatorIn = "In"

	// OperatorLessThanOrEqual is a Operator enum value
	OperatorLessThanOrEqual = "LessThanOrEqual"

	// OperatorLessThan is a Operator enum value
	OperatorLessThan = "LessThan"

	// OperatorGreaterThanOrEqual is a Operator enum value
	OperatorGreaterThanOrEqual = "GreaterThanOrEqual"

	// OperatorGreaterThan is a Operator enum value
	OperatorGreaterThan = "GreaterThan"

	// OperatorContains is a Operator enum value
	OperatorContains = "Contains"

	// OperatorNotContains is a Operator enum value
	OperatorNotContains = "NotContains"

	// OperatorBeginsWith is a Operator enum value
	OperatorBeginsWith = "BeginsWith"
)
View Source 
const (
	// OverwriteModeAlways is a OverwriteMode enum value
	OverwriteModeAlways = "ALWAYS"

	// OverwriteModeNever is a OverwriteMode enum value
	OverwriteModeNever = "NEVER"
)
View Source 
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"
)
View Source 
const (
	// PosixPermissionsNone is a PosixPermissions enum value
	PosixPermissionsNone = "NONE"

	// PosixPermissionsPreserve is a PosixPermissions enum value
	PosixPermissionsPreserve = "PRESERVE"
)
View Source 
const (
	// PreserveDeletedFilesPreserve is a PreserveDeletedFiles enum value
	PreserveDeletedFilesPreserve = "PRESERVE"

	// PreserveDeletedFilesRemove is a PreserveDeletedFiles enum value
	PreserveDeletedFilesRemove = "REMOVE"
)
View Source 
const (
	// PreserveDevicesNone is a PreserveDevices enum value
	PreserveDevicesNone = "NONE"

	// PreserveDevicesPreserve is a PreserveDevices enum value
	PreserveDevicesPreserve = "PRESERVE"
)
View Source 
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"

	// S3StorageClassOutposts is a S3StorageClass enum value
	S3StorageClassOutposts = "OUTPOSTS"
)
View Source 
const (
	// SmbSecurityDescriptorCopyFlagsNone is a SmbSecurityDescriptorCopyFlags enum value
	SmbSecurityDescriptorCopyFlagsNone = "NONE"

	// SmbSecurityDescriptorCopyFlagsOwnerDacl is a SmbSecurityDescriptorCopyFlags enum value
	SmbSecurityDescriptorCopyFlagsOwnerDacl = "OWNER_DACL"

	// SmbSecurityDescriptorCopyFlagsOwnerDaclSacl is a SmbSecurityDescriptorCopyFlags enum value
	SmbSecurityDescriptorCopyFlagsOwnerDaclSacl = "OWNER_DACL_SACL"
)
View Source 
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"
)
View Source 
const (
	// TaskExecutionStatusQueued is a TaskExecutionStatus enum value
	TaskExecutionStatusQueued = "QUEUED"

	// 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"
)
View Source 
const (
	// TaskFilterNameLocationId is a TaskFilterName enum value
	TaskFilterNameLocationId = "LocationId"

	// TaskFilterNameCreationTime is a TaskFilterName enum value
	TaskFilterNameCreationTime = "CreationTime"
)
View Source 
const (
	// TaskQueueingEnabled is a TaskQueueing enum value
	TaskQueueingEnabled = "ENABLED"

	// TaskQueueingDisabled is a TaskQueueing enum value
	TaskQueueingDisabled = "DISABLED"
)
View Source 
const (
	// TaskStatusAvailable is a TaskStatus enum value
	TaskStatusAvailable = "AVAILABLE"

	// TaskStatusCreating is a TaskStatus enum value
	TaskStatusCreating = "CREATING"

	// TaskStatusQueued is a TaskStatus enum value
	TaskStatusQueued = "QUEUED"

	// TaskStatusRunning is a TaskStatus enum value
	TaskStatusRunning = "RUNNING"

	// TaskStatusUnavailable is a TaskStatus enum value
	TaskStatusUnavailable = "UNAVAILABLE"
)
View Source 
const (
	// TransferModeChanged is a TransferMode enum value
	TransferModeChanged = "CHANGED"

	// TransferModeAll is a TransferMode enum value
	TransferModeAll = "ALL"
)
View Source 
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"
)
View Source 
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"
)
View Source 
const (

	// ErrCodeInternalException for service response error code
	// "InternalException".
	//
	// This exception is thrown when an error occurs in the DataSync service.
	ErrCodeInternalException = "InternalException"

	// ErrCodeInvalidRequestException for service response error code
	// "InvalidRequestException".
	//
	// This exception is thrown when the client submits a malformed request.
	ErrCodeInvalidRequestException = "InvalidRequestException"
)
View Source 
const (
	ServiceName = "DataSync" // Name of service.
	EndpointsID = "datasync" // ID to lookup a service endpoint with.
	ServiceID   = "DataSync" // ServiceID is a unique identifier of a specific service.
)

Service information constants

View Source 
const (
	// FilterTypeSimplePattern is a FilterType enum value
	FilterTypeSimplePattern = "SIMPLE_PATTERN"
)

Variables

This section is empty.

Functions

func AgentStatus_Values added in v1.34.3 

func AgentStatus_Values() []string

AgentStatus_Values returns all elements of the AgentStatus enum

func Atime_Values added in v1.34.3 

func Atime_Values() []string

Atime_Values returns all elements of the Atime enum

func EndpointType_Values added in v1.34.3 

func EndpointType_Values() []string

EndpointType_Values returns all elements of the EndpointType enum

func FilterType_Values added in v1.34.3 

func FilterType_Values() []string

FilterType_Values returns all elements of the FilterType enum

func Gid_Values added in v1.34.3 

func Gid_Values() []string

Gid_Values returns all elements of the Gid enum

func LocationFilterName_Values added in v1.34.7 

func LocationFilterName_Values() []string

LocationFilterName_Values returns all elements of the LocationFilterName enum

func LogLevel_Values added in v1.34.3 

func LogLevel_Values() []string

LogLevel_Values returns all elements of the LogLevel enum

func Mtime_Values added in v1.34.3 

func Mtime_Values() []string

Mtime_Values returns all elements of the Mtime enum

func NfsVersion_Values added in v1.34.3 

func NfsVersion_Values() []string

NfsVersion_Values returns all elements of the NfsVersion enum

func ObjectStorageServerProtocol_Values added in v1.34.3 

func ObjectStorageServerProtocol_Values() []string

ObjectStorageServerProtocol_Values returns all elements of the ObjectStorageServerProtocol enum

func Operator_Values added in v1.34.7 

func Operator_Values() []string

Operator_Values returns all elements of the Operator enum

func OverwriteMode_Values added in v1.34.3 

func OverwriteMode_Values() []string

OverwriteMode_Values returns all elements of the OverwriteMode enum

func PhaseStatus_Values added in v1.34.3 

func PhaseStatus_Values() []string

PhaseStatus_Values returns all elements of the PhaseStatus enum

func PosixPermissions_Values added in v1.34.3 

func PosixPermissions_Values() []string

PosixPermissions_Values returns all elements of the PosixPermissions enum

func PreserveDeletedFiles_Values added in v1.34.3 

func PreserveDeletedFiles_Values() []string

PreserveDeletedFiles_Values returns all elements of the PreserveDeletedFiles enum

func PreserveDevices_Values added in v1.34.3 

func PreserveDevices_Values() []string

PreserveDevices_Values returns all elements of the PreserveDevices enum

func S3StorageClass_Values added in v1.34.3 

func S3StorageClass_Values() []string

S3StorageClass_Values returns all elements of the S3StorageClass enum

func SmbSecurityDescriptorCopyFlags_Values added in v1.38.51 

func SmbSecurityDescriptorCopyFlags_Values() []string

SmbSecurityDescriptorCopyFlags_Values returns all elements of the SmbSecurityDescriptorCopyFlags enum

func SmbVersion_Values added in v1.34.3 

func SmbVersion_Values() []string

SmbVersion_Values returns all elements of the SmbVersion enum

func TaskExecutionStatus_Values added in v1.34.3 

func TaskExecutionStatus_Values() []string

TaskExecutionStatus_Values returns all elements of the TaskExecutionStatus enum

func TaskFilterName_Values added in v1.34.7 

func TaskFilterName_Values() []string

TaskFilterName_Values returns all elements of the TaskFilterName enum

func TaskQueueing_Values added in v1.34.3 

func TaskQueueing_Values() []string

TaskQueueing_Values returns all elements of the TaskQueueing enum

func TaskStatus_Values added in v1.34.3 

func TaskStatus_Values() []string

TaskStatus_Values returns all elements of the TaskStatus enum

func TransferMode_Values added in v1.34.3 

func TransferMode_Values() []string

TransferMode_Values returns all elements of the TransferMode enum

func Uid_Values added in v1.34.3 

func Uid_Values() []string

Uid_Values returns all elements of the Uid enum

func VerifyMode_Values added in v1.34.3 

func VerifyMode_Values() []string

VerifyMode_Values returns all elements of the VerifyMode enum

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 (https://docs.aws.amazon.com/datasync/latest/userguide/API_ListAgents.html) operation is called.

func (AgentListEntry) GoString 

func (s AgentListEntry) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (CancelTaskExecutionOutput) String 

func (s CancelTaskExecutionOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 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 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 SecurityGroupArns (https://docs.aws.amazon.com/datasync/latest/userguide/API_Ec2Config.html#DataSync-Type-Ec2Config-SecurityGroupArns).
	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 Amazon 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 Amazon Web Services Region.
	AgentArn *string `type:"string"`
	// contains filtered or unexported fields
}

CreateAgentResponse

func (CreateAgentOutput) GoString 

func (s CreateAgentOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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, DataSync uses the root directory.
	//
	// Subdirectory must be specified with forward slashes. For example, /path/to/folder.
	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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateLocationFsxWindowsInput added in v1.28.9 

type CreateLocationFsxWindowsInput struct {

	// The name of the Windows domain that the FSx for Windows File Server belongs
	// to.
	Domain *string `type:"string"`

	// The Amazon Resource Name (ARN) for the FSx for Windows File Server file system.
	//
	// FsxFilesystemArn is a required field
	FsxFilesystemArn *string `type:"string" required:"true"`

	// The password of the user who has the permissions to access files and folders
	// in the FSx for Windows File Server file system.
	//
	// Password is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by CreateLocationFsxWindowsInput's
	// String and GoString methods.
	//
	// Password is a required field
	Password *string `type:"string" required:"true" sensitive:"true"`

	// The Amazon Resource Names (ARNs) of the security groups that are to use to
	// configure the FSx for Windows File Server file system.
	//
	// SecurityGroupArns is a required field
	SecurityGroupArns []*string `min:"1" type:"list" required:"true"`

	// A subdirectory in the location’s path. This subdirectory in the Amazon
	// FSx for Windows File Server file system is used to read data from the Amazon
	// FSx for Windows File Server source location or write data to the FSx for
	// Windows File Server destination.
	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"`

	// The user who has the permissions to access files and folders in the FSx for
	// Windows File Server file system.
	//
	// For information about choosing a user name that ensures sufficient permissions
	// to files, folders, and metadata, see user (create-fsx-location.html#FSxWuser).
	//
	// User is a required field
	User *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateLocationFsxWindowsInput) GoString added in v1.28.9 

func (s CreateLocationFsxWindowsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateLocationFsxWindowsInput) SetDomain added in v1.28.9 

func (s *CreateLocationFsxWindowsInput) SetDomain(v string) *CreateLocationFsxWindowsInput

SetDomain sets the Domain field's value.

func (*CreateLocationFsxWindowsInput) SetFsxFilesystemArn added in v1.28.9 

func (s *CreateLocationFsxWindowsInput) SetFsxFilesystemArn(v string) *CreateLocationFsxWindowsInput

SetFsxFilesystemArn sets the FsxFilesystemArn field's value.

func (*CreateLocationFsxWindowsInput) SetPassword added in v1.28.9 

func (s *CreateLocationFsxWindowsInput) SetPassword(v string) *CreateLocationFsxWindowsInput

SetPassword sets the Password field's value.

func (*CreateLocationFsxWindowsInput) SetSecurityGroupArns added in v1.28.9 

func (s *CreateLocationFsxWindowsInput) SetSecurityGroupArns(v []*string) *CreateLocationFsxWindowsInput

SetSecurityGroupArns sets the SecurityGroupArns field's value.

func (*CreateLocationFsxWindowsInput) SetSubdirectory added in v1.28.9 

func (s *CreateLocationFsxWindowsInput) SetSubdirectory(v string) *CreateLocationFsxWindowsInput

SetSubdirectory sets the Subdirectory field's value.

func (*CreateLocationFsxWindowsInput) SetTags added in v1.28.9 

func (s *CreateLocationFsxWindowsInput) SetTags(v []*TagListEntry) *CreateLocationFsxWindowsInput

SetTags sets the Tags field's value.

func (*CreateLocationFsxWindowsInput) SetUser added in v1.28.9 

func (s *CreateLocationFsxWindowsInput) SetUser(v string) *CreateLocationFsxWindowsInput

SetUser sets the User field's value.

func (CreateLocationFsxWindowsInput) String added in v1.28.9 

func (s CreateLocationFsxWindowsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateLocationFsxWindowsInput) Validate added in v1.28.9 

func (s *CreateLocationFsxWindowsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateLocationFsxWindowsOutput added in v1.28.9 

type CreateLocationFsxWindowsOutput struct {

	// The Amazon Resource Name (ARN) of the FSx for Windows File Server file system
	// location that is created.
	LocationArn *string `type:"string"`
	// contains filtered or unexported fields
}

func (CreateLocationFsxWindowsOutput) GoString added in v1.28.9 

func (s CreateLocationFsxWindowsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateLocationFsxWindowsOutput) SetLocationArn added in v1.28.9 

func (s *CreateLocationFsxWindowsOutput) SetLocationArn(v string) *CreateLocationFsxWindowsOutput

SetLocationArn sets the LocationArn field's value.

func (CreateLocationFsxWindowsOutput) String added in v1.28.9 

func (s CreateLocationFsxWindowsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.
	//
	// If you are copying data to or from your Snowcone device, see NFS Server on
	// Snowcone (https://docs.aws.amazon.com/datasync/latest/userguide/create-nfs-location.html#nfs-on-snowcone)
	// for more information.
	//
	// 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.
	//
	// If you are copying data to or from your Snowcone device, see NFS Server on
	// Snowcone (https://docs.aws.amazon.com/datasync/latest/userguide/create-nfs-location.html#nfs-on-snowcone)
	// for more information.
	//
	// 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.
	//
	// If you are copying data to or from your Snowcone device, see NFS Server on
	// Snowcone (https://docs.aws.amazon.com/datasync/latest/userguide/create-nfs-location.html#nfs-on-snowcone)
	// for more information.
	//
	// 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateLocationObjectStorageInput added in v1.33.13 

type CreateLocationObjectStorageInput struct {

	// Optional. The access key is used if credentials are required to access the
	// self-managed object storage server. If your object storage requires a user
	// name and password to authenticate, use AccessKey and SecretKey to provide
	// the user name and password, respectively.
	AccessKey *string `min:"8" type:"string"`

	// The Amazon Resource Name (ARN) of the agents associated with the self-managed
	// object storage server location.
	//
	// AgentArns is a required field
	AgentArns []*string `min:"1" type:"list" required:"true"`

	// The bucket on the self-managed object storage server that is used to read
	// data from.
	//
	// BucketName is a required field
	BucketName *string `min:"3" type:"string" required:"true"`

	// Optional. The secret key is used if credentials are required to access the
	// self-managed object storage server. If your object storage requires a user
	// name and password to authenticate, use AccessKey and SecretKey to provide
	// the user name and password, respectively.
	//
	// SecretKey is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by CreateLocationObjectStorageInput's
	// String and GoString methods.
	SecretKey *string `min:"8" type:"string" sensitive:"true"`

	// The name of the self-managed object storage server. This value is the IP
	// address or Domain Name Service (DNS) name of the object storage server. An
	// agent uses this host name to mount the object storage server in a network.
	//
	// ServerHostname is a required field
	ServerHostname *string `type:"string" required:"true"`

	// The port that your self-managed object storage server accepts inbound network
	// traffic on. The server port is set by default to TCP 80 (HTTP) or TCP 443
	// (HTTPS). You can specify a custom port if your self-managed object storage
	// server requires one.
	ServerPort *int64 `min:"1" type:"integer"`

	// The protocol that the object storage server uses to communicate. Valid values
	// are HTTP or HTTPS.
	ServerProtocol *string `type:"string" enum:"ObjectStorageServerProtocol"`

	// The subdirectory in the self-managed object storage server that is used to
	// read data from.
	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
}

CreateLocationObjectStorageRequest

func (CreateLocationObjectStorageInput) GoString added in v1.33.13 

func (s CreateLocationObjectStorageInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateLocationObjectStorageInput) SetAccessKey added in v1.33.13 

func (s *CreateLocationObjectStorageInput) SetAccessKey(v string) *CreateLocationObjectStorageInput

SetAccessKey sets the AccessKey field's value.

func (*CreateLocationObjectStorageInput) SetAgentArns added in v1.33.13 

func (s *CreateLocationObjectStorageInput) SetAgentArns(v []*string) *CreateLocationObjectStorageInput

SetAgentArns sets the AgentArns field's value.

func (*CreateLocationObjectStorageInput) SetBucketName added in v1.33.13 

func (s *CreateLocationObjectStorageInput) SetBucketName(v string) *CreateLocationObjectStorageInput

SetBucketName sets the BucketName field's value.

func (*CreateLocationObjectStorageInput) SetSecretKey added in v1.33.13 

func (s *CreateLocationObjectStorageInput) SetSecretKey(v string) *CreateLocationObjectStorageInput

SetSecretKey sets the SecretKey field's value.

func (*CreateLocationObjectStorageInput) SetServerHostname added in v1.33.13 

func (s *CreateLocationObjectStorageInput) SetServerHostname(v string) *CreateLocationObjectStorageInput

SetServerHostname sets the ServerHostname field's value.

func (*CreateLocationObjectStorageInput) SetServerPort added in v1.33.13 

func (s *CreateLocationObjectStorageInput) SetServerPort(v int64) *CreateLocationObjectStorageInput

SetServerPort sets the ServerPort field's value.

func (*CreateLocationObjectStorageInput) SetServerProtocol added in v1.33.13 

func (s *CreateLocationObjectStorageInput) SetServerProtocol(v string) *CreateLocationObjectStorageInput

SetServerProtocol sets the ServerProtocol field's value.

func (*CreateLocationObjectStorageInput) SetSubdirectory added in v1.33.13 

func (s *CreateLocationObjectStorageInput) SetSubdirectory(v string) *CreateLocationObjectStorageInput

SetSubdirectory sets the Subdirectory field's value.

func (*CreateLocationObjectStorageInput) SetTags added in v1.33.13 

func (s *CreateLocationObjectStorageInput) SetTags(v []*TagListEntry) *CreateLocationObjectStorageInput

SetTags sets the Tags field's value.

func (CreateLocationObjectStorageInput) String added in v1.33.13 

func (s CreateLocationObjectStorageInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateLocationObjectStorageInput) Validate added in v1.33.13 

func (s *CreateLocationObjectStorageInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateLocationObjectStorageOutput added in v1.33.13 

type CreateLocationObjectStorageOutput struct {

	// The Amazon Resource Name (ARN) of the agents associated with the self-managed
	// object storage server location.
	LocationArn *string `type:"string"`
	// contains filtered or unexported fields
}

CreateLocationObjectStorageResponse

func (CreateLocationObjectStorageOutput) GoString added in v1.33.13 

func (s CreateLocationObjectStorageOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateLocationObjectStorageOutput) SetLocationArn added in v1.33.13 

func (s *CreateLocationObjectStorageOutput) SetLocationArn(v string) *CreateLocationObjectStorageOutput

SetLocationArn sets the LocationArn field's value.

func (CreateLocationObjectStorageOutput) String added in v1.33.13 

func (s CreateLocationObjectStorageOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateLocationS3Input 

type CreateLocationS3Input struct {

	// If you are using DataSync on an Amazon Web Services Outpost, specify the
	// Amazon Resource Names (ARNs) of the DataSync agents deployed on your Outpost.
	// For more information about launching a DataSync agent on an Amazon Web Services
	// Outpost, see Deploy your DataSync agent on Outposts (https://docs.aws.amazon.com/datasync/latest/userguide/deploy-agents.html#outposts-agent).
	AgentArns []*string `min:"1" type:"list"`

	// The ARN of the Amazon S3 bucket. If the bucket is on an Amazon Web Services
	// Outpost, this must be an access point ARN.
	//
	// S3BucketArn is a required field
	S3BucketArn *string `type:"string" required:"true"`

	// The Amazon Resource Name (ARN) of the 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 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 buckets in Amazon Web Services
	// Regions, the storage class defaults to Standard. For buckets on Outposts,
	// the storage class defaults to Amazon Web Services S3 Outposts.
	//
	// For more information about S3 storage classes, see Amazon S3 Storage Classes
	// (http://aws.amazon.com/s3/storage-classes/). Some storage classes have behaviors
	// that can affect your S3 storage cost. For detailed information, see Considerations
	// when working with S3 storage classes in DataSync (https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateLocationS3Input) SetAgentArns added in v1.35.0 

func (s *CreateLocationS3Input) SetAgentArns(v []*string) *CreateLocationS3Input

SetAgentArns sets the AgentArns field's value.

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by CreateLocationSmbInput's
	// String and GoString methods.
	//
	// Password is a required field
	Password *string `type:"string" required:"true" sensitive:"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.
	//
	// Subdirectory must be specified with forward slashes. For example, /path/to/folder.
	//
	// 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.
	//
	// For information about choosing a user name that ensures sufficient permissions
	// to files, folders, and metadata, see user (create-smb-location.html#SMBuser).
	//
	// 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.
	CloudWatchLogGroupArn *string `type:"string"`

	// The Amazon Resource Name (ARN) of an Amazon Web Services 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"`

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

	// 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 the task execution. For more information,
	// see the StartTaskExecution (https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html)
	// operation.
	Options *Options `type:"structure"`

	// Specifies a schedule used to periodically transfer files from a source to
	// a destination location. The schedule should be specified in UTC time. For
	// more information, see Scheduling your task (https://docs.aws.amazon.com/datasync/latest/userguide/task-scheduling.html).
	Schedule *TaskSchedule `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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) SetIncludes added in v1.40.30 

func (s *CreateTaskInput) SetIncludes(v []*FilterRule) *CreateTaskInput

SetIncludes sets the Includes 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) SetSchedule added in v1.25.39 

func (s *CreateTaskInput) SetSchedule(v *TaskSchedule) *CreateTaskInput

SetSchedule sets the Schedule 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DataSync 

type DataSync struct {
	*client.Client
}

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: 

mySession := session.Must(session.NewSession())

// 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 is 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, 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 Types:

  • InvalidRequestException This exception is thrown when the client submits a malformed request.

  • InternalException This exception is thrown when an error occurs in the 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 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 Amazon Web Services Region that you want to activate the agent in. You activate the agent in the Amazon Web Services Region where your target locations (in Amazon S3 or Amazon EFS) reside. Your tasks are created in this Amazon Web Services 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 Amazon Web Services 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 Types:

  • InvalidRequestException This exception is thrown when the client submits a malformed request.

  • InternalException This exception is thrown when an error occurs in the 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 Types:

  • InvalidRequestException This exception is thrown when the client submits a malformed request.

  • InternalException This exception is thrown when an error occurs in the 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) CreateLocationFsxWindows added in v1.28.9 

func (c *DataSync) CreateLocationFsxWindows(input *CreateLocationFsxWindowsInput) (*CreateLocationFsxWindowsOutput, error)

CreateLocationFsxWindows API operation for AWS DataSync.

Creates an endpoint for an Amazon FSx for Windows File Server 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 CreateLocationFsxWindows for usage and error information.

Returned Error Types:

  • InvalidRequestException This exception is thrown when the client submits a malformed request.

  • InternalException This exception is thrown when an error occurs in the DataSync service.

See also, https://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/CreateLocationFsxWindows

func (*DataSync) CreateLocationFsxWindowsRequest added in v1.28.9 

func (c *DataSync) CreateLocationFsxWindowsRequest(input *CreateLocationFsxWindowsInput) (req *request.Request, output *CreateLocationFsxWindowsOutput)

CreateLocationFsxWindowsRequest generates a "aws/request.Request" representing the client's request for the CreateLocationFsxWindows 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 CreateLocationFsxWindows for more information on using the CreateLocationFsxWindows 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 CreateLocationFsxWindowsRequest method.
req, resp := client.CreateLocationFsxWindowsRequest(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/CreateLocationFsxWindows

func (*DataSync) CreateLocationFsxWindowsWithContext added in v1.28.9 

func (c *DataSync) CreateLocationFsxWindowsWithContext(ctx aws.Context, input *CreateLocationFsxWindowsInput, opts ...request.Option) (*CreateLocationFsxWindowsOutput, error)

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

See CreateLocationFsxWindows 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.

Defines a file system on a Network File System (NFS) server that can be read from or written to.

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

  • InvalidRequestException This exception is thrown when the client submits a malformed request.

  • InternalException This exception is thrown when an error occurs in the 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) CreateLocationObjectStorage added in v1.33.13 

func (c *DataSync) CreateLocationObjectStorage(input *CreateLocationObjectStorageInput) (*CreateLocationObjectStorageOutput, error)

CreateLocationObjectStorage API operation for AWS DataSync.

Creates an endpoint for a self-managed object storage bucket. For more information about self-managed object storage locations, see Creating a location for object storage (https://docs.aws.amazon.com/datasync/latest/userguide/create-object-location.html).

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 CreateLocationObjectStorage for usage and error information.

Returned Error Types:

  • InvalidRequestException This exception is thrown when the client submits a malformed request.

  • InternalException This exception is thrown when an error occurs in the DataSync service.

See also, https://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/CreateLocationObjectStorage

func (*DataSync) CreateLocationObjectStorageRequest added in v1.33.13 

func (c *DataSync) CreateLocationObjectStorageRequest(input *CreateLocationObjectStorageInput) (req *request.Request, output *CreateLocationObjectStorageOutput)

CreateLocationObjectStorageRequest generates a "aws/request.Request" representing the client's request for the CreateLocationObjectStorage 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 CreateLocationObjectStorage for more information on using the CreateLocationObjectStorage 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 CreateLocationObjectStorageRequest method.
req, resp := client.CreateLocationObjectStorageRequest(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/CreateLocationObjectStorage

func (*DataSync) CreateLocationObjectStorageWithContext added in v1.33.13 

func (c *DataSync) CreateLocationObjectStorageWithContext(ctx aws.Context, input *CreateLocationObjectStorageInput, opts ...request.Option) (*CreateLocationObjectStorageOutput, error)

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

See CreateLocationObjectStorage 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 more information, see Create an Amazon S3 location (https://docs.aws.amazon.com/datasync/latest/userguide/create-locations-cli.html#create-location-s3-cli) in the 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 Types:

  • InvalidRequestException This exception is thrown when the client submits a malformed request.

  • InternalException This exception is thrown when an error occurs in the 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.

Defines a file system on a Server Message Block (SMB) server that can be read from or written to.

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

  • InvalidRequestException This exception is thrown when the client submits a malformed request.

  • InternalException This exception is thrown when an error occurs in the 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 includes a source location and a destination location, and a configuration that specifies how data is transferred. A task always transfers data from the source location to the destination location. The configuration specifies options such as task scheduling, bandwidth limits, etc. A task is the complete definition of a data transfer.

When you create a task that transfers data between Amazon Web Services services in different Amazon Web Services Regions, one of the two locations that you specify must reside in the Region where DataSync is being used. The other location must be specified in a different Region.

You can transfer data between commercial Amazon Web Services Regions except for China, or between Amazon Web Services GovCloud (US) Regions.

When you use DataSync to copy files or objects between Amazon Web Services Regions, you pay for data transfer between Regions. This is billed as data transfer OUT from your source Region to your destination Region. For more information, see Data Transfer pricing (http://aws.amazon.com/ec2/pricing/on-demand/#Data_Transfer).

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

  • InvalidRequestException This exception is thrown when the client submits a malformed request.

  • InternalException This exception is thrown when an error occurs in the 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 Amazon Web Services 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 Types:

  • InvalidRequestException This exception is thrown when the client submits a malformed request.

  • InternalException This exception is thrown when an error occurs in the 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 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 Types:

  • InvalidRequestException This exception is thrown when the client submits a malformed request.

  • InternalException This exception is thrown when an error occurs in the 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 Types:

  • InvalidRequestException This exception is thrown when the client submits a malformed request.

  • InternalException This exception is thrown when an error occurs in the 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 Types:

  • InvalidRequestException This exception is thrown when the client submits a malformed request.

  • InternalException This exception is thrown when an error occurs in the 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 Types:

  • InvalidRequestException This exception is thrown when the client submits a malformed request.

  • InternalException This exception is thrown when an error occurs in the 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) DescribeLocationFsxWindows added in v1.28.9 

func (c *DataSync) DescribeLocationFsxWindows(input *DescribeLocationFsxWindowsInput) (*DescribeLocationFsxWindowsOutput, error)

DescribeLocationFsxWindows API operation for AWS DataSync.

Returns metadata, such as the path information about an Amazon FSx for Windows File Server 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 DescribeLocationFsxWindows for usage and error information.

Returned Error Types:

  • InvalidRequestException This exception is thrown when the client submits a malformed request.

  • InternalException This exception is thrown when an error occurs in the DataSync service.

See also, https://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/DescribeLocationFsxWindows

func (*DataSync) DescribeLocationFsxWindowsRequest added in v1.28.9 

func (c *DataSync) DescribeLocationFsxWindowsRequest(input *DescribeLocationFsxWindowsInput) (req *request.Request, output *DescribeLocationFsxWindowsOutput)

DescribeLocationFsxWindowsRequest generates a "aws/request.Request" representing the client's request for the DescribeLocationFsxWindows 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 DescribeLocationFsxWindows for more information on using the DescribeLocationFsxWindows 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 DescribeLocationFsxWindowsRequest method.
req, resp := client.DescribeLocationFsxWindowsRequest(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/DescribeLocationFsxWindows

func (*DataSync) DescribeLocationFsxWindowsWithContext added in v1.28.9 

func (c *DataSync) DescribeLocationFsxWindowsWithContext(ctx aws.Context, input *DescribeLocationFsxWindowsInput, opts ...request.Option) (*DescribeLocationFsxWindowsOutput, error)

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

See DescribeLocationFsxWindows 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 an 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 Types:

  • InvalidRequestException This exception is thrown when the client submits a malformed request.

  • InternalException This exception is thrown when an error occurs in the 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) DescribeLocationObjectStorage added in v1.33.13 

func (c *DataSync) DescribeLocationObjectStorage(input *DescribeLocationObjectStorageInput) (*DescribeLocationObjectStorageOutput, error)

DescribeLocationObjectStorage API operation for AWS DataSync.

Returns metadata about a self-managed object storage server location. For more information about self-managed object storage locations, see Creating a location for object storage (https://docs.aws.amazon.com/datasync/latest/userguide/create-object-location.html).

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 DescribeLocationObjectStorage for usage and error information.

Returned Error Types:

  • InvalidRequestException This exception is thrown when the client submits a malformed request.

  • InternalException This exception is thrown when an error occurs in the DataSync service.

See also, https://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/DescribeLocationObjectStorage

func (*DataSync) DescribeLocationObjectStorageRequest added in v1.33.13 

func (c *DataSync) DescribeLocationObjectStorageRequest(input *DescribeLocationObjectStorageInput) (req *request.Request, output *DescribeLocationObjectStorageOutput)

DescribeLocationObjectStorageRequest generates a "aws/request.Request" representing the client's request for the DescribeLocationObjectStorage 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 DescribeLocationObjectStorage for more information on using the DescribeLocationObjectStorage 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 DescribeLocationObjectStorageRequest method.
req, resp := client.DescribeLocationObjectStorageRequest(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/DescribeLocationObjectStorage

func (*DataSync) DescribeLocationObjectStorageWithContext added in v1.33.13 

func (c *DataSync) DescribeLocationObjectStorageWithContext(ctx aws.Context, input *DescribeLocationObjectStorageInput, opts ...request.Option) (*DescribeLocationObjectStorageOutput, error)

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

See DescribeLocationObjectStorage 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 Types:

  • InvalidRequestException This exception is thrown when the client submits a malformed request.

  • InternalException This exception is thrown when an error occurs in the 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 an 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 Types:

  • InvalidRequestException This exception is thrown when the client submits a malformed request.

  • InternalException This exception is thrown when an error occurs in the 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 Types:

  • InvalidRequestException This exception is thrown when the client submits a malformed request.

  • InternalException This exception is thrown when an error occurs in the 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 Types:

  • InvalidRequestException This exception is thrown when the client submits a malformed request.

  • InternalException This exception is thrown when an error occurs in the 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 Amazon Web Services account in the Amazon Web Services 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 Types:

  • InvalidRequestException This exception is thrown when the client submits a malformed request.

  • InternalException This exception is thrown when an error occurs in the 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 list 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 Types:

  • InvalidRequestException This exception is thrown when the client submits a malformed request.

  • InternalException This exception is thrown when an error occurs in the 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 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 ListTagsForResource for usage and error information.

Returned Error Types:

  • InvalidRequestException This exception is thrown when the client submits a malformed request.

  • InternalException This exception is thrown when an error occurs in the 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 Types:

  • InvalidRequestException This exception is thrown when the client submits a malformed request.

  • InternalException This exception is thrown when an error occurs in the 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 Types:

  • InvalidRequestException This exception is thrown when the client submits a malformed request.

  • InternalException This exception is thrown when an error occurs in the 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 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 Types:

  • InvalidRequestException This exception is thrown when the client submits a malformed request.

  • InternalException This exception is thrown when an error occurs in the 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 Amazon Web Services 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 Types:

  • InvalidRequestException This exception is thrown when the client submits a malformed request.

  • InternalException This exception is thrown when an error occurs in the 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 Amazon Web Services 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 Types:

  • InvalidRequestException This exception is thrown when the client submits a malformed request.

  • InternalException This exception is thrown when an error occurs in the 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 Types:

  • InvalidRequestException This exception is thrown when the client submits a malformed request.

  • InternalException This exception is thrown when an error occurs in the 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) UpdateLocationNfs added in v1.37.22 

func (c *DataSync) UpdateLocationNfs(input *UpdateLocationNfsInput) (*UpdateLocationNfsOutput, error)

UpdateLocationNfs API operation for AWS DataSync.

Updates some of the parameters of a previously created location for Network File System (NFS) access. For information about creating an NFS location, see Creating a location for NFS (https://docs.aws.amazon.com/datasync/latest/userguide/create-nfs-location.html).

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 UpdateLocationNfs for usage and error information.

Returned Error Types:

  • InvalidRequestException This exception is thrown when the client submits a malformed request.

  • InternalException This exception is thrown when an error occurs in the DataSync service.

See also, https://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/UpdateLocationNfs

func (*DataSync) UpdateLocationNfsRequest added in v1.37.22 

func (c *DataSync) UpdateLocationNfsRequest(input *UpdateLocationNfsInput) (req *request.Request, output *UpdateLocationNfsOutput)

UpdateLocationNfsRequest generates a "aws/request.Request" representing the client's request for the UpdateLocationNfs 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 UpdateLocationNfs for more information on using the UpdateLocationNfs 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 UpdateLocationNfsRequest method.
req, resp := client.UpdateLocationNfsRequest(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/UpdateLocationNfs

func (*DataSync) UpdateLocationNfsWithContext added in v1.37.22 

func (c *DataSync) UpdateLocationNfsWithContext(ctx aws.Context, input *UpdateLocationNfsInput, opts ...request.Option) (*UpdateLocationNfsOutput, error)

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

See UpdateLocationNfs 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) UpdateLocationObjectStorage added in v1.37.22 

func (c *DataSync) UpdateLocationObjectStorage(input *UpdateLocationObjectStorageInput) (*UpdateLocationObjectStorageOutput, error)

UpdateLocationObjectStorage API operation for AWS DataSync.

Updates some of the parameters of a previously created location for self-managed object storage server access. For information about creating a self-managed object storage location, see Creating a location for object storage (https://docs.aws.amazon.com/datasync/latest/userguide/create-object-location.html).

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 UpdateLocationObjectStorage for usage and error information.

Returned Error Types:

  • InvalidRequestException This exception is thrown when the client submits a malformed request.

  • InternalException This exception is thrown when an error occurs in the DataSync service.

See also, https://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/UpdateLocationObjectStorage

func (*DataSync) UpdateLocationObjectStorageRequest added in v1.37.22 

func (c *DataSync) UpdateLocationObjectStorageRequest(input *UpdateLocationObjectStorageInput) (req *request.Request, output *UpdateLocationObjectStorageOutput)

UpdateLocationObjectStorageRequest generates a "aws/request.Request" representing the client's request for the UpdateLocationObjectStorage 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 UpdateLocationObjectStorage for more information on using the UpdateLocationObjectStorage 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 UpdateLocationObjectStorageRequest method.
req, resp := client.UpdateLocationObjectStorageRequest(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/UpdateLocationObjectStorage

func (*DataSync) UpdateLocationObjectStorageWithContext added in v1.37.22 

func (c *DataSync) UpdateLocationObjectStorageWithContext(ctx aws.Context, input *UpdateLocationObjectStorageInput, opts ...request.Option) (*UpdateLocationObjectStorageOutput, error)

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

See UpdateLocationObjectStorage 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) UpdateLocationSmb added in v1.37.22 

func (c *DataSync) UpdateLocationSmb(input *UpdateLocationSmbInput) (*UpdateLocationSmbOutput, error)

UpdateLocationSmb API operation for AWS DataSync.

Updates some of the parameters of a previously created location for Server Message Block (SMB) file system access. For information about creating an SMB location, see Creating a location for SMB (https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html).

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 UpdateLocationSmb for usage and error information.

Returned Error Types:

  • InvalidRequestException This exception is thrown when the client submits a malformed request.

  • InternalException This exception is thrown when an error occurs in the DataSync service.

See also, https://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/UpdateLocationSmb

func (*DataSync) UpdateLocationSmbRequest added in v1.37.22 

func (c *DataSync) UpdateLocationSmbRequest(input *UpdateLocationSmbInput) (req *request.Request, output *UpdateLocationSmbOutput)

UpdateLocationSmbRequest generates a "aws/request.Request" representing the client's request for the UpdateLocationSmb 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 UpdateLocationSmb for more information on using the UpdateLocationSmb 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 UpdateLocationSmbRequest method.
req, resp := client.UpdateLocationSmbRequest(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/UpdateLocationSmb

func (*DataSync) UpdateLocationSmbWithContext added in v1.37.22 

func (c *DataSync) UpdateLocationSmbWithContext(ctx aws.Context, input *UpdateLocationSmbInput, opts ...request.Option) (*UpdateLocationSmbOutput, error)

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

See UpdateLocationSmb 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 Types:

  • InvalidRequestException This exception is thrown when the client submits a malformed request.

  • InternalException This exception is thrown when an error occurs in the DataSync service.

See also, https://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/UpdateTask

func (*DataSync) UpdateTaskExecution added in v1.35.24 

func (c *DataSync) UpdateTaskExecution(input *UpdateTaskExecutionInput) (*UpdateTaskExecutionOutput, error)

UpdateTaskExecution API operation for AWS DataSync.

Updates execution of a task.

You can modify bandwidth throttling for a task execution that is running or queued. For more information, see Adjusting Bandwidth Throttling for a Task Execution (https://docs.aws.amazon.com/datasync/latest/userguide/working-with-task-executions.html#adjust-bandwidth-throttling).

The only Option that can be modified by UpdateTaskExecution is BytesPerSecond (https://docs.aws.amazon.com/datasync/latest/userguide/API_Options.html#DataSync-Type-Options-BytesPerSecond) .

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 UpdateTaskExecution for usage and error information.

Returned Error Types:

  • InvalidRequestException This exception is thrown when the client submits a malformed request.

  • InternalException This exception is thrown when an error occurs in the DataSync service.

See also, https://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/UpdateTaskExecution

func (*DataSync) UpdateTaskExecutionRequest added in v1.35.24 

func (c *DataSync) UpdateTaskExecutionRequest(input *UpdateTaskExecutionInput) (req *request.Request, output *UpdateTaskExecutionOutput)

UpdateTaskExecutionRequest generates a "aws/request.Request" representing the client's request for the UpdateTaskExecution 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 UpdateTaskExecution for more information on using the UpdateTaskExecution 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 UpdateTaskExecutionRequest method.
req, resp := client.UpdateTaskExecutionRequest(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/UpdateTaskExecution

func (*DataSync) UpdateTaskExecutionWithContext added in v1.35.24 

func (c *DataSync) UpdateTaskExecutionWithContext(ctx aws.Context, input *UpdateTaskExecutionInput, opts ...request.Option) (*UpdateTaskExecutionOutput, error)

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

See UpdateTaskExecution 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) 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 Amazon Web Services
	// 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteAgentOutput) String 

func (s DeleteAgentOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteLocationOutput) String 

func (s DeleteLocationOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteTaskOutput) String 

func (s DeleteTaskOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 DataSync.
	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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeLocationFsxWindowsInput added in v1.28.9 

type DescribeLocationFsxWindowsInput struct {

	// The Amazon Resource Name (ARN) of the FSx for Windows File Server location
	// to describe.
	//
	// LocationArn is a required field
	LocationArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeLocationFsxWindowsInput) GoString added in v1.28.9 

func (s DescribeLocationFsxWindowsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeLocationFsxWindowsInput) SetLocationArn added in v1.28.9 

func (s *DescribeLocationFsxWindowsInput) SetLocationArn(v string) *DescribeLocationFsxWindowsInput

SetLocationArn sets the LocationArn field's value.

func (DescribeLocationFsxWindowsInput) String added in v1.28.9 

func (s DescribeLocationFsxWindowsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeLocationFsxWindowsInput) Validate added in v1.28.9 

func (s *DescribeLocationFsxWindowsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeLocationFsxWindowsOutput added in v1.28.9 

type DescribeLocationFsxWindowsOutput struct {

	// The time that the FSx for Windows File Server location was created.
	CreationTime *time.Time `type:"timestamp"`

	// The name of the Windows domain that the FSx for Windows File Server belongs
	// to.
	Domain *string `type:"string"`

	// The Amazon Resource Name (ARN) of the FSx for Windows File Server location
	// that was described.
	LocationArn *string `type:"string"`

	// The URL of the FSx for Windows File Server location that was described.
	LocationUri *string `type:"string"`

	// The Amazon Resource Names (ARNs) of the security groups that are configured
	// for the FSx for Windows File Server file system.
	SecurityGroupArns []*string `min:"1" type:"list"`

	// The user who has the permissions to access files and folders in the FSx for
	// Windows File Server file system.
	User *string `type:"string"`
	// contains filtered or unexported fields
}

func (DescribeLocationFsxWindowsOutput) GoString added in v1.28.9 

func (s DescribeLocationFsxWindowsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeLocationFsxWindowsOutput) SetCreationTime added in v1.28.9 

func (s *DescribeLocationFsxWindowsOutput) SetCreationTime(v time.Time) *DescribeLocationFsxWindowsOutput

SetCreationTime sets the CreationTime field's value.

func (*DescribeLocationFsxWindowsOutput) SetDomain added in v1.28.9 

func (s *DescribeLocationFsxWindowsOutput) SetDomain(v string) *DescribeLocationFsxWindowsOutput

SetDomain sets the Domain field's value.

func (*DescribeLocationFsxWindowsOutput) SetLocationArn added in v1.28.9 

func (s *DescribeLocationFsxWindowsOutput) SetLocationArn(v string) *DescribeLocationFsxWindowsOutput

SetLocationArn sets the LocationArn field's value.

func (*DescribeLocationFsxWindowsOutput) SetLocationUri added in v1.28.9 

func (s *DescribeLocationFsxWindowsOutput) SetLocationUri(v string) *DescribeLocationFsxWindowsOutput

SetLocationUri sets the LocationUri field's value.

func (*DescribeLocationFsxWindowsOutput) SetSecurityGroupArns added in v1.28.9 

func (s *DescribeLocationFsxWindowsOutput) SetSecurityGroupArns(v []*string) *DescribeLocationFsxWindowsOutput

SetSecurityGroupArns sets the SecurityGroupArns field's value.

func (*DescribeLocationFsxWindowsOutput) SetUser added in v1.28.9 

func (s *DescribeLocationFsxWindowsOutput) SetUser(v string) *DescribeLocationFsxWindowsOutput

SetUser sets the User field's value.

func (DescribeLocationFsxWindowsOutput) String added in v1.28.9 

func (s DescribeLocationFsxWindowsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeLocationObjectStorageInput added in v1.33.13 

type DescribeLocationObjectStorageInput struct {

	// The Amazon Resource Name (ARN) of the self-managed object storage server
	// location that was described.
	//
	// LocationArn is a required field
	LocationArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

DescribeLocationObjectStorageRequest

func (DescribeLocationObjectStorageInput) GoString added in v1.33.13 

func (s DescribeLocationObjectStorageInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeLocationObjectStorageInput) SetLocationArn added in v1.33.13 

func (s *DescribeLocationObjectStorageInput) SetLocationArn(v string) *DescribeLocationObjectStorageInput

SetLocationArn sets the LocationArn field's value.

func (DescribeLocationObjectStorageInput) String added in v1.33.13 

func (s DescribeLocationObjectStorageInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeLocationObjectStorageInput) Validate added in v1.33.13 

func (s *DescribeLocationObjectStorageInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeLocationObjectStorageOutput added in v1.33.13 

type DescribeLocationObjectStorageOutput struct {

	// Optional. The access key is used if credentials are required to access the
	// self-managed object storage server. If your object storage requires a user
	// name and password to authenticate, use AccessKey and SecretKey to provide
	// the user name and password, respectively.
	AccessKey *string `min:"8" type:"string"`

	// The Amazon Resource Name (ARN) of the agents associated with the self-managed
	// object storage server location.
	AgentArns []*string `min:"1" type:"list"`

	// The time that the self-managed object storage server agent was created.
	CreationTime *time.Time `type:"timestamp"`

	// The Amazon Resource Name (ARN) of the self-managed object storage server
	// location to describe.
	LocationArn *string `type:"string"`

	// The URL of the source self-managed object storage server location that was
	// described.
	LocationUri *string `type:"string"`

	// The port that your self-managed object storage server accepts inbound network
	// traffic on. The server port is set by default to TCP 80 (HTTP) or TCP 443
	// (HTTPS).
	ServerPort *int64 `min:"1" type:"integer"`

	// The protocol that the object storage server uses to communicate. Valid values
	// are HTTP or HTTPS.
	ServerProtocol *string `type:"string" enum:"ObjectStorageServerProtocol"`
	// contains filtered or unexported fields
}

DescribeLocationObjectStorageResponse

func (DescribeLocationObjectStorageOutput) GoString added in v1.33.13 

func (s DescribeLocationObjectStorageOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeLocationObjectStorageOutput) SetAccessKey added in v1.33.13 

func (s *DescribeLocationObjectStorageOutput) SetAccessKey(v string) *DescribeLocationObjectStorageOutput

SetAccessKey sets the AccessKey field's value.

func (*DescribeLocationObjectStorageOutput) SetAgentArns added in v1.33.13 

func (s *DescribeLocationObjectStorageOutput) SetAgentArns(v []*string) *DescribeLocationObjectStorageOutput

SetAgentArns sets the AgentArns field's value.

func (*DescribeLocationObjectStorageOutput) SetCreationTime added in v1.33.13 

func (s *DescribeLocationObjectStorageOutput) SetCreationTime(v time.Time) *DescribeLocationObjectStorageOutput

SetCreationTime sets the CreationTime field's value.

func (*DescribeLocationObjectStorageOutput) SetLocationArn added in v1.33.13 

func (s *DescribeLocationObjectStorageOutput) SetLocationArn(v string) *DescribeLocationObjectStorageOutput

SetLocationArn sets the LocationArn field's value.

func (*DescribeLocationObjectStorageOutput) SetLocationUri added in v1.33.13 

func (s *DescribeLocationObjectStorageOutput) SetLocationUri(v string) *DescribeLocationObjectStorageOutput

SetLocationUri sets the LocationUri field's value.

func (*DescribeLocationObjectStorageOutput) SetServerPort added in v1.33.13 

func (s *DescribeLocationObjectStorageOutput) SetServerPort(v int64) *DescribeLocationObjectStorageOutput

SetServerPort sets the ServerPort field's value.

func (*DescribeLocationObjectStorageOutput) SetServerProtocol added in v1.33.13 

func (s *DescribeLocationObjectStorageOutput) SetServerProtocol(v string) *DescribeLocationObjectStorageOutput

SetServerProtocol sets the ServerProtocol field's value.

func (DescribeLocationObjectStorageOutput) String added in v1.33.13 

func (s DescribeLocationObjectStorageOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 {

	// If you are using DataSync on an Amazon Web Services Outpost, the Amazon Resource
	// Name (ARNs) of the EC2 agents deployed on your Outpost. For more information
	// about launching a DataSync agent on an Amazon Web Services Outpost, see Deploy
	// your DataSync agent on Outposts (https://docs.aws.amazon.com/datasync/latest/userguide/deploy-agents.html#outposts-agent).
	AgentArns []*string `min:"1" type:"list"`

	// 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 or access point.
	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 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 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 (http://aws.amazon.com/s3/storage-classes/).
	// Some storage classes have behaviors that can affect your S3 storage cost.
	// For detailed information, see Considerations when working with S3 storage
	// classes in DataSync (https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeLocationS3Output) SetAgentArns added in v1.35.0 

func (s *DescribeLocationS3Output) SetAgentArns(v []*string) *DescribeLocationS3Output

SetAgentArns sets the AgentArns field's value.

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 SMB 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 Amazon Web Services
	// 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
	// (https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html)
	// 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 (https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html),
	// the default value is used. You can override the defaults options on each
	// task execution by specifying an overriding Options value to StartTaskExecution
	// (https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html).
	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 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 Amazon Web Services 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 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"`

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

	// 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 StartTaskExecution (https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html)
	// operation.
	Options *Options `type:"structure"`

	// The schedule used to periodically transfer files from a source to a destination
	// location.
	Schedule *TaskSchedule `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 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) SetIncludes added in v1.40.30 

func (s *DescribeTaskOutput) SetIncludes(v []*FilterRule) *DescribeTaskOutput

SetIncludes sets the Includes 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) SetSchedule added in v1.25.39 

func (s *DescribeTaskOutput) SetSchedule(v *TaskSchedule) *DescribeTaskOutput

SetSchedule sets the Schedule 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) GoString 

func (s Ec2Config) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Ec2Config) SetSecurityGroupArns 

func (s *Ec2Config) SetSecurityGroupArns(v []*string) *Ec2Config

SetSecurityGroupArns sets the SecurityGroupArns field's value.

func (*Ec2Config) SetSubnetArn 

func (s *Ec2Config) SetSubnetArn(v string) *Ec2Config

SetSubnetArn sets the SubnetArn field's value.

func (Ec2Config) String 

func (s Ec2Config) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Ec2Config) Validate 

func (s *Ec2Config) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type FilterRule added in v1.19.29 

type FilterRule struct {

	// The type of filter rule to apply. 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InternalException added in v1.28.0 

type InternalException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	ErrorCode *string `locationName:"errorCode" type:"string"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

This exception is thrown when an error occurs in the DataSync service.

func (*InternalException) Code added in v1.28.0 

func (s *InternalException) Code() string

Code returns the exception type name.

func (*InternalException) Error added in v1.28.0 

func (s *InternalException) Error() string

func (InternalException) GoString added in v1.28.0 

func (s InternalException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InternalException) Message added in v1.28.0 

func (s *InternalException) Message() string

Message returns the exception's message.

func (*InternalException) OrigErr added in v1.28.0 

func (s *InternalException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InternalException) RequestID added in v1.28.0 

func (s *InternalException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InternalException) StatusCode added in v1.28.0 

func (s *InternalException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InternalException) String added in v1.28.0 

func (s InternalException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InvalidRequestException added in v1.28.0 

type InvalidRequestException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	ErrorCode *string `locationName:"errorCode" type:"string"`

	Message_ *string `locationName:"message" type:"string"`
	// contains filtered or unexported fields
}

This exception is thrown when the client submits a malformed request.

func (*InvalidRequestException) Code added in v1.28.0 

func (s *InvalidRequestException) Code() string

Code returns the exception type name.

func (*InvalidRequestException) Error added in v1.28.0 

func (s *InvalidRequestException) Error() string

func (InvalidRequestException) GoString added in v1.28.0 

func (s InvalidRequestException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InvalidRequestException) Message added in v1.28.0 

func (s *InvalidRequestException) Message() string

Message returns the exception's message.

func (*InvalidRequestException) OrigErr added in v1.28.0 

func (s *InvalidRequestException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidRequestException) RequestID added in v1.28.0 

func (s *InvalidRequestException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidRequestException) StatusCode added in v1.28.0 

func (s *InvalidRequestException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InvalidRequestException) String added in v1.28.0 

func (s InvalidRequestException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListLocationsInput 

type ListLocationsInput struct {

	// You can use API filters to narrow down the list of resources returned by
	// ListLocations. For example, to retrieve all tasks on a specific source location,
	// you can use ListLocations with filter name LocationType S3 and Operator Equals.
	Filters []*LocationFilter `type:"list"`

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListLocationsInput) SetFilters added in v1.34.7 

func (s *ListLocationsInput) SetFilters(v []*LocationFilter) *ListLocationsInput

SetFilters sets the Filters field's value.

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListLocationsInput) Validate added in v1.34.7 

func (s *ListLocationsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListTasksInput 

type ListTasksInput struct {

	// You can use API filters to narrow down the list of resources returned by
	// ListTasks. For example, to retrieve all tasks on a specific source location,
	// you can use ListTasks with filter name LocationId and Operator Equals with
	// the ARN for the location.
	Filters []*TaskFilter `type:"list"`

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

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTasksInput) SetFilters added in v1.34.7 

func (s *ListTasksInput) SetFilters(v []*TaskFilter) *ListTasksInput

SetFilters sets the Filters field's value.

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTasksInput) Validate added in v1.34.7 

func (s *ListTasksInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type LocationFilter added in v1.34.7 

type LocationFilter struct {

	// The name of the filter being used. Each API call supports a list of filters
	// that are available for it (for example, LocationType for ListLocations).
	//
	// Name is a required field
	Name *string `type:"string" required:"true" enum:"LocationFilterName"`

	// The operator that is used to compare filter values (for example, Equals or
	// Contains). For more about API filtering operators, see API filters for ListTasks
	// and ListLocations (https://docs.aws.amazon.com/datasync/latest/userguide/query-resources.html).
	//
	// Operator is a required field
	Operator *string `type:"string" required:"true" enum:"Operator"`

	// The values that you want to filter for. For example, you might want to display
	// only Amazon S3 locations.
	//
	// Values is a required field
	Values []*string `type:"list" required:"true"`
	// contains filtered or unexported fields
}

You can use API filters to narrow down the list of resources returned by ListLocations. For example, to retrieve all your Amazon S3 locations, you can use ListLocations with filter name LocationType S3 and Operator Equals.

func (LocationFilter) GoString added in v1.34.7 

func (s LocationFilter) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LocationFilter) SetName added in v1.34.7 

func (s *LocationFilter) SetName(v string) *LocationFilter

SetName sets the Name field's value.

func (*LocationFilter) SetOperator added in v1.34.7 

func (s *LocationFilter) SetOperator(v string) *LocationFilter

SetOperator sets the Operator field's value.

func (*LocationFilter) SetValues added in v1.34.7 

func (s *LocationFilter) SetValues(v []*string) *LocationFilter

SetValues sets the Values field's value.

func (LocationFilter) String added in v1.34.7 

func (s LocationFilter) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LocationFilter) Validate added in v1.34.7 

func (s *LocationFilter) Validate() error

Validate inspects the fields of the type to determine if they are valid.

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 (https://docs.aws.amazon.com/datasync/latest/userguide/API_ListLocations.html)
	// 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 (https://docs.aws.amazon.com/datasync/latest/userguide/API_ListLocations.html) operation is called.

func (LocationListEntry) GoString 

func (s LocationListEntry) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 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 DataSync. For example, if you want
	// DataSync to use a maximum of 1 MB, set this value to 1048576 (=1024*1024).
	BytesPerSecond *int64 `type:"long"`

	// The POSIX group ID (GID) of the file's owners. This option should only be
	// set for NFS, EFS, and S3 locations. For more information about what metadata
	// is copied by DataSync, see Metadata Copied by DataSync (https://docs.aws.amazon.com/datasync/latest/userguide/special-files.html#metadata-copied).
	//
	// 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 determines the type of logs that DataSync publishes to a log
	// stream in the Amazon CloudWatch log group that you provide. For more information
	// about providing a log group for DataSync, see CloudWatchLogGroupArn (https://docs.aws.amazon.com/datasync/latest/userguide/API_CreateTask.html#DataSync-CreateTask-request-CloudWatchLogGroupArn).
	// If set to OFF, no logs are published. BASIC publishes logs on errors for
	// individual files transferred, and TRANSFER publishes logs for every file
	// or object that is transferred and integrity checked.
	LogLevel *string `type:"string" enum:"LogLevel"`

	// A value that indicates the last time that a file was modified (that is, a
	// file was written to) before the PREPARING phase. This option is required
	// for cases when you need to run the same task more than one time.
	//
	// 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 Considerations when working with Amazon
	// S3 storage classes in DataSync (https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#using-storage-classes)
	// in the 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. This option should
	// only be set for NFS, EFS, and S3 locations. For more information about what
	// metadata is copied by DataSync, see Metadata Copied by DataSync (https://docs.aws.amazon.com/datasync/latest/userguide/special-files.html#metadata-copied).
	//
	// Default value: PRESERVE.
	//
	// PRESERVE: Preserve POSIX-style permissions (recommended).
	//
	// NONE: Ignore permissions.
	//
	// 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
	// Considerations when working with Amazon S3 storage classes in DataSync (https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#using-storage-classes)
	// in the 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 DataSync should preserve the metadata of
	// block and character devices in the source file system, and re-create the
	// files with that device name and metadata on the destination. DataSync does
	// not copy the contents of such devices, only the name and metadata.
	//
	// 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"`

	// A value that determines which components of the SMB security descriptor are
	// copied from source to destination objects.
	//
	// This value is only used for transfers between SMB and Amazon FSx for Windows
	// File Server locations, or between two Amazon FSx for Windows File Server
	// locations. For more information about how DataSync handles metadata, see
	// How DataSync Handles Metadata and Special Files (https://docs.aws.amazon.com/datasync/latest/userguide/special-files.html).
	//
	// Default value: OWNER_DACL.
	//
	// OWNER_DACL: For each copied object, DataSync copies the following metadata:
	//
	//    * Object owner.
	//
	//    * NTFS discretionary access control lists (DACLs), which determine whether
	//    to grant access to an object.
	//
	// When choosing this option, DataSync does NOT copy the NTFS system access
	// control lists (SACLs), which are used by administrators to log attempts to
	// access a secured object.
	//
	// OWNER_DACL_SACL: For each copied object, DataSync copies the following metadata:
	//
	//    * Object owner.
	//
	//    * NTFS discretionary access control lists (DACLs), which determine whether
	//    to grant access to an object.
	//
	//    * NTFS system access control lists (SACLs), which are used by administrators
	//    to log attempts to access a secured object.
	//
	// Copying SACLs requires granting additional permissions to the Windows user
	// that DataSync uses to access your SMB location. For information about choosing
	// a user that ensures sufficient permissions to files, folders, and metadata,
	// see user (create-smb-location.html#SMBuser).
	//
	// NONE: None of the SMB security descriptor components are copied. Destination
	// objects are owned by the user that was provided for accessing the destination
	// location. DACLs and SACLs are set based on the destination server’s configuration.
	SecurityDescriptorCopyFlags *string `type:"string" enum:"SmbSecurityDescriptorCopyFlags"`

	// A value that determines whether tasks should be queued before executing the
	// tasks. If set to ENABLED, the tasks will be queued. The default is ENABLED.
	//
	// If you use the same agent to run multiple tasks, you can enable the tasks
	// to run in series. For more information, see Queueing task executions (https://docs.aws.amazon.com/datasync/latest/userguide/run-task.html#queue-task-execution).
	TaskQueueing *string `type:"string" enum:"TaskQueueing"`

	// A value that determines whether DataSync transfers only the data and metadata
	// that differ between the source and the destination location, or whether DataSync
	// transfers all the content from the source, without comparing to the destination
	// location.
	//
	// CHANGED: DataSync copies only data or metadata that is new or different content
	// from the source location to the destination location.
	//
	// ALL: DataSync copies all source location content to the destination, without
	// comparing to existing content on the destination.
	TransferMode *string `type:"string" enum:"TransferMode"`

	// The POSIX user ID (UID) of the file's owner. This option should only be set
	// for NFS, EFS, and S3 locations. To learn more about what metadata is copied
	// by DataSync, see Metadata Copied by DataSync (https://docs.aws.amazon.com/datasync/latest/userguide/special-files.html#metadata-copied).
	//
	// 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.
	// For more information, see Configure task settings (https://docs.aws.amazon.com/datasync/latest/userguide/create-task.html).
	//
	// Default value: POINT_IN_TIME_CONSISTENT.
	//
	// ONLY_FILES_TRANSFERRED (recommended): Perform verification only on files
	// that were transferred.
	//
	// POINT_IN_TIME_CONSISTENT: Scan the entire source and entire destination at
	// the end of the transfer to verify that source and destination are fully synchronized.
	// This option isn't supported when transferring to S3 Glacier or S3 Glacier
	// Deep Archive storage classes.
	//
	// NONE: No additional verification is done at the end of the transfer, but
	// all data transmissions are integrity-checked with checksum verification during
	// the transfer.
	VerifyMode *string `type:"string" enum:"VerifyMode"`
	// contains filtered or unexported fields
}

Represents the options that are available to control the behavior of a StartTaskExecution (https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html) 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 (https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html), the default value is used. You can override the defaults options on each task execution by specifying an overriding Options value to StartTaskExecution (https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html).

func (Options) GoString 

func (s Options) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Options) SetAtime 

func (s *Options) SetAtime(v string) *Options

SetAtime sets the Atime field's value.

func (*Options) SetBytesPerSecond 

func (s *Options) SetBytesPerSecond(v int64) *Options

SetBytesPerSecond sets the BytesPerSecond field's value.

func (*Options) SetGid 

func (s *Options) SetGid(v string) *Options

SetGid sets the Gid field's value.

func (*Options) SetLogLevel added in v1.28.9 

func (s *Options) SetLogLevel(v string) *Options

SetLogLevel sets the LogLevel field's value.

func (*Options) SetMtime 

func (s *Options) SetMtime(v string) *Options

SetMtime sets the Mtime field's value.

func (*Options) SetOverwriteMode added in v1.24.5 

func (s *Options) SetOverwriteMode(v string) *Options

SetOverwriteMode sets the OverwriteMode field's value.

func (*Options) SetPosixPermissions 

func (s *Options) SetPosixPermissions(v string) *Options

SetPosixPermissions sets the PosixPermissions field's value.

func (*Options) SetPreserveDeletedFiles 

func (s *Options) SetPreserveDeletedFiles(v string) *Options

SetPreserveDeletedFiles sets the PreserveDeletedFiles field's value.

func (*Options) SetPreserveDevices 

func (s *Options) SetPreserveDevices(v string) *Options

SetPreserveDevices sets the PreserveDevices field's value.

func (*Options) SetSecurityDescriptorCopyFlags added in v1.38.51 

func (s *Options) SetSecurityDescriptorCopyFlags(v string) *Options

SetSecurityDescriptorCopyFlags sets the SecurityDescriptorCopyFlags field's value.

func (*Options) SetTaskQueueing added in v1.25.8 

func (s *Options) SetTaskQueueing(v string) *Options

SetTaskQueueing sets the TaskQueueing field's value.

func (*Options) SetTransferMode added in v1.33.13 

func (s *Options) SetTransferMode(v string) *Options

SetTransferMode sets the TransferMode field's value.

func (*Options) SetUid 

func (s *Options) SetUid(v string) *Options

SetUid sets the Uid field's value.

func (*Options) SetVerifyMode 

func (s *Options) SetVerifyMode(v string) *Options

SetVerifyMode sets the VerifyMode field's value.

func (Options) String 

func (s Options) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Options) Validate 

func (s *Options) Validate() error

Validate inspects the fields of the type to determine if they are valid.

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type S3Config 

type S3Config struct {

	// The Amazon S3 bucket to access. This bucket is used as a parameter in the
	// CreateLocationS3 (https://docs.aws.amazon.com/datasync/latest/userguide/API_CreateLocationS3.html)
	// operation.
	//
	// BucketAccessRoleArn is a required field
	BucketAccessRoleArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

The Amazon Resource Name (ARN) of the 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 DataSync User Guide.

func (S3Config) GoString 

func (s S3Config) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*S3Config) SetBucketAccessRoleArn 

func (s *S3Config) SetBucketAccessRoleArn(v string) *S3Config

SetBucketAccessRoleArn sets the BucketAccessRoleArn field's value.

func (S3Config) String 

func (s S3Config) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*S3Config) Validate 

func (s *S3Config) Validate() error

Validate inspects the fields of the type to determine if they are valid.

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StartTaskExecutionInput 

type StartTaskExecutionInput struct {

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

	// 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
	// (https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html)
	// 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 (https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html),
	// the default value is used. You can override the defaults options on each
	// task execution by specifying an overriding Options value to StartTaskExecution
	// (https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html).
	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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StartTaskExecutionInput) SetExcludes added in v1.40.30 

func (s *StartTaskExecutionInput) SetExcludes(v []*FilterRule) *StartTaskExecutionInput

SetExcludes sets the Excludes field's value.

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TagListEntry 

type TagListEntry struct {

	// The key for an Amazon Web Services resource tag.
	//
	// Key is a required field
	Key *string `min:"1" type:"string" required:"true"`

	// The value for an Amazon Web Services 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 (https://docs.aws.amazon.com/datasync/latest/userguide/API_ListTagsForResource.html) operation is called.

func (TagListEntry) GoString 

func (s TagListEntry) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (TagResourceOutput) String 

func (s TagResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 the ListTaskExecutions (https://docs.aws.amazon.com/datasync/latest/userguide/API_ListTaskExecutions.html) operation is called.

func (TaskExecutionListEntry) GoString 

func (s TaskExecutionListEntry) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TaskExecutionResultDetail 

type TaskExecutionResultDetail struct {

	// Errors that 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 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 DataSync took to transfer the file from
	// the source to the destination location.
	TotalDuration *int64 `type:"long"`

	// The total time in milliseconds that 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 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) SetTotalDuration added in v1.25.39 

func (s *TaskExecutionResultDetail) SetTotalDuration(v int64) *TaskExecutionResultDetail

SetTotalDuration sets the TotalDuration 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TaskFilter added in v1.34.7 

type TaskFilter struct {

	// The name of the filter being used. Each API call supports a list of filters
	// that are available for it. For example, LocationId for ListTasks.
	//
	// Name is a required field
	Name *string `type:"string" required:"true" enum:"TaskFilterName"`

	// The operator that is used to compare filter values (for example, Equals or
	// Contains). For more about API filtering operators, see API filters for ListTasks
	// and ListLocations (https://docs.aws.amazon.com/datasync/latest/userguide/query-resources.html).
	//
	// Operator is a required field
	Operator *string `type:"string" required:"true" enum:"Operator"`

	// The values that you want to filter for. For example, you might want to display
	// only tasks for a specific destination location.
	//
	// Values is a required field
	Values []*string `type:"list" required:"true"`
	// contains filtered or unexported fields
}

You can use API filters to narrow down the list of resources returned by ListTasks. For example, to retrieve all tasks on a source location, you can use ListTasks with filter name LocationId and Operator Equals with the ARN for the location.

func (TaskFilter) GoString added in v1.34.7 

func (s TaskFilter) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TaskFilter) SetName added in v1.34.7 

func (s *TaskFilter) SetName(v string) *TaskFilter

SetName sets the Name field's value.

func (*TaskFilter) SetOperator added in v1.34.7 

func (s *TaskFilter) SetOperator(v string) *TaskFilter

SetOperator sets the Operator field's value.

func (*TaskFilter) SetValues added in v1.34.7 

func (s *TaskFilter) SetValues(v []*string) *TaskFilter

SetValues sets the Values field's value.

func (TaskFilter) String added in v1.34.7 

func (s TaskFilter) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TaskFilter) Validate added in v1.34.7 

func (s *TaskFilter) Validate() error

Validate inspects the fields of the type to determine if they are valid.

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 (https://docs.aws.amazon.com/datasync/latest/userguide/API_ListTasks.html) 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TaskSchedule added in v1.25.39 

type TaskSchedule struct {

	// A cron expression that specifies when DataSync initiates a scheduled transfer
	// from a source to a destination location.
	//
	// ScheduleExpression is a required field
	ScheduleExpression *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

Specifies the schedule you want your task to use for repeated executions. For more information, see Schedule Expressions for Rules (https://docs.aws.amazon.com/AmazonCloudWatch/latest/events/ScheduledEvents.html).

func (TaskSchedule) GoString added in v1.25.39 

func (s TaskSchedule) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TaskSchedule) SetScheduleExpression added in v1.25.39 

func (s *TaskSchedule) SetScheduleExpression(v string) *TaskSchedule

SetScheduleExpression sets the ScheduleExpression field's value.

func (TaskSchedule) String added in v1.25.39 

func (s TaskSchedule) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TaskSchedule) Validate added in v1.25.39 

func (s *TaskSchedule) Validate() error

Validate inspects the fields of the type to determine if they are valid.

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (UntagResourceOutput) String 

func (s UntagResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (UpdateAgentOutput) String 

func (s UpdateAgentOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateLocationNfsInput added in v1.37.22 

type UpdateLocationNfsInput struct {

	// The Amazon Resource Name (ARN) of the NFS location to update.
	//
	// LocationArn is a required field
	LocationArn *string `type:"string" required:"true"`

	// Represents the mount options that are available for DataSync to access an
	// NFS location.
	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"`

	// 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 that you specified, DataSync must
	// have permissions to read all the data. To ensure this, either configure the
	// NFS export with no_root_squash, or ensure that the files you want DataSync
	// to access have permissions that allow read access for all users. Doing either
	// option enables the agent to read the files. For the agent to access directories,
	// you must additionally enable all execute access.
	//
	// If you are copying data to or from your Snowcone device, see NFS Server on
	// Snowcone (https://docs.aws.amazon.com/datasync/latest/userguide/create-nfs-location.html#nfs-on-snowcone)
	// for more information.
	//
	// For information about NFS export configuration, see 18.7. The /etc/exports
	// Configuration File in the Red Hat Enterprise Linux documentation.
	Subdirectory *string `type:"string"`
	// contains filtered or unexported fields
}

func (UpdateLocationNfsInput) GoString added in v1.37.22 

func (s UpdateLocationNfsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateLocationNfsInput) SetLocationArn added in v1.37.22 

func (s *UpdateLocationNfsInput) SetLocationArn(v string) *UpdateLocationNfsInput

SetLocationArn sets the LocationArn field's value.

func (*UpdateLocationNfsInput) SetMountOptions added in v1.37.22 

func (s *UpdateLocationNfsInput) SetMountOptions(v *NfsMountOptions) *UpdateLocationNfsInput

SetMountOptions sets the MountOptions field's value.

func (*UpdateLocationNfsInput) SetOnPremConfig added in v1.37.22 

func (s *UpdateLocationNfsInput) SetOnPremConfig(v *OnPremConfig) *UpdateLocationNfsInput

SetOnPremConfig sets the OnPremConfig field's value.

func (*UpdateLocationNfsInput) SetSubdirectory added in v1.37.22 

func (s *UpdateLocationNfsInput) SetSubdirectory(v string) *UpdateLocationNfsInput

SetSubdirectory sets the Subdirectory field's value.

func (UpdateLocationNfsInput) String added in v1.37.22 

func (s UpdateLocationNfsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateLocationNfsInput) Validate added in v1.37.22 

func (s *UpdateLocationNfsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateLocationNfsOutput added in v1.37.22 

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

func (UpdateLocationNfsOutput) GoString added in v1.37.22 

func (s UpdateLocationNfsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (UpdateLocationNfsOutput) String added in v1.37.22 

func (s UpdateLocationNfsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateLocationObjectStorageInput added in v1.37.22 

type UpdateLocationObjectStorageInput struct {

	// Optional. The access key is used if credentials are required to access the
	// self-managed object storage server. If your object storage requires a user
	// name and password to authenticate, use AccessKey and SecretKey to provide
	// the user name and password, respectively.
	AccessKey *string `min:"8" type:"string"`

	// The Amazon Resource Name (ARN) of the agents associated with the self-managed
	// object storage server location.
	AgentArns []*string `min:"1" type:"list"`

	// The Amazon Resource Name (ARN) of the self-managed object storage server
	// location to be updated.
	//
	// LocationArn is a required field
	LocationArn *string `type:"string" required:"true"`

	// Optional. The secret key is used if credentials are required to access the
	// self-managed object storage server. If your object storage requires a user
	// name and password to authenticate, use AccessKey and SecretKey to provide
	// the user name and password, respectively.
	//
	// SecretKey is a sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by UpdateLocationObjectStorageInput's
	// String and GoString methods.
	SecretKey *string `min:"8" type:"string" sensitive:"true"`

	// The port that your self-managed object storage server accepts inbound network
	// traffic on. The server port is set by default to TCP 80 (HTTP) or TCP 443
	// (HTTPS). You can specify a custom port if your self-managed object storage
	// server requires one.
	ServerPort *int64 `min:"1" type:"integer"`

	// The protocol that the object storage server uses to communicate. Valid values
	// are HTTP or HTTPS.
	ServerProtocol *string `type:"string" enum:"ObjectStorageServerProtocol"`

	// The subdirectory in the self-managed object storage server that is used to
	// read data from.
	Subdirectory *string `type:"string"`
	// contains filtered or unexported fields
}

func (UpdateLocationObjectStorageInput) GoString added in v1.37.22 

func (s UpdateLocationObjectStorageInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateLocationObjectStorageInput) SetAccessKey added in v1.37.22 

func (s *UpdateLocationObjectStorageInput) SetAccessKey(v string) *UpdateLocationObjectStorageInput

SetAccessKey sets the AccessKey field's value.

func (*UpdateLocationObjectStorageInput) SetAgentArns added in v1.37.22 

func (s *UpdateLocationObjectStorageInput) SetAgentArns(v []*string) *UpdateLocationObjectStorageInput

SetAgentArns sets the AgentArns field's value.

func (*UpdateLocationObjectStorageInput) SetLocationArn added in v1.37.22 

func (s *UpdateLocationObjectStorageInput) SetLocationArn(v string) *UpdateLocationObjectStorageInput

SetLocationArn sets the LocationArn field's value.

func (*UpdateLocationObjectStorageInput) SetSecretKey added in v1.37.22 

func (s *UpdateLocationObjectStorageInput) SetSecretKey(v string) *UpdateLocationObjectStorageInput

SetSecretKey sets the SecretKey field's value.

func (*UpdateLocationObjectStorageInput) SetServerPort added in v1.37.22 

func (s *UpdateLocationObjectStorageInput) SetServerPort(v int64) *UpdateLocationObjectStorageInput

SetServerPort sets the ServerPort field's value.

func (*UpdateLocationObjectStorageInput) SetServerProtocol added in v1.37.22 

func (s *UpdateLocationObjectStorageInput) SetServerProtocol(v string) *UpdateLocationObjectStorageInput

SetServerProtocol sets the ServerProtocol field's value.

func (*UpdateLocationObjectStorageInput) SetSubdirectory added in v1.37.22 

func (s *UpdateLocationObjectStorageInput) SetSubdirectory(v string) *UpdateLocationObjectStorageInput

SetSubdirectory sets the Subdirectory field's value.

func (UpdateLocationObjectStorageInput) String added in v1.37.22 

func (s UpdateLocationObjectStorageInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateLocationObjectStorageInput) Validate added in v1.37.22 

func (s *UpdateLocationObjectStorageInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateLocationObjectStorageOutput added in v1.37.22 

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

func (UpdateLocationObjectStorageOutput) GoString added in v1.37.22 

func (s UpdateLocationObjectStorageOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (UpdateLocationObjectStorageOutput) String added in v1.37.22 

func (s UpdateLocationObjectStorageOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateLocationSmbInput added in v1.37.22 

type UpdateLocationSmbInput struct {

	// The Amazon Resource Names (ARNs) of agents to use for a Simple Message Block
	// (SMB) location.
	AgentArns []*string `min:"1" type:"list"`

	// 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 to update.
	//
	// LocationArn is a required field
	LocationArn *string `type:"string" required:"true"`

	// Represents the mount options that are available for DataSync to access an
	// SMB location.
	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 sensitive parameter and its value will be
	// replaced with "sensitive" in string returned by UpdateLocationSmbInput's
	// String and GoString methods.
	Password *string `type:"string" sensitive:"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.
	//
	// Subdirectory must be specified with forward slashes. For example, /path/to/folder.
	//
	// To transfer all the data in the folder that you specified, DataSync must
	// have permissions to mount the SMB share and to access all the data in that
	// share. To ensure this, do either of the following:
	//
	//    * 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.
	//
	//    * Use credentials of a member of the Backup Operators group to mount the
	//    share.
	//
	// Doing either of these options enables the agent to access the data. For the
	// agent to access directories, you must also enable all execute access.
	Subdirectory *string `type:"string"`

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

func (UpdateLocationSmbInput) GoString added in v1.37.22 

func (s UpdateLocationSmbInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateLocationSmbInput) SetAgentArns added in v1.37.22 

func (s *UpdateLocationSmbInput) SetAgentArns(v []*string) *UpdateLocationSmbInput

SetAgentArns sets the AgentArns field's value.

func (*UpdateLocationSmbInput) SetDomain added in v1.37.22 

func (s *UpdateLocationSmbInput) SetDomain(v string) *UpdateLocationSmbInput

SetDomain sets the Domain field's value.

func (*UpdateLocationSmbInput) SetLocationArn added in v1.37.22 

func (s *UpdateLocationSmbInput) SetLocationArn(v string) *UpdateLocationSmbInput

SetLocationArn sets the LocationArn field's value.

func (*UpdateLocationSmbInput) SetMountOptions added in v1.37.22 

func (s *UpdateLocationSmbInput) SetMountOptions(v *SmbMountOptions) *UpdateLocationSmbInput

SetMountOptions sets the MountOptions field's value.

func (*UpdateLocationSmbInput) SetPassword added in v1.37.22 

func (s *UpdateLocationSmbInput) SetPassword(v string) *UpdateLocationSmbInput

SetPassword sets the Password field's value.

func (*UpdateLocationSmbInput) SetSubdirectory added in v1.37.22 

func (s *UpdateLocationSmbInput) SetSubdirectory(v string) *UpdateLocationSmbInput

SetSubdirectory sets the Subdirectory field's value.

func (*UpdateLocationSmbInput) SetUser added in v1.37.22 

func (s *UpdateLocationSmbInput) SetUser(v string) *UpdateLocationSmbInput

SetUser sets the User field's value.

func (UpdateLocationSmbInput) String added in v1.37.22 

func (s UpdateLocationSmbInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateLocationSmbInput) Validate added in v1.37.22 

func (s *UpdateLocationSmbInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateLocationSmbOutput added in v1.37.22 

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

func (UpdateLocationSmbOutput) GoString added in v1.37.22 

func (s UpdateLocationSmbOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (UpdateLocationSmbOutput) String added in v1.37.22 

func (s UpdateLocationSmbOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateTaskExecutionInput added in v1.35.24 

type UpdateTaskExecutionInput struct {

	// Represents the options that are available to control the behavior of a StartTaskExecution
	// (https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html)
	// 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 (https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html),
	// the default value is used. You can override the defaults options on each
	// task execution by specifying an overriding Options value to StartTaskExecution
	// (https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html).
	//
	// Options is a required field
	Options *Options `type:"structure" required:"true"`

	// The Amazon Resource Name (ARN) of the specific task execution that is being
	// updated.
	//
	// TaskExecutionArn is a required field
	TaskExecutionArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateTaskExecutionInput) GoString added in v1.35.24 

func (s UpdateTaskExecutionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateTaskExecutionInput) SetOptions added in v1.35.24 

func (s *UpdateTaskExecutionInput) SetOptions(v *Options) *UpdateTaskExecutionInput

SetOptions sets the Options field's value.

func (*UpdateTaskExecutionInput) SetTaskExecutionArn added in v1.35.24 

func (s *UpdateTaskExecutionInput) SetTaskExecutionArn(v string) *UpdateTaskExecutionInput

SetTaskExecutionArn sets the TaskExecutionArn field's value.

func (UpdateTaskExecutionInput) String added in v1.35.24 

func (s UpdateTaskExecutionInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateTaskExecutionInput) Validate added in v1.35.24 

func (s *UpdateTaskExecutionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateTaskExecutionOutput added in v1.35.24 

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

func (UpdateTaskExecutionOutput) GoString added in v1.35.24 

func (s UpdateTaskExecutionOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (UpdateTaskExecutionOutput) String added in v1.35.24 

func (s UpdateTaskExecutionOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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"`

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

	// 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
	// (https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html)
	// 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 (https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html),
	// the default value is used. You can override the defaults options on each
	// task execution by specifying an overriding Options value to StartTaskExecution
	// (https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html).
	Options *Options `type:"structure"`

	// Specifies a schedule used to periodically transfer files from a source to
	// a destination location. You can configure your task to execute hourly, daily,
	// weekly or on specific days of the week. You control when in the day or hour
	// you want the task to execute. The time you specify is UTC time. For more
	// information, see Scheduling your task (https://docs.aws.amazon.com/datasync/latest/userguide/task-scheduling.html).
	Schedule *TaskSchedule `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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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) SetIncludes added in v1.40.30 

func (s *UpdateTaskInput) SetIncludes(v []*FilterRule) *UpdateTaskInput

SetIncludes sets the Includes 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) SetSchedule added in v1.25.39 

func (s *UpdateTaskInput) SetSchedule(v *TaskSchedule) *UpdateTaskInput

SetSchedule sets the Schedule 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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (UpdateTaskOutput) String 

func (s UpdateTaskOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

Source Files

View all Source files

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.

Jump to

Keyboard shortcuts

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