datasync

package module
v1.14.3 Latest Latest
Warning

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

 Go to latest Published: Mar 30, 2022 License: Apache-2.0 Imports: 32 Imported by: 9

Documentation

Overview

Package datasync provides the API client, operations, and parameter types for AWS DataSync.

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.

Index

Constants

View Source 
const ServiceAPIVersion = "2018-11-09"
View Source 
const ServiceID = "DataSync"

Variables

This section is empty.

Functions

func NewDefaultEndpointResolver 

func NewDefaultEndpointResolver() *internalendpoints.Resolver

NewDefaultEndpointResolver constructs a new service endpoint resolver

func WithAPIOptions added in v1.0.0 

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

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

func WithEndpointResolver 

func WithEndpointResolver(v EndpointResolver) func(*Options)

WithEndpointResolver returns a functional option for setting the Client's EndpointResolver option.

Types

type CancelTaskExecutionInput 

type CancelTaskExecutionInput struct {

	// The Amazon Resource Name (ARN) of the task execution to cancel.
	//
	// This member is required.
	TaskExecutionArn *string
	// contains filtered or unexported fields
}

CancelTaskExecutionRequest

type CancelTaskExecutionOutput 

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

type Client 

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

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

func New 

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

New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.

func NewFromConfig 

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

NewFromConfig returns a new client from the provided config.

func (*Client) CancelTaskExecution 

func (c *Client) CancelTaskExecution(ctx context.Context, params *CancelTaskExecutionInput, optFns ...func(*Options)) (*CancelTaskExecutionOutput, error)

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.

func (*Client) CreateAgent 

func (c *Client) CreateAgent(ctx context.Context, params *CreateAgentInput, optFns ...func(*Options)) (*CreateAgentOutput, error)

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.

func (*Client) CreateLocationEfs 

func (c *Client) CreateLocationEfs(ctx context.Context, params *CreateLocationEfsInput, optFns ...func(*Options)) (*CreateLocationEfsOutput, error)

Creates an endpoint for an Amazon EFS file system.

func (*Client) CreateLocationFsxLustre added in v1.10.0 

func (c *Client) CreateLocationFsxLustre(ctx context.Context, params *CreateLocationFsxLustreInput, optFns ...func(*Options)) (*CreateLocationFsxLustreOutput, error)

Creates an endpoint for an Amazon FSx for Lustre file system.

func (*Client) CreateLocationFsxWindows 

func (c *Client) CreateLocationFsxWindows(ctx context.Context, params *CreateLocationFsxWindowsInput, optFns ...func(*Options)) (*CreateLocationFsxWindowsOutput, error)

Creates an endpoint for an Amazon FSx for Windows File Server file system.

func (*Client) CreateLocationHdfs added in v1.8.0 

func (c *Client) CreateLocationHdfs(ctx context.Context, params *CreateLocationHdfsInput, optFns ...func(*Options)) (*CreateLocationHdfsOutput, error)

Creates an endpoint for a Hadoop Distributed File System (HDFS).

func (*Client) CreateLocationNfs 

func (c *Client) CreateLocationNfs(ctx context.Context, params *CreateLocationNfsInput, optFns ...func(*Options)) (*CreateLocationNfsOutput, error)

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

func (*Client) CreateLocationObjectStorage 

func (c *Client) CreateLocationObjectStorage(ctx context.Context, params *CreateLocationObjectStorageInput, optFns ...func(*Options)) (*CreateLocationObjectStorageOutput, error)

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

func (*Client) CreateLocationS3 

func (c *Client) CreateLocationS3(ctx context.Context, params *CreateLocationS3Input, optFns ...func(*Options)) (*CreateLocationS3Output, error)

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.

func (*Client) CreateLocationSmb 

func (c *Client) CreateLocationSmb(ctx context.Context, params *CreateLocationSmbInput, optFns ...func(*Options)) (*CreateLocationSmbOutput, error)

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

func (*Client) CreateTask 

func (c *Client) CreateTask(ctx context.Context, params *CreateTaskInput, optFns ...func(*Options)) (*CreateTaskOutput, error)

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

func (*Client) DeleteAgent 

func (c *Client) DeleteAgent(ctx context.Context, params *DeleteAgentInput, optFns ...func(*Options)) (*DeleteAgentOutput, error)

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.

func (*Client) DeleteLocation 

func (c *Client) DeleteLocation(ctx context.Context, params *DeleteLocationInput, optFns ...func(*Options)) (*DeleteLocationOutput, error)

Deletes the configuration of a location used by DataSync.

func (*Client) DeleteTask 

func (c *Client) DeleteTask(ctx context.Context, params *DeleteTaskInput, optFns ...func(*Options)) (*DeleteTaskOutput, error)

Deletes a task.

func (*Client) DescribeAgent 

func (c *Client) DescribeAgent(ctx context.Context, params *DescribeAgentInput, optFns ...func(*Options)) (*DescribeAgentOutput, error)

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.

func (*Client) DescribeLocationEfs 

func (c *Client) DescribeLocationEfs(ctx context.Context, params *DescribeLocationEfsInput, optFns ...func(*Options)) (*DescribeLocationEfsOutput, error)

Returns metadata, such as the path information about an Amazon EFS location.

func (*Client) DescribeLocationFsxLustre added in v1.10.0 

func (c *Client) DescribeLocationFsxLustre(ctx context.Context, params *DescribeLocationFsxLustreInput, optFns ...func(*Options)) (*DescribeLocationFsxLustreOutput, error)

Returns metadata, such as the path information about an Amazon FSx for Lustre location.

func (*Client) DescribeLocationFsxWindows 

func (c *Client) DescribeLocationFsxWindows(ctx context.Context, params *DescribeLocationFsxWindowsInput, optFns ...func(*Options)) (*DescribeLocationFsxWindowsOutput, error)

Returns metadata, such as the path information about an Amazon FSx for Windows File Server location.

func (*Client) DescribeLocationHdfs added in v1.8.0 

func (c *Client) DescribeLocationHdfs(ctx context.Context, params *DescribeLocationHdfsInput, optFns ...func(*Options)) (*DescribeLocationHdfsOutput, error)

Returns metadata, such as the authentication information about the Hadoop Distributed File System (HDFS) location.

func (*Client) DescribeLocationNfs 

func (c *Client) DescribeLocationNfs(ctx context.Context, params *DescribeLocationNfsInput, optFns ...func(*Options)) (*DescribeLocationNfsOutput, error)

Returns metadata, such as the path information, about an NFS location.

