datasync

package
v0.24.0 Latest Latest
Warning

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

 Go to latest Published: Jul 22, 2020 License: Apache-2.0 Imports: 8 Imported by: 15

Documentation

Overview

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

AWS DataSync is a managed data transfer service that makes it simpler for you to automate moving data between on-premises storage and Amazon Simple Storage Service (Amazon S3) or Amazon Elastic File System (Amazon EFS).

This API interface reference for AWS DataSync contains documentation for a programming interface that you can use to manage AWS DataSync.

See https://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09 for more information on this service.

See datasync package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/datasync/

Using the Client

To use DataSync with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the DataSync client for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/datasync/#New

Index

Constants

View Source 
const (
	ServiceName = "DataSync" // Service's name
	ServiceID   = "DataSync" // Service's identifier
	EndpointsID = "datasync" // Service's Endpoint identifier
)
View Source 
const (

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

	// ErrCodeInvalidRequestException for service response error code
	// "InvalidRequestException".
	//
	// This exception is thrown when the client submits a malformed request.
	ErrCodeInvalidRequestException = "InvalidRequestException"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type AgentListEntry 

type AgentListEntry struct {

	// The Amazon Resource Name (ARN) of the agent.
	AgentArn *string `type:"string"`

	// The name of the agent.
	Name *string `min:"1" type:"string"`

	// The status of the agent.
	Status AgentStatus `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

Represents a single entry in a list of agents. AgentListEntry returns an array that contains a list of agents when the ListAgents operation is called.

func (AgentListEntry) String 

func (s AgentListEntry) String() string

String returns the string representation

type AgentStatus 

type AgentStatus string
const (
	AgentStatusOnline  AgentStatus = "ONLINE"
	AgentStatusOffline AgentStatus = "OFFLINE"
)

Enum values for AgentStatus

func (AgentStatus) MarshalValue 

func (enum AgentStatus) MarshalValue() (string, error)

func (AgentStatus) MarshalValueBuf 

func (enum AgentStatus) MarshalValueBuf(b []byte) ([]byte, error)

type Atime 

type Atime string
const (
	AtimeNone       Atime = "NONE"
	AtimeBestEffort Atime = "BEST_EFFORT"
)

Enum values for Atime

func (Atime) MarshalValue 

func (enum Atime) MarshalValue() (string, error)

func (Atime) MarshalValueBuf 

func (enum Atime) MarshalValueBuf(b []byte) ([]byte, error)

type CancelTaskExecutionInput 

type CancelTaskExecutionInput struct {

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

CancelTaskExecutionRequest

func (CancelTaskExecutionInput) String 

func (s CancelTaskExecutionInput) String() string

String returns the string representation

func (*CancelTaskExecutionInput) Validate 

func (s *CancelTaskExecutionInput) Validate() error

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

type CancelTaskExecutionOutput 

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

func (CancelTaskExecutionOutput) String 

func (s CancelTaskExecutionOutput) String() string

String returns the string representation

type CancelTaskExecutionRequest 

type CancelTaskExecutionRequest struct {
	*aws.Request
	Input *CancelTaskExecutionInput
	Copy  func(*CancelTaskExecutionInput) CancelTaskExecutionRequest
}

CancelTaskExecutionRequest is the request type for the CancelTaskExecution API operation.

func (CancelTaskExecutionRequest) Send 

func (r CancelTaskExecutionRequest) Send(ctx context.Context) (*CancelTaskExecutionResponse, error)

Send marshals and sends the CancelTaskExecution API request.

type CancelTaskExecutionResponse added in v0.9.0 

type CancelTaskExecutionResponse struct {
	*CancelTaskExecutionOutput
	// contains filtered or unexported fields
}

CancelTaskExecutionResponse is the response type for the CancelTaskExecution API operation.

func (*CancelTaskExecutionResponse) SDKResponseMetdata added in v0.9.0 

func (r *CancelTaskExecutionResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CancelTaskExecution request.

type Client added in v0.9.0 

type Client struct {
	*aws.Client
}

Client provides the API operation methods for making requests to DataSync. See this package's package overview docs for details on the service.

The client's methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New 

func New(config aws.Config) *Client

New creates a new instance of the client from the provided Config.

Example: 

// Create a client from just a config.
svc := datasync.New(myConfig)

func (*Client) CancelTaskExecutionRequest added in v0.9.0 

func (c *Client) CancelTaskExecutionRequest(input *CancelTaskExecutionInput) CancelTaskExecutionRequest

CancelTaskExecutionRequest returns a request value for making API operation for AWS DataSync.

Cancels execution of a task.

When you cancel a task execution, the transfer of some files are abruptly interrupted. The contents of files that are transferred to the destination might be incomplete or inconsistent with the source files. However, if you start a new task execution on the same task and you allow the task execution to complete, file content on the destination is complete and consistent. This applies to other unexpected failures that interrupt a task execution. In all of these cases, AWS DataSync successfully complete the transfer when you start the next task execution. 

// Example sending a request using CancelTaskExecutionRequest.
req := client.CancelTaskExecutionRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/CancelTaskExecution

func (*Client) CreateAgentRequest added in v0.9.0 

func (c *Client) CreateAgentRequest(input *CreateAgentInput) CreateAgentRequest

CreateAgentRequest returns a request value for making API operation for AWS DataSync.

Activates an AWS DataSync agent that you have deployed on your host. The activation process associates your agent with your account. In the activation process, you specify information such as the AWS Region that you want to activate the agent in. You activate the agent in the AWS Region where your target locations (in Amazon S3 or Amazon EFS) reside. Your tasks are created in this AWS Region.

You can activate the agent in a VPC (Virtual private Cloud) or provide the agent access to a VPC endpoint so you can run tasks without going over the public Internet.

You can use an agent for more than one location. If a task uses multiple agents, all of them need to have status AVAILABLE for the task to run. If you use multiple agents for a source location, the status of all the agents must be AVAILABLE for the task to run.

Agents are automatically updated by AWS on a regular basis, using a mechanism that ensures minimal interruption to your tasks. 

// Example sending a request using CreateAgentRequest.
req := client.CreateAgentRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/CreateAgent

func (*Client) CreateLocationEfsRequest added in v0.9.0 

func (c *Client) CreateLocationEfsRequest(input *CreateLocationEfsInput) CreateLocationEfsRequest

CreateLocationEfsRequest returns a request value for making API operation for AWS DataSync.

Creates an endpoint for an Amazon EFS file system. 

// Example sending a request using CreateLocationEfsRequest.
req := client.CreateLocationEfsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/CreateLocationEfs

func (*Client) CreateLocationFsxWindowsRequest added in v0.19.0 

func (c *Client) CreateLocationFsxWindowsRequest(input *CreateLocationFsxWindowsInput) CreateLocationFsxWindowsRequest

CreateLocationFsxWindowsRequest returns a request value for making API operation for AWS DataSync.

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

// Example sending a request using CreateLocationFsxWindowsRequest.
req := client.CreateLocationFsxWindowsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) CreateLocationNfsRequest added in v0.9.0 

func (c *Client) CreateLocationNfsRequest(input *CreateLocationNfsInput) CreateLocationNfsRequest

CreateLocationNfsRequest returns a request value for making API operation for AWS DataSync.

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

// Example sending a request using CreateLocationNfsRequest.
req := client.CreateLocationNfsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/CreateLocationNfs

func (*Client) CreateLocationS3Request added in v0.9.0 

func (c *Client) CreateLocationS3Request(input *CreateLocationS3Input) CreateLocationS3Request

CreateLocationS3Request returns a request value for making API operation for AWS DataSync.

Creates an endpoint for an Amazon S3 bucket.

For AWS DataSync to access a destination S3 bucket, it needs an AWS Identity and Access Management (IAM) role that has the required permissions. You can set up the required permissions by creating an IAM policy that grants the required permissions and attaching the policy to the role. An example of such a policy is shown in the examples section.

For more information, see https://docs.aws.amazon.com/datasync/latest/userguide/working-with-locations.html#create-s3-location in the AWS DataSync User Guide. 

// Example sending a request using CreateLocationS3Request.
req := client.CreateLocationS3Request(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/CreateLocationS3

func (*Client) CreateLocationSmbRequest added in v0.11.0 

func (c *Client) CreateLocationSmbRequest(input *CreateLocationSmbInput) CreateLocationSmbRequest

CreateLocationSmbRequest returns a request value for making API operation for AWS DataSync.

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

// Example sending a request using CreateLocationSmbRequest.
req := client.CreateLocationSmbRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/CreateLocationSmb

func (*Client) CreateTaskRequest added in v0.9.0 

func (c *Client) CreateTaskRequest(input *CreateTaskInput) CreateTaskRequest

CreateTaskRequest returns a request value for making API operation for AWS DataSync.

Creates a task. A task is a set of two locations (source and destination) and a set of Options that you use to control the behavior of a task. If you don't specify Options when you create a task, AWS DataSync populates them with service defaults.

When you create a task, it first enters the CREATING state. During CREATING AWS DataSync attempts to mount the on-premises Network File System (NFS) location. The task transitions to the AVAILABLE state without waiting for the AWS location to become mounted. If required, AWS DataSync mounts the AWS location before each task execution.

If an agent that is associated with a source (NFS) location goes offline, the task transitions to the UNAVAILABLE status. If the status of the task remains in the CREATING status for more than a few minutes, it means that your agent might be having trouble mounting the source NFS file system. Check the task's ErrorCode and ErrorDetail. Mount issues are often caused by either a misconfigured firewall or a mistyped NFS server host name. 

// Example sending a request using CreateTaskRequest.
req := client.CreateTaskRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/CreateTask

func (*Client) DeleteAgentRequest added in v0.9.0 

func (c *Client) DeleteAgentRequest(input *DeleteAgentInput) DeleteAgentRequest

DeleteAgentRequest returns a request value for making API operation for AWS DataSync.

Deletes an agent. To specify which agent to delete, use the Amazon Resource Name (ARN) of the agent in your request. The operation disassociates the agent from your AWS account. However, it doesn't delete the agent virtual machine (VM) from your on-premises environment. 

// Example sending a request using DeleteAgentRequest.
req := client.DeleteAgentRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/DeleteAgent

func (*Client) DeleteLocationRequest added in v0.9.0 

func (c *Client) DeleteLocationRequest(input *DeleteLocationInput) DeleteLocationRequest

DeleteLocationRequest returns a request value for making API operation for AWS DataSync.

Deletes the configuration of a location used by AWS DataSync. 

// Example sending a request using DeleteLocationRequest.
req := client.DeleteLocationRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/DeleteLocation

func (*Client) DeleteTaskRequest added in v0.9.0 

func (c *Client) DeleteTaskRequest(input *DeleteTaskInput) DeleteTaskRequest

DeleteTaskRequest returns a request value for making API operation for AWS DataSync.

Deletes a task. 

// Example sending a request using DeleteTaskRequest.
req := client.DeleteTaskRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/DeleteTask

func (*Client) DescribeAgentRequest added in v0.9.0 

func (c *Client) DescribeAgentRequest(input *DescribeAgentInput) DescribeAgentRequest

DescribeAgentRequest returns a request value for making API operation for AWS DataSync.

Returns metadata such as the name, the network interfaces, and the status (that is, whether the agent is running or not) for an agent. To specify which agent to describe, use the Amazon Resource Name (ARN) of the agent in your request. 

// Example sending a request using DescribeAgentRequest.
req := client.DescribeAgentRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/DescribeAgent

func (*Client) DescribeLocationEfsRequest added in v0.9.0 

func (c *Client) DescribeLocationEfsRequest(input *DescribeLocationEfsInput) DescribeLocationEfsRequest

DescribeLocationEfsRequest returns a request value for making API operation for AWS DataSync.

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

// Example sending a request using DescribeLocationEfsRequest.
req := client.DescribeLocationEfsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/DescribeLocationEfs

func (*Client) DescribeLocationFsxWindowsRequest added in v0.19.0 

func (c *Client) DescribeLocationFsxWindowsRequest(input *DescribeLocationFsxWindowsInput) DescribeLocationFsxWindowsRequest

DescribeLocationFsxWindowsRequest returns a request value for making API operation for AWS DataSync.

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

// Example sending a request using DescribeLocationFsxWindowsRequest.
req := client.DescribeLocationFsxWindowsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

func (*Client) DescribeLocationNfsRequest added in v0.9.0 

func (c *Client) DescribeLocationNfsRequest(input *DescribeLocationNfsInput) DescribeLocationNfsRequest

DescribeLocationNfsRequest returns a request value for making API operation for AWS DataSync.

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

// Example sending a request using DescribeLocationNfsRequest.
req := client.DescribeLocationNfsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/DescribeLocationNfs

func (*Client) DescribeLocationS3Request added in v0.9.0 

func (c *Client) DescribeLocationS3Request(input *DescribeLocationS3Input) DescribeLocationS3Request

DescribeLocationS3Request returns a request value for making API operation for AWS DataSync.

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

// Example sending a request using DescribeLocationS3Request.
req := client.DescribeLocationS3Request(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/DescribeLocationS3

func (*Client) DescribeLocationSmbRequest added in v0.11.0 

func (c *Client) DescribeLocationSmbRequest(input *DescribeLocationSmbInput) DescribeLocationSmbRequest

DescribeLocationSmbRequest returns a request value for making API operation for AWS DataSync.

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

// Example sending a request using DescribeLocationSmbRequest.
req := client.DescribeLocationSmbRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/DescribeLocationSmb

func (*Client) DescribeTaskExecutionRequest added in v0.9.0 

func (c *Client) DescribeTaskExecutionRequest(input *DescribeTaskExecutionInput) DescribeTaskExecutionRequest

DescribeTaskExecutionRequest returns a request value for making API operation for AWS DataSync.

Returns detailed metadata about a task that is being executed. 

// Example sending a request using DescribeTaskExecutionRequest.
req := client.DescribeTaskExecutionRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/DescribeTaskExecution

func (*Client) DescribeTaskRequest added in v0.9.0 

func (c *Client) DescribeTaskRequest(input *DescribeTaskInput) DescribeTaskRequest

DescribeTaskRequest returns a request value for making API operation for AWS DataSync.

Returns metadata about a task. 

// Example sending a request using DescribeTaskRequest.
req := client.DescribeTaskRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/DescribeTask

func (*Client) ListAgentsRequest added in v0.9.0 

func (c *Client) ListAgentsRequest(input *ListAgentsInput) ListAgentsRequest

ListAgentsRequest returns a request value for making API operation for AWS DataSync.

Returns a list of agents owned by an AWS account in the AWS Region specified in the request. The returned list is ordered by agent Amazon Resource Name (ARN).

By default, this operation returns a maximum of 100 agents. This operation supports pagination that enables you to optionally reduce the number of agents returned in a response.

If you have more agents than are returned in a response (that is, the response returns only a truncated list of your agents), the response contains a marker that you can specify in your next request to fetch the next page of agents. 

// Example sending a request using ListAgentsRequest.
req := client.ListAgentsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/ListAgents

func (*Client) ListLocationsRequest added in v0.9.0 

func (c *Client) ListLocationsRequest(input *ListLocationsInput) ListLocationsRequest

ListLocationsRequest returns a request value for making API operation for AWS DataSync.

Returns a lists of source and destination locations.

If you have more locations than are returned in a response (that is, the response returns only a truncated list of your agents), the response contains a token that you can specify in your next request to fetch the next page of locations. 

// Example sending a request using ListLocationsRequest.
req := client.ListLocationsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/ListLocations

func (*Client) ListTagsForResourceRequest added in v0.9.0 

func (c *Client) ListTagsForResourceRequest(input *ListTagsForResourceInput) ListTagsForResourceRequest

ListTagsForResourceRequest returns a request value for making API operation for AWS DataSync.

Returns all the tags associated with a specified resources. 

// Example sending a request using ListTagsForResourceRequest.
req := client.ListTagsForResourceRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/ListTagsForResource

func (*Client) ListTaskExecutionsRequest added in v0.9.0 

func (c *Client) ListTaskExecutionsRequest(input *ListTaskExecutionsInput) ListTaskExecutionsRequest

ListTaskExecutionsRequest returns a request value for making API operation for AWS DataSync.

Returns a list of executed tasks. 

// Example sending a request using ListTaskExecutionsRequest.
req := client.ListTaskExecutionsRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/ListTaskExecutions

func (*Client) ListTasksRequest added in v0.9.0 

func (c *Client) ListTasksRequest(input *ListTasksInput) ListTasksRequest

ListTasksRequest returns a request value for making API operation for AWS DataSync.

Returns a list of all the tasks. 

// Example sending a request using ListTasksRequest.
req := client.ListTasksRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/ListTasks

func (*Client) StartTaskExecutionRequest added in v0.9.0 

func (c *Client) StartTaskExecutionRequest(input *StartTaskExecutionInput) StartTaskExecutionRequest

StartTaskExecutionRequest returns a request value for making API operation for AWS DataSync.

Starts a specific invocation of a task. A TaskExecution value represents an individual run of a task. Each task can have at most one TaskExecution at a time.

TaskExecution has the following transition phases: INITIALIZING | PREPARING | TRANSFERRING | VERIFYING | SUCCESS/FAILURE.

For detailed information, see the Task Execution section in the Components and Terminology topic in the AWS DataSync User Guide. 

// Example sending a request using StartTaskExecutionRequest.
req := client.StartTaskExecutionRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/StartTaskExecution

func (*Client) TagResourceRequest added in v0.9.0 

func (c *Client) TagResourceRequest(input *TagResourceInput) TagResourceRequest

TagResourceRequest returns a request value for making API operation for AWS DataSync.

Applies a key-value pair to an AWS resource. 

// Example sending a request using TagResourceRequest.
req := client.TagResourceRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/TagResource

func (*Client) UntagResourceRequest added in v0.9.0 

func (c *Client) UntagResourceRequest(input *UntagResourceInput) UntagResourceRequest

UntagResourceRequest returns a request value for making API operation for AWS DataSync.

Removes a tag from an AWS resource. 

// Example sending a request using UntagResourceRequest.
req := client.UntagResourceRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/UntagResource

func (*Client) UpdateAgentRequest added in v0.9.0 

func (c *Client) UpdateAgentRequest(input *UpdateAgentInput) UpdateAgentRequest

UpdateAgentRequest returns a request value for making API operation for AWS DataSync.

Updates the name of an agent. 

// Example sending a request using UpdateAgentRequest.
req := client.UpdateAgentRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

Please also see https://docs.aws.amazon.com/goto/WebAPI/datasync-2018-11-09/UpdateAgent

func (*Client) UpdateTaskRequest added in v0.9.0 

func (c *Client) UpdateTaskRequest(input *UpdateTaskInput) UpdateTaskRequest

UpdateTaskRequest returns a request value for making API operation for AWS DataSync.

Updates the metadata associated with a task. 

// Example sending a request using UpdateTaskRequest.
req := client.UpdateTaskRequest(params)
resp, err := req.Send(context.TODO())
if err == nil {
    fmt.Println(resp)
}

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

type CreateAgentInput 

type CreateAgentInput struct {

	// Your agent activation key. You can get the activation key either by sending
	// an HTTP GET request with redirects that enable you to get the agent IP address
	// (port 80). Alternatively, you can get it from the AWS DataSync console.
	//
	// The redirect URL returned in the response provides you the activation key
	// for your agent in the query string parameter activationKey. It might also
	// include other activation-related parameters; however, these are merely defaults.
	// The arguments you pass to this API call determine the actual configuration
	// of your agent.
	//
	// For more information, see Activating an Agent in the AWS DataSync User Guide.
	//
	// ActivationKey is a required field
	ActivationKey *string `type:"string" required:"true"`

	// The name you configured for your agent. This value is a text reference that
	// is used to identify the agent in the console.
	AgentName *string `min:"1" type:"string"`

	// The ARNs of the security groups used to protect your data transfer task subnets.
	// See CreateAgentRequest$SubnetArns.
	SecurityGroupArns []string `min:"1" type:"list"`

	// The Amazon Resource Names (ARNs) of the subnets in which DataSync will create
	// elastic network interfaces for each data transfer task. The agent that runs
	// a task must be private. When you start a task that is associated with an
	// agent created in a VPC, or one that has access to an IP address in a VPC,
	// then the task is also private. In this case, DataSync creates four network
	// interfaces for each task in your subnet. For a data transfer to work, the
	// agent must be able to route to all these four network interfaces.
	SubnetArns []string `min:"1" type:"list"`

	// The key-value pair that represents the tag that you want to associate with
	// the agent. The value can be an empty string. This value helps you manage,
	// filter, and search for your agents.
	//
	// Valid characters for key and value are letters, spaces, and numbers representable
	// in UTF-8 format, and the following special characters: + - = . _ : / @.
	Tags []TagListEntry `type:"list"`

	// The ID of the VPC (Virtual Private Cloud) endpoint that the agent has access
	// to. This is the client-side VPC endpoint, also called a PrivateLink. If you
	// don't have a PrivateLink VPC endpoint, see Creating a VPC Endpoint Service
	// Configuration (https://docs.aws.amazon.com/vpc/latest/userguide/endpoint-service.html#create-endpoint-service)
	// in the AWS VPC User Guide.
	//
	// VPC endpoint ID looks like this: vpce-01234d5aff67890e1.
	VpcEndpointId *string `type:"string"`
	// contains filtered or unexported fields
}

CreateAgentRequest

func (CreateAgentInput) String 

func (s CreateAgentInput) String() string

String returns the string representation

func (*CreateAgentInput) Validate 

func (s *CreateAgentInput) Validate() error

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

type CreateAgentOutput 

type CreateAgentOutput struct {

	// The Amazon Resource Name (ARN) of the agent. Use the ListAgents operation
	// to return a list of agents for your account and AWS Region.
	AgentArn *string `type:"string"`
	// contains filtered or unexported fields
}

CreateAgentResponse

func (CreateAgentOutput) String 

func (s CreateAgentOutput) String() string

String returns the string representation

type CreateAgentRequest 

type CreateAgentRequest struct {
	*aws.Request
	Input *CreateAgentInput
	Copy  func(*CreateAgentInput) CreateAgentRequest
}

CreateAgentRequest is the request type for the CreateAgent API operation.

func (CreateAgentRequest) Send 

func (r CreateAgentRequest) Send(ctx context.Context) (*CreateAgentResponse, error)

Send marshals and sends the CreateAgent API request.

type CreateAgentResponse added in v0.9.0 

type CreateAgentResponse struct {
	*CreateAgentOutput
	// contains filtered or unexported fields
}

CreateAgentResponse is the response type for the CreateAgent API operation.

func (*CreateAgentResponse) SDKResponseMetdata added in v0.9.0 

func (r *CreateAgentResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CreateAgent request.

type CreateLocationEfsInput 

type CreateLocationEfsInput struct {

	// The subnet and security group that the Amazon EFS file system uses. The security
	// group that you provide needs to be able to communicate with the security
	// group on the mount target in the subnet specified.
	//
	// The exact relationship between security group M (of the mount target) and
	// security group S (which you provide for DataSync to use at this stage) is
	// as follows:
	//
	//    * Security group M (which you associate with the mount target) must allow
	//    inbound access for the Transmission Control Protocol (TCP) on the NFS
	//    port (2049) from security group S. You can enable inbound connections
	//    either by IP address (CIDR range) or security group.
	//
	//    * Security group S (provided to DataSync to access EFS) should have a
	//    rule that enables outbound connections to the NFS port on one of the file
	//    system’s mount targets. You can enable outbound connections either by
	//    IP address (CIDR range) or security group. For information about security
	//    groups and mount targets, see Security Groups for Amazon EC2 Instances
	//    and Mount Targets in the Amazon EFS User Guide.
	//
	// Ec2Config is a required field
	Ec2Config *Ec2Config `type:"structure" required:"true"`

	// The Amazon Resource Name (ARN) for the Amazon EFS file system.
	//
	// EfsFilesystemArn is a required field
	EfsFilesystemArn *string `type:"string" required:"true"`

	// A subdirectory in the location’s path. This subdirectory in the EFS file
	// system is used to read data from the EFS source location or write data to
	// the EFS destination. By default, AWS DataSync uses the root directory.
	//
	// Subdirectory must be specified with forward slashes. For example /path/to/folder.
	Subdirectory *string `type:"string"`

	// The key-value pair that represents a tag that you want to add to the resource.
	// The value can be an empty string. This value helps you manage, filter, and
	// search for your resources. We recommend that you create a name tag for your
	// location.
	Tags []TagListEntry `type:"list"`
	// contains filtered or unexported fields
}

CreateLocationEfsRequest

func (CreateLocationEfsInput) String 

func (s CreateLocationEfsInput) String() string

String returns the string representation

func (*CreateLocationEfsInput) Validate 

func (s *CreateLocationEfsInput) Validate() error

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

type CreateLocationEfsOutput 

type CreateLocationEfsOutput struct {

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

CreateLocationEfs

func (CreateLocationEfsOutput) String 

func (s CreateLocationEfsOutput) String() string

String returns the string representation

type CreateLocationEfsRequest 

type CreateLocationEfsRequest struct {
	*aws.Request
	Input *CreateLocationEfsInput
	Copy  func(*CreateLocationEfsInput) CreateLocationEfsRequest
}

CreateLocationEfsRequest is the request type for the CreateLocationEfs API operation.

func (CreateLocationEfsRequest) Send 

func (r CreateLocationEfsRequest) Send(ctx context.Context) (*CreateLocationEfsResponse, error)

Send marshals and sends the CreateLocationEfs API request.

type CreateLocationEfsResponse added in v0.9.0 

type CreateLocationEfsResponse struct {
	*CreateLocationEfsOutput
	// contains filtered or unexported fields
}

CreateLocationEfsResponse is the response type for the CreateLocationEfs API operation.

func (*CreateLocationEfsResponse) SDKResponseMetdata added in v0.9.0 

func (r *CreateLocationEfsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CreateLocationEfs request.

type CreateLocationFsxWindowsInput added in v0.19.0 

type CreateLocationFsxWindowsInput struct {

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

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

	// The password of the user who has the permissions to access files and folders
	// in the FSx for Windows file system.
	//
	// Password is a required field
	Password *string `type:"string" required:"true" sensitive:"true"`

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

	// A subdirectory in the location’s path. This subdirectory in the Amazon
	// FSx for Windows file system is used to read data from the Amazon FSx for
	// Windows source location or write data to the FSx for Windows destination.
	Subdirectory *string `type:"string"`

	// The key-value pair that represents a tag that you want to add to the resource.
	// The value can be an empty string. This value helps you manage, filter, and
	// search for your resources. We recommend that you create a name tag for your
	// location.
	Tags []TagListEntry `type:"list"`

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

func (CreateLocationFsxWindowsInput) String added in v0.19.0 

func (s CreateLocationFsxWindowsInput) String() string

String returns the string representation

func (*CreateLocationFsxWindowsInput) Validate added in v0.19.0 

func (s *CreateLocationFsxWindowsInput) Validate() error

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

type CreateLocationFsxWindowsOutput added in v0.19.0 

type CreateLocationFsxWindowsOutput struct {

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

func (CreateLocationFsxWindowsOutput) String added in v0.19.0 

func (s CreateLocationFsxWindowsOutput) String() string

String returns the string representation

type CreateLocationFsxWindowsRequest added in v0.19.0 

type CreateLocationFsxWindowsRequest struct {
	*aws.Request
	Input *CreateLocationFsxWindowsInput
	Copy  func(*CreateLocationFsxWindowsInput) CreateLocationFsxWindowsRequest
}

CreateLocationFsxWindowsRequest is the request type for the CreateLocationFsxWindows API operation.

func (CreateLocationFsxWindowsRequest) Send added in v0.19.0 

func (r CreateLocationFsxWindowsRequest) Send(ctx context.Context) (*CreateLocationFsxWindowsResponse, error)

Send marshals and sends the CreateLocationFsxWindows API request.

type CreateLocationFsxWindowsResponse added in v0.19.0 

type CreateLocationFsxWindowsResponse struct {
	*CreateLocationFsxWindowsOutput
	// contains filtered or unexported fields
}

CreateLocationFsxWindowsResponse is the response type for the CreateLocationFsxWindows API operation.

func (*CreateLocationFsxWindowsResponse) SDKResponseMetdata added in v0.19.0 

func (r *CreateLocationFsxWindowsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CreateLocationFsxWindows request.

type CreateLocationNfsInput 

type CreateLocationNfsInput struct {

	// The NFS mount options that DataSync can use to mount your NFS share.
	MountOptions *NfsMountOptions `type:"structure"`

	// Contains a list of Amazon Resource Names (ARNs) of agents that are used to
	// connect to an NFS server.
	//
	// OnPremConfig is a required field
	OnPremConfig *OnPremConfig `type:"structure" required:"true"`

	// The name of the NFS server. This value is the IP address or Domain Name Service
	// (DNS) name of the NFS server. An agent that is installed on-premises uses
	// this host name to mount the NFS server in a network.
	//
	// This name must either be DNS-compliant or must be an IP version 4 (IPv4)
	// address.
	//
	// ServerHostname is a required field
	ServerHostname *string `type:"string" required:"true"`

	// The subdirectory in the NFS file system that is used to read data from the
	// NFS source location or write data to the NFS destination. The NFS path should
	// be a path that's exported by the NFS server, or a subdirectory of that path.
	// The path should be such that it can be mounted by other NFS clients in your
	// network.
	//
	// To see all the paths exported by your NFS server. run "showmount -e nfs-server-name"
	// from an NFS client that has access to your server. You can specify any directory
	// that appears in the results, and any subdirectory of that directory. Ensure
	// that the NFS export is accessible without Kerberos authentication.
	//
	// To transfer all the data in the folder you specified, DataSync needs to have
	// permissions to read all the data. To ensure this, either configure the NFS
	// export with no_root_squash, or ensure that the permissions for all of the
	// files that you want DataSync allow read access for all users. Doing either
	// enables the agent to read the files. For the agent to access directories,
	// you must additionally enable all execute access.
	//
	// For information about NFS export configuration, see 18.7. The /etc/exports
	// Configuration File in the Red Hat Enterprise Linux documentation.
	//
	// Subdirectory is a required field
	Subdirectory *string `type:"string" required:"true"`

	// The key-value pair that represents the tag that you want to add to the location.
	// The value can be an empty string. We recommend using tags to name your resources.
	Tags []TagListEntry `type:"list"`
	// contains filtered or unexported fields
}

CreateLocationNfsRequest

func (CreateLocationNfsInput) String 

func (s CreateLocationNfsInput) String() string

String returns the string representation

func (*CreateLocationNfsInput) Validate 

func (s *CreateLocationNfsInput) Validate() error

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

type CreateLocationNfsOutput 

type CreateLocationNfsOutput struct {

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

CreateLocationNfsResponse

func (CreateLocationNfsOutput) String 

func (s CreateLocationNfsOutput) String() string

String returns the string representation

type CreateLocationNfsRequest 

type CreateLocationNfsRequest struct {
	*aws.Request
	Input *CreateLocationNfsInput
	Copy  func(*CreateLocationNfsInput) CreateLocationNfsRequest
}

CreateLocationNfsRequest is the request type for the CreateLocationNfs API operation.

func (CreateLocationNfsRequest) Send 

func (r CreateLocationNfsRequest) Send(ctx context.Context) (*CreateLocationNfsResponse, error)

Send marshals and sends the CreateLocationNfs API request.

type CreateLocationNfsResponse added in v0.9.0 

type CreateLocationNfsResponse struct {
	*CreateLocationNfsOutput
	// contains filtered or unexported fields
}

CreateLocationNfsResponse is the response type for the CreateLocationNfs API operation.

func (*CreateLocationNfsResponse) SDKResponseMetdata added in v0.9.0 

func (r *CreateLocationNfsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CreateLocationNfs request.

type CreateLocationS3Input 

type CreateLocationS3Input struct {

	// The Amazon Resource Name (ARN) of the Amazon S3 bucket.
	//
	// S3BucketArn is a required field
	S3BucketArn *string `type:"string" required:"true"`

	// The Amazon Resource Name (ARN) of the AWS Identity and Access Management
	// (IAM) role that is used to access an Amazon S3 bucket.
	//
	// For detailed information about using such a role, see Creating a Location
	// for Amazon S3 in the AWS DataSync User Guide.
	//
	// S3Config is a required field
	S3Config *S3Config `type:"structure" required:"true"`

	// The Amazon S3 storage class that you want to store your files in when this
	// location is used as a task destination. For more information about S3 storage
	// classes, see Amazon S3 Storage Classes (https://aws.amazon.com/s3/storage-classes/)
	// in the Amazon Simple Storage Service Developer Guide. Some storage classes
	// have behaviors that can affect your S3 storage cost. For detailed information,
	// see using-storage-classes.
	S3StorageClass S3StorageClass `type:"string" enum:"true"`

	// A subdirectory in the Amazon S3 bucket. This subdirectory in Amazon S3 is
	// used to read data from the S3 source location or write data to the S3 destination.
	Subdirectory *string `type:"string"`

	// The key-value pair that represents the tag that you want to add to the location.
	// The value can be an empty string. We recommend using tags to name your resources.
	Tags []TagListEntry `type:"list"`
	// contains filtered or unexported fields
}

CreateLocationS3Request

func (CreateLocationS3Input) String 

func (s CreateLocationS3Input) String() string

String returns the string representation

func (*CreateLocationS3Input) Validate 

func (s *CreateLocationS3Input) Validate() error

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

type CreateLocationS3Output 

type CreateLocationS3Output struct {

	// The Amazon Resource Name (ARN) of the source Amazon S3 bucket location that
	// is created.
	LocationArn *string `type:"string"`
	// contains filtered or unexported fields
}

CreateLocationS3Response

func (CreateLocationS3Output) String 

func (s CreateLocationS3Output) String() string

String returns the string representation

type CreateLocationS3Request 

type CreateLocationS3Request struct {
	*aws.Request
	Input *CreateLocationS3Input
	Copy  func(*CreateLocationS3Input) CreateLocationS3Request
}

CreateLocationS3Request is the request type for the CreateLocationS3 API operation.

func (CreateLocationS3Request) Send 

func (r CreateLocationS3Request) Send(ctx context.Context) (*CreateLocationS3Response, error)

Send marshals and sends the CreateLocationS3 API request.

type CreateLocationS3Response added in v0.9.0 

type CreateLocationS3Response struct {
	*CreateLocationS3Output
	// contains filtered or unexported fields
}

CreateLocationS3Response is the response type for the CreateLocationS3 API operation.

func (*CreateLocationS3Response) SDKResponseMetdata added in v0.9.0 

func (r *CreateLocationS3Response) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CreateLocationS3 request.

type CreateLocationSmbInput added in v0.11.0 

type CreateLocationSmbInput struct {

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

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

	// The mount options used by DataSync to access the SMB server.
	MountOptions *SmbMountOptions `type:"structure"`

	// The password of the user who can mount the share, has the permissions to
	// access files and folders in the SMB share.
	//
	// Password is a required field
	Password *string `type:"string" required:"true" sensitive:"true"`

	// The name of the SMB server. This value is the IP address or Domain Name Service
	// (DNS) name of the SMB server. An agent that is installed on-premises uses
	// this hostname to mount the SMB server in a network.
	//
	// This name must either be DNS-compliant or must be an IP version 4 (IPv4)
	// address.
	//
	// ServerHostname is a required field
	ServerHostname *string `type:"string" required:"true"`

	// The subdirectory in the SMB file system that is used to read data from the
	// SMB source location or write data to the SMB destination. The SMB path should
	// be a path that's exported by the SMB server, or a subdirectory of that path.
	// The path should be such that it can be mounted by other SMB clients in your
	// network.
	//
	// Subdirectory must be specified with forward slashes. For example /path/to/folder.
	//
	// To transfer all the data in the folder you specified, DataSync needs to have
	// permissions to mount the SMB share, as well as to access all the data in
	// that share. To ensure this, either ensure that the user/password specified
	// belongs to the user who can mount the share, and who has the appropriate
	// permissions for all of the files and directories that you want DataSync to
	// access, or use credentials of a member of the Backup Operators group to mount
	// the share. Doing either enables the agent to access the data. For the agent
	// to access directories, you must additionally enable all execute access.
	//
	// Subdirectory is a required field
	Subdirectory *string `type:"string" required:"true"`

	// The key-value pair that represents the tag that you want to add to the location.
	// The value can be an empty string. We recommend using tags to name your resources.
	Tags []TagListEntry `type:"list"`

	// The user who can mount the share, has the permissions to access files and
	// folders in the SMB share.
	//
	// User is a required field
	User *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

CreateLocationSmbRequest

func (CreateLocationSmbInput) String added in v0.11.0 

func (s CreateLocationSmbInput) String() string

String returns the string representation

func (*CreateLocationSmbInput) Validate added in v0.11.0 

func (s *CreateLocationSmbInput) Validate() error

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

type CreateLocationSmbOutput added in v0.11.0 

type CreateLocationSmbOutput struct {

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

CreateLocationSmbResponse

func (CreateLocationSmbOutput) String added in v0.11.0 

func (s CreateLocationSmbOutput) String() string

String returns the string representation

type CreateLocationSmbRequest added in v0.11.0 

type CreateLocationSmbRequest struct {
	*aws.Request
	Input *CreateLocationSmbInput
	Copy  func(*CreateLocationSmbInput) CreateLocationSmbRequest
}

CreateLocationSmbRequest is the request type for the CreateLocationSmb API operation.

func (CreateLocationSmbRequest) Send added in v0.11.0 

func (r CreateLocationSmbRequest) Send(ctx context.Context) (*CreateLocationSmbResponse, error)

Send marshals and sends the CreateLocationSmb API request.

type CreateLocationSmbResponse added in v0.11.0 

type CreateLocationSmbResponse struct {
	*CreateLocationSmbOutput
	// contains filtered or unexported fields
}

CreateLocationSmbResponse is the response type for the CreateLocationSmb API operation.

func (*CreateLocationSmbResponse) SDKResponseMetdata added in v0.11.0 

func (r *CreateLocationSmbResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CreateLocationSmb request.

type CreateTaskInput 

type CreateTaskInput struct {

	// The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that is
	// used to monitor and log events in the task.
	//
	// For more information on these groups, see Working with Log Groups and Log
	// Streams in the Amazon CloudWatch User Guide.
	//
	// For more information about how to use CloudWatch Logs with DataSync, see
	// Monitoring Your Task in the AWS DataSync User Guide.
	CloudWatchLogGroupArn *string `type:"string"`

	// The Amazon Resource Name (ARN) of an AWS storage resource's location.
	//
	// DestinationLocationArn is a required field
	DestinationLocationArn *string `type:"string" required:"true"`

	// A list of filter rules that determines which files to exclude from a task.
	// The list should contain a single filter string that consists of the patterns
	// to exclude. The patterns are delimited by "|" (that is, a pipe), for example,
	// "/folder1|/folder2"
	Excludes []FilterRule `type:"list"`

	// The name of a task. This value is a text reference that is used to identify
	// the task in the console.
	Name *string `min:"1" type:"string"`

	// The set of configuration options that control the behavior of a single execution
	// of the task that occurs when you call StartTaskExecution. You can configure
	// these options to preserve metadata such as user ID (UID) and group ID (GID),
	// file permissions, data integrity verification, and so on.
	//
	// For each individual task execution, you can override these options by specifying
	// the OverrideOptions before starting a the task execution. For more information,
	// see the operation.
	Options *Options `type:"structure"`

	// 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 task-scheduling.
	Schedule *TaskSchedule `type:"structure"`

	// The Amazon Resource Name (ARN) of the source location for the task.
	//
	// SourceLocationArn is a required field
	SourceLocationArn *string `type:"string" required:"true"`

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

CreateTaskRequest

func (CreateTaskInput) String 

func (s CreateTaskInput) String() string

String returns the string representation

func (*CreateTaskInput) Validate 

func (s *CreateTaskInput) Validate() error

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

type CreateTaskOutput 

type CreateTaskOutput struct {

	// The Amazon Resource Name (ARN) of the task.
	TaskArn *string `type:"string"`
	// contains filtered or unexported fields
}

CreateTaskResponse

func (CreateTaskOutput) String 

func (s CreateTaskOutput) String() string

String returns the string representation

type CreateTaskRequest 

type CreateTaskRequest struct {
	*aws.Request
	Input *CreateTaskInput
	Copy  func(*CreateTaskInput) CreateTaskRequest
}

CreateTaskRequest is the request type for the CreateTask API operation.

func (CreateTaskRequest) Send 

func (r CreateTaskRequest) Send(ctx context.Context) (*CreateTaskResponse, error)

Send marshals and sends the CreateTask API request.

type CreateTaskResponse added in v0.9.0 

type CreateTaskResponse struct {
	*CreateTaskOutput
	// contains filtered or unexported fields
}

CreateTaskResponse is the response type for the CreateTask API operation.

func (*CreateTaskResponse) SDKResponseMetdata added in v0.9.0 

func (r *CreateTaskResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the CreateTask request.

type DeleteAgentInput 

type DeleteAgentInput struct {

	// The Amazon Resource Name (ARN) of the agent to delete. Use the ListAgents
	// operation to return a list of agents for your account and AWS Region.
	//
	// AgentArn is a required field
	AgentArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

DeleteAgentRequest

func (DeleteAgentInput) String 

func (s DeleteAgentInput) String() string

String returns the string representation

func (*DeleteAgentInput) Validate 

func (s *DeleteAgentInput) Validate() error

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

type DeleteAgentOutput 

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

func (DeleteAgentOutput) String 

func (s DeleteAgentOutput) String() string

String returns the string representation

type DeleteAgentRequest 

type DeleteAgentRequest struct {
	*aws.Request
	Input *DeleteAgentInput
	Copy  func(*DeleteAgentInput) DeleteAgentRequest
}

DeleteAgentRequest is the request type for the DeleteAgent API operation.

func (DeleteAgentRequest) Send 

func (r DeleteAgentRequest) Send(ctx context.Context) (*DeleteAgentResponse, error)

Send marshals and sends the DeleteAgent API request.

type DeleteAgentResponse added in v0.9.0 

type DeleteAgentResponse struct {
	*DeleteAgentOutput
	// contains filtered or unexported fields
}

DeleteAgentResponse is the response type for the DeleteAgent API operation.

func (*DeleteAgentResponse) SDKResponseMetdata added in v0.9.0 

func (r *DeleteAgentResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeleteAgent request.

type DeleteLocationInput 

type DeleteLocationInput struct {

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

DeleteLocation

func (DeleteLocationInput) String 

func (s DeleteLocationInput) String() string

String returns the string representation

func (*DeleteLocationInput) Validate 

func (s *DeleteLocationInput) Validate() error

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

type DeleteLocationOutput 

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

func (DeleteLocationOutput) String 

func (s DeleteLocationOutput) String() string

String returns the string representation

type DeleteLocationRequest 

type DeleteLocationRequest struct {
	*aws.Request
	Input *DeleteLocationInput
	Copy  func(*DeleteLocationInput) DeleteLocationRequest
}

DeleteLocationRequest is the request type for the DeleteLocation API operation.

func (DeleteLocationRequest) Send 

func (r DeleteLocationRequest) Send(ctx context.Context) (*DeleteLocationResponse, error)

Send marshals and sends the DeleteLocation API request.

type DeleteLocationResponse added in v0.9.0 

type DeleteLocationResponse struct {
	*DeleteLocationOutput
	// contains filtered or unexported fields
}

DeleteLocationResponse is the response type for the DeleteLocation API operation.

func (*DeleteLocationResponse) SDKResponseMetdata added in v0.9.0 

func (r *DeleteLocationResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeleteLocation request.

type DeleteTaskInput 

type DeleteTaskInput struct {

	// The Amazon Resource Name (ARN) of the task to delete.
	//
	// TaskArn is a required field
	TaskArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

DeleteTask

func (DeleteTaskInput) String 

func (s DeleteTaskInput) String() string

String returns the string representation

func (*DeleteTaskInput) Validate 

func (s *DeleteTaskInput) Validate() error

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

type DeleteTaskOutput 

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

func (DeleteTaskOutput) String 

func (s DeleteTaskOutput) String() string

String returns the string representation

type DeleteTaskRequest 

type DeleteTaskRequest struct {
	*aws.Request
	Input *DeleteTaskInput
	Copy  func(*DeleteTaskInput) DeleteTaskRequest
}

DeleteTaskRequest is the request type for the DeleteTask API operation.

func (DeleteTaskRequest) Send 

func (r DeleteTaskRequest) Send(ctx context.Context) (*DeleteTaskResponse, error)

Send marshals and sends the DeleteTask API request.

type DeleteTaskResponse added in v0.9.0 

type DeleteTaskResponse struct {
	*DeleteTaskOutput
	// contains filtered or unexported fields
}

DeleteTaskResponse is the response type for the DeleteTask API operation.

func (*DeleteTaskResponse) SDKResponseMetdata added in v0.9.0 

func (r *DeleteTaskResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DeleteTask request.

type DescribeAgentInput 

type DescribeAgentInput struct {

	// The Amazon Resource Name (ARN) of the agent to describe.
	//
	// AgentArn is a required field
	AgentArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

DescribeAgent

func (DescribeAgentInput) String 

func (s DescribeAgentInput) String() string

String returns the string representation

func (*DescribeAgentInput) Validate 

func (s *DescribeAgentInput) Validate() error

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

type DescribeAgentOutput 

type DescribeAgentOutput struct {

	// The Amazon Resource Name (ARN) of the agent.
	AgentArn *string `type:"string"`

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

	// The type of endpoint that your agent is connected to. If the endpoint is
	// a VPC endpoint, the agent is not accessible over the public Internet.
	EndpointType EndpointType `type:"string" enum:"true"`

	// The time that the agent last connected to DataSyc.
	LastConnectionTime *time.Time `type:"timestamp"`

	// The name of the agent.
	Name *string `min:"1" type:"string"`

	// The subnet and the security group that DataSync used to access a VPC endpoint.
	PrivateLinkConfig *PrivateLinkConfig `type:"structure"`

	// The status of the agent. If the status is ONLINE, then the agent is configured
	// properly and is available to use. The Running status is the normal running
	// status for an agent. If the status is OFFLINE, the agent's VM is turned off
	// or the agent is in an unhealthy state. When the issue that caused the unhealthy
	// state is resolved, the agent returns to ONLINE status.
	Status AgentStatus `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

DescribeAgentResponse

func (DescribeAgentOutput) String 

func (s DescribeAgentOutput) String() string

String returns the string representation

type DescribeAgentRequest 

type DescribeAgentRequest struct {
	*aws.Request
	Input *DescribeAgentInput
	Copy  func(*DescribeAgentInput) DescribeAgentRequest
}

DescribeAgentRequest is the request type for the DescribeAgent API operation.

func (DescribeAgentRequest) Send 

func (r DescribeAgentRequest) Send(ctx context.Context) (*DescribeAgentResponse, error)

Send marshals and sends the DescribeAgent API request.

type DescribeAgentResponse added in v0.9.0 

type DescribeAgentResponse struct {
	*DescribeAgentOutput
	// contains filtered or unexported fields
}

DescribeAgentResponse is the response type for the DescribeAgent API operation.

func (*DescribeAgentResponse) SDKResponseMetdata added in v0.9.0 

func (r *DescribeAgentResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeAgent request.

type DescribeLocationEfsInput 

type DescribeLocationEfsInput struct {

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

DescribeLocationEfsRequest

func (DescribeLocationEfsInput) String 

func (s DescribeLocationEfsInput) String() string

String returns the string representation

func (*DescribeLocationEfsInput) Validate 

func (s *DescribeLocationEfsInput) Validate() error

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

type DescribeLocationEfsOutput 

type DescribeLocationEfsOutput struct {

	// The time that the EFS location was created.
	CreationTime *time.Time `type:"timestamp"`

	// The subnet and the security group that DataSync uses to access target EFS
	// file system. The subnet must have at least one mount target for that file
	// system. The security group that you provide needs to be able to communicate
	// with the security group on the mount target in the subnet specified.
	Ec2Config *Ec2Config `type:"structure"`

	// The Amazon resource Name (ARN) of the EFS location that was described.
	LocationArn *string `type:"string"`

	// The URL of the EFS location that was described.
	LocationUri *string `type:"string"`
	// contains filtered or unexported fields
}

DescribeLocationEfsResponse

func (DescribeLocationEfsOutput) String 

func (s DescribeLocationEfsOutput) String() string

String returns the string representation

type DescribeLocationEfsRequest 

type DescribeLocationEfsRequest struct {
	*aws.Request
	Input *DescribeLocationEfsInput
	Copy  func(*DescribeLocationEfsInput) DescribeLocationEfsRequest
}

DescribeLocationEfsRequest is the request type for the DescribeLocationEfs API operation.

func (DescribeLocationEfsRequest) Send 

func (r DescribeLocationEfsRequest) Send(ctx context.Context) (*DescribeLocationEfsResponse, error)

Send marshals and sends the DescribeLocationEfs API request.

type DescribeLocationEfsResponse added in v0.9.0 

type DescribeLocationEfsResponse struct {
	*DescribeLocationEfsOutput
	// contains filtered or unexported fields
}

DescribeLocationEfsResponse is the response type for the DescribeLocationEfs API operation.

func (*DescribeLocationEfsResponse) SDKResponseMetdata added in v0.9.0 

func (r *DescribeLocationEfsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeLocationEfs request.

type DescribeLocationFsxWindowsInput added in v0.19.0 

type DescribeLocationFsxWindowsInput struct {

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

func (DescribeLocationFsxWindowsInput) String added in v0.19.0 

func (s DescribeLocationFsxWindowsInput) String() string

String returns the string representation

func (*DescribeLocationFsxWindowsInput) Validate added in v0.19.0 

func (s *DescribeLocationFsxWindowsInput) Validate() error

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

type DescribeLocationFsxWindowsOutput added in v0.19.0 

type DescribeLocationFsxWindowsOutput struct {

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

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

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

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

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

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

func (DescribeLocationFsxWindowsOutput) String added in v0.19.0 

func (s DescribeLocationFsxWindowsOutput) String() string

String returns the string representation

type DescribeLocationFsxWindowsRequest added in v0.19.0 

type DescribeLocationFsxWindowsRequest struct {
	*aws.Request
	Input *DescribeLocationFsxWindowsInput
	Copy  func(*DescribeLocationFsxWindowsInput) DescribeLocationFsxWindowsRequest
}

DescribeLocationFsxWindowsRequest is the request type for the DescribeLocationFsxWindows API operation.

func (DescribeLocationFsxWindowsRequest) Send added in v0.19.0 

func (r DescribeLocationFsxWindowsRequest) Send(ctx context.Context) (*DescribeLocationFsxWindowsResponse, error)

Send marshals and sends the DescribeLocationFsxWindows API request.

type DescribeLocationFsxWindowsResponse added in v0.19.0 

type DescribeLocationFsxWindowsResponse struct {
	*DescribeLocationFsxWindowsOutput
	// contains filtered or unexported fields
}

DescribeLocationFsxWindowsResponse is the response type for the DescribeLocationFsxWindows API operation.

func (*DescribeLocationFsxWindowsResponse) SDKResponseMetdata added in v0.19.0 

func (r *DescribeLocationFsxWindowsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeLocationFsxWindows request.

type DescribeLocationNfsInput 

type DescribeLocationNfsInput struct {

	// The Amazon resource Name (ARN) of the NFS location to describe.
	//
	// LocationArn is a required field
	LocationArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

DescribeLocationNfsRequest

func (DescribeLocationNfsInput) String 

func (s DescribeLocationNfsInput) String() string

String returns the string representation

func (*DescribeLocationNfsInput) Validate 

func (s *DescribeLocationNfsInput) Validate() error

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

type DescribeLocationNfsOutput 

type DescribeLocationNfsOutput struct {

	// The time that the NFS location was created.
	CreationTime *time.Time `type:"timestamp"`

	// The Amazon resource Name (ARN) of the NFS location that was described.
	LocationArn *string `type:"string"`

	// The URL of the source NFS location that was described.
	LocationUri *string `type:"string"`

	// The NFS mount options that DataSync used to mount your NFS share.
	MountOptions *NfsMountOptions `type:"structure"`

	// A list of Amazon Resource Names (ARNs) of agents to use for a Network File
	// System (NFS) location.
	OnPremConfig *OnPremConfig `type:"structure"`
	// contains filtered or unexported fields
}

DescribeLocationNfsResponse

func (DescribeLocationNfsOutput) String 

func (s DescribeLocationNfsOutput) String() string

String returns the string representation

type DescribeLocationNfsRequest 

type DescribeLocationNfsRequest struct {
	*aws.Request
	Input *DescribeLocationNfsInput
	Copy  func(*DescribeLocationNfsInput) DescribeLocationNfsRequest
}

DescribeLocationNfsRequest is the request type for the DescribeLocationNfs API operation.

func (DescribeLocationNfsRequest) Send 

func (r DescribeLocationNfsRequest) Send(ctx context.Context) (*DescribeLocationNfsResponse, error)

Send marshals and sends the DescribeLocationNfs API request.

type DescribeLocationNfsResponse added in v0.9.0 

type DescribeLocationNfsResponse struct {
	*DescribeLocationNfsOutput
	// contains filtered or unexported fields
}

DescribeLocationNfsResponse is the response type for the DescribeLocationNfs API operation.

func (*DescribeLocationNfsResponse) SDKResponseMetdata added in v0.9.0 

func (r *DescribeLocationNfsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeLocationNfs request.

type DescribeLocationS3Input 

type DescribeLocationS3Input struct {

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

DescribeLocationS3Request

func (DescribeLocationS3Input) String 

func (s DescribeLocationS3Input) String() string

String returns the string representation

func (*DescribeLocationS3Input) Validate 

func (s *DescribeLocationS3Input) Validate() error

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

type DescribeLocationS3Output 

type DescribeLocationS3Output struct {

	// The time that the Amazon S3 bucket location was created.
	CreationTime *time.Time `type:"timestamp"`

	// The Amazon Resource Name (ARN) of the Amazon S3 bucket location.
	LocationArn *string `type:"string"`

	// The URL of the Amazon S3 location that was described.
	LocationUri *string `type:"string"`

	// The Amazon Resource Name (ARN) of the AWS Identity and Access Management
	// (IAM) role that is used to access an Amazon S3 bucket.
	//
	// For detailed information about using such a role, see Creating a Location
	// for Amazon S3 in the AWS DataSync User Guide.
	S3Config *S3Config `type:"structure"`

	// The Amazon S3 storage class that you chose to store your files in when this
	// location is used as a task destination. For more information about S3 storage
	// classes, see Amazon S3 Storage Classes (https://aws.amazon.com/s3/storage-classes/)
	// in the Amazon Simple Storage Service Developer Guide. Some storage classes
	// have behaviors that can affect your S3 storage cost. For detailed information,
	// see using-storage-classes.
	S3StorageClass S3StorageClass `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

DescribeLocationS3Response

func (DescribeLocationS3Output) String 

func (s DescribeLocationS3Output) String() string

String returns the string representation

type DescribeLocationS3Request 

type DescribeLocationS3Request struct {
	*aws.Request
	Input *DescribeLocationS3Input
	Copy  func(*DescribeLocationS3Input) DescribeLocationS3Request
}

DescribeLocationS3Request is the request type for the DescribeLocationS3 API operation.

func (DescribeLocationS3Request) Send 

func (r DescribeLocationS3Request) Send(ctx context.Context) (*DescribeLocationS3Response, error)

Send marshals and sends the DescribeLocationS3 API request.

type DescribeLocationS3Response added in v0.9.0 

type DescribeLocationS3Response struct {
	*DescribeLocationS3Output
	// contains filtered or unexported fields
}

DescribeLocationS3Response is the response type for the DescribeLocationS3 API operation.

func (*DescribeLocationS3Response) SDKResponseMetdata added in v0.9.0 

func (r *DescribeLocationS3Response) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeLocationS3 request.

type DescribeLocationSmbInput added in v0.11.0 

type DescribeLocationSmbInput struct {

	// The Amazon resource Name (ARN) of the SMB location to describe.
	//
	// LocationArn is a required field
	LocationArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

DescribeLocationSmbRequest

func (DescribeLocationSmbInput) String added in v0.11.0 

func (s DescribeLocationSmbInput) String() string

String returns the string representation

func (*DescribeLocationSmbInput) Validate added in v0.11.0 

func (s *DescribeLocationSmbInput) Validate() error

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

type DescribeLocationSmbOutput added in v0.11.0 

type DescribeLocationSmbOutput struct {

	// The Amazon Resource Name (ARN) of the source SMB file system location that
	// is created.
	AgentArns []string `min:"1" type:"list"`

	// The time that the SMB location was created.
	CreationTime *time.Time `type:"timestamp"`

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

	// The Amazon resource Name (ARN) of the SMB location that was described.
	LocationArn *string `type:"string"`

	// The URL of the source SBM location that was described.
	LocationUri *string `type:"string"`

	// The mount options that are available for DataSync to use to access an SMB
	// location.
	MountOptions *SmbMountOptions `type:"structure"`

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

DescribeLocationSmbResponse

func (DescribeLocationSmbOutput) String added in v0.11.0 

func (s DescribeLocationSmbOutput) String() string

String returns the string representation

type DescribeLocationSmbRequest added in v0.11.0 

type DescribeLocationSmbRequest struct {
	*aws.Request
	Input *DescribeLocationSmbInput
	Copy  func(*DescribeLocationSmbInput) DescribeLocationSmbRequest
}

DescribeLocationSmbRequest is the request type for the DescribeLocationSmb API operation.

func (DescribeLocationSmbRequest) Send added in v0.11.0 

func (r DescribeLocationSmbRequest) Send(ctx context.Context) (*DescribeLocationSmbResponse, error)

Send marshals and sends the DescribeLocationSmb API request.

type DescribeLocationSmbResponse added in v0.11.0 

type DescribeLocationSmbResponse struct {
	*DescribeLocationSmbOutput
	// contains filtered or unexported fields
}

DescribeLocationSmbResponse is the response type for the DescribeLocationSmb API operation.

func (*DescribeLocationSmbResponse) SDKResponseMetdata added in v0.11.0 

func (r *DescribeLocationSmbResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeLocationSmb request.

type DescribeTaskExecutionInput 

type DescribeTaskExecutionInput struct {

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

DescribeTaskExecutionRequest

func (DescribeTaskExecutionInput) String 

func (s DescribeTaskExecutionInput) String() string

String returns the string representation

func (*DescribeTaskExecutionInput) Validate 

func (s *DescribeTaskExecutionInput) Validate() error

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

type DescribeTaskExecutionOutput 

type DescribeTaskExecutionOutput struct {

	// The physical number of bytes transferred over the network.
	BytesTransferred *int64 `type:"long"`

	// The number of logical bytes written to the destination AWS storage resource.
	BytesWritten *int64 `type:"long"`

	// The estimated physical number of bytes that is to be transferred over the
	// network.
	EstimatedBytesToTransfer *int64 `type:"long"`

	// The expected number of files that is to be transferred over the network.
	// This value is calculated during the PREPARING phase, before the TRANSFERRING
	// phase. This value is the expected number of files to be transferred. It's
	// calculated based on comparing the content of the source and destination locations
	// and finding the delta that needs to be transferred.
	EstimatedFilesToTransfer *int64 `type:"long"`

	// A list of filter rules that determines which files to exclude from a task.
	// The list should contain a single filter string that consists of the patterns
	// to exclude. The patterns are delimited by "|" (that is, a pipe), for example:
	// "/folder1|/folder2"
	Excludes []FilterRule `type:"list"`

	// The actual number of files that was transferred over the network. This value
	// is calculated and updated on an ongoing basis during the TRANSFERRING phase.
	// It's updated periodically when each file is read from the source and sent
	// over the network.
	//
	// If failures occur during a transfer, this value can be less than EstimatedFilesToTransfer.
	// This value can also be greater than EstimatedFilesTransferred in some cases.
	// This element is implementation-specific for some location types, so don't
	// use it as an indicator for a correct file number or to monitor your task
	// execution.
	FilesTransferred *int64 `type:"long"`

	// A list of filter rules that determines which files to include when running
	// a task. The list should contain a single filter string that consists of the
	// patterns to include. The patterns are delimited by "|" (that is, a pipe),
	// for example: "/folder1|/folder2"
	Includes []FilterRule `type:"list"`

	// Represents the options that are available to control the behavior of a StartTaskExecution
	// operation. Behavior includes preserving metadata such as user ID (UID), group
	// ID (GID), and file permissions, and also overwriting files in the destination,
	// data integrity verification, and so on.
	//
	// A task has a set of default options associated with it. If you don't specify
	// an option in StartTaskExecution, the default value is used. You can override
	// the defaults options on each task execution by specifying an overriding Options
	// value to StartTaskExecution.
	Options *Options `type:"structure"`

	// The result of the task execution.
	Result *TaskExecutionResultDetail `type:"structure"`

	// The time that the task execution was started.
	StartTime *time.Time `type:"timestamp"`

	// The status of the task execution.
	//
	// For detailed information about task execution statuses, see Understanding
	// Task Statuses in the AWS DataSync User Guide.
	Status TaskExecutionStatus `type:"string" enum:"true"`

	// The Amazon Resource Name (ARN) of the task execution that was described.
	// TaskExecutionArn is hierarchical and includes TaskArn for the task that was
	// executed.
	//
	// For example, a TaskExecution value with the ARN arn:aws:datasync:us-east-1:111222333444:task/task-0208075f79cedf4a2/execution/exec-08ef1e88ec491019b
	// executed the task with the ARN arn:aws:datasync:us-east-1:111222333444:task/task-0208075f79cedf4a2.
	TaskExecutionArn *string `type:"string"`
	// contains filtered or unexported fields
}

DescribeTaskExecutionResponse

func (DescribeTaskExecutionOutput) String 

func (s DescribeTaskExecutionOutput) String() string

String returns the string representation

type DescribeTaskExecutionRequest 

type DescribeTaskExecutionRequest struct {
	*aws.Request
	Input *DescribeTaskExecutionInput
	Copy  func(*DescribeTaskExecutionInput) DescribeTaskExecutionRequest
}

DescribeTaskExecutionRequest is the request type for the DescribeTaskExecution API operation.

func (DescribeTaskExecutionRequest) Send 

func (r DescribeTaskExecutionRequest) Send(ctx context.Context) (*DescribeTaskExecutionResponse, error)

Send marshals and sends the DescribeTaskExecution API request.

type DescribeTaskExecutionResponse added in v0.9.0 

type DescribeTaskExecutionResponse struct {
	*DescribeTaskExecutionOutput
	// contains filtered or unexported fields
}

DescribeTaskExecutionResponse is the response type for the DescribeTaskExecution API operation.

func (*DescribeTaskExecutionResponse) SDKResponseMetdata added in v0.9.0 

func (r *DescribeTaskExecutionResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeTaskExecution request.

type DescribeTaskInput 

type DescribeTaskInput struct {

	// The Amazon Resource Name (ARN) of the task to describe.
	//
	// TaskArn is a required field
	TaskArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

DescribeTaskRequest

func (DescribeTaskInput) String 

func (s DescribeTaskInput) String() string

String returns the string representation

func (*DescribeTaskInput) Validate 

func (s *DescribeTaskInput) Validate() error

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

type DescribeTaskOutput 

type DescribeTaskOutput struct {

	// The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that was
	// used to monitor and log events in the task.
	//
	// For more information on these groups, see Working with Log Groups and Log
	// Streams in the Amazon CloudWatch User Guide.
	CloudWatchLogGroupArn *string `type:"string"`

	// The time that the task was created.
	CreationTime *time.Time `type:"timestamp"`

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

	// The Amazon Resource Name (ARN) of the AWS storage resource's location.
	DestinationLocationArn *string `type:"string"`

	// The Amazon Resource Name (ARN) of the destination ENIs (Elastic Network Interface)
	// that was created for your subnet.
	DestinationNetworkInterfaceArns []string `type:"list"`

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

	// Detailed description of an error that was encountered during the task execution.
	// You can use this information to help troubleshoot issues.
	ErrorDetail *string `type:"string"`

	// A list of filter rules that determines which files to exclude from a task.
	// The list should contain a single filter string that consists of the patterns
	// to exclude. The patterns are delimited by "|" (that is, a pipe), for example:
	// "/folder1|/folder2"
	Excludes []FilterRule `type:"list"`

	// The name of the task that was described.
	Name *string `min:"1" type:"string"`

	// The set of configuration options that control the behavior of a single execution
	// of the task that occurs when you call StartTaskExecution. You can configure
	// these options to preserve metadata such as user ID (UID) and group (GID),
	// file permissions, data integrity verification, and so on.
	//
	// For each individual task execution, you can override these options by specifying
	// the overriding OverrideOptions value to operation.
	Options *Options `type:"structure"`

	// The schedule used to periodically transfer files from a source to a destination
	// location.
	Schedule *TaskSchedule `type:"structure"`

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

	// The Amazon Resource Name (ARN) of the source ENIs (Elastic Network Interface)
	// that was created for your subnet.
	SourceNetworkInterfaceArns []string `type:"list"`

	// The status of the task that was described.
	//
	// For detailed information about task execution statuses, see Understanding
	// Task Statuses in the AWS DataSync User Guide.
	Status TaskStatus `type:"string" enum:"true"`

	// The Amazon Resource Name (ARN) of the task that was described.
	TaskArn *string `type:"string"`
	// contains filtered or unexported fields
}

DescribeTaskResponse

func (DescribeTaskOutput) String 

func (s DescribeTaskOutput) String() string

String returns the string representation

type DescribeTaskRequest 

type DescribeTaskRequest struct {
	*aws.Request
	Input *DescribeTaskInput
	Copy  func(*DescribeTaskInput) DescribeTaskRequest
}

DescribeTaskRequest is the request type for the DescribeTask API operation.

func (DescribeTaskRequest) Send 

func (r DescribeTaskRequest) Send(ctx context.Context) (*DescribeTaskResponse, error)

Send marshals and sends the DescribeTask API request.

type DescribeTaskResponse added in v0.9.0 

type DescribeTaskResponse struct {
	*DescribeTaskOutput
	// contains filtered or unexported fields
}

DescribeTaskResponse is the response type for the DescribeTask API operation.

func (*DescribeTaskResponse) SDKResponseMetdata added in v0.9.0 

func (r *DescribeTaskResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the DescribeTask request.

type Ec2Config 

type Ec2Config struct {

	// The Amazon Resource Names (ARNs) of the security groups that are configured
	// for the Amazon EC2 resource.
	//
	// SecurityGroupArns is a required field
	SecurityGroupArns []string `min:"1" type:"list" required:"true"`

	// The ARN of the subnet and the security group that DataSync uses to access
	// the target EFS file system.
	//
	// SubnetArn is a required field
	SubnetArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

The subnet and the security group that DataSync uses to access target EFS file system. The subnet must have at least one mount target for that file system. The security group that you provide needs to be able to communicate with the security group on the mount target in the subnet specified.

func (Ec2Config) String 

func (s Ec2Config) String() string

String returns the string representation

func (*Ec2Config) Validate 

func (s *Ec2Config) Validate() error

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

type EndpointType added in v0.11.0 

type EndpointType string
const (
	EndpointTypePublic      EndpointType = "PUBLIC"
	EndpointTypePrivateLink EndpointType = "PRIVATE_LINK"
	EndpointTypeFips        EndpointType = "FIPS"
)

Enum values for EndpointType

func (EndpointType) MarshalValue added in v0.11.0 

func (enum EndpointType) MarshalValue() (string, error)

func (EndpointType) MarshalValueBuf added in v0.11.0 

func (enum EndpointType) MarshalValueBuf(b []byte) ([]byte, error)

type FilterRule added in v0.9.0 

type FilterRule struct {

	// The type of filter rule to apply. AWS DataSync only supports the SIMPLE_PATTERN
	// rule type.
	FilterType FilterType `type:"string" enum:"true"`

	// A single filter string that consists of the patterns to include or exclude.
	// The patterns are delimited by "|" (that is, a pipe), for example: /folder1|/folder2
	Value *string `type:"string"`
	// contains filtered or unexported fields
}

Specifies which files, folders and objects to include or exclude when transferring files from source to destination.

func (FilterRule) String added in v0.9.0 

func (s FilterRule) String() string

String returns the string representation

type FilterType added in v0.9.0 

type FilterType string
const (
	FilterTypeSimplePattern FilterType = "SIMPLE_PATTERN"
)

Enum values for FilterType

func (FilterType) MarshalValue added in v0.9.0 

func (enum FilterType) MarshalValue() (string, error)

func (FilterType) MarshalValueBuf added in v0.9.0 

func (enum FilterType) MarshalValueBuf(b []byte) ([]byte, error)

type Gid 

type Gid string
const (
	GidNone     Gid = "NONE"
	GidIntValue Gid = "INT_VALUE"
	GidName     Gid = "NAME"
	GidBoth     Gid = "BOTH"
)

Enum values for Gid

func (Gid) MarshalValue 

func (enum Gid) MarshalValue() (string, error)

func (Gid) MarshalValueBuf 

func (enum Gid) MarshalValueBuf(b []byte) ([]byte, error)

type ListAgentsInput 

type ListAgentsInput struct {

	// The maximum number of agents to list.
	MaxResults *int64 `type:"integer"`

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

ListAgentsRequest

func (ListAgentsInput) String 

func (s ListAgentsInput) String() string

String returns the string representation

type ListAgentsOutput 

type ListAgentsOutput struct {

	// A list of agents in your account.
	Agents []AgentListEntry `type:"list"`

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

ListAgentsResponse

func (ListAgentsOutput) String 

func (s ListAgentsOutput) String() string

String returns the string representation

type ListAgentsPaginator added in v0.9.0 

type ListAgentsPaginator struct {
	aws.Pager
}

ListAgentsPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewListAgentsPaginator added in v0.9.0 

func NewListAgentsPaginator(req ListAgentsRequest) ListAgentsPaginator

NewListAgentsRequestPaginator returns a paginator for ListAgents. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service. 

// Example iterating over pages.
req := client.ListAgentsRequest(input)
p := datasync.NewListAgentsRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*ListAgentsPaginator) CurrentPage added in v0.9.0 

func (p *ListAgentsPaginator) CurrentPage() *ListAgentsOutput

type ListAgentsRequest 

type ListAgentsRequest struct {
	*aws.Request
	Input *ListAgentsInput
	Copy  func(*ListAgentsInput) ListAgentsRequest
}

ListAgentsRequest is the request type for the ListAgents API operation.

func (ListAgentsRequest) Send 

func (r ListAgentsRequest) Send(ctx context.Context) (*ListAgentsResponse, error)

Send marshals and sends the ListAgents API request.

type ListAgentsResponse added in v0.9.0 

type ListAgentsResponse struct {
	*ListAgentsOutput
	// contains filtered or unexported fields
}

ListAgentsResponse is the response type for the ListAgents API operation.

func (*ListAgentsResponse) SDKResponseMetdata added in v0.9.0 

func (r *ListAgentsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListAgents request.

type ListLocationsInput 

type ListLocationsInput struct {

	// The maximum number of locations to return.
	MaxResults *int64 `type:"integer"`

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

ListLocationsRequest

func (ListLocationsInput) String 

func (s ListLocationsInput) String() string

String returns the string representation

type ListLocationsOutput 

type ListLocationsOutput struct {

	// An array that contains a list of locations.
	Locations []LocationListEntry `type:"list"`

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

ListLocationsResponse

func (ListLocationsOutput) String 

func (s ListLocationsOutput) String() string

String returns the string representation

type ListLocationsPaginator added in v0.9.0 

type ListLocationsPaginator struct {
	aws.Pager
}

ListLocationsPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewListLocationsPaginator added in v0.9.0 

func NewListLocationsPaginator(req ListLocationsRequest) ListLocationsPaginator

NewListLocationsRequestPaginator returns a paginator for ListLocations. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service. 

// Example iterating over pages.
req := client.ListLocationsRequest(input)
p := datasync.NewListLocationsRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*ListLocationsPaginator) CurrentPage added in v0.9.0 

func (p *ListLocationsPaginator) CurrentPage() *ListLocationsOutput

type ListLocationsRequest 

type ListLocationsRequest struct {
	*aws.Request
	Input *ListLocationsInput
	Copy  func(*ListLocationsInput) ListLocationsRequest
}

ListLocationsRequest is the request type for the ListLocations API operation.

func (ListLocationsRequest) Send 

func (r ListLocationsRequest) Send(ctx context.Context) (*ListLocationsResponse, error)

Send marshals and sends the ListLocations API request.

type ListLocationsResponse added in v0.9.0 

type ListLocationsResponse struct {
	*ListLocationsOutput
	// contains filtered or unexported fields
}

ListLocationsResponse is the response type for the ListLocations API operation.

func (*ListLocationsResponse) SDKResponseMetdata added in v0.9.0 

func (r *ListLocationsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListLocations request.

type ListTagsForResourceInput 

type ListTagsForResourceInput struct {

	// The maximum number of locations to return.
	MaxResults *int64 `type:"integer"`

	// An opaque string that indicates the position at which to begin the next list
	// of locations.
	NextToken *string `type:"string"`

	// The Amazon Resource Name (ARN) of the resource whose tags to list.
	//
	// ResourceArn is a required field
	ResourceArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

ListTagsForResourceRequest

func (ListTagsForResourceInput) String 

func (s ListTagsForResourceInput) String() string

String returns the string representation

func (*ListTagsForResourceInput) Validate 

func (s *ListTagsForResourceInput) Validate() error

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

type ListTagsForResourceOutput 

type ListTagsForResourceOutput struct {

	// An opaque string that indicates the position at which to begin returning
	// the next list of resource tags.
	NextToken *string `type:"string"`

	// Array of resource tags.
	Tags []TagListEntry `type:"list"`
	// contains filtered or unexported fields
}

ListTagsForResourceResponse

func (ListTagsForResourceOutput) String 

func (s ListTagsForResourceOutput) String() string

String returns the string representation

type ListTagsForResourcePaginator added in v0.9.0 

type ListTagsForResourcePaginator struct {
	aws.Pager
}

ListTagsForResourcePaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewListTagsForResourcePaginator added in v0.9.0 

func NewListTagsForResourcePaginator(req ListTagsForResourceRequest) ListTagsForResourcePaginator

NewListTagsForResourceRequestPaginator returns a paginator for ListTagsForResource. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service. 

// Example iterating over pages.
req := client.ListTagsForResourceRequest(input)
p := datasync.NewListTagsForResourceRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*ListTagsForResourcePaginator) CurrentPage added in v0.9.0 

func (p *ListTagsForResourcePaginator) CurrentPage() *ListTagsForResourceOutput

type ListTagsForResourceRequest 

type ListTagsForResourceRequest struct {
	*aws.Request
	Input *ListTagsForResourceInput
	Copy  func(*ListTagsForResourceInput) ListTagsForResourceRequest
}

ListTagsForResourceRequest is the request type for the ListTagsForResource API operation.

func (ListTagsForResourceRequest) Send 

func (r ListTagsForResourceRequest) Send(ctx context.Context) (*ListTagsForResourceResponse, error)

Send marshals and sends the ListTagsForResource API request.

type ListTagsForResourceResponse added in v0.9.0 

type ListTagsForResourceResponse struct {
	*ListTagsForResourceOutput
	// contains filtered or unexported fields
}

ListTagsForResourceResponse is the response type for the ListTagsForResource API operation.

func (*ListTagsForResourceResponse) SDKResponseMetdata added in v0.9.0 

func (r *ListTagsForResourceResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListTagsForResource request.

type ListTaskExecutionsInput 

type ListTaskExecutionsInput struct {

	// The maximum number of executed tasks to list.
	MaxResults *int64 `type:"integer"`

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

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

ListTaskExecutions

func (ListTaskExecutionsInput) String 

func (s ListTaskExecutionsInput) String() string

String returns the string representation

type ListTaskExecutionsOutput 

type ListTaskExecutionsOutput struct {

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

	// A list of executed tasks.
	TaskExecutions []TaskExecutionListEntry `type:"list"`
	// contains filtered or unexported fields
}

ListTaskExecutionsResponse

func (ListTaskExecutionsOutput) String 

func (s ListTaskExecutionsOutput) String() string

String returns the string representation

type ListTaskExecutionsPaginator added in v0.9.0 

type ListTaskExecutionsPaginator struct {
	aws.Pager
}

ListTaskExecutionsPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewListTaskExecutionsPaginator added in v0.9.0 

func NewListTaskExecutionsPaginator(req ListTaskExecutionsRequest) ListTaskExecutionsPaginator

NewListTaskExecutionsRequestPaginator returns a paginator for ListTaskExecutions. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service. 

// Example iterating over pages.
req := client.ListTaskExecutionsRequest(input)
p := datasync.NewListTaskExecutionsRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*ListTaskExecutionsPaginator) CurrentPage added in v0.9.0 

func (p *ListTaskExecutionsPaginator) CurrentPage() *ListTaskExecutionsOutput

type ListTaskExecutionsRequest 

type ListTaskExecutionsRequest struct {
	*aws.Request
	Input *ListTaskExecutionsInput
	Copy  func(*ListTaskExecutionsInput) ListTaskExecutionsRequest
}

ListTaskExecutionsRequest is the request type for the ListTaskExecutions API operation.

func (ListTaskExecutionsRequest) Send 

func (r ListTaskExecutionsRequest) Send(ctx context.Context) (*ListTaskExecutionsResponse, error)

Send marshals and sends the ListTaskExecutions API request.

type ListTaskExecutionsResponse added in v0.9.0 

type ListTaskExecutionsResponse struct {
	*ListTaskExecutionsOutput
	// contains filtered or unexported fields
}

ListTaskExecutionsResponse is the response type for the ListTaskExecutions API operation.

func (*ListTaskExecutionsResponse) SDKResponseMetdata added in v0.9.0 

func (r *ListTaskExecutionsResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListTaskExecutions request.

type ListTasksInput 

type ListTasksInput struct {

	// The maximum number of tasks to return.
	MaxResults *int64 `type:"integer"`

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

ListTasksRequest

func (ListTasksInput) String 

func (s ListTasksInput) String() string

String returns the string representation

type ListTasksOutput 

type ListTasksOutput struct {

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

	// A list of all the tasks that are returned.
	Tasks []TaskListEntry `type:"list"`
	// contains filtered or unexported fields
}

ListTasksResponse

func (ListTasksOutput) String 

func (s ListTasksOutput) String() string

String returns the string representation

type ListTasksPaginator added in v0.9.0 

type ListTasksPaginator struct {
	aws.Pager
}

ListTasksPaginator is used to paginate the request. This can be done by calling Next and CurrentPage.

func NewListTasksPaginator added in v0.9.0 

func NewListTasksPaginator(req ListTasksRequest) ListTasksPaginator

NewListTasksRequestPaginator returns a paginator for ListTasks. Use Next method to get the next page, and CurrentPage to get the current response page from the paginator. Next will return false, if there are no more pages, or an error was encountered.

Note: This operation can generate multiple requests to a service. 

// Example iterating over pages.
req := client.ListTasksRequest(input)
p := datasync.NewListTasksRequestPaginator(req)

for p.Next(context.TODO()) {
    page := p.CurrentPage()
}

if err := p.Err(); err != nil {
    return err
}

func (*ListTasksPaginator) CurrentPage added in v0.9.0 

func (p *ListTasksPaginator) CurrentPage() *ListTasksOutput

type ListTasksRequest 

type ListTasksRequest struct {
	*aws.Request
	Input *ListTasksInput
	Copy  func(*ListTasksInput) ListTasksRequest
}

ListTasksRequest is the request type for the ListTasks API operation.

func (ListTasksRequest) Send 

func (r ListTasksRequest) Send(ctx context.Context) (*ListTasksResponse, error)

Send marshals and sends the ListTasks API request.

type ListTasksResponse added in v0.9.0 

type ListTasksResponse struct {
	*ListTasksOutput
	// contains filtered or unexported fields
}

ListTasksResponse is the response type for the ListTasks API operation.

func (*ListTasksResponse) SDKResponseMetdata added in v0.9.0 

func (r *ListTasksResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the ListTasks request.

type LocationListEntry 

type LocationListEntry struct {

	// The Amazon Resource Name (ARN) of the location. For Network File System (NFS)
	// or Amazon EFS, the location is the export path. For Amazon S3, the location
	// is the prefix path that you want to mount and use as the root of the location.
	LocationArn *string `type:"string"`

	// Represents a list of URLs of a location. LocationUri returns an array that
	// contains a list of locations when the ListLocations operation is called.
	//
	// Format: TYPE://GLOBAL_ID/SUBDIR.
	//
	// TYPE designates the type of location. Valid values: NFS | EFS | S3.
	//
	// GLOBAL_ID is the globally unique identifier of the resource that backs the
	// location. An example for EFS is us-east-2.fs-abcd1234. An example for Amazon
	// S3 is the bucket name, such as myBucket. An example for NFS is a valid IPv4
	// address or a host name compliant with Domain Name Service (DNS).
	//
	// SUBDIR is a valid file system path, delimited by forward slashes as is the
	// *nix convention. For NFS and Amazon EFS, it's the export path to mount the
	// location. For Amazon S3, it's the prefix path that you mount to and treat
	// as the root of the location.
	LocationUri *string `type:"string"`
	// contains filtered or unexported fields
}

Represents a single entry in a list of locations. LocationListEntry returns an array that contains a list of locations when the ListLocations operation is called.

func (LocationListEntry) String 

func (s LocationListEntry) String() string

String returns the string representation

type LogLevel added in v0.19.0 

type LogLevel string
const (
	LogLevelOff      LogLevel = "OFF"
	LogLevelBasic    LogLevel = "BASIC"
	LogLevelTransfer LogLevel = "TRANSFER"
)

Enum values for LogLevel

func (LogLevel) MarshalValue added in v0.19.0 

func (enum LogLevel) MarshalValue() (string, error)

func (LogLevel) MarshalValueBuf added in v0.19.0 

func (enum LogLevel) MarshalValueBuf(b []byte) ([]byte, error)

type Mtime 

type Mtime string
const (
	MtimeNone     Mtime = "NONE"
	MtimePreserve Mtime = "PRESERVE"
)

Enum values for Mtime

func (Mtime) MarshalValue 

func (enum Mtime) MarshalValue() (string, error)

func (Mtime) MarshalValueBuf 

func (enum Mtime) MarshalValueBuf(b []byte) ([]byte, error)

type NfsMountOptions added in v0.9.0 

type NfsMountOptions struct {

	// The specific NFS version that you want DataSync to use to mount your NFS
	// share. If the server refuses to use the version specified, the sync will
	// fail. If you don't specify a version, DataSync defaults to AUTOMATIC. That
	// is, DataSync automatically selects a version based on negotiation with the
	// NFS server.
	//
	// You can specify the following NFS versions:
	//
	//    * NFSv3 (https://tools.ietf.org/html/rfc1813) - stateless protocol version
	//    that allows for asynchronous writes on the server.
	//
	//    * NFSv4.0 (https://tools.ietf.org/html/rfc3530) - stateful, firewall-friendly
	//    protocol version that supports delegations and pseudo filesystems.
	//
	//    * NFSv4.1 (https://tools.ietf.org/html/rfc5661) - stateful protocol version
	//    that supports sessions, directory delegations, and parallel data processing.
	//    Version 4.1 also includes all features available in version 4.0.
	Version NfsVersion `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

Represents the mount options that are available for DataSync to access an NFS location.

func (NfsMountOptions) String added in v0.9.0 

func (s NfsMountOptions) String() string

String returns the string representation

type NfsVersion added in v0.9.0 

type NfsVersion string
const (
	NfsVersionAutomatic NfsVersion = "AUTOMATIC"
	NfsVersionNfs3      NfsVersion = "NFS3"
	NfsVersionNfs40     NfsVersion = "NFS4_0"
	NfsVersionNfs41     NfsVersion = "NFS4_1"
)

Enum values for NfsVersion

func (NfsVersion) MarshalValue added in v0.9.0 

func (enum NfsVersion) MarshalValue() (string, error)

func (NfsVersion) MarshalValueBuf added in v0.9.0 

func (enum NfsVersion) MarshalValueBuf(b []byte) ([]byte, error)

type OnPremConfig 

type OnPremConfig struct {

	// ARNs)of the agents to use for an NFS location.
	//
	// AgentArns is a required field
	AgentArns []string `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

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

func (OnPremConfig) String 

func (s OnPremConfig) String() string

String returns the string representation

func (*OnPremConfig) Validate 

func (s *OnPremConfig) Validate() error

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

type Options 

type Options struct {

	// A file metadata value that shows the last time a file was accessed (that
	// is, when the file was read or written to). If you set Atime to BEST_EFFORT,
	// DataSync attempts to preserve the original Atime attribute on all source
	// files (that is, the version before the PREPARING phase). However, Atime's
	// behavior is not fully standard across platforms, so AWS DataSync can only
	// do this on a best-effort basis.
	//
	// Default value: BEST_EFFORT.
	//
	// BEST_EFFORT: Attempt to preserve the per-file Atime value (recommended).
	//
	// NONE: Ignore Atime.
	//
	// If Atime is set to BEST_EFFORT, Mtime must be set to PRESERVE.
	//
	// If Atime is set to NONE, Mtime must also be NONE.
	Atime Atime `type:"string" enum:"true"`

	// A value that limits the bandwidth used by AWS DataSync. For example, if you
	// want AWS DataSync to use a maximum of 1 MB, set this value to 1048576 (=1024*1024).
	BytesPerSecond *int64 `type:"long"`

	// The group ID (GID) of the file's owners.
	//
	// Default value: INT_VALUE. This preserves the integer value of the ID.
	//
	// INT_VALUE: Preserve the integer value of user ID (UID) and GID (recommended).
	//
	// NONE: Ignore UID and GID.
	Gid Gid `type:"string" enum:"true"`

	// A value that determines the type of logs DataSync will deliver to your AWS
	// CloudWatch Logs file. If set to OFF, no logs will be delivered. BASIC will
	// deliver a few logs per transfer operation and TRANSFER will deliver a verbose
	// log that contains logs for every file that is transferred.
	LogLevel LogLevel `type:"string" enum:"true"`

	// A value that indicates the last time that a file was modified (that is, a
	// file was written to) before the PREPARING phase.
	//
	// Default value: PRESERVE.
	//
	// PRESERVE: Preserve original Mtime (recommended)
	//
	// NONE: Ignore Mtime.
	//
	// If Mtime is set to PRESERVE, Atime must be set to BEST_EFFORT.
	//
	// If Mtime is set to NONE, Atime must also be set to NONE.
	Mtime Mtime `type:"string" enum:"true"`

	// A value that determines whether files at the destination should be overwritten
	// or preserved when copying files. If set to NEVER a destination file will
	// not be replaced by a source file, even if the destination file differs from
	// the source file. If you modify files in the destination and you sync the
	// files, you can use this value to protect against overwriting those changes.
	//
	// Some storage classes have specific behaviors that can affect your S3 storage
	// cost. For detailed information, see using-storage-classes in the AWS DataSync
	// User Guide.
	OverwriteMode OverwriteMode `type:"string" enum:"true"`

	// A value that determines which users or groups can access a file for a specific
	// purpose such as reading, writing, or execution of the file.
	//
	// Default value: PRESERVE.
	//
	// PRESERVE: Preserve POSIX-style permissions (recommended).
	//
	// NONE: Ignore permissions.
	//
	// AWS DataSync can preserve extant permissions of a source location.
	PosixPermissions PosixPermissions `type:"string" enum:"true"`

	// A value that specifies whether files in the destination that don't exist
	// in the source file system should be preserved. This option can affect your
	// storage cost. If your task deletes objects, you might incur minimum storage
	// duration charges for certain storage classes. For detailed information, see
	// using-storage-classes in the AWS DataSync User Guide.
	//
	// Default value: PRESERVE.
	//
	// PRESERVE: Ignore such destination files (recommended).
	//
	// REMOVE: Delete destination files that aren’t present in the source.
	PreserveDeletedFiles PreserveDeletedFiles `type:"string" enum:"true"`

	// A value that determines whether AWS DataSync should preserve the metadata
	// of block and character devices in the source file system, and recreate the
	// files with that device name and metadata on the destination.
	//
	// AWS DataSync can't sync the actual contents of such devices, because they
	// are nonterminal and don't return an end-of-file (EOF) marker.
	//
	// Default value: NONE.
	//
	// NONE: Ignore special devices (recommended).
	//
	// PRESERVE: Preserve character and block device metadata. This option isn't
	// currently supported for Amazon EFS.
	PreserveDevices PreserveDevices `type:"string" enum:"true"`

	// A value that determines whether tasks should be queued before executing the
	// tasks. If set to ENABLED, the tasks will be queued. The default is ENABLED.
	//
	// If you use the same agent to run multiple tasks you can enable the tasks
	// to run in series. For more information see queue-task-execution.
	TaskQueueing TaskQueueing `type:"string" enum:"true"`

	// The user ID (UID) of the file's owner.
	//
	// Default value: INT_VALUE. This preserves the integer value of the ID.
	//
	// INT_VALUE: Preserve the integer value of UID and group ID (GID) (recommended).
	//
	// NONE: Ignore UID and GID.
	Uid Uid `type:"string" enum:"true"`

	// A value that determines whether a data integrity verification should be performed
	// at the end of a task execution after all data and metadata have been transferred.
	//
	// Default value: POINT_IN_TIME_CONSISTENT.
	//
	// POINT_IN_TIME_CONSISTENT: Perform verification (recommended).
	//
	// ONLY_FILES_TRANSFERRED: Perform verification on only files that were transferred.
	//
	// NONE: Skip verification.
	VerifyMode VerifyMode `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

Represents the options that are available to control the behavior of a StartTaskExecution operation. Behavior includes preserving metadata such as user ID (UID), group ID (GID), and file permissions, and also overwriting files in the destination, data integrity verification, and so on.

A task has a set of default options associated with it. If you don't specify an option in StartTaskExecution, the default value is used. You can override the defaults options on each task execution by specifying an overriding Options value to StartTaskExecution.

func (Options) String 

func (s Options) String() string

String returns the string representation

func (*Options) Validate 

func (s *Options) Validate() error

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

type OverwriteMode added in v0.13.0 

type OverwriteMode string
const (
	OverwriteModeAlways OverwriteMode = "ALWAYS"
	OverwriteModeNever  OverwriteMode = "NEVER"
)

Enum values for OverwriteMode

func (OverwriteMode) MarshalValue added in v0.13.0 

func (enum OverwriteMode) MarshalValue() (string, error)

func (OverwriteMode) MarshalValueBuf added in v0.13.0 

func (enum OverwriteMode) MarshalValueBuf(b []byte) ([]byte, error)

type PhaseStatus 

type PhaseStatus string
const (
	PhaseStatusPending PhaseStatus = "PENDING"
	PhaseStatusSuccess PhaseStatus = "SUCCESS"
	PhaseStatusError   PhaseStatus = "ERROR"
)

Enum values for PhaseStatus

func (PhaseStatus) MarshalValue 

func (enum PhaseStatus) MarshalValue() (string, error)

func (PhaseStatus) MarshalValueBuf 

func (enum PhaseStatus) MarshalValueBuf(b []byte) ([]byte, error)

type PosixPermissions 

type PosixPermissions string
const (
	PosixPermissionsNone     PosixPermissions = "NONE"
	PosixPermissionsPreserve PosixPermissions = "PRESERVE"
)

Enum values for PosixPermissions

func (PosixPermissions) MarshalValue 

func (enum PosixPermissions) MarshalValue() (string, error)

func (PosixPermissions) MarshalValueBuf 

func (enum PosixPermissions) MarshalValueBuf(b []byte) ([]byte, error)

type PreserveDeletedFiles 

type PreserveDeletedFiles string
const (
	PreserveDeletedFilesPreserve PreserveDeletedFiles = "PRESERVE"
	PreserveDeletedFilesRemove   PreserveDeletedFiles = "REMOVE"
)

Enum values for PreserveDeletedFiles

func (PreserveDeletedFiles) MarshalValue 

func (enum PreserveDeletedFiles) MarshalValue() (string, error)

func (PreserveDeletedFiles) MarshalValueBuf 

func (enum PreserveDeletedFiles) MarshalValueBuf(b []byte) ([]byte, error)

type PreserveDevices 

type PreserveDevices string
const (
	PreserveDevicesNone     PreserveDevices = "NONE"
	PreserveDevicesPreserve PreserveDevices = "PRESERVE"
)

Enum values for PreserveDevices

func (PreserveDevices) MarshalValue 

func (enum PreserveDevices) MarshalValue() (string, error)

func (PreserveDevices) MarshalValueBuf 

func (enum PreserveDevices) MarshalValueBuf(b []byte) ([]byte, error)

type PrivateLinkConfig added in v0.9.0 

type PrivateLinkConfig struct {

	// The private endpoint that is configured for an agent that has access to IP
	// addresses in a PrivateLink (https://docs.aws.amazon.com/vpc/latest/userguide/endpoint-service.html).
	// An agent that is configured with this endpoint will not be accessible over
	// the public Internet.
	PrivateLinkEndpoint *string `min:"7" type:"string"`

	// The Amazon Resource Names (ARNs) of the security groups that are configured
	// for the EC2 resource that hosts an agent activated in a VPC or an agent that
	// has access to a VPC endpoint.
	SecurityGroupArns []string `min:"1" type:"list"`

	// The Amazon Resource Names (ARNs) of the subnets that are configured for an
	// agent activated in a VPC or an agent that has access to a VPC endpoint.
	SubnetArns []string `min:"1" type:"list"`

	// The ID of the VPC endpoint that is configured for an agent. An agent that
	// is configured with a VPC endpoint will not be accessible over the public
	// Internet.
	VpcEndpointId *string `type:"string"`
	// contains filtered or unexported fields
}

The VPC endpoint, subnet and security group that an agent uses to access IP addresses in a VPC (Virtual Private Cloud).

func (PrivateLinkConfig) String added in v0.9.0 

func (s PrivateLinkConfig) String() string

String returns the string representation

type S3Config 

type S3Config struct {

	// The Amazon S3 bucket to access. This bucket is used as a parameter in the
	// CreateLocationS3 operation.
	//
	// BucketAccessRoleArn is a required field
	BucketAccessRoleArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that is used to access an Amazon S3 bucket.

For detailed information about using such a role, see Creating a Location for Amazon S3 in the AWS DataSync User Guide.

func (S3Config) String 

func (s S3Config) String() string

String returns the string representation

func (*S3Config) Validate 

func (s *S3Config) Validate() error

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

type S3StorageClass added in v0.13.0 

type S3StorageClass string
const (
	S3StorageClassStandard           S3StorageClass = "STANDARD"
	S3StorageClassStandardIa         S3StorageClass = "STANDARD_IA"
	S3StorageClassOnezoneIa          S3StorageClass = "ONEZONE_IA"
	S3StorageClassIntelligentTiering S3StorageClass = "INTELLIGENT_TIERING"
	S3StorageClassGlacier            S3StorageClass = "GLACIER"
	S3StorageClassDeepArchive        S3StorageClass = "DEEP_ARCHIVE"
)

Enum values for S3StorageClass

func (S3StorageClass) MarshalValue added in v0.13.0 

func (enum S3StorageClass) MarshalValue() (string, error)

func (S3StorageClass) MarshalValueBuf added in v0.13.0 

func (enum S3StorageClass) MarshalValueBuf(b []byte) ([]byte, error)

type SmbMountOptions added in v0.11.0 

type SmbMountOptions struct {

	// The specific SMB version that you want DataSync to use to mount your SMB
	// share. If you don't specify a version, DataSync defaults to AUTOMATIC. That
	// is, DataSync automatically selects a version based on negotiation with the
	// SMB server.
	Version SmbVersion `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

Represents the mount options that are available for DataSync to access an SMB location.

func (SmbMountOptions) String added in v0.11.0 

func (s SmbMountOptions) String() string

String returns the string representation

type SmbVersion added in v0.11.0 

type SmbVersion string
const (
	SmbVersionAutomatic SmbVersion = "AUTOMATIC"
	SmbVersionSmb2      SmbVersion = "SMB2"
	SmbVersionSmb3      SmbVersion = "SMB3"
)

Enum values for SmbVersion

func (SmbVersion) MarshalValue added in v0.11.0 

func (enum SmbVersion) MarshalValue() (string, error)

func (SmbVersion) MarshalValueBuf added in v0.11.0 

func (enum SmbVersion) MarshalValueBuf(b []byte) ([]byte, error)

type StartTaskExecutionInput 

type StartTaskExecutionInput struct {

	// A list of filter rules that determines which files to include when running
	// a task. The pattern should contain a single filter string that consists of
	// the patterns to include. The patterns are delimited by "|" (that is, a pipe).
	// For example: "/folder1|/folder2"
	Includes []FilterRule `type:"list"`

	// Represents the options that are available to control the behavior of a StartTaskExecution
	// operation. Behavior includes preserving metadata such as user ID (UID), group
	// ID (GID), and file permissions, and also overwriting files in the destination,
	// data integrity verification, and so on.
	//
	// A task has a set of default options associated with it. If you don't specify
	// an option in StartTaskExecution, the default value is used. You can override
	// the defaults options on each task execution by specifying an overriding Options
	// value to StartTaskExecution.
	OverrideOptions *Options `type:"structure"`

	// The Amazon Resource Name (ARN) of the task to start.
	//
	// TaskArn is a required field
	TaskArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

StartTaskExecutionRequest

func (StartTaskExecutionInput) String 

func (s StartTaskExecutionInput) String() string

String returns the string representation

func (*StartTaskExecutionInput) Validate 

func (s *StartTaskExecutionInput) Validate() error

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

type StartTaskExecutionOutput 

type StartTaskExecutionOutput struct {

	// The Amazon Resource Name (ARN) of the specific task execution that was started.
	TaskExecutionArn *string `type:"string"`
	// contains filtered or unexported fields
}

StartTaskExecutionResponse

func (StartTaskExecutionOutput) String 

func (s StartTaskExecutionOutput) String() string

String returns the string representation

type StartTaskExecutionRequest 

type StartTaskExecutionRequest struct {
	*aws.Request
	Input *StartTaskExecutionInput
	Copy  func(*StartTaskExecutionInput) StartTaskExecutionRequest
}

StartTaskExecutionRequest is the request type for the StartTaskExecution API operation.

func (StartTaskExecutionRequest) Send 

func (r StartTaskExecutionRequest) Send(ctx context.Context) (*StartTaskExecutionResponse, error)

Send marshals and sends the StartTaskExecution API request.

type StartTaskExecutionResponse added in v0.9.0 

type StartTaskExecutionResponse struct {
	*StartTaskExecutionOutput
	// contains filtered or unexported fields
}

StartTaskExecutionResponse is the response type for the StartTaskExecution API operation.

func (*StartTaskExecutionResponse) SDKResponseMetdata added in v0.9.0 

func (r *StartTaskExecutionResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the StartTaskExecution request.

type TagListEntry 

type TagListEntry struct {

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

	// The value for an AWS resource tag.
	Value *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

Represents a single entry in a list of AWS resource tags. TagListEntry returns an array that contains a list of tasks when the ListTagsForResource operation is called.

func (TagListEntry) String 

func (s TagListEntry) String() string

String returns the string representation

func (*TagListEntry) Validate 

func (s *TagListEntry) Validate() error

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

type TagResourceInput 

type TagResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource to apply the tag to.
	//
	// ResourceArn is a required field
	ResourceArn *string `type:"string" required:"true"`

	// The tags to apply.
	//
	// Tags is a required field
	Tags []TagListEntry `type:"list" required:"true"`
	// contains filtered or unexported fields
}

TagResourceRequest

func (TagResourceInput) String 

func (s TagResourceInput) String() string

String returns the string representation

func (*TagResourceInput) Validate 

func (s *TagResourceInput) Validate() error

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

type TagResourceOutput 

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

func (TagResourceOutput) String 

func (s TagResourceOutput) String() string

String returns the string representation

type TagResourceRequest 

type TagResourceRequest struct {
	*aws.Request
	Input *TagResourceInput
	Copy  func(*TagResourceInput) TagResourceRequest
}

TagResourceRequest is the request type for the TagResource API operation.

func (TagResourceRequest) Send 

func (r TagResourceRequest) Send(ctx context.Context) (*TagResourceResponse, error)

Send marshals and sends the TagResource API request.

type TagResourceResponse added in v0.9.0 

type TagResourceResponse struct {
	*TagResourceOutput
	// contains filtered or unexported fields
}

TagResourceResponse is the response type for the TagResource API operation.

func (*TagResourceResponse) SDKResponseMetdata added in v0.9.0 

func (r *TagResourceResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the TagResource request.

type TaskExecutionListEntry 

type TaskExecutionListEntry struct {

	// The status of a task execution.
	Status TaskExecutionStatus `type:"string" enum:"true"`

	// The Amazon Resource Name (ARN) of the task that was executed.
	TaskExecutionArn *string `type:"string"`
	// contains filtered or unexported fields
}

Represents a single entry in a list of task executions. TaskExecutionListEntry returns an array that contains a list of specific invocations of a task when ListTaskExecutions operation is called.

func (TaskExecutionListEntry) String 

func (s TaskExecutionListEntry) String() string

String returns the string representation

type TaskExecutionResultDetail 

type TaskExecutionResultDetail struct {

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

	// Detailed description of an error that was encountered during the task execution.
	// You can use this information to help troubleshoot issues.
	ErrorDetail *string `type:"string"`

	// The total time in milliseconds that AWS DataSync spent in the PREPARING phase.
	PrepareDuration *int64 `type:"long"`

	// The status of the PREPARING phase.
	PrepareStatus PhaseStatus `type:"string" enum:"true"`

	// The total time in milliseconds that AWS DataSync took to transfer the file
	// from the source to the destination location.
	TotalDuration *int64 `type:"long"`

	// The total time in milliseconds that AWS DataSync spent in the TRANSFERRING
	// phase.
	TransferDuration *int64 `type:"long"`

	// The status of the TRANSFERRING Phase.
	TransferStatus PhaseStatus `type:"string" enum:"true"`

	// The total time in milliseconds that AWS DataSync spent in the VERIFYING phase.
	VerifyDuration *int64 `type:"long"`

	// The status of the VERIFYING Phase.
	VerifyStatus PhaseStatus `type:"string" enum:"true"`
	// contains filtered or unexported fields
}

Describes the detailed result of a TaskExecution operation. This result includes the time in milliseconds spent in each phase, the status of the task execution, and the errors encountered.

func (TaskExecutionResultDetail) String 

func (s TaskExecutionResultDetail) String() string

String returns the string representation

type TaskExecutionStatus 

type TaskExecutionStatus string
const (
	TaskExecutionStatusQueued       TaskExecutionStatus = "QUEUED"
	TaskExecutionStatusLaunching    TaskExecutionStatus = "LAUNCHING"
	TaskExecutionStatusPreparing    TaskExecutionStatus = "PREPARING"
	TaskExecutionStatusTransferring TaskExecutionStatus = "TRANSFERRING"
	TaskExecutionStatusVerifying    TaskExecutionStatus = "VERIFYING"
	TaskExecutionStatusSuccess      TaskExecutionStatus = "SUCCESS"
	TaskExecutionStatusError        TaskExecutionStatus = "ERROR"
)

Enum values for TaskExecutionStatus

func (TaskExecutionStatus) MarshalValue 

func (enum TaskExecutionStatus) MarshalValue() (string, error)

func (TaskExecutionStatus) MarshalValueBuf 

func (enum TaskExecutionStatus) MarshalValueBuf(b []byte) ([]byte, error)

type TaskListEntry 

type TaskListEntry struct {

	// The name of the task.
	Name *string `min:"1" type:"string"`

	// The status of the task.
	Status TaskStatus `type:"string" enum:"true"`

	// The Amazon Resource Name (ARN) of the task.
	TaskArn *string `type:"string"`
	// contains filtered or unexported fields
}

Represents a single entry in a list of tasks. TaskListEntry returns an array that contains a list of tasks when the ListTasks operation is called. A task includes the source and destination file systems to sync and the options to use for the tasks.

func (TaskListEntry) String 

func (s TaskListEntry) String() string

String returns the string representation

type TaskQueueing added in v0.15.0 

type TaskQueueing string
const (
	TaskQueueingEnabled  TaskQueueing = "ENABLED"
	TaskQueueingDisabled TaskQueueing = "DISABLED"
)

Enum values for TaskQueueing

func (TaskQueueing) MarshalValue added in v0.15.0 

func (enum TaskQueueing) MarshalValue() (string, error)

func (TaskQueueing) MarshalValueBuf added in v0.15.0 

func (enum TaskQueueing) MarshalValueBuf(b []byte) ([]byte, error)

type TaskSchedule added in v0.17.0 

type TaskSchedule struct {

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

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

func (TaskSchedule) String added in v0.17.0 

func (s TaskSchedule) String() string

String returns the string representation

func (*TaskSchedule) Validate added in v0.17.0 

func (s *TaskSchedule) Validate() error

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

type TaskStatus 

type TaskStatus string
const (
	TaskStatusAvailable   TaskStatus = "AVAILABLE"
	TaskStatusCreating    TaskStatus = "CREATING"
	TaskStatusQueued      TaskStatus = "QUEUED"
	TaskStatusRunning     TaskStatus = "RUNNING"
	TaskStatusUnavailable TaskStatus = "UNAVAILABLE"
)

Enum values for TaskStatus

func (TaskStatus) MarshalValue 

func (enum TaskStatus) MarshalValue() (string, error)

func (TaskStatus) MarshalValueBuf 

func (enum TaskStatus) MarshalValueBuf(b []byte) ([]byte, error)

type Uid 

type Uid string
const (
	UidNone     Uid = "NONE"
	UidIntValue Uid = "INT_VALUE"
	UidName     Uid = "NAME"
	UidBoth     Uid = "BOTH"
)

Enum values for Uid

func (Uid) MarshalValue 

func (enum Uid) MarshalValue() (string, error)

func (Uid) MarshalValueBuf 

func (enum Uid) MarshalValueBuf(b []byte) ([]byte, error)

type UntagResourceInput 

type UntagResourceInput struct {

	// The keys in the key-value pair in the tag to remove.
	//
	// Keys is a required field
	Keys []string `min:"1" type:"list" required:"true"`

	// The Amazon Resource Name (ARN) of the resource to remove the tag from.
	//
	// ResourceArn is a required field
	ResourceArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

UntagResourceRequest

func (UntagResourceInput) String 

func (s UntagResourceInput) String() string

String returns the string representation

func (*UntagResourceInput) Validate 

func (s *UntagResourceInput) Validate() error

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

type UntagResourceOutput 

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

func (UntagResourceOutput) String 

func (s UntagResourceOutput) String() string

String returns the string representation

type UntagResourceRequest 

type UntagResourceRequest struct {
	*aws.Request
	Input *UntagResourceInput
	Copy  func(*UntagResourceInput) UntagResourceRequest
}

UntagResourceRequest is the request type for the UntagResource API operation.

func (UntagResourceRequest) Send 

func (r UntagResourceRequest) Send(ctx context.Context) (*UntagResourceResponse, error)

Send marshals and sends the UntagResource API request.

type UntagResourceResponse added in v0.9.0 

type UntagResourceResponse struct {
	*UntagResourceOutput
	// contains filtered or unexported fields
}

UntagResourceResponse is the response type for the UntagResource API operation.

func (*UntagResourceResponse) SDKResponseMetdata added in v0.9.0 

func (r *UntagResourceResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UntagResource request.

type UpdateAgentInput 

type UpdateAgentInput struct {

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

	// The name that you want to use to configure the agent.
	Name *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

UpdateAgentRequest

func (UpdateAgentInput) String 

func (s UpdateAgentInput) String() string

String returns the string representation

func (*UpdateAgentInput) Validate 

func (s *UpdateAgentInput) Validate() error

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

type UpdateAgentOutput 

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

func (UpdateAgentOutput) String 

func (s UpdateAgentOutput) String() string

String returns the string representation

type UpdateAgentRequest 

type UpdateAgentRequest struct {
	*aws.Request
	Input *UpdateAgentInput
	Copy  func(*UpdateAgentInput) UpdateAgentRequest
}

UpdateAgentRequest is the request type for the UpdateAgent API operation.

func (UpdateAgentRequest) Send 

func (r UpdateAgentRequest) Send(ctx context.Context) (*UpdateAgentResponse, error)

Send marshals and sends the UpdateAgent API request.

type UpdateAgentResponse added in v0.9.0 

type UpdateAgentResponse struct {
	*UpdateAgentOutput
	// contains filtered or unexported fields
}

UpdateAgentResponse is the response type for the UpdateAgent API operation.

func (*UpdateAgentResponse) SDKResponseMetdata added in v0.9.0 

func (r *UpdateAgentResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UpdateAgent request.

type UpdateTaskInput 

type UpdateTaskInput struct {

	// The Amazon Resource Name (ARN) of the resource name of the CloudWatch LogGroup.
	CloudWatchLogGroupArn *string `type:"string"`

	// A list of filter rules that determines which files to exclude from a task.
	// The list should contain a single filter string that consists of the patterns
	// to exclude. The patterns are delimited by "|" (that is, a pipe), for example:
	// "/folder1|/folder2"
	Excludes []FilterRule `type:"list"`

	// The name of the task to update.
	Name *string `min:"1" type:"string"`

	// Represents the options that are available to control the behavior of a StartTaskExecution
	// operation. Behavior includes preserving metadata such as user ID (UID), group
	// ID (GID), and file permissions, and also overwriting files in the destination,
	// data integrity verification, and so on.
	//
	// A task has a set of default options associated with it. If you don't specify
	// an option in StartTaskExecution, the default value is used. You can override
	// the defaults options on each task execution by specifying an overriding Options
	// value to StartTaskExecution.
	Options *Options `type:"structure"`

	// 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 task-scheduling.
	Schedule *TaskSchedule `type:"structure"`

	// The Amazon Resource Name (ARN) of the resource name of the task to update.
	//
	// TaskArn is a required field
	TaskArn *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

UpdateTaskResponse

func (UpdateTaskInput) String 

func (s UpdateTaskInput) String() string

String returns the string representation

func (*UpdateTaskInput) Validate 

func (s *UpdateTaskInput) Validate() error

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

type UpdateTaskOutput 

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

func (UpdateTaskOutput) String 

func (s UpdateTaskOutput) String() string

String returns the string representation

type UpdateTaskRequest 

type UpdateTaskRequest struct {
	*aws.Request
	Input *UpdateTaskInput
	Copy  func(*UpdateTaskInput) UpdateTaskRequest
}

UpdateTaskRequest is the request type for the UpdateTask API operation.

func (UpdateTaskRequest) Send 

func (r UpdateTaskRequest) Send(ctx context.Context) (*UpdateTaskResponse, error)

Send marshals and sends the UpdateTask API request.

type UpdateTaskResponse added in v0.9.0 

type UpdateTaskResponse struct {
	*UpdateTaskOutput
	// contains filtered or unexported fields
}

UpdateTaskResponse is the response type for the UpdateTask API operation.

func (*UpdateTaskResponse) SDKResponseMetdata added in v0.9.0 

func (r *UpdateTaskResponse) SDKResponseMetdata() *aws.Response

SDKResponseMetdata returns the response metadata for the UpdateTask request.

type VerifyMode 

type VerifyMode string
const (
	VerifyModePointInTimeConsistent VerifyMode = "POINT_IN_TIME_CONSISTENT"
	VerifyModeOnlyFilesTransferred  VerifyMode = "ONLY_FILES_TRANSFERRED"
	VerifyModeNone                  VerifyMode = "NONE"
)

Enum values for VerifyMode

func (VerifyMode) MarshalValue 

func (enum VerifyMode) MarshalValue() (string, error)

func (VerifyMode) MarshalValueBuf 

func (enum VerifyMode) MarshalValueBuf(b []byte) ([]byte, error)

Source Files

View all Source files

Directories

Path Synopsis
Package datasynciface provides an interface to enable mocking the AWS DataSync service client for testing your code.
 Package datasynciface provides an interface to enable mocking the AWS DataSync service client for testing your code.

Jump to

Keyboard shortcuts

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