package datasync
import "github.com/aws/aws-sdk-go-v2/service/datasync"
Index ¶
- Constants
- func AddResolveEndpointMiddleware(stack *middleware.Stack, options ResolveEndpointMiddlewareOptions)
- func NewDefaultEndpointResolver() *internalendpoints.Resolver
- func RemoveResolveEndpointMiddleware(stack *middleware.Stack) error
- type CancelTaskExecutionInput
- type CancelTaskExecutionOutput
- type Client
- func New(options Options, optFns ...func(*Options)) *Client
- func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client
- func (c *Client) CancelTaskExecution(ctx context.Context, params *CancelTaskExecutionInput, optFns ...func(*Options)) (*CancelTaskExecutionOutput, error)
- func (c *Client) CreateAgent(ctx context.Context, params *CreateAgentInput, optFns ...func(*Options)) (*CreateAgentOutput, error)
- func (c *Client) CreateLocationEfs(ctx context.Context, params *CreateLocationEfsInput, optFns ...func(*Options)) (*CreateLocationEfsOutput, error)
- func (c *Client) CreateLocationFsxWindows(ctx context.Context, params *CreateLocationFsxWindowsInput, optFns ...func(*Options)) (*CreateLocationFsxWindowsOutput, error)
- func (c *Client) CreateLocationNfs(ctx context.Context, params *CreateLocationNfsInput, optFns ...func(*Options)) (*CreateLocationNfsOutput, error)
- func (c *Client) CreateLocationObjectStorage(ctx context.Context, params *CreateLocationObjectStorageInput, optFns ...func(*Options)) (*CreateLocationObjectStorageOutput, error)
- func (c *Client) CreateLocationS3(ctx context.Context, params *CreateLocationS3Input, optFns ...func(*Options)) (*CreateLocationS3Output, error)
- func (c *Client) CreateLocationSmb(ctx context.Context, params *CreateLocationSmbInput, optFns ...func(*Options)) (*CreateLocationSmbOutput, error)
- func (c *Client) CreateTask(ctx context.Context, params *CreateTaskInput, optFns ...func(*Options)) (*CreateTaskOutput, error)
- func (c *Client) DeleteAgent(ctx context.Context, params *DeleteAgentInput, optFns ...func(*Options)) (*DeleteAgentOutput, error)
- func (c *Client) DeleteLocation(ctx context.Context, params *DeleteLocationInput, optFns ...func(*Options)) (*DeleteLocationOutput, error)
- func (c *Client) DeleteTask(ctx context.Context, params *DeleteTaskInput, optFns ...func(*Options)) (*DeleteTaskOutput, error)
- func (c *Client) DescribeAgent(ctx context.Context, params *DescribeAgentInput, optFns ...func(*Options)) (*DescribeAgentOutput, error)
- func (c *Client) DescribeLocationEfs(ctx context.Context, params *DescribeLocationEfsInput, optFns ...func(*Options)) (*DescribeLocationEfsOutput, error)
- func (c *Client) DescribeLocationFsxWindows(ctx context.Context, params *DescribeLocationFsxWindowsInput, optFns ...func(*Options)) (*DescribeLocationFsxWindowsOutput, error)
- func (c *Client) DescribeLocationNfs(ctx context.Context, params *DescribeLocationNfsInput, optFns ...func(*Options)) (*DescribeLocationNfsOutput, error)
- func (c *Client) DescribeLocationObjectStorage(ctx context.Context, params *DescribeLocationObjectStorageInput, optFns ...func(*Options)) (*DescribeLocationObjectStorageOutput, error)
- func (c *Client) DescribeLocationS3(ctx context.Context, params *DescribeLocationS3Input, optFns ...func(*Options)) (*DescribeLocationS3Output, error)
- func (c *Client) DescribeLocationSmb(ctx context.Context, params *DescribeLocationSmbInput, optFns ...func(*Options)) (*DescribeLocationSmbOutput, error)
- func (c *Client) DescribeTask(ctx context.Context, params *DescribeTaskInput, optFns ...func(*Options)) (*DescribeTaskOutput, error)
- func (c *Client) DescribeTaskExecution(ctx context.Context, params *DescribeTaskExecutionInput, optFns ...func(*Options)) (*DescribeTaskExecutionOutput, error)
- func (c *Client) ListAgents(ctx context.Context, params *ListAgentsInput, optFns ...func(*Options)) (*ListAgentsOutput, error)
- func (c *Client) ListLocations(ctx context.Context, params *ListLocationsInput, optFns ...func(*Options)) (*ListLocationsOutput, error)
- func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)
- func (c *Client) ListTaskExecutions(ctx context.Context, params *ListTaskExecutionsInput, optFns ...func(*Options)) (*ListTaskExecutionsOutput, error)
- func (c *Client) ListTasks(ctx context.Context, params *ListTasksInput, optFns ...func(*Options)) (*ListTasksOutput, error)
- func (c *Client) StartTaskExecution(ctx context.Context, params *StartTaskExecutionInput, optFns ...func(*Options)) (*StartTaskExecutionOutput, error)
- func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)
- func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)
- func (c *Client) UpdateAgent(ctx context.Context, params *UpdateAgentInput, optFns ...func(*Options)) (*UpdateAgentOutput, error)
- func (c *Client) UpdateTask(ctx context.Context, params *UpdateTaskInput, optFns ...func(*Options)) (*UpdateTaskOutput, error)
- type CreateAgentInput
- type CreateAgentOutput
- type CreateLocationEfsInput
- type CreateLocationEfsOutput
- type CreateLocationFsxWindowsInput
- type CreateLocationFsxWindowsOutput
- type CreateLocationNfsInput
- type CreateLocationNfsOutput
- type CreateLocationObjectStorageInput
- type CreateLocationObjectStorageOutput
- type CreateLocationS3Input
- type CreateLocationS3Output
- type CreateLocationSmbInput
- type CreateLocationSmbOutput
- type CreateTaskInput
- type CreateTaskOutput
- type DeleteAgentInput
- type DeleteAgentOutput
- type DeleteLocationInput
- type DeleteLocationOutput
- type DeleteTaskInput
- type DeleteTaskOutput
- type DescribeAgentInput
- type DescribeAgentOutput
- type DescribeLocationEfsInput
- type DescribeLocationEfsOutput
- type DescribeLocationFsxWindowsInput
- type DescribeLocationFsxWindowsOutput
- type DescribeLocationNfsInput
- type DescribeLocationNfsOutput
- type DescribeLocationObjectStorageInput
- type DescribeLocationObjectStorageOutput
- type DescribeLocationS3Input
- type DescribeLocationS3Output
- type DescribeLocationSmbInput
- type DescribeLocationSmbOutput
- type DescribeTaskExecutionInput
- type DescribeTaskExecutionOutput
- type DescribeTaskInput
- type DescribeTaskOutput
- type EndpointResolver
- type EndpointResolverFunc
- type HTTPClient
- type HTTPSignerV4
- type ListAgentsInput
- type ListAgentsOutput
- type ListLocationsInput
- type ListLocationsOutput
- type ListTagsForResourceInput
- type ListTagsForResourceOutput
- type ListTaskExecutionsInput
- type ListTaskExecutionsOutput
- type ListTasksInput
- type ListTasksOutput
- type Options
- func (o Options) Copy() Options
- func (o Options) GetCredentials() aws.CredentialsProvider
- func (o Options) GetEndpointOptions() ResolverOptions
- func (o Options) GetEndpointResolver() EndpointResolver
- func (o Options) GetHTTPSignerV4() HTTPSignerV4
- func (o Options) GetRegion() string
- func (o Options) GetRetryer() retry.Retryer
- type ResolveEndpoint
- func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) ( out middleware.SerializeOutput, metadata middleware.Metadata, err error, )
- func (*ResolveEndpoint) ID() string
- type ResolveEndpointMiddlewareOptions
- type ResolverOptions
- type StartTaskExecutionInput
- type StartTaskExecutionOutput
- type TagResourceInput
- type TagResourceOutput
- type UntagResourceInput
- type UntagResourceOutput
- type UpdateAgentInput
- type UpdateAgentOutput
- type UpdateTaskInput
- type UpdateTaskOutput
Constants ¶
const ServiceAPIVersion = "2018-11-09"
const ServiceID = "DataSync"
Functions ¶
func AddResolveEndpointMiddleware ¶
func AddResolveEndpointMiddleware(stack *middleware.Stack, options ResolveEndpointMiddlewareOptions)
func NewDefaultEndpointResolver ¶
func NewDefaultEndpointResolver() *internalendpoints.Resolver
NewDefaultEndpointResolver constructs a new service endpoint resolver
func RemoveResolveEndpointMiddleware ¶
func RemoveResolveEndpointMiddleware(stack *middleware.Stack) error
Types ¶
type CancelTaskExecutionInput ¶
type CancelTaskExecutionInput struct { // The Amazon Resource Name (ARN) of the task execution to cancel. TaskExecutionArn *string }
CancelTaskExecutionRequest
type CancelTaskExecutionOutput ¶
type CancelTaskExecutionOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
AWS DataSync <p>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). </p> <p>This API interface reference for AWS DataSync contains documentation for a programming interface that you can use to manage AWS DataSync.</p>
func New ¶
New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.
func NewFromConfig ¶
NewFromConfig returns a new client from the provided config.
func (*Client) CancelTaskExecution ¶
func (c *Client) CancelTaskExecution(ctx context.Context, params *CancelTaskExecutionInput, optFns ...func(*Options)) (*CancelTaskExecutionOutput, error)
Cancels execution of a task. When you cancel a task execution, the transfer of some files is abruptly interrupted. The contents of files that are transferred to the destination might be incomplete or inconsistent with the source files. However, if you start a new task execution on the same task and you allow the task execution to complete, file content on the destination is complete and consistent. This applies to other unexpected failures that interrupt a task execution. In all of these cases, AWS DataSync successfully complete the transfer when you start the next task execution.
func (*Client) CreateAgent ¶
func (c *Client) CreateAgent(ctx context.Context, params *CreateAgentInput, optFns ...func(*Options)) (*CreateAgentOutput, error)
Activates an 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. <p>Agents are automatically updated by AWS on a regular basis, using a mechanism that ensures minimal interruption to your tasks.</p> <p></p>
func (*Client) CreateLocationEfs ¶
func (c *Client) CreateLocationEfs(ctx context.Context, params *CreateLocationEfsInput, optFns ...func(*Options)) (*CreateLocationEfsOutput, error)
Creates an endpoint for an Amazon EFS file system.
func (*Client) CreateLocationFsxWindows ¶
func (c *Client) CreateLocationFsxWindows(ctx context.Context, params *CreateLocationFsxWindowsInput, optFns ...func(*Options)) (*CreateLocationFsxWindowsOutput, error)
Creates an endpoint for an Amazon FSx for Windows file system.
func (*Client) CreateLocationNfs ¶
func (c *Client) CreateLocationNfs(ctx context.Context, params *CreateLocationNfsInput, optFns ...func(*Options)) (*CreateLocationNfsOutput, error)
Defines a file system on a Network File System (NFS) server that can be read from or written to.
func (*Client) CreateLocationObjectStorage ¶
func (c *Client) CreateLocationObjectStorage(ctx context.Context, params *CreateLocationObjectStorageInput, optFns ...func(*Options)) (*CreateLocationObjectStorageOutput, error)
Creates an endpoint for a self-managed object storage bucket.
func (*Client) CreateLocationS3 ¶
func (c *Client) CreateLocationS3(ctx context.Context, params *CreateLocationS3Input, optFns ...func(*Options)) (*CreateLocationS3Output, error)
Creates an endpoint for an Amazon S3 bucket. For 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. <p>For more information, see https://docs.aws.amazon.com/datasync/latest/userguide/working-with-locations.html#create-s3-location in the <i>AWS DataSync User Guide.</i> </p>
func (*Client) CreateLocationSmb ¶
func (c *Client) CreateLocationSmb(ctx context.Context, params *CreateLocationSmbInput, optFns ...func(*Options)) (*CreateLocationSmbOutput, error)
Defines a file system on a Server Message Block (SMB) server that can be read from or written to.
func (*Client) CreateTask ¶
func (c *Client) CreateTask(ctx context.Context, params *CreateTaskInput, optFns ...func(*Options)) (*CreateTaskOutput, error)
Creates a task. A task 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.
func (*Client) DeleteAgent ¶
func (c *Client) DeleteAgent(ctx context.Context, params *DeleteAgentInput, optFns ...func(*Options)) (*DeleteAgentOutput, error)
Deletes an agent. To specify which agent to delete, use the Amazon Resource Name (ARN) of the agent in your request. The operation disassociates the agent from your AWS account. However, it doesn't delete the agent virtual machine (VM) from your on-premises environment.
func (*Client) DeleteLocation ¶
func (c *Client) DeleteLocation(ctx context.Context, params *DeleteLocationInput, optFns ...func(*Options)) (*DeleteLocationOutput, error)
Deletes the configuration of a location used by AWS DataSync.
func (*Client) DeleteTask ¶
func (c *Client) DeleteTask(ctx context.Context, params *DeleteTaskInput, optFns ...func(*Options)) (*DeleteTaskOutput, error)
Deletes a task.
func (*Client) DescribeAgent ¶
func (c *Client) DescribeAgent(ctx context.Context, params *DescribeAgentInput, optFns ...func(*Options)) (*DescribeAgentOutput, error)
Returns metadata such as the name, the network interfaces, and the status (that is, whether the agent is running or not) for an agent. To specify which agent to describe, use the Amazon Resource Name (ARN) of the agent in your request.
func (*Client) DescribeLocationEfs ¶
func (c *Client) DescribeLocationEfs(ctx context.Context, params *DescribeLocationEfsInput, optFns ...func(*Options)) (*DescribeLocationEfsOutput, error)
Returns metadata, such as the path information about an Amazon EFS location.
func (*Client) DescribeLocationFsxWindows ¶
func (c *Client) DescribeLocationFsxWindows(ctx context.Context, params *DescribeLocationFsxWindowsInput, optFns ...func(*Options)) (*DescribeLocationFsxWindowsOutput, error)
Returns metadata, such as the path information about an Amazon FSx for Windows location.
func (*Client) DescribeLocationNfs ¶
func (c *Client) DescribeLocationNfs(ctx context.Context, params *DescribeLocationNfsInput, optFns ...func(*Options)) (*DescribeLocationNfsOutput, error)
Returns metadata, such as the path information, about an NFS location.
func (*Client) DescribeLocationObjectStorage ¶
func (c *Client) DescribeLocationObjectStorage(ctx context.Context, params *DescribeLocationObjectStorageInput, optFns ...func(*Options)) (*DescribeLocationObjectStorageOutput, error)
Returns metadata about a self-managed object storage server location.
func (*Client) DescribeLocationS3 ¶
func (c *Client) DescribeLocationS3(ctx context.Context, params *DescribeLocationS3Input, optFns ...func(*Options)) (*DescribeLocationS3Output, error)
Returns metadata, such as bucket name, about an Amazon S3 bucket location.
func (*Client) DescribeLocationSmb ¶
func (c *Client) DescribeLocationSmb(ctx context.Context, params *DescribeLocationSmbInput, optFns ...func(*Options)) (*DescribeLocationSmbOutput, error)
Returns metadata, such as the path and user information about an SMB location.
func (*Client) DescribeTask ¶
func (c *Client) DescribeTask(ctx context.Context, params *DescribeTaskInput, optFns ...func(*Options)) (*DescribeTaskOutput, error)
Returns metadata about a task.
func (*Client) DescribeTaskExecution ¶
func (c *Client) DescribeTaskExecution(ctx context.Context, params *DescribeTaskExecutionInput, optFns ...func(*Options)) (*DescribeTaskExecutionOutput, error)
Returns detailed metadata about a task that is being executed.
func (*Client) ListAgents ¶
func (c *Client) ListAgents(ctx context.Context, params *ListAgentsInput, optFns ...func(*Options)) (*ListAgentsOutput, error)
Returns a list of agents owned by an 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.
func (*Client) ListLocations ¶
func (c *Client) ListLocations(ctx context.Context, params *ListLocationsInput, optFns ...func(*Options)) (*ListLocationsOutput, error)
Returns a list of source and destination locations. If you have more locations than are returned in a response (that is, the response returns only a truncated list of your agents), the response contains a token that you can specify in your next request to fetch the next page of locations.
func (*Client) ListTagsForResource ¶
func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)
Returns all the tags associated with a specified resource.
func (*Client) ListTaskExecutions ¶
func (c *Client) ListTaskExecutions(ctx context.Context, params *ListTaskExecutionsInput, optFns ...func(*Options)) (*ListTaskExecutionsOutput, error)
Returns a list of executed tasks.
func (*Client) ListTasks ¶
func (c *Client) ListTasks(ctx context.Context, params *ListTasksInput, optFns ...func(*Options)) (*ListTasksOutput, error)
Returns a list of all the tasks.
func (*Client) StartTaskExecution ¶
func (c *Client) StartTaskExecution(ctx context.Context, params *StartTaskExecutionInput, optFns ...func(*Options)) (*StartTaskExecutionOutput, error)
Starts a specific invocation of a task. A TaskExecution value represents an individual run of a task. Each task can have at most one TaskExecution at a time. TaskExecution has the following transition phases: INITIALIZING | PREPARING | TRANSFERRING | VERIFYING | SUCCESS/FAILURE. <p>For detailed information, see the Task Execution section in the Components and Terminology topic in the <i>AWS DataSync User Guide</i>.</p>
func (*Client) TagResource ¶
func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)
Applies a key-value pair to an AWS resource.
func (*Client) UntagResource ¶
func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)
Removes a tag from an AWS resource.
func (*Client) UpdateAgent ¶
func (c *Client) UpdateAgent(ctx context.Context, params *UpdateAgentInput, optFns ...func(*Options)) (*UpdateAgentOutput, error)
Updates the name of an agent.
func (*Client) UpdateTask ¶
func (c *Client) UpdateTask(ctx context.Context, params *UpdateTaskInput, optFns ...func(*Options)) (*UpdateTaskOutput, error)
Updates the metadata associated with a task.
type CreateAgentInput ¶
type CreateAgentInput struct { // The Amazon Resource Names (ARNs) of the subnets in which DataSync will create // elastic network interfaces for each data transfer task. The agent that runs a // task must be private. When you start a task that is associated with an agent // created in a VPC, or one that has access to an IP address in a VPC, then the // task is also private. In this case, DataSync creates four network interfaces for // each task in your subnet. For a data transfer to work, the agent must be able to // route to all these four network interfaces. SubnetArns []*string // The key-value pair that represents the tag that you want to associate with the // agent. The value can be an empty string. This value helps you manage, filter, // and search for your agents. Valid characters for key and value are letters, // spaces, and numbers representable in UTF-8 format, and the following special // characters: + - = . _ : / @. Tags []*types.TagListEntry // The ID of the VPC (virtual private cloud) endpoint that the agent has access to. // This is the client-side VPC endpoint, also called a PrivateLink. If you don't // have a PrivateLink VPC endpoint, see Creating a VPC Endpoint Service // Configuration // (https://docs.aws.amazon.com/vpc/latest/userguide/endpoint-service.html#create-endpoint-service) // in the Amazon VPC User Guide. VPC endpoint ID looks like this: // vpce-01234d5aff67890e1. VpcEndpointId *string // 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 // 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. // <p>For more information, see Activating an Agent in the <i>AWS DataSync User // Guide.</i> </p> ActivationKey *string // The ARNs of the security groups used to protect your data transfer task subnets. // See CreateAgentRequest$SubnetArns (). SecurityGroupArns []*string }
CreateAgentRequest
type CreateAgentOutput ¶
type CreateAgentOutput struct { // The Amazon Resource Name (ARN) of the agent. Use the ListAgents operation to // return a list of agents for your account and AWS Region. AgentArn *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
CreateAgentResponse
type CreateLocationEfsInput ¶
type CreateLocationEfsInput struct { // 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 // The key-value pair that represents a tag that you want to add to the resource. // The value can be an empty string. This value helps you manage, filter, and // search for your resources. We recommend that you create a name tag for your // location. Tags []*types.TagListEntry // The Amazon Resource Name (ARN) for the Amazon EFS file system. EfsFilesystemArn *string // 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. <p>For information about security // groups and mount targets, see Security Groups for Amazon EC2 Instances and Mount // Targets in the <i>Amazon EFS User Guide.</i> </p> </li> </ul> Ec2Config *types.Ec2Config }
CreateLocationEfsRequest
type CreateLocationEfsOutput ¶
type CreateLocationEfsOutput struct { // The Amazon Resource Name (ARN) of the Amazon EFS file system location that is // created. LocationArn *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
CreateLocationEfs
type CreateLocationFsxWindowsInput ¶
type CreateLocationFsxWindowsInput struct { // The Amazon Resource Names (ARNs) of the security groups that are to use to // configure the FSx for Windows file system. SecurityGroupArns []*string // The Amazon Resource Name (ARN) for the FSx for Windows file system. FsxFilesystemArn *string // The name of the Windows domain that the FSx for Windows server belongs to. Domain *string // The password of the user who has the permissions to access files and folders in // the FSx for Windows file system. Password *string // The key-value pair that represents a tag that you want to add to the resource. // The value can be an empty string. This value helps you manage, filter, and // search for your resources. We recommend that you create a name tag for your // location. Tags []*types.TagListEntry // The user who has the permissions to access files and folders in the FSx for // Windows file system. User *string // 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 CreateLocationFsxWindowsOutput ¶
type CreateLocationFsxWindowsOutput struct { // The Amazon Resource Name (ARN) of the FSx for Windows file system location that // is created. LocationArn *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type CreateLocationNfsInput ¶
type CreateLocationNfsInput struct { // The NFS mount options that DataSync can use to mount your NFS share. MountOptions *types.NfsMountOptions // Contains a list of Amazon Resource Names (ARNs) of agents that are used to // connect to an NFS server. If you are copying data to or from your AWS Snowcone // device, see NFS Server on AWS Snowcone // (https://docs.aws.amazon.com/datasync/latest/userguide/create-nfs-location.html#nfs-on-snowcone) // for more information. OnPremConfig *types.OnPremConfig // The key-value pair that represents the tag that you want to add to the location. // The value can be an empty string. We recommend using tags to name your // resources. Tags []*types.TagListEntry // The name of the NFS server. This value is the IP address or Domain Name Service // (DNS) name of the NFS server. An agent that is installed on-premises uses this // host name to mount the NFS server in a network. If you are copying data to or // from your AWS Snowcone device, see NFS Server on AWS Snowcone // (https://docs.aws.amazon.com/datasync/latest/userguide/create-nfs-location.html#nfs-on-snowcone) // for more information. This name must either be DNS-compliant or must be an IP // version 4 (IPv4) address. ServerHostname *string // The subdirectory in the NFS file system that is used to read data from the NFS // source location or write data to the NFS destination. The NFS path should be a // path that's exported by the NFS server, or a subdirectory of that path. The path // should be such that it can be mounted by other NFS clients in your network. To // see all the paths exported by your NFS server. run "showmount -e // nfs-server-name" from an NFS client that has access to your server. You can // specify any directory that appears in the results, and any subdirectory of that // directory. Ensure that the NFS export is accessible without Kerberos // authentication. To transfer all the data in the folder you specified, DataSync // needs to have permissions to read all the data. To ensure this, either configure // the NFS export with no_root_squash, or ensure that the permissions for all of // the files that you want DataSync allow read access for all users. Doing either // enables the agent to read the files. For the agent to access directories, you // must additionally enable all execute access. If you are copying data to or from // your AWS Snowcone device, see NFS Server on AWS Snowcone // (https://docs.aws.amazon.com/datasync/latest/userguide/create-nfs-location.html#nfs-on-snowcone) // for more information. <p>For information about NFS export configuration, see // 18.7. The /etc/exports Configuration File in the Red Hat Enterprise Linux // documentation.</p> Subdirectory *string }
CreateLocationNfsRequest
type CreateLocationNfsOutput ¶
type CreateLocationNfsOutput struct { // The Amazon Resource Name (ARN) of the source NFS file system location that is // created. LocationArn *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
CreateLocationNfsResponse
type CreateLocationObjectStorageInput ¶
type CreateLocationObjectStorageInput struct { // The protocol that the object storage server uses to communicate. Valid values // are HTTP or HTTPS. ServerProtocol types.ObjectStorageServerProtocol // The key-value pair that represents the tag that you want to add to the location. // The value can be an empty string. We recommend using tags to name your // resources. Tags []*types.TagListEntry // The subdirectory in the self-managed object storage server that is used to read // data from. Subdirectory *string // The Amazon Resource Name (ARN) of the agents associated with the self-managed // object storage server location. AgentArns []*string // The bucket on the self-managed object storage server that is used to read data // from. BucketName *string // Optional. The access key is used if credentials are required to access the // self-managed object storage server. AccessKey *string // Optional. The secret key is used if credentials are required to access the // self-managed object storage server. SecretKey *string // The port that your self-managed object storage server accepts inbound network // traffic on. The server port is set by default to TCP 80 (HTTP) or TCP 443 // (HTTPS). You can specify a custom port if your self-managed object storage // server requires one. ServerPort *int32 // The name of the self-managed object storage server. This value is the IP address // or Domain Name Service (DNS) name of the object storage server. An agent uses // this host name to mount the object storage server in a network. ServerHostname *string }
CreateLocationObjectStorageRequest
type CreateLocationObjectStorageOutput ¶
type CreateLocationObjectStorageOutput struct { // The Amazon Resource Name (ARN) of the agents associated with the self-managed // object storage server location. LocationArn *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
CreateLocationObjectStorageResponse
type CreateLocationS3Input ¶
type CreateLocationS3Input struct { // The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) // role that is used to access an Amazon S3 bucket. <p>For detailed information // about using such a role, see Creating a Location for Amazon S3 in the <i>AWS // DataSync User Guide</i>.</p> S3Config *types.S3Config // 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 types.S3StorageClass // A subdirectory in the Amazon S3 bucket. This subdirectory in Amazon S3 is used // to read data from the S3 source location or write data to the S3 destination. Subdirectory *string // The key-value pair that represents the tag that you want to add to the location. // The value can be an empty string. We recommend using tags to name your // resources. Tags []*types.TagListEntry // The Amazon Resource Name (ARN) of the Amazon S3 bucket. S3BucketArn *string }
CreateLocationS3Request
type CreateLocationS3Output ¶
type CreateLocationS3Output struct { // The Amazon Resource Name (ARN) of the source Amazon S3 bucket location that is // created. LocationArn *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
CreateLocationS3Response
type CreateLocationSmbInput ¶
type CreateLocationSmbInput struct { // The name of the Windows domain that the SMB server belongs to. Domain *string // The Amazon Resource Names (ARNs) of agents to use for a Simple Message Block // (SMB) location. AgentArns []*string // The mount options used by DataSync to access the SMB server. MountOptions *types.SmbMountOptions // The password of the user who can mount the share, has the permissions to access // files and folders in the SMB share. Password *string // The user who can mount the share, has the permissions to access files and // folders in the SMB share. User *string // The key-value pair that represents the tag that you want to add to the location. // The value can be an empty string. We recommend using tags to name your // resources. Tags []*types.TagListEntry // 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. <p>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.</p> Subdirectory *string // The name of the SMB server. This value is the IP address or Domain Name Service // (DNS) name of the SMB server. An agent that is installed on-premises uses this // hostname to mount the SMB server in a network. This name must either be // DNS-compliant or must be an IP version 4 (IPv4) address. ServerHostname *string }
CreateLocationSmbRequest
type CreateLocationSmbOutput ¶
type CreateLocationSmbOutput struct { // The Amazon Resource Name (ARN) of the source SMB file system location that is // created. LocationArn *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
CreateLocationSmbResponse
type CreateTaskInput ¶
type CreateTaskInput struct { // The Amazon Resource Name (ARN) of the source location for the task. SourceLocationArn *string // The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that is used // to monitor and log events in the task. CloudWatchLogGroupArn *string // The name of a task. This value is a text reference that is used to identify the // task in the console. Name *string // The Amazon Resource Name (ARN) of an AWS storage resource's location. DestinationLocationArn *string // The key-value pair that represents the tag that you want to add to the resource. // The value can be an empty string. Tags []*types.TagListEntry // A list of filter rules that determines which files to exclude from a task. The // list should contain a single filter string that consists of the patterns to // exclude. The patterns are delimited by "|" (that is, a pipe), for example, // "/folder1|/folder2" Excludes []*types.FilterRule // 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 *types.TaskSchedule // The set of configuration options that control the behavior of a single execution // of the task that occurs when you call StartTaskExecution. You can configure // these options to preserve metadata such as user ID (UID) and group ID (GID), // file permissions, data integrity verification, and so on. For each individual // task execution, you can override these options by specifying the OverrideOptions // before starting the task execution. For more information, see the operation. Options *types.Options }
CreateTaskRequest
type CreateTaskOutput ¶
type CreateTaskOutput struct { // The Amazon Resource Name (ARN) of the task. TaskArn *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
CreateTaskResponse
type DeleteAgentInput ¶
type DeleteAgentInput struct { // The Amazon Resource Name (ARN) of the agent to delete. Use the ListAgents // operation to return a list of agents for your account and AWS Region. AgentArn *string }
DeleteAgentRequest
type DeleteAgentOutput ¶
type DeleteAgentOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DeleteLocationInput ¶
type DeleteLocationInput struct { // The Amazon Resource Name (ARN) of the location to delete. LocationArn *string }
DeleteLocation
type DeleteLocationOutput ¶
type DeleteLocationOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DeleteTaskInput ¶
type DeleteTaskInput struct { // The Amazon Resource Name (ARN) of the task to delete. TaskArn *string }
DeleteTask
type DeleteTaskOutput ¶
type DeleteTaskOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DescribeAgentInput ¶
type DescribeAgentInput struct { // The Amazon Resource Name (ARN) of the agent to describe. AgentArn *string }
DescribeAgent
type DescribeAgentOutput ¶
type DescribeAgentOutput struct { // The time that the agent was activated (that is, created in your account). CreationTime *time.Time // The name of the agent. Name *string // The type of endpoint that your agent is connected to. If the endpoint is a VPC // endpoint, the agent is not accessible over the public internet. EndpointType types.EndpointType // The time that the agent last connected to DataSyc. LastConnectionTime *time.Time // The status of the agent. If the status is ONLINE, then the agent is configured // properly and is available to use. The Running status is the normal running // status for an agent. If the status is OFFLINE, the agent's VM is turned off or // the agent is in an unhealthy state. When the issue that caused the unhealthy // state is resolved, the agent returns to ONLINE status. Status types.AgentStatus // The subnet and the security group that DataSync used to access a VPC endpoint. PrivateLinkConfig *types.PrivateLinkConfig // The Amazon Resource Name (ARN) of the agent. AgentArn *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
DescribeAgentResponse
type DescribeLocationEfsInput ¶
type DescribeLocationEfsInput struct { // The Amazon Resource Name (ARN) of the EFS location to describe. LocationArn *string }
DescribeLocationEfsRequest
type DescribeLocationEfsOutput ¶
type DescribeLocationEfsOutput struct { // The subnet and the security group that DataSync uses to access target EFS file // system. The subnet must have at least one mount target for that file system. The // security group that you provide needs to be able to communicate with the // security group on the mount target in the subnet specified. Ec2Config *types.Ec2Config // The URL of the EFS location that was described. LocationUri *string // The Amazon Resource Name (ARN) of the EFS location that was described. LocationArn *string // The time that the EFS location was created. CreationTime *time.Time // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
DescribeLocationEfsResponse
type DescribeLocationFsxWindowsInput ¶
type DescribeLocationFsxWindowsInput struct { // The Amazon Resource Name (ARN) of the FSx for Windows location to describe. LocationArn *string }
type DescribeLocationFsxWindowsOutput ¶
type DescribeLocationFsxWindowsOutput struct { // The Amazon Resource Name (ARN) of the FSx for Windows location that was // described. LocationArn *string // The user who has the permissions to access files and folders in the FSx for // Windows file system. User *string // The name of the Windows domain that the FSx for Windows server belongs to. Domain *string // The Amazon Resource Names (ARNs) of the security groups that are configured for // the FSx for Windows file system. SecurityGroupArns []*string // The time that the FSx for Windows location was created. CreationTime *time.Time // The URL of the FSx for Windows location that was described. LocationUri *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type DescribeLocationNfsInput ¶
type DescribeLocationNfsInput struct { // The Amazon Resource Name (ARN) of the NFS location to describe. LocationArn *string }
DescribeLocationNfsRequest
type DescribeLocationNfsOutput ¶
type DescribeLocationNfsOutput struct { // The URL of the source NFS location that was described. LocationUri *string // The NFS mount options that DataSync used to mount your NFS share. MountOptions *types.NfsMountOptions // The Amazon Resource Name (ARN) of the NFS location that was described. LocationArn *string // A list of Amazon Resource Names (ARNs) of agents to use for a Network File // System (NFS) location. OnPremConfig *types.OnPremConfig // The time that the NFS location was created. CreationTime *time.Time // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
DescribeLocationNfsResponse
type DescribeLocationObjectStorageInput ¶
type DescribeLocationObjectStorageInput struct { // The Amazon Resource Name (ARN) of the self-managed object storage server // location that was described. LocationArn *string }
DescribeLocationObjectStorageRequest
type DescribeLocationObjectStorageOutput ¶
type DescribeLocationObjectStorageOutput struct { // The Amazon Resource Name (ARN) of the agents associated with the self-managed // object storage server location. AgentArns []*string // The Amazon Resource Name (ARN) of the self-managed object storage server // location to describe. LocationArn *string // The URL of the source self-managed object storage server location that was // described. LocationUri *string // Optional. The access key is used if credentials are required to access the // self-managed object storage server. AccessKey *string // The port that your self-managed object storage server accepts inbound network // traffic on. The server port is set by default to TCP 80 (HTTP) or TCP 443 // (HTTPS). ServerPort *int32 // The time that the self-managed object storage server agent was created. CreationTime *time.Time // The protocol that the object storage server uses to communicate. Valid values // are HTTP or HTTPS. ServerProtocol types.ObjectStorageServerProtocol // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
DescribeLocationObjectStorageResponse
type DescribeLocationS3Input ¶
type DescribeLocationS3Input struct { // The Amazon Resource Name (ARN) of the Amazon S3 bucket location to describe. LocationArn *string }
DescribeLocationS3Request
type DescribeLocationS3Output ¶
type DescribeLocationS3Output struct { // The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) // role that is used to access an Amazon S3 bucket. <p>For detailed information // about using such a role, see Creating a Location for Amazon S3 in the <i>AWS // DataSync User Guide</i>.</p> S3Config *types.S3Config // The time that the Amazon S3 bucket location was created. CreationTime *time.Time // 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 types.S3StorageClass // The Amazon Resource Name (ARN) of the Amazon S3 bucket location. LocationArn *string // The URL of the Amazon S3 location that was described. LocationUri *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
DescribeLocationS3Response
type DescribeLocationSmbInput ¶
type DescribeLocationSmbInput struct { // The Amazon Resource Name (ARN) of the SMB location to describe. LocationArn *string }
DescribeLocationSmbRequest
type DescribeLocationSmbOutput ¶
type DescribeLocationSmbOutput struct { // The Amazon Resource Name (ARN) of the SMB location that was described. LocationArn *string // The Amazon Resource Name (ARN) of the source SMB file system location that is // created. AgentArns []*string // The time that the SMB location was created. CreationTime *time.Time // The user who can mount the share, has the permissions to access files and // folders in the SMB share. User *string // The name of the Windows domain that the SMB server belongs to. Domain *string // The mount options that are available for DataSync to use to access an SMB // location. MountOptions *types.SmbMountOptions // The URL of the source SBM location that was described. LocationUri *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
DescribeLocationSmbResponse
type DescribeTaskExecutionInput ¶
type DescribeTaskExecutionInput struct { // The Amazon Resource Name (ARN) of the task that is being executed. TaskExecutionArn *string }
DescribeTaskExecutionRequest
type DescribeTaskExecutionOutput ¶
type DescribeTaskExecutionOutput struct { // A list of filter rules that determines which files to include when running a // task. The list should contain a single filter string that consists of the // patterns to include. The patterns are delimited by "|" (that is, a pipe), for // example: "/folder1|/folder2" Includes []*types.FilterRule // The status of the task execution. <p>For detailed information about task // execution statuses, see Understanding Task Statuses in the <i>AWS DataSync User // Guide.</i> </p> Status types.TaskExecutionStatus // 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 // 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 *types.Options // 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 // The number of logical bytes written to the destination AWS storage resource. BytesWritten *int64 // The physical number of bytes transferred over the network. BytesTransferred *int64 // The time that the task execution was started. StartTime *time.Time // 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 // The estimated physical number of bytes that is to be transferred over the // network. EstimatedBytesToTransfer *int64 // A list of filter rules that determines which files to exclude from a task. The // list should contain a single filter string that consists of the patterns to // exclude. The patterns are delimited by "|" (that is, a pipe), for example: // "/folder1|/folder2" Excludes []*types.FilterRule // The result of the task execution. Result *types.TaskExecutionResultDetail // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
DescribeTaskExecutionResponse
type DescribeTaskInput ¶
type DescribeTaskInput struct { // The Amazon Resource Name (ARN) of the task to describe. TaskArn *string }
DescribeTaskRequest
type DescribeTaskOutput ¶
type DescribeTaskOutput struct { // The Amazon Resource Name (ARN) of the destination ENIs (Elastic Network // Interface) that was created for your subnet. DestinationNetworkInterfaceArns []*string // Errors that AWS DataSync encountered during execution of the task. You can use // this error code to help troubleshoot issues. ErrorCode *string // The Amazon Resource Name (ARN) of the source file system's location. SourceLocationArn *string // The time that the task was created. CreationTime *time.Time // Detailed description of an error that was encountered during the task execution. // You can use this information to help troubleshoot issues. ErrorDetail *string // The status of the task that was described. <p>For detailed information about // task execution statuses, see Understanding Task Statuses in the <i>AWS DataSync // User Guide.</i> </p> Status types.TaskStatus // 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 *types.Options // The Amazon Resource Name (ARN) of the AWS storage resource's location. DestinationLocationArn *string // The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that was used // to monitor and log events in the task. <p>For more information on these groups, // see Working with Log Groups and Log Streams in the <i>Amazon CloudWatch User // Guide</i>.</p> CloudWatchLogGroupArn *string // The Amazon Resource Name (ARN) of the source ENIs (Elastic Network Interface) // that was created for your subnet. SourceNetworkInterfaceArns []*string // The schedule used to periodically transfer files from a source to a destination // location. Schedule *types.TaskSchedule // The name of the task that was described. Name *string // The Amazon Resource Name (ARN) of the task execution that is syncing files. CurrentTaskExecutionArn *string // A list of filter rules that determines which files to exclude from a task. The // list should contain a single filter string that consists of the patterns to // exclude. The patterns are delimited by "|" (that is, a pipe), for example: // "/folder1|/folder2" Excludes []*types.FilterRule // The Amazon Resource Name (ARN) of the task that was described. TaskArn *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
DescribeTaskResponse
type EndpointResolver ¶
type EndpointResolver interface { ResolveEndpoint(region string, options ResolverOptions) (aws.Endpoint, error) }
EndpointResolver interface for resolving service endpoints.
func WithEndpointResolver ¶
func WithEndpointResolver(awsResolver aws.EndpointResolver, fallbackResolver EndpointResolver) EndpointResolver
WithEndpointResolver returns an EndpointResolver that first delegates endpoint resolution to the awsResolver. If awsResolver returns aws.EndpointNotFoundError error, the resolver will use the the provided fallbackResolver for resolution. awsResolver and fallbackResolver must not be nil
type EndpointResolverFunc ¶
type EndpointResolverFunc func(region string, options ResolverOptions) (aws.Endpoint, error)
EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.
func (EndpointResolverFunc) ResolveEndpoint ¶
func (fn EndpointResolverFunc) ResolveEndpoint(region string, options ResolverOptions) (endpoint aws.Endpoint, err error)
type HTTPClient ¶
type HTTPSignerV4 ¶
type HTTPSignerV4 interface { SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time) error }
type ListAgentsInput ¶
type ListAgentsInput struct { // The maximum number of agents to list. MaxResults *int32 // An opaque string that indicates the position at which to begin the next list of // agents. NextToken *string }
ListAgentsRequest
type ListAgentsOutput ¶
type ListAgentsOutput struct { // A list of agents in your account. Agents []*types.AgentListEntry // An opaque string that indicates the position at which to begin returning the // next list of agents. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
ListAgentsResponse
type ListLocationsInput ¶
type ListLocationsInput struct { // An opaque string that indicates the position at which to begin the next list of // locations. NextToken *string // The maximum number of locations to return. MaxResults *int32 }
ListLocationsRequest
type ListLocationsOutput ¶
type ListLocationsOutput struct { // An opaque string that indicates the position at which to begin returning the // next list of locations. NextToken *string // An array that contains a list of locations. Locations []*types.LocationListEntry // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
ListLocationsResponse
type ListTagsForResourceInput ¶
type ListTagsForResourceInput struct { // The Amazon Resource Name (ARN) of the resource whose tags to list. ResourceArn *string // The maximum number of locations to return. MaxResults *int32 // An opaque string that indicates the position at which to begin the next list of // locations. NextToken *string }
ListTagsForResourceRequest
type ListTagsForResourceOutput ¶
type ListTagsForResourceOutput struct { // Array of resource tags. Tags []*types.TagListEntry // An opaque string that indicates the position at which to begin returning the // next list of resource tags. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
ListTagsForResourceResponse
type ListTaskExecutionsInput ¶
type ListTaskExecutionsInput struct { // The maximum number of executed tasks to list. MaxResults *int32 // An opaque string that indicates the position at which to begin the next list of // the executed tasks. NextToken *string // The Amazon Resource Name (ARN) of the task whose tasks you want to list. TaskArn *string }
ListTaskExecutions
type ListTaskExecutionsOutput ¶
type ListTaskExecutionsOutput struct { // An opaque string that indicates the position at which to begin returning the // next list of executed tasks. NextToken *string // A list of executed tasks. TaskExecutions []*types.TaskExecutionListEntry // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
ListTaskExecutionsResponse
type ListTasksInput ¶
type ListTasksInput struct { // The maximum number of tasks to return. MaxResults *int32 // An opaque string that indicates the position at which to begin the next list of // tasks. NextToken *string }
ListTasksRequest
type ListTasksOutput ¶
type ListTasksOutput struct { // An opaque string that indicates the position at which to begin returning the // next list of tasks. NextToken *string // A list of all the tasks that are returned. Tasks []*types.TaskListEntry // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
ListTasksResponse
type Options ¶
type Options struct { // Set of options to modify how an operation is invoked. These apply to all // operations invoked for this client. Use functional options on operation call to // modify this list for per operation behavior. APIOptions []func(*middleware.Stack) error // The credentials object to use when signing requests. Credentials aws.CredentialsProvider // The endpoint options to be used when attempting to resolve an endpoint. EndpointOptions ResolverOptions // The service endpoint resolver. EndpointResolver EndpointResolver // Signature Version 4 (SigV4) Signer HTTPSignerV4 HTTPSignerV4 // The region to send requests to. (Required) Region string // Retryer guides how HTTP requests should be retried in case of recoverable // failures. When nil the API client will use a default retryer. Retryer retry.Retryer // The HTTP client to invoke API calls with. Defaults to client's default HTTP // implementation if nil. HTTPClient HTTPClient }
func (Options) Copy ¶
Copy creates a clone where the APIOptions list is deep copied.
func (Options) GetCredentials ¶
func (o Options) GetCredentials() aws.CredentialsProvider
func (Options) GetEndpointOptions ¶
func (o Options) GetEndpointOptions() ResolverOptions
func (Options) GetEndpointResolver ¶
func (o Options) GetEndpointResolver() EndpointResolver
func (Options) GetHTTPSignerV4 ¶
func (o Options) GetHTTPSignerV4() HTTPSignerV4
func (Options) GetRegion ¶
func (Options) GetRetryer ¶
type ResolveEndpoint ¶
type ResolveEndpoint struct { Resolver EndpointResolver Options ResolverOptions }
func (*ResolveEndpoint) HandleSerialize ¶
func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) ( out middleware.SerializeOutput, metadata middleware.Metadata, err error, )
func (*ResolveEndpoint) ID ¶
func (*ResolveEndpoint) ID() string
type ResolveEndpointMiddlewareOptions ¶
type ResolveEndpointMiddlewareOptions interface { GetEndpointResolver() EndpointResolver GetEndpointOptions() ResolverOptions }
type ResolverOptions ¶
type ResolverOptions = internalendpoints.Options
ResolverOptions is the service endpoint resolver options
type StartTaskExecutionInput ¶
type StartTaskExecutionInput struct { // 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 *types.Options // The Amazon Resource Name (ARN) of the task to start. TaskArn *string // A list of filter rules that determines which files to include when running a // task. The pattern should contain a single filter string that consists of the // patterns to include. The patterns are delimited by "|" (that is, a pipe). For // example: "/folder1|/folder2" Includes []*types.FilterRule }
StartTaskExecutionRequest
type StartTaskExecutionOutput ¶
type StartTaskExecutionOutput struct { // The Amazon Resource Name (ARN) of the specific task execution that was started. TaskExecutionArn *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
StartTaskExecutionResponse
type TagResourceInput ¶
type TagResourceInput struct { // The Amazon Resource Name (ARN) of the resource to apply the tag to. ResourceArn *string // The tags to apply. Tags []*types.TagListEntry }
TagResourceRequest
type TagResourceOutput ¶
type TagResourceOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type UntagResourceInput ¶
type UntagResourceInput struct { // The keys in the key-value pair in the tag to remove. Keys []*string // The Amazon Resource Name (ARN) of the resource to remove the tag from. ResourceArn *string }
UntagResourceRequest
type UntagResourceOutput ¶
type UntagResourceOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type UpdateAgentInput ¶
type UpdateAgentInput struct { // The Amazon Resource Name (ARN) of the agent to update. AgentArn *string // The name that you want to use to configure the agent. Name *string }
UpdateAgentRequest
type UpdateAgentOutput ¶
type UpdateAgentOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
type UpdateTaskInput ¶
type UpdateTaskInput struct { // The Amazon Resource Name (ARN) of the resource name of the task to update. TaskArn *string // 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 *types.TaskSchedule // The Amazon Resource Name (ARN) of the resource name of the CloudWatch LogGroup. CloudWatchLogGroupArn *string // The name of the task to update. Name *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 *types.Options // A list of filter rules that determines which files to exclude from a task. The // list should contain a single filter string that consists of the patterns to // exclude. The patterns are delimited by "|" (that is, a pipe), for example: // "/folder1|/folder2" Excludes []*types.FilterRule }
UpdateTaskResponse
type UpdateTaskOutput ¶
type UpdateTaskOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata }
Source Files ¶
api_client.go api_op_CancelTaskExecution.go api_op_CreateAgent.go api_op_CreateLocationEfs.go api_op_CreateLocationFsxWindows.go api_op_CreateLocationNfs.go api_op_CreateLocationObjectStorage.go api_op_CreateLocationS3.go api_op_CreateLocationSmb.go api_op_CreateTask.go api_op_DeleteAgent.go api_op_DeleteLocation.go api_op_DeleteTask.go api_op_DescribeAgent.go api_op_DescribeLocationEfs.go api_op_DescribeLocationFsxWindows.go api_op_DescribeLocationNfs.go api_op_DescribeLocationObjectStorage.go api_op_DescribeLocationS3.go api_op_DescribeLocationSmb.go api_op_DescribeTask.go api_op_DescribeTaskExecution.go api_op_ListAgents.go api_op_ListLocations.go api_op_ListTagsForResource.go api_op_ListTaskExecutions.go api_op_ListTasks.go api_op_StartTaskExecution.go api_op_TagResource.go api_op_UntagResource.go api_op_UpdateAgent.go api_op_UpdateTask.go deserializers.go endpoints.go serializers.go validators.go
Directories ¶
Path | Synopsis |
---|---|
internal | |
types |
- Version
- v0.1.0
- Published
- Sep 29, 2020
- Platform
- darwin/amd64
- Imports
- 26 packages
- Last checked
- now –
Tools for package owners.