func (*Client) DescribeLocationObjectStorage 

func (c *Client) DescribeLocationObjectStorage(ctx context.Context, params *DescribeLocationObjectStorageInput, optFns ...func(*Options)) (*DescribeLocationObjectStorageOutput, error)

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

func (*Client) DescribeLocationS3 

func (c *Client) DescribeLocationS3(ctx context.Context, params *DescribeLocationS3Input, optFns ...func(*Options)) (*DescribeLocationS3Output, error)

Returns metadata, such as bucket name, about an Amazon S3 bucket location.

func (*Client) DescribeLocationSmb 

func (c *Client) DescribeLocationSmb(ctx context.Context, params *DescribeLocationSmbInput, optFns ...func(*Options)) (*DescribeLocationSmbOutput, error)

Returns metadata, such as the path and user information about an SMB location.

func (*Client) DescribeTask 

func (c *Client) DescribeTask(ctx context.Context, params *DescribeTaskInput, optFns ...func(*Options)) (*DescribeTaskOutput, error)

Returns metadata about a task.

func (*Client) DescribeTaskExecution 

func (c *Client) DescribeTaskExecution(ctx context.Context, params *DescribeTaskExecutionInput, optFns ...func(*Options)) (*DescribeTaskExecutionOutput, error)

Returns detailed metadata about a task that is being executed.

func (*Client) ListAgents 

func (c *Client) ListAgents(ctx context.Context, params *ListAgentsInput, optFns ...func(*Options)) (*ListAgentsOutput, error)

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.

func (*Client) ListLocations 

func (c *Client) ListLocations(ctx context.Context, params *ListLocationsInput, optFns ...func(*Options)) (*ListLocationsOutput, error)

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.

func (*Client) ListTagsForResource 

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

Returns all the tags associated with a specified resource.

func (*Client) ListTaskExecutions 

func (c *Client) ListTaskExecutions(ctx context.Context, params *ListTaskExecutionsInput, optFns ...func(*Options)) (*ListTaskExecutionsOutput, error)

Returns a list of executed tasks.

func (*Client) ListTasks 

func (c *Client) ListTasks(ctx context.Context, params *ListTasksInput, optFns ...func(*Options)) (*ListTasksOutput, error)

Returns a list of all the tasks.

func (*Client) StartTaskExecution 

func (c *Client) StartTaskExecution(ctx context.Context, params *StartTaskExecutionInput, optFns ...func(*Options)) (*StartTaskExecutionOutput, error)

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.

func (*Client) TagResource 

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

Applies a key-value pair to an Amazon Web Services resource.

func (*Client) UntagResource 

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

Removes a tag from an Amazon Web Services resource.

func (*Client) UpdateAgent 

func (c *Client) UpdateAgent(ctx context.Context, params *UpdateAgentInput, optFns ...func(*Options)) (*UpdateAgentOutput, error)

Updates the name of an agent.

func (*Client) UpdateLocationHdfs added in v1.8.0 

func (c *Client) UpdateLocationHdfs(ctx context.Context, params *UpdateLocationHdfsInput, optFns ...func(*Options)) (*UpdateLocationHdfsOutput, error)

Updates some parameters of a previously created location for a Hadoop Distributed File System cluster.

func (*Client) UpdateLocationNfs added in v1.2.0 

func (c *Client) UpdateLocationNfs(ctx context.Context, params *UpdateLocationNfsInput, optFns ...func(*Options)) (*UpdateLocationNfsOutput, error)

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

func (*Client) UpdateLocationObjectStorage added in v1.2.0 

func (c *Client) UpdateLocationObjectStorage(ctx context.Context, params *UpdateLocationObjectStorageInput, optFns ...func(*Options)) (*UpdateLocationObjectStorageOutput, error)

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

func (*Client) UpdateLocationSmb added in v1.2.0 

func (c *Client) UpdateLocationSmb(ctx context.Context, params *UpdateLocationSmbInput, optFns ...func(*Options)) (*UpdateLocationSmbOutput, error)

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

func (*Client) UpdateTask 

func (c *Client) UpdateTask(ctx context.Context, params *UpdateTaskInput, optFns ...func(*Options)) (*UpdateTaskOutput, error)

Updates the metadata associated with a task.

func (*Client) UpdateTaskExecution added in v0.30.0 

func (c *Client) UpdateTaskExecution(ctx context.Context, params *UpdateTaskExecutionInput, optFns ...func(*Options)) (*UpdateTaskExecutionOutput, error)

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

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.
	//
	// This member is required.
	ActivationKey *string

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

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

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

	// 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 []types.TagListEntry

	// 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
	// contains filtered or unexported fields
}

CreateAgentRequest

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

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

CreateAgentResponse

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.
	//
	// This member is required.
	Ec2Config *types.Ec2Config

	// The Amazon Resource Name (ARN) for the Amazon EFS file system.
	//
	// This member is required.
	EfsFilesystemArn *string

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

	// 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 []types.TagListEntry
	// contains filtered or unexported fields
}

CreateLocationEfsRequest

type CreateLocationEfsOutput 

type CreateLocationEfsOutput struct {

	// The Amazon Resource Name (ARN) of the Amazon EFS file system location that is
	// created.
	LocationArn *string

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

CreateLocationEfs

type CreateLocationFsxLustreInput added in v1.10.0 

type CreateLocationFsxLustreInput struct {

	// The Amazon Resource Name (ARN) for the FSx for Lustre file system.
	//
	// This member is required.
	FsxFilesystemArn *string

	// The Amazon Resource Names (ARNs) of the security groups that are used to
	// configure the FSx for Lustre file system.
	//
	// This member is required.
	SecurityGroupArns []string

	// A subdirectory in the location's path. This subdirectory in the FSx for Lustre
	// file system is used to read data from the FSx for Lustre source location or
	// write data to the FSx for Lustre destination.
	Subdirectory *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 []types.TagListEntry
	// contains filtered or unexported fields
}

type CreateLocationFsxLustreOutput added in v1.10.0 

type CreateLocationFsxLustreOutput struct {

	// The Amazon Resource Name (ARN) of the FSx for Lustre file system location that's
	// created.
	LocationArn *string

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

type CreateLocationFsxWindowsInput 

type CreateLocationFsxWindowsInput struct {

	// The Amazon Resource Name (ARN) for the FSx for Windows File Server file system.
	//
	// This member is required.
	FsxFilesystemArn *string

	// The password of the user who has the permissions to access files and folders in
	// the FSx for Windows File Server file system.
	//
	// This member is required.
	Password *string

	// The Amazon Resource Names (ARNs) of the security groups that are used to
	// configure the FSx for Windows File Server file system.
	//
	// This member is required.
	SecurityGroupArns []string

	// 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.
	//
	// This member is required.
	User *string

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

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

	// 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 []types.TagListEntry
	// contains filtered or unexported fields
}

type CreateLocationFsxWindowsOutput 

type CreateLocationFsxWindowsOutput struct {

	// The Amazon Resource Name (ARN) of the FSx for Windows File Server file system
	// location that is created.
	LocationArn *string

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

type CreateLocationHdfsInput added in v1.8.0 

type CreateLocationHdfsInput struct {

	// The Amazon Resource Names (ARNs) of the agents that are used to connect to the
	// HDFS cluster.
	//
	// This member is required.
	AgentArns []string

	// The type of authentication used to determine the identity of the user.
	//
	// This member is required.
	AuthenticationType types.HdfsAuthenticationType

	// The NameNode that manages the HDFS namespace. The NameNode performs operations
	// such as opening, closing, and renaming files and directories. The NameNode
	// contains the information to map blocks of data to the DataNodes. You can use
	// only one NameNode.
	//
	// This member is required.
	NameNodes []types.HdfsNameNode

	// The size of data blocks to write into the HDFS cluster. The block size must be a
	// multiple of 512 bytes. The default block size is 128 mebibytes (MiB).
	BlockSize *int32

	// The Kerberos key table (keytab) that contains mappings between the defined
	// Kerberos principal and the encrypted keys. You can load the keytab from a file
	// by providing the file's address. If you're using the CLI, it performs base64
	// encoding for you. Otherwise, provide the base64-encoded text. If KERBEROS is
	// specified for AuthenticationType, this parameter is required.
	KerberosKeytab []byte

	// The krb5.conf file that contains the Kerberos configuration information. You can
	// load the krb5.conf file by providing the file's address. If you're using the
	// CLI, it performs the base64 encoding for you. Otherwise, provide the
	// base64-encoded text. If KERBEROS is specified for AuthenticationType, this
	// parameter is required.
	KerberosKrb5Conf []byte

	// The Kerberos principal with access to the files and folders on the HDFS cluster.
	// If KERBEROS is specified for AuthenticationType, this parameter is required.
	KerberosPrincipal *string

	// The URI of the HDFS cluster's Key Management Server (KMS).
	KmsKeyProviderUri *string

	// The Quality of Protection (QOP) configuration specifies the Remote Procedure
	// Call (RPC) and data transfer protection settings configured on the Hadoop
	// Distributed File System (HDFS) cluster. If QopConfiguration isn't specified,
	// RpcProtection and DataTransferProtection default to PRIVACY. If you set
	// RpcProtection or DataTransferProtection, the other parameter assumes the same
	// value.
	QopConfiguration *types.QopConfiguration

	// The number of DataNodes to replicate the data to when writing to the HDFS
	// cluster. By default, data is replicated to three DataNodes.
	ReplicationFactor *int32

	// The user name used to identify the client on the host operating system. If
	// SIMPLE is specified for AuthenticationType, this parameter is required.
	SimpleUser *string

	// A subdirectory in the HDFS cluster. This subdirectory is used to read data from
	// or write data to the HDFS cluster. If the subdirectory isn't specified, it will
	// default to /.
	Subdirectory *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 []types.TagListEntry
	// contains filtered or unexported fields
}

type CreateLocationHdfsOutput added in v1.8.0 

type CreateLocationHdfsOutput struct {

	// The ARN of the source HDFS cluster location that's created.
	LocationArn *string

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

type CreateLocationNfsInput 

type CreateLocationNfsInput struct {

	// 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.
	//
	// This member is required.
	OnPremConfig *types.OnPremConfig

	// 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.
	//
	// This member is required.
	ServerHostname *string

	// 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.
	//
	// This member is required.
	Subdirectory *string

	// The NFS mount options that DataSync can use to mount your NFS share.
	MountOptions *types.NfsMountOptions

	// 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 []types.TagListEntry
	// contains filtered or unexported fields
}

CreateLocationNfsRequest

type CreateLocationNfsOutput 

type CreateLocationNfsOutput struct {

	// The Amazon Resource Name (ARN) of the source NFS file system location that is
	// created.
	LocationArn *string

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

CreateLocationNfsResponse

type CreateLocationObjectStorageInput 

type CreateLocationObjectStorageInput struct {

	// The Amazon Resource Name (ARN) of the agents associated with the self-managed
	// object storage server location.
	//
	// This member is required.
	AgentArns []string

	// The bucket on the self-managed object storage server that is used to read data
	// from.
	//
	// This member is required.
	BucketName *string

	// 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.
	//
	// This member is required.
	ServerHostname *string

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

	// 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 *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). You can specify a custom port if your self-managed object storage
	// server requires one.
	ServerPort *int32

	// The protocol that the object storage server uses to communicate. Valid values
	// are HTTP or HTTPS.
	ServerProtocol types.ObjectStorageServerProtocol

	// The subdirectory in the self-managed object storage server that is used to read
	// data from.
	Subdirectory *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 []types.TagListEntry
	// contains filtered or unexported fields
}

CreateLocationObjectStorageRequest

type CreateLocationObjectStorageOutput 

type CreateLocationObjectStorageOutput struct {

	// The Amazon Resource Name (ARN) of the agents associated with the self-managed
	// object storage server location.
	LocationArn *string

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

CreateLocationObjectStorageResponse

type CreateLocationS3Input 

type CreateLocationS3Input struct {

	// The ARN of the Amazon S3 bucket. If the bucket is on an Amazon Web Services
	// Outpost, this must be an access point ARN.
	//
	// This member is required.
	S3BucketArn *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.
	//
	// This member is required.
	S3Config *types.S3Config

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

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

	// 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 []types.TagListEntry
	// contains filtered or unexported fields
}

CreateLocationS3Request

type CreateLocationS3Output 

type CreateLocationS3Output struct {

	// The Amazon Resource Name (ARN) of the source Amazon S3 bucket location that is
	// created.
	LocationArn *string

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

CreateLocationS3Response

type CreateLocationSmbInput 

type CreateLocationSmbInput struct {

	// The Amazon Resource Names (ARNs) of agents to use for a Simple Message Block
	// (SMB) location.
	//
	// This member is required.
	AgentArns []string

	// The password of the user who can mount the share, has the permissions to access
	// files and folders in the SMB share.
	//
	// This member is required.
	Password *string

	// 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.
	//
	// This member is required.
	ServerHostname *string

	// 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.
	//
	// This member is required.
	Subdirectory *string

	// 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.
	//
	// This member is required.
	User *string

	// The name of the Windows domain that the SMB server belongs to.
	Domain *string

	// The mount options used by DataSync to access the SMB server.
	MountOptions *types.SmbMountOptions

	// 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 []types.TagListEntry
	// contains filtered or unexported fields
}

CreateLocationSmbRequest

type CreateLocationSmbOutput 

type CreateLocationSmbOutput struct {

	// The Amazon Resource Name (ARN) of the source SMB file system location that is
	// created.
	LocationArn *string

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

CreateLocationSmbResponse

type CreateTaskInput 

type CreateTaskInput struct {

	// The Amazon Resource Name (ARN) of an Amazon Web Services storage resource's
	// location.
	//
	// This member is required.
	DestinationLocationArn *string

	// The Amazon Resource Name (ARN) of the source location for the task.
	//
	// This member is required.
	SourceLocationArn *string

	// The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that is used
	// to monitor and log events in the task.
	CloudWatchLogGroupArn *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 []types.FilterRule

	// A list of filter rules that determines which files to include when running a
	// task. The pattern contains 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 []types.FilterRule

	// The name of a task. This value is a text reference that is used to identify the
	// task in the console.
	Name *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 *types.Options

	// 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 *types.TaskSchedule

	// The key-value pair that represents the tag that you want to add to the resource.
	// The value can be an empty string.
	Tags []types.TagListEntry
	// contains filtered or unexported fields
}

CreateTaskRequest

type CreateTaskOutput 

type CreateTaskOutput struct {

	// The Amazon Resource Name (ARN) of the task.
	TaskArn *string

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

CreateTaskResponse

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.
	//
	// This member is required.
	AgentArn *string
	// contains filtered or unexported fields
}

DeleteAgentRequest

type DeleteAgentOutput 

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

type DeleteLocationInput 

type DeleteLocationInput struct {

	// The Amazon Resource Name (ARN) of the location to delete.
	//
	// This member is required.
	LocationArn *string
	// contains filtered or unexported fields
}

DeleteLocation

type DeleteLocationOutput 

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

type DeleteTaskInput 

type DeleteTaskInput struct {

	// The Amazon Resource Name (ARN) of the task to delete.
	//
	// This member is required.
	TaskArn *string
	// contains filtered or unexported fields
}

DeleteTask

type DeleteTaskOutput 

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

type DescribeAgentInput 

type DescribeAgentInput struct {

	// The Amazon Resource Name (ARN) of the agent to describe.
	//
	// This member is required.
	AgentArn *string
	// contains filtered or unexported fields
}

DescribeAgent

type DescribeAgentOutput 

type DescribeAgentOutput struct {

	// The Amazon Resource Name (ARN) of the agent.
	AgentArn *string

	// The time that the agent was activated (that is, created in your account).
	CreationTime *time.Time

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

	// The time that the agent last connected to DataSync.
	LastConnectionTime *time.Time

	// The name of the agent.
	Name *string

	// The subnet and the security group that DataSync used to access a VPC endpoint.
	PrivateLinkConfig *types.PrivateLinkConfig

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

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

DescribeAgentResponse

type DescribeLocationEfsInput 

type DescribeLocationEfsInput struct {

	// The Amazon Resource Name (ARN) of the EFS location to describe.
	//
	// This member is required.
	LocationArn *string
	// contains filtered or unexported fields
}

DescribeLocationEfsRequest

type DescribeLocationEfsOutput 

type DescribeLocationEfsOutput struct {

	// The time that the EFS location was created.
	CreationTime *time.Time

	// 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 *types.Ec2Config

	// The Amazon Resource Name (ARN) of the EFS location that was described.
	LocationArn *string

	// The URL of the EFS location that was described.
	LocationUri *string

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

DescribeLocationEfsResponse

type DescribeLocationFsxLustreInput added in v1.10.0 

type DescribeLocationFsxLustreInput struct {

	// The Amazon Resource Name (ARN) of the FSx for Lustre location to describe.
	//
	// This member is required.
	LocationArn *string
	// contains filtered or unexported fields
}

type DescribeLocationFsxLustreOutput added in v1.10.0 

type DescribeLocationFsxLustreOutput struct {

	// The time that the FSx for Lustre location was created.
	CreationTime *time.Time

	// The Amazon Resource Name (ARN) of the FSx for Lustre location that was
	// described.
	LocationArn *string

	// The URI of the FSx for Lustre location that was described.
	LocationUri *string

	// The Amazon Resource Names (ARNs) of the security groups that are configured for
	// the FSx for Lustre file system.
	SecurityGroupArns []string

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

type DescribeLocationFsxWindowsInput 

type DescribeLocationFsxWindowsInput struct {

	// The Amazon Resource Name (ARN) of the FSx for Windows File Server location to
	// describe.
	//
	// This member is required.
	LocationArn *string
	// contains filtered or unexported fields
}

type DescribeLocationFsxWindowsOutput 

type DescribeLocationFsxWindowsOutput struct {

	// The time that the FSx for Windows File Server location was created.
	CreationTime *time.Time

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

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

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

	// The Amazon Resource Names (ARNs) of the security groups that are configured for
	// the FSx for Windows File Server file system.
	SecurityGroupArns []string

	// The user who has the permissions to access files and folders in the FSx for
	// Windows File Server file system.
	User *string

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

type DescribeLocationHdfsInput added in v1.8.0 

type DescribeLocationHdfsInput struct {

	// The Amazon Resource Name (ARN) of the HDFS cluster location to describe.
	//
	// This member is required.
	LocationArn *string
	// contains filtered or unexported fields
}

type DescribeLocationHdfsOutput added in v1.8.0 

type DescribeLocationHdfsOutput struct {

	// The ARNs of the agents that are used to connect to the HDFS cluster.
	AgentArns []string

	// The type of authentication used to determine the identity of the user.
	AuthenticationType types.HdfsAuthenticationType

	// The size of the data blocks to write into the HDFS cluster.
	BlockSize *int32

	// The time that the HDFS location was created.
	CreationTime *time.Time

	// The Kerberos principal with access to the files and folders on the HDFS cluster.
	// This parameter is used if the AuthenticationType is defined as KERBEROS.
	KerberosPrincipal *string

	// The URI of the HDFS cluster's Key Management Server (KMS).
	KmsKeyProviderUri *string

	// The ARN of the HDFS cluster location.
	LocationArn *string

	// The URI of the HDFS cluster location.
	LocationUri *string

	// The NameNode that manage the HDFS namespace.
	NameNodes []types.HdfsNameNode

	// The Quality of Protection (QOP) configuration specifies the Remote Procedure
	// Call (RPC) and data transfer protection settings configured on the Hadoop
	// Distributed File System (HDFS) cluster.
	QopConfiguration *types.QopConfiguration

	// The number of DataNodes to replicate the data to when writing to the HDFS
	// cluster.
	ReplicationFactor *int32

	// The user name used to identify the client on the host operating system. This
	// parameter is used if the AuthenticationType is defined as SIMPLE.
	SimpleUser *string

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

type DescribeLocationNfsInput 

type DescribeLocationNfsInput struct {

	// The Amazon Resource Name (ARN) of the NFS location to describe.
	//
	// This member is required.
	LocationArn *string
	// contains filtered or unexported fields
}

DescribeLocationNfsRequest

type DescribeLocationNfsOutput 

type DescribeLocationNfsOutput struct {

	// The time that the NFS location was created.
	CreationTime *time.Time

	// The Amazon Resource Name (ARN) of the NFS location that was described.
	LocationArn *string

	// The URL of the source NFS location that was described.
	LocationUri *string

	// The NFS mount options that DataSync used to mount your NFS share.
	MountOptions *types.NfsMountOptions

	// A list of Amazon Resource Names (ARNs) of agents to use for a Network File
	// System (NFS) location.
	OnPremConfig *types.OnPremConfig

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

DescribeLocationNfsResponse

type DescribeLocationObjectStorageInput 

type DescribeLocationObjectStorageInput struct {

	// The Amazon Resource Name (ARN) of the self-managed object storage server
	// location that was described.
	//
	// This member is required.
	LocationArn *string
	// contains filtered or unexported fields
}

DescribeLocationObjectStorageRequest

type DescribeLocationObjectStorageOutput 

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

	// The Amazon Resource Name (ARN) of the agents associated with the self-managed
	// object storage server location.
	AgentArns []string

	// The time that the self-managed object storage server agent was created.
	CreationTime *time.Time

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

	// The URL of the source self-managed object storage server location that was
	// described.
	LocationUri *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 *int32

	// The protocol that the object storage server uses to communicate. Valid values
	// are HTTP or HTTPS.
	ServerProtocol types.ObjectStorageServerProtocol

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

DescribeLocationObjectStorageResponse

type DescribeLocationS3Input 

type DescribeLocationS3Input struct {

	// The Amazon Resource Name (ARN) of the Amazon S3 bucket location to describe.
	//
	// This member is required.
	LocationArn *string
	// contains filtered or unexported fields
}

DescribeLocationS3Request

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

	// The time that the Amazon S3 bucket location was created.
	CreationTime *time.Time

	// The Amazon Resource Name (ARN) of the Amazon S3 bucket or access point.
	LocationArn *string

	// The URL of the Amazon S3 location that was described.
	LocationUri *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 *types.S3Config

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

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

DescribeLocationS3Response

type DescribeLocationSmbInput 

type DescribeLocationSmbInput struct {

	// The Amazon Resource Name (ARN) of the SMB location to describe.
	//
	// This member is required.
	LocationArn *string
	// contains filtered or unexported fields
}

DescribeLocationSmbRequest

type DescribeLocationSmbOutput 

type DescribeLocationSmbOutput struct {

	// The Amazon Resource Name (ARN) of the source SMB file system location that is
	// created.
	AgentArns []string

	// The time that the SMB location was created.
	CreationTime *time.Time

	// The name of the Windows domain that the SMB server belongs to.
	Domain *string

	// The Amazon Resource Name (ARN) of the SMB location that was described.
	LocationArn *string

	// The URL of the source SMB location that was described.
	LocationUri *string

	// The mount options that are available for DataSync to use to access an SMB
	// location.
	MountOptions *types.SmbMountOptions

	// The user who can mount the share, has the permissions to access files and
	// folders in the SMB share.
	User *string

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

DescribeLocationSmbResponse

type DescribeTaskExecutionInput 

type DescribeTaskExecutionInput struct {

	// The Amazon Resource Name (ARN) of the task that is being executed.
	//
	// This member is required.
	TaskExecutionArn *string
	// contains filtered or unexported fields
}

DescribeTaskExecutionRequest

type DescribeTaskExecutionOutput 

type DescribeTaskExecutionOutput struct {

	// The physical number of bytes transferred over the network.
	BytesTransferred int64

	// The number of logical bytes written to the destination Amazon Web Services
	// storage resource.
	BytesWritten int64

	// The estimated physical number of bytes that is to be transferred over the
	// network.
	EstimatedBytesToTransfer int64

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

	// 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 []types.FilterRule

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

	// 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 []types.FilterRule

	// 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 *types.Options

	// The result of the task execution.
	Result *types.TaskExecutionResultDetail

	// The time that the task execution was started.
	StartTime *time.Time

	// The status of the task execution. For detailed information about task execution
	// statuses, see Understanding Task Statuses in the DataSync User Guide.
	Status types.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

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

DescribeTaskExecutionResponse

type DescribeTaskInput 

type DescribeTaskInput struct {

	// The Amazon Resource Name (ARN) of the task to describe.
	//
	// This member is required.
	TaskArn *string
	// contains filtered or unexported fields
}

DescribeTaskRequest

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

	// The time that the task was created.
	CreationTime *time.Time

	// The Amazon Resource Name (ARN) of the task execution that is syncing files.
	CurrentTaskExecutionArn *string

	// The Amazon Resource Name (ARN) of the Amazon Web Services storage resource's
	// location.
	DestinationLocationArn *string

	// The Amazon Resource Names (ARNs) of the destination elastic network interfaces
	// (ENIs) that were created for your subnet.
	DestinationNetworkInterfaceArns []string

	// Errors that DataSync encountered during execution of the task. You can use this
	// error code to help troubleshoot issues.
	ErrorCode *string

	// Detailed description of an error that was encountered during the task execution.
	// You can use this information to help troubleshoot issues.
	ErrorDetail *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 []types.FilterRule

	// A list of filter rules that determines which files to include when running a
	// task. The pattern contains 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 []types.FilterRule

	// The name of the task that was described.
	Name *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 *types.Options

	// The schedule used to periodically transfer files from a source to a destination
	// location.
	Schedule *types.TaskSchedule

	// The Amazon Resource Name (ARN) of the source file system's location.
	SourceLocationArn *string

	// The Amazon Resource Names (ARNs) of the source elastic network interfaces (ENIs)
	// that were created for your subnet.
	SourceNetworkInterfaceArns []string

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

	// The Amazon Resource Name (ARN) of the task that was described.
	TaskArn *string

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

DescribeTaskResponse

type EndpointResolver 

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

EndpointResolver interface for resolving service endpoints.

func EndpointResolverFromURL added in v1.1.0 

func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver

EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.

type EndpointResolverFunc 

type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)

EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.

func (EndpointResolverFunc) ResolveEndpoint 

func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)

type EndpointResolverOptions added in v0.29.0 

type EndpointResolverOptions = internalendpoints.Options

EndpointResolverOptions is the service endpoint resolver options

type HTTPClient 

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

type HTTPSignerV4 

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

type ListAgentsAPIClient added in v0.30.0 

type ListAgentsAPIClient interface {
	ListAgents(context.Context, *ListAgentsInput, ...func(*Options)) (*ListAgentsOutput, error)
}

ListAgentsAPIClient is a client that implements the ListAgents operation.

type ListAgentsInput 

type ListAgentsInput struct {

	// The maximum number of agents to list.
	MaxResults *int32

	// An opaque string that indicates the position at which to begin the next list of
	// agents.
	NextToken *string
	// contains filtered or unexported fields
}

ListAgentsRequest

type ListAgentsOutput 

type ListAgentsOutput struct {

	// A list of agents in your account.
	Agents []types.AgentListEntry

	// An opaque string that indicates the position at which to begin returning the
	// next list of agents.
	NextToken *string

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

ListAgentsResponse

type ListAgentsPaginator added in v0.30.0 

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

ListAgentsPaginator is a paginator for ListAgents

func NewListAgentsPaginator added in v0.30.0 

func NewListAgentsPaginator(client ListAgentsAPIClient, params *ListAgentsInput, optFns ...func(*ListAgentsPaginatorOptions)) *ListAgentsPaginator

NewListAgentsPaginator returns a new ListAgentsPaginator

func (*ListAgentsPaginator) HasMorePages added in v0.30.0 

func (p *ListAgentsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListAgentsPaginator) NextPage added in v0.30.0 

func (p *ListAgentsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListAgentsOutput, error)

NextPage retrieves the next ListAgents page.

type ListAgentsPaginatorOptions added in v0.30.0 

type ListAgentsPaginatorOptions struct {
	// The maximum number of agents to list.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListAgentsPaginatorOptions is the paginator options for ListAgents

type ListLocationsAPIClient added in v0.30.0 

type ListLocationsAPIClient interface {
	ListLocations(context.Context, *ListLocationsInput, ...func(*Options)) (*ListLocationsOutput, error)
}

ListLocationsAPIClient is a client that implements the ListLocations operation.

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 []types.LocationFilter

	// The maximum number of locations to return.
	MaxResults *int32

	// An opaque string that indicates the position at which to begin the next list of
	// locations.
	NextToken *string
	// contains filtered or unexported fields
}

ListLocationsRequest

type ListLocationsOutput 

type ListLocationsOutput struct {

	// An array that contains a list of locations.
	Locations []types.LocationListEntry

	// An opaque string that indicates the position at which to begin returning the
	// next list of locations.
	NextToken *string

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

ListLocationsResponse

type ListLocationsPaginator added in v0.30.0 

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

ListLocationsPaginator is a paginator for ListLocations

func NewListLocationsPaginator added in v0.30.0 

func NewListLocationsPaginator(client ListLocationsAPIClient, params *ListLocationsInput, optFns ...func(*ListLocationsPaginatorOptions)) *ListLocationsPaginator

NewListLocationsPaginator returns a new ListLocationsPaginator

func (*ListLocationsPaginator) HasMorePages added in v0.30.0 

func (p *ListLocationsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListLocationsPaginator) NextPage added in v0.30.0 

func (p *ListLocationsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListLocationsOutput, error)

NextPage retrieves the next ListLocations page.

type ListLocationsPaginatorOptions added in v0.30.0 

type ListLocationsPaginatorOptions struct {
	// The maximum number of locations to return.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListLocationsPaginatorOptions is the paginator options for ListLocations

type ListTagsForResourceAPIClient added in v0.30.0 

type ListTagsForResourceAPIClient interface {
	ListTagsForResource(context.Context, *ListTagsForResourceInput, ...func(*Options)) (*ListTagsForResourceOutput, error)
}

ListTagsForResourceAPIClient is a client that implements the ListTagsForResource operation.

type ListTagsForResourceInput 

type ListTagsForResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource whose tags to list.
	//
	// This member is required.
	ResourceArn *string

	// The maximum number of locations to return.
	MaxResults *int32

	// An opaque string that indicates the position at which to begin the next list of
	// locations.
	NextToken *string
	// contains filtered or unexported fields
}

ListTagsForResourceRequest

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

	// Array of resource tags.
	Tags []types.TagListEntry

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

ListTagsForResourceResponse

type ListTagsForResourcePaginator added in v0.30.0 

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

ListTagsForResourcePaginator is a paginator for ListTagsForResource

func NewListTagsForResourcePaginator added in v0.30.0 

func NewListTagsForResourcePaginator(client ListTagsForResourceAPIClient, params *ListTagsForResourceInput, optFns ...func(*ListTagsForResourcePaginatorOptions)) *ListTagsForResourcePaginator

NewListTagsForResourcePaginator returns a new ListTagsForResourcePaginator

func (*ListTagsForResourcePaginator) HasMorePages added in v0.30.0 

func (p *ListTagsForResourcePaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListTagsForResourcePaginator) NextPage added in v0.30.0 

func (p *ListTagsForResourcePaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)

NextPage retrieves the next ListTagsForResource page.

type ListTagsForResourcePaginatorOptions added in v0.30.0 

type ListTagsForResourcePaginatorOptions struct {
	// The maximum number of locations to return.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListTagsForResourcePaginatorOptions is the paginator options for ListTagsForResource

type ListTaskExecutionsAPIClient added in v0.30.0 

type ListTaskExecutionsAPIClient interface {
	ListTaskExecutions(context.Context, *ListTaskExecutionsInput, ...func(*Options)) (*ListTaskExecutionsOutput, error)
}

ListTaskExecutionsAPIClient is a client that implements the ListTaskExecutions operation.

type ListTaskExecutionsInput 

type ListTaskExecutionsInput struct {

	// The maximum number of executed tasks to list.
	MaxResults *int32

	// An opaque string that indicates the position at which to begin the next list of
	// the executed tasks.
	NextToken *string

	// The Amazon Resource Name (ARN) of the task whose tasks you want to list.
	TaskArn *string
	// contains filtered or unexported fields
}

ListTaskExecutions

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

	// A list of executed tasks.
	TaskExecutions []types.TaskExecutionListEntry

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

ListTaskExecutionsResponse

type ListTaskExecutionsPaginator added in v0.30.0 

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

ListTaskExecutionsPaginator is a paginator for ListTaskExecutions

func NewListTaskExecutionsPaginator added in v0.30.0 

func NewListTaskExecutionsPaginator(client ListTaskExecutionsAPIClient, params *ListTaskExecutionsInput, optFns ...func(*ListTaskExecutionsPaginatorOptions)) *ListTaskExecutionsPaginator

NewListTaskExecutionsPaginator returns a new ListTaskExecutionsPaginator

func (*ListTaskExecutionsPaginator) HasMorePages added in v0.30.0 

func (p *ListTaskExecutionsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListTaskExecutionsPaginator) NextPage added in v0.30.0 

func (p *ListTaskExecutionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListTaskExecutionsOutput, error)

NextPage retrieves the next ListTaskExecutions page.

type ListTaskExecutionsPaginatorOptions added in v0.30.0 

type ListTaskExecutionsPaginatorOptions struct {
	// The maximum number of executed tasks to list.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListTaskExecutionsPaginatorOptions is the paginator options for ListTaskExecutions

type ListTasksAPIClient added in v0.30.0 

type ListTasksAPIClient interface {
	ListTasks(context.Context, *ListTasksInput, ...func(*Options)) (*ListTasksOutput, error)
}

ListTasksAPIClient is a client that implements the ListTasks operation.

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 []types.TaskFilter

	// The maximum number of tasks to return.
	MaxResults *int32

	// An opaque string that indicates the position at which to begin the next list of
	// tasks.
	NextToken *string
	// contains filtered or unexported fields
}

ListTasksRequest

type ListTasksOutput 

type ListTasksOutput struct {

	// An opaque string that indicates the position at which to begin returning the
	// next list of tasks.
	NextToken *string

	// A list of all the tasks that are returned.
	Tasks []types.TaskListEntry

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

ListTasksResponse

type ListTasksPaginator added in v0.30.0 

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

ListTasksPaginator is a paginator for ListTasks

func NewListTasksPaginator added in v0.30.0 

func NewListTasksPaginator(client ListTasksAPIClient, params *ListTasksInput, optFns ...func(*ListTasksPaginatorOptions)) *ListTasksPaginator

NewListTasksPaginator returns a new ListTasksPaginator

func (*ListTasksPaginator) HasMorePages added in v0.30.0 

func (p *ListTasksPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListTasksPaginator) NextPage added in v0.30.0 

func (p *ListTasksPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListTasksOutput, error)

NextPage retrieves the next ListTasks page.

type ListTasksPaginatorOptions added in v0.30.0 

type ListTasksPaginatorOptions struct {
	// The maximum number of tasks to return.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListTasksPaginatorOptions is the paginator options for ListTasks

type Options 

type Options struct {
	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	APIOptions []func(*middleware.Stack) error

	// Configures the events that will be sent to the configured logger.
	ClientLogMode aws.ClientLogMode

	// The credentials object to use when signing requests.
	Credentials aws.CredentialsProvider

	// The configuration DefaultsMode that the SDK should use when constructing the
	// clients initial default settings.
	DefaultsMode aws.DefaultsMode

	// The endpoint options to be used when attempting to resolve an endpoint.
	EndpointOptions EndpointResolverOptions

	// The service endpoint resolver.
	EndpointResolver EndpointResolver

	// Signature Version 4 (SigV4) Signer
	HTTPSignerV4 HTTPSignerV4

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

	// The region to send requests to. (Required)
	Region string

	// RetryMaxAttempts specifies the maximum number attempts an API client will call
	// an operation that fails with a retryable error. A value of 0 is ignored, and
	// will not be used to configure the API client created default retryer, or modify
	// per operation call's retry max attempts. When creating a new API Clients this
	// member will only be used if the Retryer Options member is nil. This value will
	// be ignored if Retryer is not nil. If specified in an operation call's functional
	// options with a value that is different than the constructed client's Options,
	// the Client's Retryer will be wrapped to use the operation's specific
	// RetryMaxAttempts value.
	RetryMaxAttempts int

	// RetryMode specifies the retry mode the API client will be created with, if
	// Retryer option is not also specified. When creating a new API Clients this
	// member will only be used if the Retryer Options member is nil. This value will
	// be ignored if Retryer is not nil. Currently does not support per operation call
	// overrides, may in the future.
	RetryMode aws.RetryMode

	// Retryer guides how HTTP requests should be retried in case of recoverable
	// failures. When nil the API client will use a default retryer. The kind of
	// default retry created by the API client can be changed with the RetryMode
	// option.
	Retryer aws.Retryer

	// The RuntimeEnvironment configuration, only populated if the DefaultsMode is set
	// to DefaultsModeAuto and is initialized using config.LoadDefaultConfig. You
	// should not populate this structure programmatically, or rely on the values here
	// within your applications.
	RuntimeEnvironment aws.RuntimeEnvironment

	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
	// implementation if nil.
	HTTPClient HTTPClient
	// contains filtered or unexported fields
}

func (Options) Copy 

func (o Options) Copy() Options

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

type ResolveEndpoint 

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  EndpointResolverOptions
}

func (*ResolveEndpoint) HandleSerialize 

func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) (
	out middleware.SerializeOutput, metadata middleware.Metadata, err error,
)

func (*ResolveEndpoint) ID 

func (*ResolveEndpoint) ID() string

type StartTaskExecutionInput 

type StartTaskExecutionInput struct {

	// The Amazon Resource Name (ARN) of the task to start.
	//
	// This member is required.
	TaskArn *string

	// A list of filter rules that determines which files to exclude from a task. The
	// list contains 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 []types.FilterRule

	// 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 []types.FilterRule

	// 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 *types.Options
	// contains filtered or unexported fields
}

StartTaskExecutionRequest

type StartTaskExecutionOutput 

type StartTaskExecutionOutput struct {

	// The Amazon Resource Name (ARN) of the specific task execution that was started.
	TaskExecutionArn *string

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

StartTaskExecutionResponse

type TagResourceInput 

type TagResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource to apply the tag to.
	//
	// This member is required.
	ResourceArn *string

	// The tags to apply.
	//
	// This member is required.
	Tags []types.TagListEntry
	// contains filtered or unexported fields
}

TagResourceRequest

type TagResourceOutput 

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

type UntagResourceInput 

type UntagResourceInput struct {

	// The keys in the key-value pair in the tag to remove.
	//
	// This member is required.
	Keys []string

	// The Amazon Resource Name (ARN) of the resource to remove the tag from.
	//
	// This member is required.
	ResourceArn *string
	// contains filtered or unexported fields
}

UntagResourceRequest

type UntagResourceOutput 

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

type UpdateAgentInput 

type UpdateAgentInput struct {

	// The Amazon Resource Name (ARN) of the agent to update.
	//
	// This member is required.
	AgentArn *string

	// The name that you want to use to configure the agent.
	Name *string
	// contains filtered or unexported fields
}

UpdateAgentRequest

type UpdateAgentOutput 

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

type UpdateLocationHdfsInput added in v1.8.0 

type UpdateLocationHdfsInput struct {

	// The Amazon Resource Name (ARN) of the source HDFS cluster location.
	//
	// This member is required.
	LocationArn *string

	// The ARNs of the agents that are used to connect to the HDFS cluster.
	AgentArns []string

	// The type of authentication used to determine the identity of the user.
	AuthenticationType types.HdfsAuthenticationType

	// The size of the data blocks to write into the HDFS cluster.
	BlockSize *int32

	// The Kerberos key table (keytab) that contains mappings between the defined
	// Kerberos principal and the encrypted keys. You can load the keytab from a file
	// by providing the file's address. If you use the AWS CLI, it performs base64
	// encoding for you. Otherwise, provide the base64-encoded text.
	KerberosKeytab []byte

	// The krb5.conf file that contains the Kerberos configuration information. You can
	// load the krb5.conf file by providing the file's address. If you're using the AWS
	// CLI, it performs the base64 encoding for you. Otherwise, provide the
	// base64-encoded text.
	KerberosKrb5Conf []byte

	// The Kerberos principal with access to the files and folders on the HDFS cluster.
	KerberosPrincipal *string

	// The URI of the HDFS cluster's Key Management Server (KMS).
	KmsKeyProviderUri *string

	// The NameNode that manages the HDFS namespace. The NameNode performs operations
	// such as opening, closing, and renaming files and directories. The NameNode
	// contains the information to map blocks of data to the DataNodes. You can use
	// only one NameNode.
	NameNodes []types.HdfsNameNode

	// The Quality of Protection (QOP) configuration specifies the Remote Procedure
	// Call (RPC) and data transfer privacy settings configured on the Hadoop
	// Distributed File System (HDFS) cluster.
	QopConfiguration *types.QopConfiguration

	// The number of DataNodes to replicate the data to when writing to the HDFS
	// cluster.
	ReplicationFactor *int32

	// The user name used to identify the client on the host operating system.
	SimpleUser *string

	// A subdirectory in the HDFS cluster. This subdirectory is used to read data from
	// or write data to the HDFS cluster.
	Subdirectory *string
	// contains filtered or unexported fields
}

type UpdateLocationHdfsOutput added in v1.8.0 

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

type UpdateLocationNfsInput added in v1.2.0 

type UpdateLocationNfsInput struct {

	// The Amazon Resource Name (ARN) of the NFS location to update.
	//
	// This member is required.
	LocationArn *string

	// Represents the mount options that are available for DataSync to access an NFS
	// location.
	MountOptions *types.NfsMountOptions

	// A list of Amazon Resource Names (ARNs) of agents to use for a Network File
	// System (NFS) location.
	OnPremConfig *types.OnPremConfig

	// 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
	// contains filtered or unexported fields
}

type UpdateLocationNfsOutput added in v1.2.0 

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

type UpdateLocationObjectStorageInput added in v1.2.0 

type UpdateLocationObjectStorageInput struct {

	// The Amazon Resource Name (ARN) of the self-managed object storage server
	// location to be updated.
	//
	// This member is required.
	LocationArn *string

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

	// The Amazon Resource Name (ARN) of the agents associated with the self-managed
	// object storage server location.
	AgentArns []string

	// 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 *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). You can specify a custom port if your self-managed object storage
	// server requires one.
	ServerPort *int32

	// The protocol that the object storage server uses to communicate. Valid values
	// are HTTP or HTTPS.
	ServerProtocol types.ObjectStorageServerProtocol

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

type UpdateLocationObjectStorageOutput added in v1.2.0 

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

type UpdateLocationSmbInput added in v1.2.0 

type UpdateLocationSmbInput struct {

	// The Amazon Resource Name (ARN) of the SMB location to update.
	//
	// This member is required.
	LocationArn *string

	// The Amazon Resource Names (ARNs) of agents to use for a Simple Message Block
	// (SMB) location.
	AgentArns []string

	// The name of the Windows domain that the SMB server belongs to.
	Domain *string

	// Represents the mount options that are available for DataSync to access an SMB
	// location.
	MountOptions *types.SmbMountOptions

	// The password of the user who can mount the share has the permissions to access
	// files and folders in the SMB share.
	Password *string

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

	// The user who can mount the share has the permissions to access files and folders
	// in the SMB share.
	User *string
	// contains filtered or unexported fields
}

type UpdateLocationSmbOutput added in v1.2.0 

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

type UpdateTaskExecutionInput added in v0.30.0 

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).
	//
	// This member is required.
	Options *types.Options

	// The Amazon Resource Name (ARN) of the specific task execution that is being
	// updated.
	//
	// This member is required.
	TaskExecutionArn *string
	// contains filtered or unexported fields
}

type UpdateTaskExecutionOutput added in v0.30.0 

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

type UpdateTaskInput 

type UpdateTaskInput struct {

	// The Amazon Resource Name (ARN) of the resource name of the task to update.
	//
	// This member is required.
	TaskArn *string

	// The Amazon Resource Name (ARN) of the resource name of the Amazon CloudWatch log
	// group.
	CloudWatchLogGroupArn *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 []types.FilterRule

	// A list of filter rules that determines which files to include when running a
	// task. The pattern contains 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 []types.FilterRule

	// The name of the task to update.
	Name *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 *types.Options

	// 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 *types.TaskSchedule
	// contains filtered or unexported fields
}

UpdateTaskResponse

type UpdateTaskOutput 

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

Source Files

View all Source files

Directories

Path Synopsis
internal
endpoints

Jump to

Keyboard shortcuts

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