Documentation
¶
Overview ¶
Package datasync provides the API client, operations, and parameter types for AWS DataSync.
DataSync ¶
DataSync is an online data movement and discovery service that simplifies data migration and helps you quickly, easily, and securely transfer your file or object data to, from, and between Amazon Web Services storage services.
This API interface reference includes documentation for using DataSync programmatically. For complete information, see the DataSync User Guide.
Index ¶
- Constants
- func NewDefaultEndpointResolver() *internalendpoints.Resolver
- func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)
- func WithEndpointResolver(v EndpointResolver) func(*Options)deprecated
- func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)
- func WithSigV4SigningName(name string) func(*Options)
- func WithSigV4SigningRegion(region string) func(*Options)
- type AddStorageSystemInput
- type AddStorageSystemOutput
- type AuthResolverParameters
- type AuthSchemeResolver
- type CancelTaskExecutionInput
- type CancelTaskExecutionOutput
- type Client
- func (c *Client) AddStorageSystem(ctx context.Context, params *AddStorageSystemInput, optFns ...func(*Options)) (*AddStorageSystemOutput, error)
- func (c *Client) CancelTaskExecution(ctx context.Context, params *CancelTaskExecutionInput, ...) (*CancelTaskExecutionOutput, error)
- func (c *Client) CreateAgent(ctx context.Context, params *CreateAgentInput, optFns ...func(*Options)) (*CreateAgentOutput, error)
- func (c *Client) CreateLocationAzureBlob(ctx context.Context, params *CreateLocationAzureBlobInput, ...) (*CreateLocationAzureBlobOutput, error)
- func (c *Client) CreateLocationEfs(ctx context.Context, params *CreateLocationEfsInput, optFns ...func(*Options)) (*CreateLocationEfsOutput, error)
- func (c *Client) CreateLocationFsxLustre(ctx context.Context, params *CreateLocationFsxLustreInput, ...) (*CreateLocationFsxLustreOutput, error)
- func (c *Client) CreateLocationFsxOntap(ctx context.Context, params *CreateLocationFsxOntapInput, ...) (*CreateLocationFsxOntapOutput, error)
- func (c *Client) CreateLocationFsxOpenZfs(ctx context.Context, params *CreateLocationFsxOpenZfsInput, ...) (*CreateLocationFsxOpenZfsOutput, error)
- func (c *Client) CreateLocationFsxWindows(ctx context.Context, params *CreateLocationFsxWindowsInput, ...) (*CreateLocationFsxWindowsOutput, error)
- func (c *Client) CreateLocationHdfs(ctx context.Context, params *CreateLocationHdfsInput, optFns ...func(*Options)) (*CreateLocationHdfsOutput, error)
- func (c *Client) CreateLocationNfs(ctx context.Context, params *CreateLocationNfsInput, optFns ...func(*Options)) (*CreateLocationNfsOutput, error)
- func (c *Client) CreateLocationObjectStorage(ctx context.Context, params *CreateLocationObjectStorageInput, ...) (*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) DescribeDiscoveryJob(ctx context.Context, params *DescribeDiscoveryJobInput, ...) (*DescribeDiscoveryJobOutput, error)
- func (c *Client) DescribeLocationAzureBlob(ctx context.Context, params *DescribeLocationAzureBlobInput, ...) (*DescribeLocationAzureBlobOutput, error)
- func (c *Client) DescribeLocationEfs(ctx context.Context, params *DescribeLocationEfsInput, ...) (*DescribeLocationEfsOutput, error)
- func (c *Client) DescribeLocationFsxLustre(ctx context.Context, params *DescribeLocationFsxLustreInput, ...) (*DescribeLocationFsxLustreOutput, error)
- func (c *Client) DescribeLocationFsxOntap(ctx context.Context, params *DescribeLocationFsxOntapInput, ...) (*DescribeLocationFsxOntapOutput, error)
- func (c *Client) DescribeLocationFsxOpenZfs(ctx context.Context, params *DescribeLocationFsxOpenZfsInput, ...) (*DescribeLocationFsxOpenZfsOutput, error)
- func (c *Client) DescribeLocationFsxWindows(ctx context.Context, params *DescribeLocationFsxWindowsInput, ...) (*DescribeLocationFsxWindowsOutput, error)
- func (c *Client) DescribeLocationHdfs(ctx context.Context, params *DescribeLocationHdfsInput, ...) (*DescribeLocationHdfsOutput, error)
- func (c *Client) DescribeLocationNfs(ctx context.Context, params *DescribeLocationNfsInput, ...) (*DescribeLocationNfsOutput, error)
- func (c *Client) DescribeLocationObjectStorage(ctx context.Context, params *DescribeLocationObjectStorageInput, ...) (*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, ...) (*DescribeLocationSmbOutput, error)
- func (c *Client) DescribeStorageSystem(ctx context.Context, params *DescribeStorageSystemInput, ...) (*DescribeStorageSystemOutput, error)
- func (c *Client) DescribeStorageSystemResourceMetrics(ctx context.Context, params *DescribeStorageSystemResourceMetricsInput, ...) (*DescribeStorageSystemResourceMetricsOutput, error)
- func (c *Client) DescribeStorageSystemResources(ctx context.Context, params *DescribeStorageSystemResourcesInput, ...) (*DescribeStorageSystemResourcesOutput, error)
- func (c *Client) DescribeTask(ctx context.Context, params *DescribeTaskInput, optFns ...func(*Options)) (*DescribeTaskOutput, error)
- func (c *Client) DescribeTaskExecution(ctx context.Context, params *DescribeTaskExecutionInput, ...) (*DescribeTaskExecutionOutput, error)
- func (c *Client) GenerateRecommendations(ctx context.Context, params *GenerateRecommendationsInput, ...) (*GenerateRecommendationsOutput, error)
- func (c *Client) ListAgents(ctx context.Context, params *ListAgentsInput, optFns ...func(*Options)) (*ListAgentsOutput, error)
- func (c *Client) ListDiscoveryJobs(ctx context.Context, params *ListDiscoveryJobsInput, optFns ...func(*Options)) (*ListDiscoveryJobsOutput, error)
- func (c *Client) ListLocations(ctx context.Context, params *ListLocationsInput, optFns ...func(*Options)) (*ListLocationsOutput, error)
- func (c *Client) ListStorageSystems(ctx context.Context, params *ListStorageSystemsInput, optFns ...func(*Options)) (*ListStorageSystemsOutput, error)
- func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, ...) (*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) Options() Options
- func (c *Client) RemoveStorageSystem(ctx context.Context, params *RemoveStorageSystemInput, ...) (*RemoveStorageSystemOutput, error)
- func (c *Client) StartDiscoveryJob(ctx context.Context, params *StartDiscoveryJobInput, optFns ...func(*Options)) (*StartDiscoveryJobOutput, error)
- func (c *Client) StartTaskExecution(ctx context.Context, params *StartTaskExecutionInput, optFns ...func(*Options)) (*StartTaskExecutionOutput, error)
- func (c *Client) StopDiscoveryJob(ctx context.Context, params *StopDiscoveryJobInput, optFns ...func(*Options)) (*StopDiscoveryJobOutput, 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) UpdateDiscoveryJob(ctx context.Context, params *UpdateDiscoveryJobInput, optFns ...func(*Options)) (*UpdateDiscoveryJobOutput, error)
- func (c *Client) UpdateLocationAzureBlob(ctx context.Context, params *UpdateLocationAzureBlobInput, ...) (*UpdateLocationAzureBlobOutput, error)
- func (c *Client) UpdateLocationHdfs(ctx context.Context, params *UpdateLocationHdfsInput, optFns ...func(*Options)) (*UpdateLocationHdfsOutput, error)
- func (c *Client) UpdateLocationNfs(ctx context.Context, params *UpdateLocationNfsInput, optFns ...func(*Options)) (*UpdateLocationNfsOutput, error)
- func (c *Client) UpdateLocationObjectStorage(ctx context.Context, params *UpdateLocationObjectStorageInput, ...) (*UpdateLocationObjectStorageOutput, error)
- func (c *Client) UpdateLocationSmb(ctx context.Context, params *UpdateLocationSmbInput, optFns ...func(*Options)) (*UpdateLocationSmbOutput, error)
- func (c *Client) UpdateStorageSystem(ctx context.Context, params *UpdateStorageSystemInput, ...) (*UpdateStorageSystemOutput, error)
- func (c *Client) UpdateTask(ctx context.Context, params *UpdateTaskInput, optFns ...func(*Options)) (*UpdateTaskOutput, error)
- func (c *Client) UpdateTaskExecution(ctx context.Context, params *UpdateTaskExecutionInput, ...) (*UpdateTaskExecutionOutput, error)
- type CreateAgentInput
- type CreateAgentOutput
- type CreateLocationAzureBlobInput
- type CreateLocationAzureBlobOutput
- type CreateLocationEfsInput
- type CreateLocationEfsOutput
- type CreateLocationFsxLustreInput
- type CreateLocationFsxLustreOutput
- type CreateLocationFsxOntapInput
- type CreateLocationFsxOntapOutput
- type CreateLocationFsxOpenZfsInput
- type CreateLocationFsxOpenZfsOutput
- type CreateLocationFsxWindowsInput
- type CreateLocationFsxWindowsOutput
- type CreateLocationHdfsInput
- type CreateLocationHdfsOutput
- 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 DescribeDiscoveryJobInput
- type DescribeDiscoveryJobOutput
- type DescribeLocationAzureBlobInput
- type DescribeLocationAzureBlobOutput
- type DescribeLocationEfsInput
- type DescribeLocationEfsOutput
- type DescribeLocationFsxLustreInput
- type DescribeLocationFsxLustreOutput
- type DescribeLocationFsxOntapInput
- type DescribeLocationFsxOntapOutput
- type DescribeLocationFsxOpenZfsInput
- type DescribeLocationFsxOpenZfsOutput
- type DescribeLocationFsxWindowsInput
- type DescribeLocationFsxWindowsOutput
- type DescribeLocationHdfsInput
- type DescribeLocationHdfsOutput
- type DescribeLocationNfsInput
- type DescribeLocationNfsOutput
- type DescribeLocationObjectStorageInput
- type DescribeLocationObjectStorageOutput
- type DescribeLocationS3Input
- type DescribeLocationS3Output
- type DescribeLocationSmbInput
- type DescribeLocationSmbOutput
- type DescribeStorageSystemInput
- type DescribeStorageSystemOutput
- type DescribeStorageSystemResourceMetricsAPIClient
- type DescribeStorageSystemResourceMetricsInput
- type DescribeStorageSystemResourceMetricsOutput
- type DescribeStorageSystemResourceMetricsPaginator
- type DescribeStorageSystemResourceMetricsPaginatorOptions
- type DescribeStorageSystemResourcesAPIClient
- type DescribeStorageSystemResourcesInput
- type DescribeStorageSystemResourcesOutput
- type DescribeStorageSystemResourcesPaginator
- type DescribeStorageSystemResourcesPaginatorOptions
- type DescribeTaskExecutionInput
- type DescribeTaskExecutionOutput
- type DescribeTaskInput
- type DescribeTaskOutput
- type EndpointParameters
- type EndpointResolver
- type EndpointResolverFunc
- type EndpointResolverOptions
- type EndpointResolverV2
- type GenerateRecommendationsInput
- type GenerateRecommendationsOutput
- type HTTPClient
- type HTTPSignerV4
- type IdempotencyTokenProvider
- type ListAgentsAPIClient
- type ListAgentsInput
- type ListAgentsOutput
- type ListAgentsPaginator
- type ListAgentsPaginatorOptions
- type ListDiscoveryJobsAPIClient
- type ListDiscoveryJobsInput
- type ListDiscoveryJobsOutput
- type ListDiscoveryJobsPaginator
- type ListDiscoveryJobsPaginatorOptions
- type ListLocationsAPIClient
- type ListLocationsInput
- type ListLocationsOutput
- type ListLocationsPaginator
- type ListLocationsPaginatorOptions
- type ListStorageSystemsAPIClient
- type ListStorageSystemsInput
- type ListStorageSystemsOutput
- type ListStorageSystemsPaginator
- type ListStorageSystemsPaginatorOptions
- type ListTagsForResourceAPIClient
- type ListTagsForResourceInput
- type ListTagsForResourceOutput
- type ListTagsForResourcePaginator
- type ListTagsForResourcePaginatorOptions
- type ListTaskExecutionsAPIClient
- type ListTaskExecutionsInput
- type ListTaskExecutionsOutput
- type ListTaskExecutionsPaginator
- type ListTaskExecutionsPaginatorOptions
- type ListTasksAPIClient
- type ListTasksInput
- type ListTasksOutput
- type ListTasksPaginator
- type ListTasksPaginatorOptions
- type Options
- type RemoveStorageSystemInput
- type RemoveStorageSystemOutput
- type ResolveEndpoint
- type StartDiscoveryJobInput
- type StartDiscoveryJobOutput
- type StartTaskExecutionInput
- type StartTaskExecutionOutput
- type StopDiscoveryJobInput
- type StopDiscoveryJobOutput
- type TagResourceInput
- type TagResourceOutput
- type UntagResourceInput
- type UntagResourceOutput
- type UpdateAgentInput
- type UpdateAgentOutput
- type UpdateDiscoveryJobInput
- type UpdateDiscoveryJobOutput
- type UpdateLocationAzureBlobInput
- type UpdateLocationAzureBlobOutput
- type UpdateLocationHdfsInput
- type UpdateLocationHdfsOutput
- type UpdateLocationNfsInput
- type UpdateLocationNfsOutput
- type UpdateLocationObjectStorageInput
- type UpdateLocationObjectStorageOutput
- type UpdateLocationSmbInput
- type UpdateLocationSmbOutput
- type UpdateStorageSystemInput
- type UpdateStorageSystemOutput
- type UpdateTaskExecutionInput
- type UpdateTaskExecutionOutput
- type UpdateTaskInput
- type UpdateTaskOutput
Constants ¶
const ServiceAPIVersion = "2018-11-09"
const ServiceID = "DataSync"
Variables ¶
This section is empty.
Functions ¶
func NewDefaultEndpointResolver ¶
func NewDefaultEndpointResolver() *internalendpoints.Resolver
NewDefaultEndpointResolver constructs a new service endpoint resolver
func WithAPIOptions ¶
func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)
WithAPIOptions returns a functional option for setting the Client's APIOptions option.
func WithEndpointResolver
deprecated
func WithEndpointResolver(v EndpointResolver) func(*Options)
Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for this field will likely prevent you from using any endpoint-related service features released after the introduction of EndpointResolverV2 and BaseEndpoint.
To migrate an EndpointResolver implementation that uses a custom endpoint, set the client option BaseEndpoint instead.
func WithEndpointResolverV2 ¶
func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)
WithEndpointResolverV2 returns a functional option for setting the Client's EndpointResolverV2 option.
func WithSigV4SigningName ¶
WithSigV4SigningName applies an override to the authentication workflow to use the given signing name for SigV4-authenticated operations.
This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing name from both auth scheme resolution and endpoint resolution.
func WithSigV4SigningRegion ¶
WithSigV4SigningRegion applies an override to the authentication workflow to use the given signing region for SigV4-authenticated operations.
This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing region from both auth scheme resolution and endpoint resolution.
Types ¶
type AddStorageSystemInput ¶
type AddStorageSystemInput struct { // Specifies the Amazon Resource Name (ARN) of the DataSync agent that connects to // and reads from your on-premises storage system's management interface. You can // only specify one ARN. // // This member is required. AgentArns []string // Specifies a client token to make sure requests with this API operation are // idempotent. If you don't specify a client token, DataSync generates one for you // automatically. // // This member is required. ClientToken *string // Specifies the user name and password for accessing your on-premises storage // system's management interface. // // This member is required. Credentials *types.Credentials // Specifies the server name and network port required to connect with the // management interface of your on-premises storage system. // // This member is required. ServerConfiguration *types.DiscoveryServerConfiguration // Specifies the type of on-premises storage system that you want DataSync // Discovery to collect information about. // // DataSync Discovery currently supports NetApp Fabric-Attached Storage (FAS) and // All Flash FAS (AFF) systems running ONTAP 9.7 or later. // // This member is required. SystemType types.DiscoverySystemType // Specifies the ARN of the Amazon CloudWatch log group for monitoring and logging // discovery job events. CloudWatchLogGroupArn *string // Specifies a familiar name for your on-premises storage system. Name *string // Specifies labels that help you categorize, filter, and search for your Amazon // Web Services resources. We recommend creating at least a name tag for your // on-premises storage system. Tags []types.TagListEntry // contains filtered or unexported fields }
type AddStorageSystemOutput ¶
type AddStorageSystemOutput struct { // The ARN of the on-premises storage system that you can use with DataSync // Discovery. // // This member is required. StorageSystemArn *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type AuthResolverParameters ¶
type AuthResolverParameters struct { // The name of the operation being invoked. Operation string // The region in which the operation is being invoked. Region string }
AuthResolverParameters contains the set of inputs necessary for auth scheme resolution.
type AuthSchemeResolver ¶
type AuthSchemeResolver interface {
ResolveAuthSchemes(context.Context, *AuthResolverParameters) ([]*smithyauth.Option, error)
}
AuthSchemeResolver returns a set of possible authentication options for an operation.
type CancelTaskExecutionInput ¶
type CancelTaskExecutionInput struct { // The Amazon Resource Name (ARN) of the task execution to stop. // // This member is required. TaskExecutionArn *string // contains filtered or unexported fields }
CancelTaskExecutionRequest
type CancelTaskExecutionOutput ¶
type CancelTaskExecutionOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type Client ¶
type Client struct {
// contains filtered or unexported fields
}
Client provides the API client to make operations call for AWS DataSync.
func New ¶
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) AddStorageSystem ¶
func (c *Client) AddStorageSystem(ctx context.Context, params *AddStorageSystemInput, optFns ...func(*Options)) (*AddStorageSystemOutput, error)
Creates an Amazon Web Services resource for an on-premises storage system that you want DataSync Discovery to collect information about.
func (*Client) CancelTaskExecution ¶
func (c *Client) CancelTaskExecution(ctx context.Context, params *CancelTaskExecutionInput, optFns ...func(*Options)) (*CancelTaskExecutionOutput, error)
Stops an DataSync task execution that's in progress. The transfer of some files are abruptly interrupted. File contents that're transferred to the destination might be incomplete or inconsistent with the source files.
However, if you start a new task execution using the same task and allow it to finish, file content on the destination will be complete and consistent. This applies to other unexpected failures that interrupt a task execution. In all of these cases, DataSync successfully completes the transfer when you start the next task execution.
func (*Client) CreateAgent ¶
func (c *Client) CreateAgent(ctx context.Context, params *CreateAgentInput, optFns ...func(*Options)) (*CreateAgentOutput, error)
Activates an DataSync agent that you've deployed in your storage environment. The activation process associates the agent with your Amazon Web Services account.
If you haven't deployed an agent yet, see the following topics to learn more:
If you're transferring between Amazon Web Services storage services, you don't need a DataSync agent.
func (*Client) CreateLocationAzureBlob ¶
func (c *Client) CreateLocationAzureBlob(ctx context.Context, params *CreateLocationAzureBlobInput, optFns ...func(*Options)) (*CreateLocationAzureBlobOutput, error)
Creates a transfer location for a Microsoft Azure Blob Storage container. DataSync can use this location as a transfer source or destination.
Before you begin, make sure you know how DataSync accesses Azure Blob Storage and works with access tiers and blob types. You also need a DataSync agent that can connect to your container.
func (*Client) CreateLocationEfs ¶
func (c *Client) CreateLocationEfs(ctx context.Context, params *CreateLocationEfsInput, optFns ...func(*Options)) (*CreateLocationEfsOutput, error)
Creates a transfer location for an Amazon EFS file system. DataSync can use this location as a source or destination for transferring data.
Before you begin, make sure that you understand how DataSync accesses Amazon EFS file systems.
func (*Client) CreateLocationFsxLustre ¶
func (c *Client) CreateLocationFsxLustre(ctx context.Context, params *CreateLocationFsxLustreInput, optFns ...func(*Options)) (*CreateLocationFsxLustreOutput, error)
Creates a transfer location for an Amazon FSx for Lustre file system. DataSync can use this location as a source or destination for transferring data.
Before you begin, make sure that you understand how DataSync accesses FSx for Lustre file systems.
func (*Client) CreateLocationFsxOntap ¶
func (c *Client) CreateLocationFsxOntap(ctx context.Context, params *CreateLocationFsxOntapInput, optFns ...func(*Options)) (*CreateLocationFsxOntapOutput, error)
Creates a transfer location for an Amazon FSx for NetApp ONTAP file system. DataSync can use this location as a source or destination for transferring data.
Before you begin, make sure that you understand how DataSync accesses FSx for ONTAP file systems.
func (*Client) CreateLocationFsxOpenZfs ¶
func (c *Client) CreateLocationFsxOpenZfs(ctx context.Context, params *CreateLocationFsxOpenZfsInput, optFns ...func(*Options)) (*CreateLocationFsxOpenZfsOutput, error)
Creates a transfer location for an Amazon FSx for OpenZFS file system. DataSync can use this location as a source or destination for transferring data.
Before you begin, make sure that you understand how DataSync accesses FSx for OpenZFS file systems.
Request parameters related to SMB aren't supported with the CreateLocationFsxOpenZfs operation.
func (*Client) CreateLocationFsxWindows ¶
func (c *Client) CreateLocationFsxWindows(ctx context.Context, params *CreateLocationFsxWindowsInput, optFns ...func(*Options)) (*CreateLocationFsxWindowsOutput, error)
Creates a transfer location for an Amazon FSx for Windows File Server file system. DataSync can use this location as a source or destination for transferring data.
Before you begin, make sure that you understand how DataSync accesses FSx for Windows File Server file systems.
func (*Client) CreateLocationHdfs ¶
func (c *Client) CreateLocationHdfs(ctx context.Context, params *CreateLocationHdfsInput, optFns ...func(*Options)) (*CreateLocationHdfsOutput, error)
Creates a transfer location for a Hadoop Distributed File System (HDFS). DataSync can use this location as a source or destination for transferring data.
Before you begin, make sure that you understand how DataSync accesses HDFS clusters.
func (*Client) CreateLocationNfs ¶
func (c *Client) CreateLocationNfs(ctx context.Context, params *CreateLocationNfsInput, optFns ...func(*Options)) (*CreateLocationNfsOutput, error)
Creates a transfer location for a Network File System (NFS) file server. DataSync can use this location as a source or destination for transferring data.
Before you begin, make sure that you understand how DataSync accesses NFS file servers.
If you're copying data to or from an Snowcone device, you can also use CreateLocationNfs to create your transfer location. For more information, see Configuring transfers with Snowcone.
func (*Client) CreateLocationObjectStorage ¶
func (c *Client) CreateLocationObjectStorage(ctx context.Context, params *CreateLocationObjectStorageInput, optFns ...func(*Options)) (*CreateLocationObjectStorageOutput, error)
Creates a transfer location for an object storage system. DataSync can use this location as a source or destination for transferring data.
Before you begin, make sure that you understand the prerequisites for DataSync to work with object storage systems.
func (*Client) CreateLocationS3 ¶
func (c *Client) CreateLocationS3(ctx context.Context, params *CreateLocationS3Input, optFns ...func(*Options)) (*CreateLocationS3Output, error)
Creates a transfer location for an Amazon S3 bucket. DataSync can use this location as a source or destination for transferring data.
Before you begin, make sure that you read the following topics:
Storage class considerations with Amazon S3 locations
Evaluating S3 request costs when using DataSync
For more information, see Configuring transfers with Amazon S3.
func (*Client) CreateLocationSmb ¶
func (c *Client) CreateLocationSmb(ctx context.Context, params *CreateLocationSmbInput, optFns ...func(*Options)) (*CreateLocationSmbOutput, error)
Creates a transfer location for a Server Message Block (SMB) file server. DataSync can use this location as a source or destination for transferring data.
Before you begin, make sure that you understand how DataSync accesses SMB file servers.
func (*Client) CreateTask ¶
func (c *Client) CreateTask(ctx context.Context, params *CreateTaskInput, optFns ...func(*Options)) (*CreateTaskOutput, error)
Configures a task, which defines where and how DataSync transfers your data.
A task includes a source location, destination location, and transfer options (such as bandwidth limits, scheduling, and more).
If you're planning to transfer data to or from an Amazon S3 location, review how DataSync can affect your S3 request charges and the DataSync pricing pagebefore you begin.
func (*Client) DeleteAgent ¶
func (c *Client) DeleteAgent(ctx context.Context, params *DeleteAgentInput, optFns ...func(*Options)) (*DeleteAgentOutput, error)
Removes an DataSync agent resource from your Amazon Web Services account.
Keep in mind that this operation (which can't be undone) doesn't remove the agent's virtual machine (VM) or Amazon EC2 instance from your storage environment. For next steps, you can delete the VM or instance from your storage environment or reuse it to activate a new agent.
func (*Client) DeleteLocation ¶
func (c *Client) DeleteLocation(ctx context.Context, params *DeleteLocationInput, optFns ...func(*Options)) (*DeleteLocationOutput, error)
Deletes a transfer location resource from DataSync.
func (*Client) DeleteTask ¶
func (c *Client) DeleteTask(ctx context.Context, params *DeleteTaskInput, optFns ...func(*Options)) (*DeleteTaskOutput, error)
Deletes a transfer task resource from DataSync.
func (*Client) DescribeAgent ¶
func (c *Client) DescribeAgent(ctx context.Context, params *DescribeAgentInput, optFns ...func(*Options)) (*DescribeAgentOutput, error)
Returns information about an DataSync agent, such as its name, service endpoint type, and status.
func (*Client) DescribeDiscoveryJob ¶
func (c *Client) DescribeDiscoveryJob(ctx context.Context, params *DescribeDiscoveryJobInput, optFns ...func(*Options)) (*DescribeDiscoveryJobOutput, error)
Returns information about a DataSync discovery job.
func (*Client) DescribeLocationAzureBlob ¶
func (c *Client) DescribeLocationAzureBlob(ctx context.Context, params *DescribeLocationAzureBlobInput, optFns ...func(*Options)) (*DescribeLocationAzureBlobOutput, error)
Provides details about how an DataSync transfer location for Microsoft Azure Blob Storage is configured.
func (*Client) DescribeLocationEfs ¶
func (c *Client) DescribeLocationEfs(ctx context.Context, params *DescribeLocationEfsInput, optFns ...func(*Options)) (*DescribeLocationEfsOutput, error)
Provides details about how an DataSync transfer location for an Amazon EFS file system is configured.
func (*Client) DescribeLocationFsxLustre ¶
func (c *Client) DescribeLocationFsxLustre(ctx context.Context, params *DescribeLocationFsxLustreInput, optFns ...func(*Options)) (*DescribeLocationFsxLustreOutput, error)
Provides details about how an DataSync transfer location for an Amazon FSx for Lustre file system is configured.
func (*Client) DescribeLocationFsxOntap ¶
func (c *Client) DescribeLocationFsxOntap(ctx context.Context, params *DescribeLocationFsxOntapInput, optFns ...func(*Options)) (*DescribeLocationFsxOntapOutput, error)
Provides details about how an DataSync transfer location for an Amazon FSx for NetApp ONTAP file system is configured.
If your location uses SMB, the DescribeLocationFsxOntap operation doesn't actually return a Password .
func (*Client) DescribeLocationFsxOpenZfs ¶
func (c *Client) DescribeLocationFsxOpenZfs(ctx context.Context, params *DescribeLocationFsxOpenZfsInput, optFns ...func(*Options)) (*DescribeLocationFsxOpenZfsOutput, error)
Provides details about how an DataSync transfer location for an Amazon FSx for OpenZFS file system is configured.
Response elements related to SMB aren't supported with the DescribeLocationFsxOpenZfs operation.
func (*Client) DescribeLocationFsxWindows ¶
func (c *Client) DescribeLocationFsxWindows(ctx context.Context, params *DescribeLocationFsxWindowsInput, optFns ...func(*Options)) (*DescribeLocationFsxWindowsOutput, error)
Provides details about how an DataSync transfer location for an Amazon FSx for Windows File Server file system is configured.
func (*Client) DescribeLocationHdfs ¶
func (c *Client) DescribeLocationHdfs(ctx context.Context, params *DescribeLocationHdfsInput, optFns ...func(*Options)) (*DescribeLocationHdfsOutput, error)
Provides details about how an DataSync transfer location for a Hadoop Distributed File System (HDFS) is configured.
func (*Client) DescribeLocationNfs ¶
func (c *Client) DescribeLocationNfs(ctx context.Context, params *DescribeLocationNfsInput, optFns ...func(*Options)) (*DescribeLocationNfsOutput, error)
Provides details about how an DataSync transfer location for a Network File System (NFS) file server is configured.
func (*Client) DescribeLocationObjectStorage ¶
func (c *Client) DescribeLocationObjectStorage(ctx context.Context, params *DescribeLocationObjectStorageInput, optFns ...func(*Options)) (*DescribeLocationObjectStorageOutput, error)
Provides details about how an DataSync transfer location for an object storage system is configured.
func (*Client) DescribeLocationS3 ¶
func (c *Client) DescribeLocationS3(ctx context.Context, params *DescribeLocationS3Input, optFns ...func(*Options)) (*DescribeLocationS3Output, error)
Provides details about how an DataSync transfer location for an S3 bucket is configured.
func (*Client) DescribeLocationSmb ¶
func (c *Client) DescribeLocationSmb(ctx context.Context, params *DescribeLocationSmbInput, optFns ...func(*Options)) (*DescribeLocationSmbOutput, error)
Provides details about how an DataSync transfer location for a Server Message Block (SMB) file server is configured.
func (*Client) DescribeStorageSystem ¶
func (c *Client) DescribeStorageSystem(ctx context.Context, params *DescribeStorageSystemInput, optFns ...func(*Options)) (*DescribeStorageSystemOutput, error)
Returns information about an on-premises storage system that you're using with DataSync Discovery.
func (*Client) DescribeStorageSystemResourceMetrics ¶
func (c *Client) DescribeStorageSystemResourceMetrics(ctx context.Context, params *DescribeStorageSystemResourceMetricsInput, optFns ...func(*Options)) (*DescribeStorageSystemResourceMetricsOutput, error)
Returns information, including performance data and capacity usage, which DataSync Discovery collects about a specific resource in your-premises storage system.
func (*Client) DescribeStorageSystemResources ¶
func (c *Client) DescribeStorageSystemResources(ctx context.Context, params *DescribeStorageSystemResourcesInput, optFns ...func(*Options)) (*DescribeStorageSystemResourcesOutput, error)
Returns information that DataSync Discovery collects about resources in your on-premises storage system.
func (*Client) DescribeTask ¶
func (c *Client) DescribeTask(ctx context.Context, params *DescribeTaskInput, optFns ...func(*Options)) (*DescribeTaskOutput, error)
Provides information about a task, which defines where and how DataSync transfers your data.
func (*Client) DescribeTaskExecution ¶
func (c *Client) DescribeTaskExecution(ctx context.Context, params *DescribeTaskExecutionInput, optFns ...func(*Options)) (*DescribeTaskExecutionOutput, error)
Provides information about an execution of your DataSync task. You can use this operation to help monitor the progress of an ongoing transfer or check the results of the transfer.
func (*Client) GenerateRecommendations ¶
func (c *Client) GenerateRecommendations(ctx context.Context, params *GenerateRecommendationsInput, optFns ...func(*Options)) (*GenerateRecommendationsOutput, error)
Creates recommendations about where to migrate your data to in Amazon Web Services. Recommendations are generated based on information that DataSync Discovery collects about your on-premises storage system's resources. For more information, see Recommendations provided by DataSync Discovery.
Once generated, you can view your recommendations by using the DescribeStorageSystemResources operation.
func (*Client) ListAgents ¶
func (c *Client) ListAgents(ctx context.Context, params *ListAgentsInput, optFns ...func(*Options)) (*ListAgentsOutput, error)
Returns a list of DataSync agents that belong to an Amazon Web Services account in the Amazon Web Services Region specified in the request.
With pagination, you can reduce the number of agents returned in a response. If you get a truncated list of agents in a response, the response contains a marker that you can specify in your next request to fetch the next page of agents.
ListAgents is eventually consistent. This means the result of running the operation might not reflect that you just created or deleted an agent. For example, if you create an agent with CreateAgentand then immediately run ListAgents , that agent might not show up in the list right away. In situations like this, you can always confirm whether an agent has been created (or deleted) by using DescribeAgent.
func (*Client) ListDiscoveryJobs ¶
func (c *Client) ListDiscoveryJobs(ctx context.Context, params *ListDiscoveryJobsInput, optFns ...func(*Options)) (*ListDiscoveryJobsOutput, error)
Provides a list of the existing discovery jobs in the Amazon Web Services Region and Amazon Web Services account where you're using DataSync Discovery.
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) ListStorageSystems ¶
func (c *Client) ListStorageSystems(ctx context.Context, params *ListStorageSystemsInput, optFns ...func(*Options)) (*ListStorageSystemsOutput, error)
Lists the on-premises storage systems that you're using with DataSync Discovery.
func (*Client) ListTagsForResource ¶
func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)
Returns all the tags associated with an Amazon Web Services resource.
func (*Client) ListTaskExecutions ¶
func (c *Client) ListTaskExecutions(ctx context.Context, params *ListTaskExecutionsInput, optFns ...func(*Options)) (*ListTaskExecutionsOutput, error)
Returns a list of executions for an DataSync transfer task.
func (*Client) ListTasks ¶
func (c *Client) ListTasks(ctx context.Context, params *ListTasksInput, optFns ...func(*Options)) (*ListTasksOutput, error)
Returns a list of the DataSync tasks you created.
func (*Client) Options ¶
Options returns a copy of the client configuration.
Callers SHOULD NOT perform mutations on any inner structures within client config. Config overrides should instead be made on a per-operation basis through functional options.
func (*Client) RemoveStorageSystem ¶
func (c *Client) RemoveStorageSystem(ctx context.Context, params *RemoveStorageSystemInput, optFns ...func(*Options)) (*RemoveStorageSystemOutput, error)
Permanently removes a storage system resource from DataSync Discovery, including the associated discovery jobs, collected data, and recommendations.
func (*Client) StartDiscoveryJob ¶
func (c *Client) StartDiscoveryJob(ctx context.Context, params *StartDiscoveryJobInput, optFns ...func(*Options)) (*StartDiscoveryJobOutput, error)
Runs a DataSync discovery job on your on-premises storage system. If you haven't added the storage system to DataSync Discovery yet, do this first by using the AddStorageSystemoperation.
func (*Client) StartTaskExecution ¶
func (c *Client) StartTaskExecution(ctx context.Context, params *StartTaskExecutionInput, optFns ...func(*Options)) (*StartTaskExecutionOutput, error)
Starts an DataSync transfer task. For each task, you can only run one task execution at a time.
There are several phases to a task execution. For more information, see Task execution statuses.
If you're planning to transfer data to or from an Amazon S3 location, review how DataSync can affect your S3 request charges and the DataSync pricing pagebefore you begin.
func (*Client) StopDiscoveryJob ¶
func (c *Client) StopDiscoveryJob(ctx context.Context, params *StopDiscoveryJobInput, optFns ...func(*Options)) (*StopDiscoveryJobOutput, error)
Stops a running DataSync discovery job.
You can stop a discovery job anytime. A job that's stopped before it's scheduled to end likely will provide you some information about your on-premises storage system resources. To get recommendations for a stopped job, you must use the GenerateRecommendationsoperation.
func (*Client) TagResource ¶
func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)
Applies a tag to an Amazon Web Services resource. Tags are key-value pairs that can help you manage, filter, and search for your resources.
These include DataSync resources, such as locations, tasks, and task executions.
func (*Client) UntagResource ¶
func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)
Removes tags from an Amazon Web Services resource.
func (*Client) UpdateAgent ¶
func (c *Client) UpdateAgent(ctx context.Context, params *UpdateAgentInput, optFns ...func(*Options)) (*UpdateAgentOutput, error)
Updates the name of an DataSync agent.
func (*Client) UpdateDiscoveryJob ¶
func (c *Client) UpdateDiscoveryJob(ctx context.Context, params *UpdateDiscoveryJobInput, optFns ...func(*Options)) (*UpdateDiscoveryJobOutput, error)
Edits a DataSync discovery job configuration.
func (*Client) UpdateLocationAzureBlob ¶
func (c *Client) UpdateLocationAzureBlob(ctx context.Context, params *UpdateLocationAzureBlobInput, optFns ...func(*Options)) (*UpdateLocationAzureBlobOutput, error)
Modifies some configurations of the Microsoft Azure Blob Storage transfer location that you're using with DataSync.
func (*Client) UpdateLocationHdfs ¶
func (c *Client) UpdateLocationHdfs(ctx context.Context, params *UpdateLocationHdfsInput, optFns ...func(*Options)) (*UpdateLocationHdfsOutput, error)
Updates some parameters of a previously created location for a Hadoop Distributed File System cluster.
func (*Client) UpdateLocationNfs ¶
func (c *Client) UpdateLocationNfs(ctx context.Context, params *UpdateLocationNfsInput, optFns ...func(*Options)) (*UpdateLocationNfsOutput, error)
Modifies some configurations of the Network File System (NFS) transfer location that you're using with DataSync.
For more information, see Configuring transfers to or from an NFS file server.
func (*Client) UpdateLocationObjectStorage ¶
func (c *Client) UpdateLocationObjectStorage(ctx context.Context, params *UpdateLocationObjectStorageInput, optFns ...func(*Options)) (*UpdateLocationObjectStorageOutput, error)
Updates some parameters of an existing DataSync location for an object storage system.
func (*Client) UpdateLocationSmb ¶
func (c *Client) UpdateLocationSmb(ctx context.Context, params *UpdateLocationSmbInput, optFns ...func(*Options)) (*UpdateLocationSmbOutput, error)
Updates some of the parameters of a Server Message Block (SMB) file server location that you can use for DataSync transfers.
func (*Client) UpdateStorageSystem ¶
func (c *Client) UpdateStorageSystem(ctx context.Context, params *UpdateStorageSystemInput, optFns ...func(*Options)) (*UpdateStorageSystemOutput, error)
Modifies some configurations of an on-premises storage system resource that you're using with DataSync Discovery.
func (*Client) UpdateTask ¶
func (c *Client) UpdateTask(ctx context.Context, params *UpdateTaskInput, optFns ...func(*Options)) (*UpdateTaskOutput, error)
Updates the configuration of a task, which defines where and how DataSync transfers your data.
func (*Client) UpdateTaskExecution ¶
func (c *Client) UpdateTaskExecution(ctx context.Context, params *UpdateTaskExecutionInput, optFns ...func(*Options)) (*UpdateTaskExecutionOutput, error)
Updates the configuration of a running DataSync task execution.
Currently, the only Option that you can modify with UpdateTaskExecution is BytesPerSecond, which throttles bandwidth for a running or queued task execution.
type CreateAgentInput ¶
type CreateAgentInput struct { // Specifies your DataSync agent's activation key. If you don't have an activation // key, see [Activate your agent]. // // [Activate your agent]: https://docs.aws.amazon.com/datasync/latest/userguide/activate-agent.html // // This member is required. ActivationKey *string // Specifies a name for your agent. You can see this name in the DataSync console. AgentName *string // Specifies the Amazon Resource Name (ARN) of the security group that protects // your task's [network interfaces]when [using a virtual private cloud (VPC) endpoint]. You can only specify one ARN. // // [network interfaces]: https://docs.aws.amazon.com/datasync/latest/userguide/datasync-network.html#required-network-interfaces // [using a virtual private cloud (VPC) endpoint]: https://docs.aws.amazon.com/datasync/latest/userguide/choose-service-endpoint.html#choose-service-endpoint-vpc SecurityGroupArns []string // Specifies the ARN of the subnet where you want to run your DataSync task when // using a VPC endpoint. This is the subnet where DataSync creates and manages the [network interfaces] // for your transfer. You can only specify one ARN. // // [network interfaces]: https://docs.aws.amazon.com/datasync/latest/userguide/datasync-network.html#required-network-interfaces SubnetArns []string // Specifies labels that help you categorize, filter, and search for your Amazon // Web Services resources. We recommend creating at least one tag for your agent. Tags []types.TagListEntry // Specifies the ID of the VPC endpoint that you want your agent to connect to. // For example, a VPC endpoint ID looks like vpce-01234d5aff67890e1 . // // The VPC endpoint you use must include the DataSync service name (for example, // com.amazonaws.us-east-2.datasync ). VpcEndpointId *string // contains filtered or unexported fields }
CreateAgentRequest
type CreateAgentOutput ¶
type CreateAgentOutput struct { // The ARN of the agent that you just activated. Use the [ListAgents] operation to return a // list of agents in your Amazon Web Services account and Amazon Web Services // Region. // // [ListAgents]: https://docs.aws.amazon.com/datasync/latest/userguide/API_ListAgents.html AgentArn *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
CreateAgentResponse
type CreateLocationAzureBlobInput ¶
type CreateLocationAzureBlobInput struct { // Specifies the Amazon Resource Name (ARN) of the DataSync agent that can connect // with your Azure Blob Storage container. // // You can specify more than one agent. For more information, see [Using multiple agents for your transfer]. // // [Using multiple agents for your transfer]: https://docs.aws.amazon.com/datasync/latest/userguide/multiple-agents.html // // This member is required. AgentArns []string // Specifies the authentication method DataSync uses to access your Azure Blob // Storage. DataSync can access blob storage using a shared access signature (SAS). // // This member is required. AuthenticationType types.AzureBlobAuthenticationType // Specifies the URL of the Azure Blob Storage container involved in your transfer. // // This member is required. ContainerUrl *string // Specifies the access tier that you want your objects or files transferred into. // This only applies when using the location as a transfer destination. For more // information, see [Access tiers]. // // [Access tiers]: https://docs.aws.amazon.com/datasync/latest/userguide/creating-azure-blob-location.html#azure-blob-access-tiers AccessTier types.AzureAccessTier // Specifies the type of blob that you want your objects or files to be when // transferring them into Azure Blob Storage. Currently, DataSync only supports // moving data into Azure Blob Storage as block blobs. For more information on blob // types, see the [Azure Blob Storage documentation]. // // [Azure Blob Storage documentation]: https://learn.microsoft.com/en-us/rest/api/storageservices/understanding-block-blobs--append-blobs--and-page-blobs BlobType types.AzureBlobType // Specifies the SAS configuration that allows DataSync to access your Azure Blob // Storage. SasConfiguration *types.AzureBlobSasConfiguration // Specifies path segments if you want to limit your transfer to a virtual // directory in your container (for example, /my/images ). Subdirectory *string // Specifies labels that help you categorize, filter, and search for your Amazon // Web Services resources. We recommend creating at least a name tag for your // transfer location. Tags []types.TagListEntry // contains filtered or unexported fields }
type CreateLocationAzureBlobOutput ¶
type CreateLocationAzureBlobOutput struct { // The ARN of the Azure Blob Storage transfer location that you created. LocationArn *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type CreateLocationEfsInput ¶
type CreateLocationEfsInput struct { // Specifies the subnet and security groups DataSync uses to access your Amazon // EFS file system. // // This member is required. Ec2Config *types.Ec2Config // Specifies the ARN for the Amazon EFS file system. // // This member is required. EfsFilesystemArn *string // Specifies the Amazon Resource Name (ARN) of the access point that DataSync uses // to access the Amazon EFS file system. AccessPointArn *string // Specifies an Identity and Access Management (IAM) role that DataSync assumes // when mounting the Amazon EFS file system. FileSystemAccessRoleArn *string // Specifies whether you want DataSync to use Transport Layer Security (TLS) 1.2 // encryption when it copies data to or from the Amazon EFS file system. // // If you specify an access point using AccessPointArn or an IAM role using // FileSystemAccessRoleArn , you must set this parameter to TLS1_2 . InTransitEncryption types.EfsInTransitEncryption // Specifies a mount path for your Amazon EFS file system. This is where DataSync // reads or writes data (depending on if this is a source or destination location). // By default, DataSync uses the root directory, but you can also include // subdirectories. // // You must specify a value with forward slashes (for example, /path/to/folder ). Subdirectory *string // Specifies the key-value pair that represents a tag that you want to add to the // resource. The value can be an empty string. This value helps you manage, filter, // and search for your resources. We recommend that you create a name tag for your // location. Tags []types.TagListEntry // contains filtered or unexported fields }
CreateLocationEfsRequest
type CreateLocationEfsOutput ¶
type CreateLocationEfsOutput struct { // The Amazon Resource Name (ARN) of the Amazon EFS file system location that you // create. LocationArn *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
CreateLocationEfs
type CreateLocationFsxLustreInput ¶
type CreateLocationFsxLustreInput struct { // The Amazon Resource Name (ARN) for the FSx for Lustre file system. // // This member is required. FsxFilesystemArn *string // The Amazon Resource Names (ARNs) of the security groups that are used to // configure the FSx for Lustre file system. // // This member is required. SecurityGroupArns []string // A subdirectory in the location's path. This subdirectory in the FSx for Lustre // file system is used to read data from the FSx for Lustre source location or // write data to the FSx for Lustre destination. Subdirectory *string // The key-value pair that represents a tag that you want to add to the resource. // The value can be an empty string. This value helps you manage, filter, and // search for your resources. We recommend that you create a name tag for your // location. Tags []types.TagListEntry // contains filtered or unexported fields }
type CreateLocationFsxLustreOutput ¶
type CreateLocationFsxLustreOutput struct { // The Amazon Resource Name (ARN) of the FSx for Lustre file system location // that's created. LocationArn *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type CreateLocationFsxOntapInput ¶
type CreateLocationFsxOntapInput struct { // Specifies the data transfer protocol that DataSync uses to access your Amazon // FSx file system. // // This member is required. Protocol *types.FsxProtocol // Specifies the Amazon EC2 security groups that provide access to your file // system's preferred subnet. // // The security groups must allow outbound traffic on the following ports // (depending on the protocol you use): // // - Network File System (NFS): TCP ports 111, 635, and 2049 // // - Server Message Block (SMB): TCP port 445 // // Your file system's security groups must also allow inbound traffic on the same // ports. // // This member is required. SecurityGroupArns []string // Specifies the ARN of the storage virtual machine (SVM) in your file system // where you want to copy data to or from. // // This member is required. StorageVirtualMachineArn *string // Specifies a path to the file share in the SVM where you'll copy your data. // // You can specify a junction path (also known as a mount point), qtree path (for // NFS file shares), or share name (for SMB file shares). For example, your mount // path might be /vol1 , /vol1/tree1 , or /share1 . // // Don't specify a junction path in the SVM's root volume. For more information, // see [Managing FSx for ONTAP storage virtual machines]in the Amazon FSx for NetApp ONTAP User Guide. // // [Managing FSx for ONTAP storage virtual machines]: https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/managing-svms.html Subdirectory *string // Specifies labels that help you categorize, filter, and search for your Amazon // Web Services resources. We recommend creating at least a name tag for your // location. Tags []types.TagListEntry // contains filtered or unexported fields }
type CreateLocationFsxOntapOutput ¶
type CreateLocationFsxOntapOutput struct { // Specifies the ARN of the FSx for ONTAP file system location that you create. LocationArn *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type CreateLocationFsxOpenZfsInput ¶
type CreateLocationFsxOpenZfsInput struct { // The Amazon Resource Name (ARN) of the FSx for OpenZFS file system. // // This member is required. FsxFilesystemArn *string // The type of protocol that DataSync uses to access your file system. // // This member is required. Protocol *types.FsxProtocol // The ARNs of the security groups that are used to configure the FSx for OpenZFS // file system. // // This member is required. SecurityGroupArns []string // A subdirectory in the location's path that must begin with /fsx . DataSync uses // this subdirectory to read or write data (depending on whether the file system is // a source or destination location). Subdirectory *string // The key-value pair that represents a tag that you want to add to the resource. // The value can be an empty string. This value helps you manage, filter, and // search for your resources. We recommend that you create a name tag for your // location. Tags []types.TagListEntry // contains filtered or unexported fields }
type CreateLocationFsxOpenZfsOutput ¶
type CreateLocationFsxOpenZfsOutput struct { // The ARN of the FSx for OpenZFS file system location that you created. LocationArn *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type CreateLocationFsxWindowsInput ¶
type CreateLocationFsxWindowsInput struct { // Specifies the Amazon Resource Name (ARN) for the FSx for Windows File Server // file system. // // This member is required. FsxFilesystemArn *string // Specifies the password of the user with the permissions to mount and access the // files, folders, and file metadata in your FSx for Windows File Server file // system. // // This member is required. Password *string // Specifies the ARNs of the security groups that provide access to your file // system's preferred subnet. // // If you choose a security group that doesn't allow connections from within // itself, do one of the following: // // - Configure the security group to allow it to communicate within itself. // // - Choose a different security group that can communicate with the mount // target's security group. // // This member is required. SecurityGroupArns []string // Specifies the user with the permissions to mount and access the files, folders, // and file metadata in your FSx for Windows File Server file system. // // For information about choosing a user with the right level of access for your // transfer, see [required permissions]for FSx for Windows File Server locations. // // [required permissions]: https://docs.aws.amazon.com/datasync/latest/userguide/create-fsx-location.html#create-fsx-windows-location-permissions // // This member is required. User *string // Specifies the name of the Microsoft Active Directory domain that the FSx for // Windows File Server file system belongs to. // // If you have multiple Active Directory domains in your environment, configuring // this parameter makes sure that DataSync connects to the right file system. Domain *string // Specifies a mount path for your file system using forward slashes. This is // where DataSync reads or writes data (depending on if this is a source or // destination location). Subdirectory *string // Specifies labels that help you categorize, filter, and search for your Amazon // Web Services resources. We recommend creating at least a name tag for your // location. Tags []types.TagListEntry // contains filtered or unexported fields }
type CreateLocationFsxWindowsOutput ¶
type CreateLocationFsxWindowsOutput struct { // The ARN of the FSx for Windows File Server file system location you created. LocationArn *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type CreateLocationHdfsInput ¶
type CreateLocationHdfsInput struct { // The Amazon Resource Names (ARNs) of the agents that are used to connect to the // HDFS cluster. // // This member is required. AgentArns []string // The type of authentication used to determine the identity of the user. // // This member is required. AuthenticationType types.HdfsAuthenticationType // The NameNode that manages the HDFS namespace. The NameNode performs operations // such as opening, closing, and renaming files and directories. The NameNode // contains the information to map blocks of data to the DataNodes. You can use // only one NameNode. // // This member is required. NameNodes []types.HdfsNameNode // The size of data blocks to write into the HDFS cluster. The block size must be // a multiple of 512 bytes. The default block size is 128 mebibytes (MiB). BlockSize *int32 // The Kerberos key table (keytab) that contains mappings between the defined // Kerberos principal and the encrypted keys. You can load the keytab from a file // by providing the file's address. If you're using the CLI, it performs base64 // encoding for you. Otherwise, provide the base64-encoded text. // // If KERBEROS is specified for AuthenticationType , this parameter is required. KerberosKeytab []byte // The krb5.conf file that contains the Kerberos configuration information. You // can load the krb5.conf file by providing the file's address. If you're using // the CLI, it performs the base64 encoding for you. Otherwise, provide the // base64-encoded text. // // If KERBEROS is specified for AuthenticationType , this parameter is required. KerberosKrb5Conf []byte // The Kerberos principal with access to the files and folders on the HDFS // cluster. // // If KERBEROS is specified for AuthenticationType , this parameter is required. KerberosPrincipal *string // The URI of the HDFS cluster's Key Management Server (KMS). KmsKeyProviderUri *string // The Quality of Protection (QOP) configuration specifies the Remote Procedure // Call (RPC) and data transfer protection settings configured on the Hadoop // Distributed File System (HDFS) cluster. If QopConfiguration isn't specified, // RpcProtection and DataTransferProtection default to PRIVACY . If you set // RpcProtection or DataTransferProtection , the other parameter assumes the same // value. QopConfiguration *types.QopConfiguration // The number of DataNodes to replicate the data to when writing to the HDFS // cluster. By default, data is replicated to three DataNodes. ReplicationFactor *int32 // The user name used to identify the client on the host operating system. // // If SIMPLE is specified for AuthenticationType , this parameter is required. SimpleUser *string // A subdirectory in the HDFS cluster. This subdirectory is used to read data from // or write data to the HDFS cluster. If the subdirectory isn't specified, it will // default to / . Subdirectory *string // The key-value pair that represents the tag that you want to add to the // location. The value can be an empty string. We recommend using tags to name your // resources. Tags []types.TagListEntry // contains filtered or unexported fields }
type CreateLocationHdfsOutput ¶
type CreateLocationHdfsOutput struct { // The ARN of the source HDFS cluster location that's created. LocationArn *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type CreateLocationNfsInput ¶
type CreateLocationNfsInput struct { // Specifies the Amazon Resource Name (ARN) of the DataSync agent that want to // connect to your NFS file server. // // You can specify more than one agent. For more information, see [Using multiple agents for transfers]. // // [Using multiple agents for transfers]: https://docs.aws.amazon.com/datasync/latest/userguide/multiple-agents.html // // This member is required. OnPremConfig *types.OnPremConfig // Specifies the Domain Name System (DNS) name or IP version 4 address of the NFS // file server that your DataSync agent connects to. // // This member is required. ServerHostname *string // Specifies the export path in your NFS file server that you want DataSync to // mount. // // This path (or a subdirectory of the path) is where DataSync transfers data to // or from. For information on configuring an export for DataSync, see [Accessing NFS file servers]. // // [Accessing NFS file servers]: https://docs.aws.amazon.com/datasync/latest/userguide/create-nfs-location.html#accessing-nfs // // This member is required. Subdirectory *string // Specifies the options that DataSync can use to mount your NFS file server. MountOptions *types.NfsMountOptions // Specifies labels that help you categorize, filter, and search for your Amazon // Web Services resources. We recommend creating at least a name tag for your // location. Tags []types.TagListEntry // contains filtered or unexported fields }
CreateLocationNfsRequest
type CreateLocationNfsOutput ¶
type CreateLocationNfsOutput struct { // The ARN of the transfer location that you created for your NFS file server. LocationArn *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
CreateLocationNfsResponse
type CreateLocationObjectStorageInput ¶
type CreateLocationObjectStorageInput struct { // Specifies the Amazon Resource Names (ARNs) of the DataSync agents that can // securely connect with your location. // // This member is required. AgentArns []string // Specifies the name of the object storage bucket involved in the transfer. // // This member is required. BucketName *string // Specifies the domain name or IP address of the object storage server. A // DataSync agent uses this hostname to mount the object storage server in a // network. // // This member is required. ServerHostname *string // Specifies the access key (for example, a user name) if credentials are required // to authenticate with the object storage server. AccessKey *string // Specifies the secret key (for example, a password) if credentials are required // to authenticate with the object storage server. SecretKey *string // Specifies a certificate chain for DataSync to authenticate with your object // storage system if the system uses a private or self-signed certificate authority // (CA). You must specify a single .pem file with a full certificate chain (for // example, file:///home/user/.ssh/object_storage_certificates.pem ). // // The certificate chain might include: // // - The object storage system's certificate // // - All intermediate certificates (if there are any) // // - The root certificate of the signing CA // // You can concatenate your certificates into a .pem file (which can be up to // 32768 bytes before base64 encoding). The following example cat command creates // an object_storage_certificates.pem file that includes three certificates: // // cat object_server_certificate.pem intermediate_certificate.pem // ca_root_certificate.pem > object_storage_certificates.pem // // To use this parameter, configure ServerProtocol to HTTPS . ServerCertificate []byte // Specifies the port that your object storage server accepts inbound network // traffic on (for example, port 443). ServerPort *int32 // Specifies the protocol that your object storage server uses to communicate. ServerProtocol types.ObjectStorageServerProtocol // Specifies the object prefix for your object storage server. If this is a source // location, DataSync only copies objects with this prefix. If this is a // destination location, DataSync writes all objects with this prefix. Subdirectory *string // Specifies the key-value pair that represents a tag that you want to add to the // resource. Tags can help you manage, filter, and search for your resources. We // recommend creating a name tag for your location. Tags []types.TagListEntry // contains filtered or unexported fields }
CreateLocationObjectStorageRequest
type CreateLocationObjectStorageOutput ¶
type CreateLocationObjectStorageOutput struct { // Specifies the ARN of the object storage system location that you create. LocationArn *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
CreateLocationObjectStorageResponse
type CreateLocationS3Input ¶
type CreateLocationS3Input struct { // Specifies the ARN of the S3 bucket that you want to use as a location. (When // creating your DataSync task later, you specify whether this location is a // transfer source or destination.) // // If your S3 bucket is located on an Outposts resource, you must specify an // Amazon S3 access point. For more information, see [Managing data access with Amazon S3 access points]in the Amazon S3 User Guide. // // [Managing data access with Amazon S3 access points]: https://docs.aws.amazon.com/AmazonS3/latest/userguide/access-points.html // // This member is required. S3BucketArn *string // Specifies the Amazon Resource Name (ARN) of the Identity and Access Management // (IAM) role that DataSync uses to access your S3 bucket. // // For more information, see [Accessing S3 buckets]. // // [Accessing S3 buckets]: https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#create-s3-location-access // // This member is required. S3Config *types.S3Config // (Amazon S3 on Outposts only) Specifies the Amazon Resource Name (ARN) of the // DataSync agent on your Outpost. // // For more information, see [Deploy your DataSync agent on Outposts]. // // [Deploy your DataSync agent on Outposts]: https://docs.aws.amazon.com/datasync/latest/userguide/deploy-agents.html#outposts-agent AgentArns []string // Specifies the storage class that you want your objects to use when Amazon S3 is // a transfer destination. // // For buckets in Amazon Web Services Regions, the storage class defaults to // STANDARD . For buckets on Outposts, the storage class defaults to OUTPOSTS . // // For more information, see [Storage class considerations with Amazon S3 transfers]. // // [Storage class considerations with Amazon S3 transfers]: https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#using-storage-classes S3StorageClass types.S3StorageClass // Specifies a prefix in the S3 bucket that DataSync reads from or writes to // (depending on whether the bucket is a source or destination location). // // DataSync can't transfer objects with a prefix that begins with a slash ( / ) or // includes // , /./ , or /../ patterns. For example: // // - /photos // // - photos//2006/January // // - photos/./2006/February // // - photos/../2006/March Subdirectory *string // Specifies labels that help you categorize, filter, and search for your Amazon // Web Services resources. We recommend creating at least a name tag for your // transfer location. Tags []types.TagListEntry // contains filtered or unexported fields }
CreateLocationS3Request
type CreateLocationS3Output ¶
type CreateLocationS3Output struct { // The ARN of the S3 location that you created. LocationArn *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
CreateLocationS3Response
type CreateLocationSmbInput ¶
type CreateLocationSmbInput struct { // Specifies the DataSync agent (or agents) which you want to connect to your SMB // file server. You specify an agent by using its Amazon Resource Name (ARN). // // This member is required. AgentArns []string // Specifies the password of the user who can mount your SMB file server and has // permission to access the files and folders involved in your transfer. // // For more information, see [required permissions] for SMB locations. // // [required permissions]: https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions // // This member is required. Password *string // Specifies the Domain Name Service (DNS) name or IP address of the SMB file // server that your DataSync agent will mount. // // You can't specify an IP version 6 (IPv6) address. // // This member is required. ServerHostname *string // Specifies the name of the share exported by your SMB file server where DataSync // will read or write data. You can include a subdirectory in the share path (for // example, /path/to/subdirectory ). Make sure that other SMB clients in your // network can also mount this path. // // To copy all data in the subdirectory, DataSync must be able to mount the SMB // share and access all of its data. For more information, see [required permissions]for SMB locations. // // [required permissions]: https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions // // This member is required. Subdirectory *string // Specifies the user that can mount and access the files, folders, and file // metadata in your SMB file server. // // For information about choosing a user with the right level of access for your // transfer, see [required permissions]for SMB locations. // // [required permissions]: https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions // // This member is required. User *string // Specifies the name of the Active Directory domain that your SMB file server // belongs to. // // If you have multiple Active Directory domains in your environment, configuring // this parameter makes sure that DataSync connects to the right file server. Domain *string // Specifies the version of the SMB protocol that DataSync uses to access your SMB // file server. MountOptions *types.SmbMountOptions // Specifies labels that help you categorize, filter, and search for your Amazon // Web Services resources. We recommend creating at least a name tag for your // location. Tags []types.TagListEntry // contains filtered or unexported fields }
CreateLocationSmbRequest
type CreateLocationSmbOutput ¶
type CreateLocationSmbOutput struct { // The ARN of the SMB location that you created. LocationArn *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
CreateLocationSmbResponse
type CreateTaskInput ¶
type CreateTaskInput struct { // Specifies the ARN of your transfer's destination location. // // This member is required. DestinationLocationArn *string // Specifies the ARN of your transfer's source location. // // This member is required. SourceLocationArn *string // Specifies the Amazon Resource Name (ARN) of an Amazon CloudWatch log group for // monitoring your task. CloudWatchLogGroupArn *string // Specifies exclude filters that define the files, objects, and folders in your // source location that you don't want DataSync to transfer. For more information // and examples, see [Specifying what DataSync transfers by using filters]. // // [Specifying what DataSync transfers by using filters]: https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html Excludes []types.FilterRule // Specifies include filters define the files, objects, and folders in your source // location that you want DataSync to transfer. For more information and examples, // see [Specifying what DataSync transfers by using filters]. // // [Specifying what DataSync transfers by using filters]: https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html Includes []types.FilterRule // Configures a manifest, which is a list of files or objects that you want // DataSync to transfer. For more information and configuration examples, see [Specifying what DataSync transfers by using a manifest]. // // When using this parameter, your caller identity (the role that you're using // DataSync with) must have the iam:PassRole permission. The [AWSDataSyncFullAccess] policy includes this // permission. // // [AWSDataSyncFullAccess]: https://docs.aws.amazon.com/datasync/latest/userguide/security-iam-awsmanpol.html#security-iam-awsmanpol-awsdatasyncfullaccess // [Specifying what DataSync transfers by using a manifest]: https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html ManifestConfig *types.ManifestConfig // Specifies the name of your task. Name *string // Specifies your task's settings, such as preserving file metadata, verifying // data integrity, among other options. Options *types.Options // Specifies a schedule for when you want your task to run. For more information, // see [Scheduling your task]. // // [Scheduling your task]: https://docs.aws.amazon.com/datasync/latest/userguide/task-scheduling.html Schedule *types.TaskSchedule // Specifies the tags that you want to apply to your task. // // Tags are key-value pairs that help you manage, filter, and search for your // DataSync resources. Tags []types.TagListEntry // Specifies how you want to configure a task report, which provides detailed // information about your DataSync transfer. For more information, see [Monitoring your DataSync transfers with task reports]. // // When using this parameter, your caller identity (the role that you're using // DataSync with) must have the iam:PassRole permission. The [AWSDataSyncFullAccess] policy includes this // permission. // // [AWSDataSyncFullAccess]: https://docs.aws.amazon.com/datasync/latest/userguide/security-iam-awsmanpol.html#security-iam-awsmanpol-awsdatasyncfullaccess // [Monitoring your DataSync transfers with task reports]: https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html TaskReportConfig *types.TaskReportConfig // contains filtered or unexported fields }
CreateTaskRequest
type CreateTaskOutput ¶
type CreateTaskOutput struct { // The Amazon Resource Name (ARN) of the task. TaskArn *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
CreateTaskResponse
type DeleteAgentInput ¶
type DeleteAgentInput struct { // The Amazon Resource Name (ARN) of the agent to delete. Use the ListAgents // operation to return a list of agents for your account and Amazon Web Services // Region. // // This member is required. AgentArn *string // contains filtered or unexported fields }
DeleteAgentRequest
type DeleteAgentOutput ¶
type DeleteAgentOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteLocationInput ¶
type DeleteLocationInput struct { // The Amazon Resource Name (ARN) of the location to delete. // // This member is required. LocationArn *string // contains filtered or unexported fields }
DeleteLocation
type DeleteLocationOutput ¶
type DeleteLocationOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DeleteTaskInput ¶
type DeleteTaskInput struct { // Specifies the Amazon Resource Name (ARN) of the task that you want to delete. // // This member is required. TaskArn *string // contains filtered or unexported fields }
DeleteTask
type DeleteTaskOutput ¶
type DeleteTaskOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DescribeAgentInput ¶
type DescribeAgentInput struct { // Specifies the Amazon Resource Name (ARN) of the DataSync agent that you want // information about. // // This member is required. AgentArn *string // contains filtered or unexported fields }
DescribeAgent
type DescribeAgentOutput ¶
type DescribeAgentOutput struct { // The ARN of the agent. AgentArn *string // The time that the agent was [activated]. // // [activated]: https://docs.aws.amazon.com/datasync/latest/userguide/activate-agent.html CreationTime *time.Time // The type of [service endpoint] that your agent is connected to. // // [service endpoint]: https://docs.aws.amazon.com/datasync/latest/userguide/choose-service-endpoint.html EndpointType types.EndpointType // The last time that the agent was communicating with the DataSync service. LastConnectionTime *time.Time // The name of the agent. Name *string // The platform-related details about the agent, such as the version number. Platform *types.Platform // The network configuration that the agent uses when connecting to a [VPC service endpoint]. // // [VPC service endpoint]: https://docs.aws.amazon.com/datasync/latest/userguide/choose-service-endpoint.html#choose-service-endpoint-vpc PrivateLinkConfig *types.PrivateLinkConfig // The status of the agent. // // - If the status is ONLINE , the agent is configured properly and ready to use. // // - If the status is OFFLINE , the agent has been out of contact with DataSync // for five minutes or longer. This can happen for a few reasons. For more // information, see [What do I do if my agent is offline?] // // [What do I do if my agent is offline?]: https://docs.aws.amazon.com/datasync/latest/userguide/troubleshooting-datasync-agents.html#troubleshoot-agent-offline Status types.AgentStatus // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
DescribeAgentResponse
type DescribeDiscoveryJobInput ¶
type DescribeDiscoveryJobInput struct { // Specifies the Amazon Resource Name (ARN) of the discovery job that you want // information about. // // This member is required. DiscoveryJobArn *string // contains filtered or unexported fields }
type DescribeDiscoveryJobOutput ¶
type DescribeDiscoveryJobOutput struct { // The number of minutes that the discovery job runs. CollectionDurationMinutes *int32 // The ARN of the discovery job. DiscoveryJobArn *string // The time when the discovery job ended. JobEndTime *time.Time // The time when the discovery job started. JobStartTime *time.Time // Indicates the status of a discovery job. For more information, see [Discovery job statuses]. // // [Discovery job statuses]: https://docs.aws.amazon.com/datasync/latest/userguide/discovery-job-statuses.html#discovery-job-statuses-table Status types.DiscoveryJobStatus // The ARN of the on-premises storage system you're running the discovery job on. StorageSystemArn *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DescribeLocationAzureBlobInput ¶
type DescribeLocationAzureBlobInput struct { // Specifies the Amazon Resource Name (ARN) of your Azure Blob Storage transfer // location. // // This member is required. LocationArn *string // contains filtered or unexported fields }
type DescribeLocationAzureBlobOutput ¶
type DescribeLocationAzureBlobOutput struct { // The access tier that you want your objects or files transferred into. This only // applies when using the location as a transfer destination. For more information, // see [Access tiers]. // // [Access tiers]: https://docs.aws.amazon.com/datasync/latest/userguide/creating-azure-blob-location.html#azure-blob-access-tiers AccessTier types.AzureAccessTier // The ARNs of the DataSync agents that can connect with your Azure Blob Storage // container. AgentArns []string // The authentication method DataSync uses to access your Azure Blob Storage. // DataSync can access blob storage using a shared access signature (SAS). AuthenticationType types.AzureBlobAuthenticationType // The type of blob that you want your objects or files to be when transferring // them into Azure Blob Storage. Currently, DataSync only supports moving data into // Azure Blob Storage as block blobs. For more information on blob types, see the [Azure Blob Storage documentation]. // // [Azure Blob Storage documentation]: https://learn.microsoft.com/en-us/rest/api/storageservices/understanding-block-blobs--append-blobs--and-page-blobs BlobType types.AzureBlobType // The time that your Azure Blob Storage transfer location was created. CreationTime *time.Time // The ARN of your Azure Blob Storage transfer location. LocationArn *string // The URL of the Azure Blob Storage container involved in your transfer. LocationUri *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DescribeLocationEfsInput ¶
type DescribeLocationEfsInput struct { // The Amazon Resource Name (ARN) of the Amazon EFS file system location that you // want information about. // // This member is required. LocationArn *string // contains filtered or unexported fields }
DescribeLocationEfsRequest
type DescribeLocationEfsOutput ¶
type DescribeLocationEfsOutput struct { // The ARN of the access point that DataSync uses to access the Amazon EFS file // system. AccessPointArn *string // The time that the location was created. CreationTime *time.Time // The subnet and security groups that DataSync uses to access your Amazon EFS // file system. Ec2Config *types.Ec2Config // The Identity and Access Management (IAM) role that DataSync assumes when // mounting the Amazon EFS file system. FileSystemAccessRoleArn *string // Describes whether DataSync uses Transport Layer Security (TLS) encryption when // copying data to or from the Amazon EFS file system. InTransitEncryption types.EfsInTransitEncryption // The ARN of the Amazon EFS file system location. LocationArn *string // The URL of the Amazon EFS file system location. LocationUri *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
DescribeLocationEfsResponse
type DescribeLocationFsxLustreInput ¶
type DescribeLocationFsxLustreInput struct { // The Amazon Resource Name (ARN) of the FSx for Lustre location to describe. // // This member is required. LocationArn *string // contains filtered or unexported fields }
type DescribeLocationFsxLustreOutput ¶
type DescribeLocationFsxLustreOutput struct { // The time that the FSx for Lustre location was created. CreationTime *time.Time // The Amazon Resource Name (ARN) of the FSx for Lustre location that was // described. LocationArn *string // The URI of the FSx for Lustre location that was described. LocationUri *string // The Amazon Resource Names (ARNs) of the security groups that are configured for // the FSx for Lustre file system. SecurityGroupArns []string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DescribeLocationFsxOntapInput ¶
type DescribeLocationFsxOntapInput struct { // Specifies the Amazon Resource Name (ARN) of the FSx for ONTAP file system // location that you want information about. // // This member is required. LocationArn *string // contains filtered or unexported fields }
type DescribeLocationFsxOntapOutput ¶
type DescribeLocationFsxOntapOutput struct { // The time that the location was created. CreationTime *time.Time // The ARN of the FSx for ONTAP file system. FsxFilesystemArn *string // The ARN of the FSx for ONTAP file system location. LocationArn *string // The uniform resource identifier (URI) of the FSx for ONTAP file system location. LocationUri *string // Specifies the data transfer protocol that DataSync uses to access your Amazon // FSx file system. Protocol *types.FsxProtocol // The security groups that DataSync uses to access your FSx for ONTAP file system. SecurityGroupArns []string // The ARN of the storage virtual machine (SVM) on your FSx for ONTAP file system // where you're copying data to or from. StorageVirtualMachineArn *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DescribeLocationFsxOpenZfsInput ¶
type DescribeLocationFsxOpenZfsInput struct { // The Amazon Resource Name (ARN) of the FSx for OpenZFS location to describe. // // This member is required. LocationArn *string // contains filtered or unexported fields }
type DescribeLocationFsxOpenZfsOutput ¶
type DescribeLocationFsxOpenZfsOutput struct { // The time that the FSx for OpenZFS location was created. CreationTime *time.Time // The ARN of the FSx for OpenZFS location that was described. LocationArn *string // The uniform resource identifier (URI) of the FSx for OpenZFS location that was // described. // // Example: fsxz://us-west-2.fs-1234567890abcdef02/fsx/folderA/folder LocationUri *string // The type of protocol that DataSync uses to access your file system. Protocol *types.FsxProtocol // The ARNs of the security groups that are configured for the FSx for OpenZFS // file system. SecurityGroupArns []string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DescribeLocationFsxWindowsInput ¶
type DescribeLocationFsxWindowsInput struct { // Specifies the Amazon Resource Name (ARN) of the FSx for Windows File Server // location. // // This member is required. LocationArn *string // contains filtered or unexported fields }
type DescribeLocationFsxWindowsOutput ¶
type DescribeLocationFsxWindowsOutput struct { // The time that the FSx for Windows File Server location was created. CreationTime *time.Time // The name of the Microsoft Active Directory domain that the FSx for Windows File // Server file system belongs to. Domain *string // The ARN of the FSx for Windows File Server location. LocationArn *string // The uniform resource identifier (URI) of the FSx for Windows File Server // location. LocationUri *string // The ARNs of the security groups that are configured for the FSx for Windows // File Server file system. SecurityGroupArns []string // The user with the permissions to mount and access the FSx for Windows File // Server file system. User *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DescribeLocationHdfsInput ¶
type DescribeLocationHdfsInput struct { // Specifies the Amazon Resource Name (ARN) of the HDFS location. // // This member is required. LocationArn *string // contains filtered or unexported fields }
type DescribeLocationHdfsOutput ¶
type DescribeLocationHdfsOutput struct { // The ARNs of the DataSync agents that can connect with your HDFS cluster. AgentArns []string // The type of authentication used to determine the identity of the user. AuthenticationType types.HdfsAuthenticationType // The size of the data blocks to write into the HDFS cluster. BlockSize *int32 // The time that the HDFS location was created. CreationTime *time.Time // The Kerberos principal with access to the files and folders on the HDFS // cluster. This parameter is used if the AuthenticationType is defined as KERBEROS // . KerberosPrincipal *string // The URI of the HDFS cluster's Key Management Server (KMS). KmsKeyProviderUri *string // The ARN of the HDFS location. LocationArn *string // The URI of the HDFS location. LocationUri *string // The NameNode that manages the HDFS namespace. NameNodes []types.HdfsNameNode // The Quality of Protection (QOP) configuration, which specifies the Remote // Procedure Call (RPC) and data transfer protection settings configured on the // HDFS cluster. QopConfiguration *types.QopConfiguration // The number of DataNodes to replicate the data to when writing to the HDFS // cluster. ReplicationFactor *int32 // The user name to identify the client on the host operating system. This // parameter is used if the AuthenticationType is defined as SIMPLE . SimpleUser *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DescribeLocationNfsInput ¶
type DescribeLocationNfsInput struct { // Specifies the Amazon Resource Name (ARN) of the NFS location that you want // information about. // // This member is required. LocationArn *string // contains filtered or unexported fields }
DescribeLocationNfsRequest
type DescribeLocationNfsOutput ¶
type DescribeLocationNfsOutput struct { // The time when the NFS location was created. CreationTime *time.Time // The ARN of the NFS location. LocationArn *string // The URI of the NFS location. LocationUri *string // The mount options that DataSync uses to mount your NFS file server. MountOptions *types.NfsMountOptions // The DataSync agents that are connecting to a Network File System (NFS) location. OnPremConfig *types.OnPremConfig // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
DescribeLocationNfsResponse
type DescribeLocationObjectStorageInput ¶
type DescribeLocationObjectStorageInput struct { // Specifies the Amazon Resource Name (ARN) of the object storage system location. // // This member is required. LocationArn *string // contains filtered or unexported fields }
DescribeLocationObjectStorageRequest
type DescribeLocationObjectStorageOutput ¶
type DescribeLocationObjectStorageOutput struct { // The access key (for example, a user name) required to authenticate with the // object storage system. AccessKey *string // The ARNs of the DataSync agents that can connect with your object storage // system. AgentArns []string // The time that the location was created. CreationTime *time.Time // The ARN of the object storage system location. LocationArn *string // The URI of the object storage system location. LocationUri *string // The certificate chain for DataSync to authenticate with your object storage // system if the system uses a private or self-signed certificate authority (CA). ServerCertificate []byte // The port that your object storage server accepts inbound network traffic on // (for example, port 443). ServerPort *int32 // The protocol that your object storage system uses to communicate. ServerProtocol types.ObjectStorageServerProtocol // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
DescribeLocationObjectStorageResponse
type DescribeLocationS3Input ¶
type DescribeLocationS3Input struct { // Specifies the Amazon Resource Name (ARN) of the Amazon S3 location. // // This member is required. LocationArn *string // contains filtered or unexported fields }
DescribeLocationS3Request
type DescribeLocationS3Output ¶
type DescribeLocationS3Output struct { // The ARNs of the DataSync agents deployed on your Outpost when using working // with Amazon S3 on Outposts. // // For more information, see [Deploy your DataSync agent on Outposts]. // // [Deploy your DataSync agent on Outposts]: https://docs.aws.amazon.com/datasync/latest/userguide/deploy-agents.html#outposts-agent AgentArns []string // The time that the Amazon S3 location was created. CreationTime *time.Time // The ARN of the Amazon S3 location. LocationArn *string // The URL of the Amazon S3 location that was described. LocationUri *string // Specifies the Amazon Resource Name (ARN) of the Identity and Access Management // (IAM) role that DataSync uses to access your S3 bucket. // // For more information, see [Accessing S3 buckets]. // // [Accessing S3 buckets]: https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#create-s3-location-access S3Config *types.S3Config // When Amazon S3 is a destination location, this is the storage class that you // chose for your objects. // // Some storage classes have behaviors that can affect your Amazon S3 storage // costs. For more information, see [Storage class considerations with Amazon S3 transfers]. // // [Storage class considerations with Amazon S3 transfers]: https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#using-storage-classes S3StorageClass types.S3StorageClass // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
DescribeLocationS3Response
type DescribeLocationSmbInput ¶
type DescribeLocationSmbInput struct { // Specifies the Amazon Resource Name (ARN) of the SMB location that you want // information about. // // This member is required. LocationArn *string // contains filtered or unexported fields }
DescribeLocationSmbRequest
type DescribeLocationSmbOutput ¶
type DescribeLocationSmbOutput struct { // The ARNs of the DataSync agents that can connect with your SMB file server. AgentArns []string // The time that the SMB location was created. CreationTime *time.Time // The name of the Microsoft Active Directory domain that the SMB file server // belongs to. Domain *string // The ARN of the SMB location. LocationArn *string // The URI of the SMB location. LocationUri *string // The protocol that DataSync use to access your SMB file. MountOptions *types.SmbMountOptions // The user that can mount and access the files, folders, and file metadata in // your SMB file server. User *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
DescribeLocationSmbResponse
type DescribeStorageSystemInput ¶
type DescribeStorageSystemInput struct { // Specifies the Amazon Resource Name (ARN) of an on-premises storage system that // you're using with DataSync Discovery. // // This member is required. StorageSystemArn *string // contains filtered or unexported fields }
type DescribeStorageSystemOutput ¶
type DescribeStorageSystemOutput struct { // The ARN of the DataSync agent that connects to and reads from your on-premises // storage system. AgentArns []string // The ARN of the Amazon CloudWatch log group that's used to monitor and log // discovery job events. CloudWatchLogGroupArn *string // Indicates whether your DataSync agent can connect to your on-premises storage // system. ConnectivityStatus types.StorageSystemConnectivityStatus // The time when you added the on-premises storage system to DataSync Discovery. CreationTime *time.Time // Describes the connectivity error that the DataSync agent is encountering with // your on-premises storage system. ErrorMessage *string // The name that you gave your on-premises storage system when adding it to // DataSync Discovery. Name *string // The ARN of the secret that stores your on-premises storage system's // credentials. DataSync Discovery stores these credentials in [Secrets Manager]. // // [Secrets Manager]: https://docs.aws.amazon.com/datasync/latest/userguide/discovery-configure-storage.html#discovery-add-storage SecretsManagerArn *string // The server name and network port required to connect with your on-premises // storage system's management interface. ServerConfiguration *types.DiscoveryServerConfiguration // The ARN of the on-premises storage system that the discovery job looked at. StorageSystemArn *string // The type of on-premises storage system. // // DataSync Discovery currently only supports NetApp Fabric-Attached Storage (FAS) // and All Flash FAS (AFF) systems running ONTAP 9.7 or later. SystemType types.DiscoverySystemType // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DescribeStorageSystemResourceMetricsAPIClient ¶
type DescribeStorageSystemResourceMetricsAPIClient interface {
DescribeStorageSystemResourceMetrics(context.Context, *DescribeStorageSystemResourceMetricsInput, ...func(*Options)) (*DescribeStorageSystemResourceMetricsOutput, error)
}
DescribeStorageSystemResourceMetricsAPIClient is a client that implements the DescribeStorageSystemResourceMetrics operation.
type DescribeStorageSystemResourceMetricsInput ¶
type DescribeStorageSystemResourceMetricsInput struct { // Specifies the Amazon Resource Name (ARN) of the discovery job that collects // information about your on-premises storage system. // // This member is required. DiscoveryJobArn *string // Specifies the universally unique identifier (UUID) of the storage system // resource that you want information about. // // This member is required. ResourceId *string // Specifies the kind of storage system resource that you want information about. // // This member is required. ResourceType types.DiscoveryResourceType // Specifies a time within the total duration that the discovery job ran. To see // information gathered during a certain time frame, use this parameter with // StartTime . EndTime *time.Time // Specifies how many results that you want in the response. MaxResults *int32 // Specifies an opaque string that indicates the position to begin the next list // of results in the response. NextToken *string // Specifies a time within the total duration that the discovery job ran. To see // information gathered during a certain time frame, use this parameter with // EndTime . StartTime *time.Time // contains filtered or unexported fields }
type DescribeStorageSystemResourceMetricsOutput ¶
type DescribeStorageSystemResourceMetricsOutput struct { // The details that your discovery job collected about your storage system // resource. Metrics []types.ResourceMetrics // The opaque string that indicates the position to begin the next list of results // in the response. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DescribeStorageSystemResourceMetricsPaginator ¶
type DescribeStorageSystemResourceMetricsPaginator struct {
// contains filtered or unexported fields
}
DescribeStorageSystemResourceMetricsPaginator is a paginator for DescribeStorageSystemResourceMetrics
func NewDescribeStorageSystemResourceMetricsPaginator ¶
func NewDescribeStorageSystemResourceMetricsPaginator(client DescribeStorageSystemResourceMetricsAPIClient, params *DescribeStorageSystemResourceMetricsInput, optFns ...func(*DescribeStorageSystemResourceMetricsPaginatorOptions)) *DescribeStorageSystemResourceMetricsPaginator
NewDescribeStorageSystemResourceMetricsPaginator returns a new DescribeStorageSystemResourceMetricsPaginator
func (*DescribeStorageSystemResourceMetricsPaginator) HasMorePages ¶
func (p *DescribeStorageSystemResourceMetricsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*DescribeStorageSystemResourceMetricsPaginator) NextPage ¶
func (p *DescribeStorageSystemResourceMetricsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeStorageSystemResourceMetricsOutput, error)
NextPage retrieves the next DescribeStorageSystemResourceMetrics page.
type DescribeStorageSystemResourceMetricsPaginatorOptions ¶
type DescribeStorageSystemResourceMetricsPaginatorOptions struct { // Specifies how many results that you want in the response. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
DescribeStorageSystemResourceMetricsPaginatorOptions is the paginator options for DescribeStorageSystemResourceMetrics
type DescribeStorageSystemResourcesAPIClient ¶
type DescribeStorageSystemResourcesAPIClient interface {
DescribeStorageSystemResources(context.Context, *DescribeStorageSystemResourcesInput, ...func(*Options)) (*DescribeStorageSystemResourcesOutput, error)
}
DescribeStorageSystemResourcesAPIClient is a client that implements the DescribeStorageSystemResources operation.
type DescribeStorageSystemResourcesInput ¶
type DescribeStorageSystemResourcesInput struct { // Specifies the Amazon Resource Name (ARN) of the discovery job that's collecting // data from your on-premises storage system. // // This member is required. DiscoveryJobArn *string // Specifies what kind of storage system resources that you want information about. // // This member is required. ResourceType types.DiscoveryResourceType // Filters the storage system resources that you want returned. For example, this // might be volumes associated with a specific storage virtual machine (SVM). Filter map[string][]string // Specifies the maximum number of storage system resources that you want to list // in a response. MaxResults *int32 // Specifies an opaque string that indicates the position to begin the next list // of results in the response. NextToken *string // Specifies the universally unique identifiers (UUIDs) of the storage system // resources that you want information about. You can't use this parameter in // combination with the Filter parameter. ResourceIds []string // contains filtered or unexported fields }
type DescribeStorageSystemResourcesOutput ¶
type DescribeStorageSystemResourcesOutput struct { // The opaque string that indicates the position to begin the next list of results // in the response. NextToken *string // The information collected about your storage system's resources. A response can // also include Amazon Web Services storage service recommendations. // // For more information, see [storage resource information] collected by and [recommendations] provided by DataSync Discovery. // // [storage resource information]: https://docs.aws.amazon.com/datasync/latest/userguide/discovery-understand-findings.html // [recommendations]: https://docs.aws.amazon.com/datasync/latest/userguide/discovery-understand-recommendations.html ResourceDetails *types.ResourceDetails // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type DescribeStorageSystemResourcesPaginator ¶
type DescribeStorageSystemResourcesPaginator struct {
// contains filtered or unexported fields
}
DescribeStorageSystemResourcesPaginator is a paginator for DescribeStorageSystemResources
func NewDescribeStorageSystemResourcesPaginator ¶
func NewDescribeStorageSystemResourcesPaginator(client DescribeStorageSystemResourcesAPIClient, params *DescribeStorageSystemResourcesInput, optFns ...func(*DescribeStorageSystemResourcesPaginatorOptions)) *DescribeStorageSystemResourcesPaginator
NewDescribeStorageSystemResourcesPaginator returns a new DescribeStorageSystemResourcesPaginator
func (*DescribeStorageSystemResourcesPaginator) HasMorePages ¶
func (p *DescribeStorageSystemResourcesPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*DescribeStorageSystemResourcesPaginator) NextPage ¶
func (p *DescribeStorageSystemResourcesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*DescribeStorageSystemResourcesOutput, error)
NextPage retrieves the next DescribeStorageSystemResources page.
type DescribeStorageSystemResourcesPaginatorOptions ¶
type DescribeStorageSystemResourcesPaginatorOptions struct { // Specifies the maximum number of storage system resources that you want to list // in a response. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
DescribeStorageSystemResourcesPaginatorOptions is the paginator options for DescribeStorageSystemResources
type DescribeTaskExecutionInput ¶
type DescribeTaskExecutionInput struct { // Specifies the Amazon Resource Name (ARN) of the task execution that you want // information about. // // This member is required. TaskExecutionArn *string // contains filtered or unexported fields }
DescribeTaskExecutionRequest
type DescribeTaskExecutionOutput ¶
type DescribeTaskExecutionOutput struct { // The physical number of bytes transferred over the network after compression was // applied. In most cases, this number is less than BytesTransferred unless the // data isn't compressible. BytesCompressed int64 // The total number of bytes that are involved in the transfer. For the number of // bytes sent over the network, see BytesCompressed . BytesTransferred int64 // The number of logical bytes written to the destination location. BytesWritten int64 // The estimated physical number of bytes that will transfer over the network. EstimatedBytesToTransfer int64 // The expected number of files, objects, and directories that DataSync will // delete in your destination location. If you don't [configure your task]to delete data in the // destination that isn't in the source, the value is always 0 . // // [configure your task]: https://docs.aws.amazon.com/datasync/latest/userguide/configure-metadata.html EstimatedFilesToDelete int64 // The expected number of files, objects, and directories that DataSync will // transfer over the network. This value is calculated during the task execution's // PREPARING phase before the TRANSFERRING phase. The calculation is based on // comparing the content of the source and destination locations and finding the // difference that needs to be transferred. EstimatedFilesToTransfer int64 // A list of filter rules that exclude specific data during your transfer. For // more information and examples, see [Filtering data transferred by DataSync]. // // [Filtering data transferred by DataSync]: https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html Excludes []types.FilterRule // The number of files, objects, and directories that DataSync deleted in your // destination location. If you don't [configure your task]to delete data in the destination that isn't // in the source, the value is always 0 . // // [configure your task]: https://docs.aws.amazon.com/datasync/latest/userguide/configure-metadata.html FilesDeleted int64 // The number of files, objects, and directories that DataSync skipped during your // transfer. FilesSkipped int64 // The actual number of files, objects, and directories that DataSync transferred // over the network. This value is updated periodically during the task execution's // TRANSFERRING phase when something is read from the source and sent over the // network. // // If DataSync fails to transfer something, this value can be less than // EstimatedFilesToTransfer . In some cases, this value can also be greater than // EstimatedFilesToTransfer . This element is implementation-specific for some // location types, so don't use it as an exact indication of what transferred or to // monitor your task execution. FilesTransferred int64 // The number of files, objects, and directories that DataSync verified during // your transfer. // // When you configure your task to [verify only the data that's transferred], DataSync doesn't verify directories in some // situations or files that fail to transfer. // // [verify only the data that's transferred]: https://docs.aws.amazon.com/datasync/latest/userguide/configure-data-verification-options.html FilesVerified int64 // A list of filter rules that include specific data during your transfer. For // more information and examples, see [Filtering data transferred by DataSync]. // // [Filtering data transferred by DataSync]: https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html Includes []types.FilterRule // The configuration of the manifest that lists the files or objects to transfer. // For more information, see [Specifying what DataSync transfers by using a manifest]. // // [Specifying what DataSync transfers by using a manifest]: https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html ManifestConfig *types.ManifestConfig // Indicates how your transfer task is configured. These options include how // DataSync handles files, objects, and their associated metadata during your // transfer. You also can specify how to verify data integrity, set bandwidth // limits for your task, among other options. // // Each option has a default value. Unless you need to, you don't have to // configure any option before calling [StartTaskExecution]. // // You also can override your task options for each task execution. For example, // you might want to adjust the LogLevel for an individual execution. // // [StartTaskExecution]: https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html Options *types.Options // Indicates whether DataSync generated a complete [task report] for your transfer. // // [task report]: https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html ReportResult *types.ReportResult // The result of the task execution. Result *types.TaskExecutionResultDetail // The time when the task execution started. StartTime *time.Time // The status of the task execution. Status types.TaskExecutionStatus // The ARN of the task execution that you wanted information about. // 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 configuration of your task report, which provides detailed information // about for your DataSync transfer. For more information, see [Creating a task report]. // // [Creating a task report]: https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html TaskReportConfig *types.TaskReportConfig // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
DescribeTaskExecutionResponse
type DescribeTaskInput ¶
type DescribeTaskInput struct { // Specifies the Amazon Resource Name (ARN) of the transfer task that you want // information about. // // This member is required. TaskArn *string // contains filtered or unexported fields }
DescribeTaskRequest
type DescribeTaskOutput ¶
type DescribeTaskOutput struct { // The Amazon Resource Name (ARN) of an Amazon CloudWatch log group for monitoring // your task. // // For more information, see [Monitoring DataSync with Amazon CloudWatch]. // // [Monitoring DataSync with Amazon CloudWatch]: https://docs.aws.amazon.com/datasync/latest/userguide/monitor-datasync.html CloudWatchLogGroupArn *string // The time that the task was created. CreationTime *time.Time // The ARN of the most recent task execution. CurrentTaskExecutionArn *string // The ARN of your transfer's destination location. DestinationLocationArn *string // The ARNs of the [network interfaces] that DataSync created for your destination location. // // [network interfaces]: https://docs.aws.amazon.com/datasync/latest/userguide/datasync-network.html#required-network-interfaces DestinationNetworkInterfaceArns []string // If there's an issue with your task, you can use the error code to help you // troubleshoot the problem. For more information, see [Troubleshooting issues with DataSync transfers]. // // [Troubleshooting issues with DataSync transfers]: https://docs.aws.amazon.com/datasync/latest/userguide/troubleshooting-datasync-locations-tasks.html ErrorCode *string // If there's an issue with your task, you can use the error details to help you // troubleshoot the problem. For more information, see [Troubleshooting issues with DataSync transfers]. // // [Troubleshooting issues with DataSync transfers]: https://docs.aws.amazon.com/datasync/latest/userguide/troubleshooting-datasync-locations-tasks.html ErrorDetail *string // The exclude filters that define the files, objects, and folders in your source // location that you don't want DataSync to transfer. For more information and // examples, see [Specifying what DataSync transfers by using filters]. // // [Specifying what DataSync transfers by using filters]: https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html Excludes []types.FilterRule // The include filters that define the files, objects, and folders in your source // location that you want DataSync to transfer. For more information and examples, // see [Specifying what DataSync transfers by using filters]. // // [Specifying what DataSync transfers by using filters]: https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html Includes []types.FilterRule // The configuration of the manifest that lists the files or objects that you want // DataSync to transfer. For more information, see [Specifying what DataSync transfers by using a manifest]. // // [Specifying what DataSync transfers by using a manifest]: https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html ManifestConfig *types.ManifestConfig // The name of your task. Name *string // The task's settings. For example, what file metadata gets preserved, how data // integrity gets verified at the end of your transfer, bandwidth limits, among // other options. Options *types.Options // The schedule for when you want your task to run. For more information, see [Scheduling your task]. // // [Scheduling your task]: https://docs.aws.amazon.com/datasync/latest/userguide/task-scheduling.html Schedule *types.TaskSchedule // The details about your [task schedule]. // // [task schedule]: https://docs.aws.amazon.com/datasync/latest/userguide/task-scheduling.html ScheduleDetails *types.TaskScheduleDetails // The ARN of your transfer's source location. SourceLocationArn *string // The ARNs of the [network interfaces] that DataSync created for your source location. // // [network interfaces]: https://docs.aws.amazon.com/datasync/latest/userguide/datasync-network.html#required-network-interfaces SourceNetworkInterfaceArns []string // The status of your task. For information about what each status means, see [Task statuses]. // // [Task statuses]: https://docs.aws.amazon.com/datasync/latest/userguide/understand-task-statuses.html#understand-task-creation-statuses Status types.TaskStatus // The ARN of your task. TaskArn *string // The configuration of your task report, which provides detailed information // about your DataSync transfer. For more information, see [Monitoring your DataSync transfers with task reports]. // // [Monitoring your DataSync transfers with task reports]: https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html TaskReportConfig *types.TaskReportConfig // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
DescribeTaskResponse
type EndpointParameters ¶
type EndpointParameters struct { // The AWS region used to dispatch the request. // // Parameter is // required. // // AWS::Region Region *string // When true, use the dual-stack endpoint. If the configured endpoint does not // support dual-stack, dispatching the request MAY return an error. // // Defaults to // false if no value is provided. // // AWS::UseDualStack UseDualStack *bool // When true, send this request to the FIPS-compliant regional endpoint. If the // configured endpoint does not have a FIPS compliant endpoint, dispatching the // request will return an error. // // Defaults to false if no value is // provided. // // AWS::UseFIPS UseFIPS *bool // Override the endpoint used to send this request // // Parameter is // required. // // SDK::Endpoint Endpoint *string }
EndpointParameters provides the parameters that influence how endpoints are resolved.
func (EndpointParameters) ValidateRequired ¶
func (p EndpointParameters) ValidateRequired() error
ValidateRequired validates required parameters are set.
func (EndpointParameters) WithDefaults ¶
func (p EndpointParameters) WithDefaults() EndpointParameters
WithDefaults returns a shallow copy of EndpointParameterswith default values applied to members where applicable.
type EndpointResolver ¶
type EndpointResolver interface {
ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
}
EndpointResolver interface for resolving service endpoints.
func EndpointResolverFromURL ¶
func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver
EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.
type EndpointResolverFunc ¶
type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)
EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.
func (EndpointResolverFunc) ResolveEndpoint ¶
func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)
type EndpointResolverOptions ¶
type EndpointResolverOptions = internalendpoints.Options
EndpointResolverOptions is the service endpoint resolver options
type EndpointResolverV2 ¶
type EndpointResolverV2 interface { // ResolveEndpoint attempts to resolve the endpoint with the provided options, // returning the endpoint if found. Otherwise an error is returned. ResolveEndpoint(ctx context.Context, params EndpointParameters) ( smithyendpoints.Endpoint, error, ) }
EndpointResolverV2 provides the interface for resolving service endpoints.
func NewDefaultEndpointResolverV2 ¶
func NewDefaultEndpointResolverV2() EndpointResolverV2
type GenerateRecommendationsInput ¶
type GenerateRecommendationsInput struct { // Specifies the Amazon Resource Name (ARN) of the discovery job that collects // information about your on-premises storage system. // // This member is required. DiscoveryJobArn *string // Specifies the universally unique identifiers (UUIDs) of the resources in your // storage system that you want recommendations on. // // This member is required. ResourceIds []string // Specifies the type of resource in your storage system that you want // recommendations on. // // This member is required. ResourceType types.DiscoveryResourceType // contains filtered or unexported fields }
type GenerateRecommendationsOutput ¶
type GenerateRecommendationsOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type HTTPSignerV4 ¶
type IdempotencyTokenProvider ¶
IdempotencyTokenProvider interface for providing idempotency token
type ListAgentsAPIClient ¶
type ListAgentsAPIClient interface {
ListAgents(context.Context, *ListAgentsInput, ...func(*Options)) (*ListAgentsOutput, error)
}
ListAgentsAPIClient is a client that implements the ListAgents operation.
type ListAgentsInput ¶
type ListAgentsInput struct { // Specifies the maximum number of DataSync agents to list in a response. By // default, a response shows a maximum of 100 agents. MaxResults *int32 // Specifies an opaque string that indicates the position to begin the next list // of results in the response. NextToken *string // contains filtered or unexported fields }
ListAgentsRequest
type ListAgentsOutput ¶
type ListAgentsOutput struct { // A list of DataSync agents in your Amazon Web Services account in the Amazon Web // Services Region specified in the request. The list is ordered by the agents' // Amazon Resource Names (ARNs). Agents []types.AgentListEntry // The opaque string that indicates the position to begin the next list of results // in the response. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
ListAgentsResponse
type ListAgentsPaginator ¶
type ListAgentsPaginator struct {
// contains filtered or unexported fields
}
ListAgentsPaginator is a paginator for ListAgents
func NewListAgentsPaginator ¶
func NewListAgentsPaginator(client ListAgentsAPIClient, params *ListAgentsInput, optFns ...func(*ListAgentsPaginatorOptions)) *ListAgentsPaginator
NewListAgentsPaginator returns a new ListAgentsPaginator
func (*ListAgentsPaginator) HasMorePages ¶
func (p *ListAgentsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListAgentsPaginator) NextPage ¶
func (p *ListAgentsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListAgentsOutput, error)
NextPage retrieves the next ListAgents page.
type ListAgentsPaginatorOptions ¶
type ListAgentsPaginatorOptions struct { // Specifies the maximum number of DataSync agents to list in a response. By // default, a response shows a maximum of 100 agents. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListAgentsPaginatorOptions is the paginator options for ListAgents
type ListDiscoveryJobsAPIClient ¶
type ListDiscoveryJobsAPIClient interface {
ListDiscoveryJobs(context.Context, *ListDiscoveryJobsInput, ...func(*Options)) (*ListDiscoveryJobsOutput, error)
}
ListDiscoveryJobsAPIClient is a client that implements the ListDiscoveryJobs operation.
type ListDiscoveryJobsInput ¶
type ListDiscoveryJobsInput struct { // Specifies how many results you want in the response. MaxResults *int32 // Specifies an opaque string that indicates the position to begin the next list // of results in the response. NextToken *string // Specifies the Amazon Resource Name (ARN) of an on-premises storage system. Use // this parameter if you only want to list the discovery jobs that are associated // with a specific storage system. StorageSystemArn *string // contains filtered or unexported fields }
type ListDiscoveryJobsOutput ¶
type ListDiscoveryJobsOutput struct { // The discovery jobs that you've run. DiscoveryJobs []types.DiscoveryJobListEntry // The opaque string that indicates the position to begin the next list of results // in the response. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListDiscoveryJobsPaginator ¶
type ListDiscoveryJobsPaginator struct {
// contains filtered or unexported fields
}
ListDiscoveryJobsPaginator is a paginator for ListDiscoveryJobs
func NewListDiscoveryJobsPaginator ¶
func NewListDiscoveryJobsPaginator(client ListDiscoveryJobsAPIClient, params *ListDiscoveryJobsInput, optFns ...func(*ListDiscoveryJobsPaginatorOptions)) *ListDiscoveryJobsPaginator
NewListDiscoveryJobsPaginator returns a new ListDiscoveryJobsPaginator
func (*ListDiscoveryJobsPaginator) HasMorePages ¶
func (p *ListDiscoveryJobsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListDiscoveryJobsPaginator) NextPage ¶
func (p *ListDiscoveryJobsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListDiscoveryJobsOutput, error)
NextPage retrieves the next ListDiscoveryJobs page.
type ListDiscoveryJobsPaginatorOptions ¶
type ListDiscoveryJobsPaginatorOptions struct { // Specifies how many results you want in the response. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListDiscoveryJobsPaginatorOptions is the paginator options for ListDiscoveryJobs
type ListLocationsAPIClient ¶
type ListLocationsAPIClient interface {
ListLocations(context.Context, *ListLocationsInput, ...func(*Options)) (*ListLocationsOutput, error)
}
ListLocationsAPIClient is a client that implements the ListLocations operation.
type ListLocationsInput ¶
type ListLocationsInput struct { // You can use API filters to narrow down the list of resources returned by // ListLocations . For example, to retrieve all tasks on a specific source // location, you can use ListLocations with filter name LocationType S3 and // Operator Equals . Filters []types.LocationFilter // The maximum number of locations to return. MaxResults *int32 // An opaque string that indicates the position at which to begin the next list of // locations. NextToken *string // contains filtered or unexported fields }
ListLocationsRequest
type ListLocationsOutput ¶
type ListLocationsOutput struct { // An array that contains a list of locations. Locations []types.LocationListEntry // An opaque string that indicates the position at which to begin returning the // next list of locations. NextToken *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
ListLocationsResponse
type ListLocationsPaginator ¶
type ListLocationsPaginator struct {
// contains filtered or unexported fields
}
ListLocationsPaginator is a paginator for ListLocations
func NewListLocationsPaginator ¶
func NewListLocationsPaginator(client ListLocationsAPIClient, params *ListLocationsInput, optFns ...func(*ListLocationsPaginatorOptions)) *ListLocationsPaginator
NewListLocationsPaginator returns a new ListLocationsPaginator
func (*ListLocationsPaginator) HasMorePages ¶
func (p *ListLocationsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListLocationsPaginator) NextPage ¶
func (p *ListLocationsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListLocationsOutput, error)
NextPage retrieves the next ListLocations page.
type ListLocationsPaginatorOptions ¶
type ListLocationsPaginatorOptions struct { // The maximum number of locations to return. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListLocationsPaginatorOptions is the paginator options for ListLocations
type ListStorageSystemsAPIClient ¶
type ListStorageSystemsAPIClient interface {
ListStorageSystems(context.Context, *ListStorageSystemsInput, ...func(*Options)) (*ListStorageSystemsOutput, error)
}
ListStorageSystemsAPIClient is a client that implements the ListStorageSystems operation.
type ListStorageSystemsInput ¶
type ListStorageSystemsOutput ¶
type ListStorageSystemsOutput struct { // The opaque string that indicates the position to begin the next list of results // in the response. NextToken *string // The Amazon Resource Names ARNs) of the on-premises storage systems that you're // using with DataSync Discovery. StorageSystems []types.StorageSystemListEntry // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ListStorageSystemsPaginator ¶
type ListStorageSystemsPaginator struct {
// contains filtered or unexported fields
}
ListStorageSystemsPaginator is a paginator for ListStorageSystems
func NewListStorageSystemsPaginator ¶
func NewListStorageSystemsPaginator(client ListStorageSystemsAPIClient, params *ListStorageSystemsInput, optFns ...func(*ListStorageSystemsPaginatorOptions)) *ListStorageSystemsPaginator
NewListStorageSystemsPaginator returns a new ListStorageSystemsPaginator
func (*ListStorageSystemsPaginator) HasMorePages ¶
func (p *ListStorageSystemsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListStorageSystemsPaginator) NextPage ¶
func (p *ListStorageSystemsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListStorageSystemsOutput, error)
NextPage retrieves the next ListStorageSystems page.
type ListStorageSystemsPaginatorOptions ¶
type ListStorageSystemsPaginatorOptions struct { // Specifies how many results you want in the response. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListStorageSystemsPaginatorOptions is the paginator options for ListStorageSystems
type ListTagsForResourceAPIClient ¶
type ListTagsForResourceAPIClient interface {
ListTagsForResource(context.Context, *ListTagsForResourceInput, ...func(*Options)) (*ListTagsForResourceOutput, error)
}
ListTagsForResourceAPIClient is a client that implements the ListTagsForResource operation.
type ListTagsForResourceInput ¶
type ListTagsForResourceInput struct { // Specifies the Amazon Resource Name (ARN) of the resource that you want tag // information on. // // This member is required. ResourceArn *string // Specifies how many results that you want in the response. MaxResults *int32 // Specifies an opaque string that indicates the position to begin the next list // of results in the response. NextToken *string // contains filtered or unexported fields }
ListTagsForResourceRequest
type ListTagsForResourceOutput ¶
type ListTagsForResourceOutput struct { // The opaque string that indicates the position to begin the next list of results // in the response. NextToken *string // An array of tags applied to the specified resource. Tags []types.TagListEntry // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
ListTagsForResourceResponse
type ListTagsForResourcePaginator ¶
type ListTagsForResourcePaginator struct {
// contains filtered or unexported fields
}
ListTagsForResourcePaginator is a paginator for ListTagsForResource
func NewListTagsForResourcePaginator ¶
func NewListTagsForResourcePaginator(client ListTagsForResourceAPIClient, params *ListTagsForResourceInput, optFns ...func(*ListTagsForResourcePaginatorOptions)) *ListTagsForResourcePaginator
NewListTagsForResourcePaginator returns a new ListTagsForResourcePaginator
func (*ListTagsForResourcePaginator) HasMorePages ¶
func (p *ListTagsForResourcePaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListTagsForResourcePaginator) NextPage ¶
func (p *ListTagsForResourcePaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)
NextPage retrieves the next ListTagsForResource page.
type ListTagsForResourcePaginatorOptions ¶
type ListTagsForResourcePaginatorOptions struct { // Specifies how many results that you want in the response. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListTagsForResourcePaginatorOptions is the paginator options for ListTagsForResource
type ListTaskExecutionsAPIClient ¶
type ListTaskExecutionsAPIClient interface {
ListTaskExecutions(context.Context, *ListTaskExecutionsInput, ...func(*Options)) (*ListTaskExecutionsOutput, error)
}
ListTaskExecutionsAPIClient is a client that implements the ListTaskExecutions operation.
type ListTaskExecutionsInput ¶
type ListTaskExecutionsInput struct { // Specifies how many results you want in the response. MaxResults *int32 // Specifies an opaque string that indicates the position at which to begin the // next list of results in the response. NextToken *string // Specifies the Amazon Resource Name (ARN) of the task that you want execution // information about. TaskArn *string // contains filtered or unexported fields }
ListTaskExecutions
type ListTaskExecutionsOutput ¶
type ListTaskExecutionsOutput struct { // The opaque string that indicates the position to begin the next list of results // in the response. NextToken *string // A list of the task's executions. TaskExecutions []types.TaskExecutionListEntry // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
ListTaskExecutionsResponse
type ListTaskExecutionsPaginator ¶
type ListTaskExecutionsPaginator struct {
// contains filtered or unexported fields
}
ListTaskExecutionsPaginator is a paginator for ListTaskExecutions
func NewListTaskExecutionsPaginator ¶
func NewListTaskExecutionsPaginator(client ListTaskExecutionsAPIClient, params *ListTaskExecutionsInput, optFns ...func(*ListTaskExecutionsPaginatorOptions)) *ListTaskExecutionsPaginator
NewListTaskExecutionsPaginator returns a new ListTaskExecutionsPaginator
func (*ListTaskExecutionsPaginator) HasMorePages ¶
func (p *ListTaskExecutionsPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListTaskExecutionsPaginator) NextPage ¶
func (p *ListTaskExecutionsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListTaskExecutionsOutput, error)
NextPage retrieves the next ListTaskExecutions page.
type ListTaskExecutionsPaginatorOptions ¶
type ListTaskExecutionsPaginatorOptions struct { // Specifies how many results you want in the response. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListTaskExecutionsPaginatorOptions is the paginator options for ListTaskExecutions
type ListTasksAPIClient ¶
type ListTasksAPIClient interface {
ListTasks(context.Context, *ListTasksInput, ...func(*Options)) (*ListTasksOutput, error)
}
ListTasksAPIClient is a client that implements the ListTasks operation.
type ListTasksInput ¶
type ListTasksInput struct { // You can use API filters to narrow down the list of resources returned by // ListTasks . For example, to retrieve all tasks on a specific source location, // you can use ListTasks with filter name LocationId and Operator Equals with the // ARN for the location. Filters []types.TaskFilter // The maximum number of tasks to return. MaxResults *int32 // An opaque string that indicates the position at which to begin the next list of // tasks. NextToken *string // contains filtered or unexported fields }
ListTasksRequest
type ListTasksOutput ¶
type ListTasksOutput struct { // An opaque string that indicates the position at which to begin returning the // next list of tasks. NextToken *string // A list of all the tasks that are returned. Tasks []types.TaskListEntry // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
ListTasksResponse
type ListTasksPaginator ¶
type ListTasksPaginator struct {
// contains filtered or unexported fields
}
ListTasksPaginator is a paginator for ListTasks
func NewListTasksPaginator ¶
func NewListTasksPaginator(client ListTasksAPIClient, params *ListTasksInput, optFns ...func(*ListTasksPaginatorOptions)) *ListTasksPaginator
NewListTasksPaginator returns a new ListTasksPaginator
func (*ListTasksPaginator) HasMorePages ¶
func (p *ListTasksPaginator) HasMorePages() bool
HasMorePages returns a boolean indicating whether more pages are available
func (*ListTasksPaginator) NextPage ¶
func (p *ListTasksPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListTasksOutput, error)
NextPage retrieves the next ListTasks page.
type ListTasksPaginatorOptions ¶
type ListTasksPaginatorOptions struct { // The maximum number of tasks to return. Limit int32 // Set to true if pagination should stop if the service returns a pagination token // that matches the most recent token provided to the service. StopOnDuplicateToken bool }
ListTasksPaginatorOptions is the paginator options for ListTasks
type Options ¶
type Options struct { // Set of options to modify how an operation is invoked. These apply to all // operations invoked for this client. Use functional options on operation call to // modify this list for per operation behavior. APIOptions []func(*middleware.Stack) error // The optional application specific identifier appended to the User-Agent header. AppID string // This endpoint will be given as input to an EndpointResolverV2. It is used for // providing a custom base endpoint that is subject to modifications by the // processing EndpointResolverV2. BaseEndpoint *string // Configures the events that will be sent to the configured logger. ClientLogMode aws.ClientLogMode // The credentials object to use when signing requests. Credentials aws.CredentialsProvider // The configuration DefaultsMode that the SDK should use when constructing the // clients initial default settings. DefaultsMode aws.DefaultsMode // The endpoint options to be used when attempting to resolve an endpoint. EndpointOptions EndpointResolverOptions // The service endpoint resolver. // // Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a // value for this field will likely prevent you from using any endpoint-related // service features released after the introduction of EndpointResolverV2 and // BaseEndpoint. // // To migrate an EndpointResolver implementation that uses a custom endpoint, set // the client option BaseEndpoint instead. EndpointResolver EndpointResolver // Resolves the endpoint used for a particular service operation. This should be // used over the deprecated EndpointResolver. EndpointResolverV2 EndpointResolverV2 // Signature Version 4 (SigV4) Signer HTTPSignerV4 HTTPSignerV4 // Provides idempotency tokens values that will be automatically populated into // idempotent API operations. IdempotencyTokenProvider IdempotencyTokenProvider // The logger writer interface to write logging messages to. Logger logging.Logger // The region to send requests to. (Required) Region string // RetryMaxAttempts specifies the maximum number attempts an API client will call // an operation that fails with a retryable error. A value of 0 is ignored, and // will not be used to configure the API client created default retryer, or modify // per operation call's retry max attempts. // // If specified in an operation call's functional options with a value that is // different than the constructed client's Options, the Client's Retryer will be // wrapped to use the operation's specific RetryMaxAttempts value. RetryMaxAttempts int // RetryMode specifies the retry mode the API client will be created with, if // Retryer option is not also specified. // // When creating a new API Clients this member will only be used if the Retryer // Options member is nil. This value will be ignored if Retryer is not nil. // // Currently does not support per operation call overrides, may in the future. RetryMode aws.RetryMode // Retryer guides how HTTP requests should be retried in case of recoverable // failures. When nil the API client will use a default retryer. The kind of // default retry created by the API client can be changed with the RetryMode // option. Retryer aws.Retryer // The RuntimeEnvironment configuration, only populated if the DefaultsMode is set // to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You // should not populate this structure programmatically, or rely on the values here // within your applications. RuntimeEnvironment aws.RuntimeEnvironment // The HTTP client to invoke API calls with. Defaults to client's default HTTP // implementation if nil. HTTPClient HTTPClient // The auth scheme resolver which determines how to authenticate for each // operation. AuthSchemeResolver AuthSchemeResolver // The list of auth schemes supported by the client. AuthSchemes []smithyhttp.AuthScheme // contains filtered or unexported fields }
func (Options) Copy ¶
Copy creates a clone where the APIOptions list is deep copied.
func (Options) GetIdentityResolver ¶
func (o Options) GetIdentityResolver(schemeID string) smithyauth.IdentityResolver
type RemoveStorageSystemInput ¶
type RemoveStorageSystemInput struct { // Specifies the Amazon Resource Name (ARN) of the storage system that you want to // permanently remove from DataSync Discovery. // // This member is required. StorageSystemArn *string // contains filtered or unexported fields }
type RemoveStorageSystemOutput ¶
type RemoveStorageSystemOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type ResolveEndpoint ¶
type ResolveEndpoint struct { Resolver EndpointResolver Options EndpointResolverOptions }
func (*ResolveEndpoint) HandleSerialize ¶
func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) ( out middleware.SerializeOutput, metadata middleware.Metadata, err error, )
func (*ResolveEndpoint) ID ¶
func (*ResolveEndpoint) ID() string
type StartDiscoveryJobInput ¶
type StartDiscoveryJobInput struct { // Specifies a client token to make sure requests with this API operation are // idempotent. If you don't specify a client token, DataSync generates one for you // automatically. // // This member is required. ClientToken *string // Specifies in minutes how long you want the discovery job to run. // // For more accurate recommendations, we recommend a duration of at least 14 days. // Longer durations allow time to collect a sufficient number of data points and // provide a realistic representation of storage performance and utilization. // // This member is required. CollectionDurationMinutes *int32 // Specifies the Amazon Resource Name (ARN) of the on-premises storage system that // you want to run the discovery job on. // // This member is required. StorageSystemArn *string // Specifies labels that help you categorize, filter, and search for your Amazon // Web Services resources. Tags []types.TagListEntry // contains filtered or unexported fields }
type StartDiscoveryJobOutput ¶
type StartDiscoveryJobOutput struct { // The ARN of the discovery job that you started. DiscoveryJobArn *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type StartTaskExecutionInput ¶
type StartTaskExecutionInput struct { // Specifies the Amazon Resource Name (ARN) of the task that you want to start. // // This member is required. TaskArn *string // Specifies a list of filter rules that determines which files to exclude from a // task. The list contains a single filter string that consists of the patterns to // exclude. The patterns are delimited by "|" (that is, a pipe), for example, // "/folder1|/folder2" . Excludes []types.FilterRule // Specifies 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 // Configures a manifest, which is a list of files or objects that you want // DataSync to transfer. For more information and configuration examples, see [Specifying what DataSync transfers by using a manifest]. // // When using this parameter, your caller identity (the role that you're using // DataSync with) must have the iam:PassRole permission. The [AWSDataSyncFullAccess] policy includes this // permission. // // To remove a manifest configuration, specify this parameter with an empty value. // // [AWSDataSyncFullAccess]: https://docs.aws.amazon.com/datasync/latest/userguide/security-iam-awsmanpol.html#security-iam-awsmanpol-awsdatasyncfullaccess // [Specifying what DataSync transfers by using a manifest]: https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html ManifestConfig *types.ManifestConfig // Indicates how your transfer task is configured. These options include how // DataSync handles files, objects, and their associated metadata during your // transfer. You also can specify how to verify data integrity, set bandwidth // limits for your task, among other options. // // Each option has a default value. Unless you need to, you don't have to // configure any option before calling [StartTaskExecution]. // // You also can override your task options for each task execution. For example, // you might want to adjust the LogLevel for an individual execution. // // [StartTaskExecution]: https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html OverrideOptions *types.Options // Specifies the tags that you want to apply to the Amazon Resource Name (ARN) // representing the task execution. // // Tags are key-value pairs that help you manage, filter, and search for your // DataSync resources. Tags []types.TagListEntry // Specifies how you want to configure a task report, which provides detailed // information about your DataSync transfer. For more information, see [Monitoring your DataSync transfers with task reports]. // // When using this parameter, your caller identity (the role that you're using // DataSync with) must have the iam:PassRole permission. The [AWSDataSyncFullAccess] policy includes this // permission. // // To remove a task report configuration, specify this parameter as empty. // // [AWSDataSyncFullAccess]: https://docs.aws.amazon.com/datasync/latest/userguide/security-iam-awsmanpol.html#security-iam-awsmanpol-awsdatasyncfullaccess // [Monitoring your DataSync transfers with task reports]: https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html TaskReportConfig *types.TaskReportConfig // contains filtered or unexported fields }
StartTaskExecutionRequest
type StartTaskExecutionOutput ¶
type StartTaskExecutionOutput struct { // The ARN of the running task execution. TaskExecutionArn *string // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
StartTaskExecutionResponse
type StopDiscoveryJobInput ¶
type StopDiscoveryJobInput struct { // Specifies the Amazon Resource Name (ARN) of the discovery job that you want to // stop. // // This member is required. DiscoveryJobArn *string // contains filtered or unexported fields }
type StopDiscoveryJobOutput ¶
type StopDiscoveryJobOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type TagResourceInput ¶
type TagResourceInput struct { // Specifies the Amazon Resource Name (ARN) of the resource to apply the tag to. // // This member is required. ResourceArn *string // Specifies the tags that you want to apply to the resource. // // This member is required. Tags []types.TagListEntry // contains filtered or unexported fields }
TagResourceRequest
type TagResourceOutput ¶
type TagResourceOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type UntagResourceInput ¶
type UntagResourceInput struct { // Specifies the keys in the tags that you want to remove. // // This member is required. Keys []string // Specifies the Amazon Resource Name (ARN) of the resource to remove the tags // from. // // This member is required. ResourceArn *string // contains filtered or unexported fields }
UntagResourceRequest
type UntagResourceOutput ¶
type UntagResourceOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type UpdateAgentInput ¶
type UpdateAgentInput struct { // The Amazon Resource Name (ARN) of the agent to update. // // This member is required. AgentArn *string // The name that you want to use to configure the agent. Name *string // contains filtered or unexported fields }
UpdateAgentRequest
type UpdateAgentOutput ¶
type UpdateAgentOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type UpdateDiscoveryJobInput ¶
type UpdateDiscoveryJobInput struct { // Specifies in minutes how long that you want the discovery job to run. (You // can't set this parameter to less than the number of minutes that the job has // already run for.) // // This member is required. CollectionDurationMinutes *int32 // Specifies the Amazon Resource Name (ARN) of the discovery job that you want to // update. // // This member is required. DiscoveryJobArn *string // contains filtered or unexported fields }
type UpdateDiscoveryJobOutput ¶
type UpdateDiscoveryJobOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type UpdateLocationAzureBlobInput ¶
type UpdateLocationAzureBlobInput struct { // Specifies the ARN of the Azure Blob Storage transfer location that you're // updating. // // This member is required. LocationArn *string // Specifies the access tier that you want your objects or files transferred into. // This only applies when using the location as a transfer destination. For more // information, see [Access tiers]. // // [Access tiers]: https://docs.aws.amazon.com/datasync/latest/userguide/creating-azure-blob-location.html#azure-blob-access-tiers AccessTier types.AzureAccessTier // Specifies the Amazon Resource Name (ARN) of the DataSync agent that can connect // with your Azure Blob Storage container. // // You can specify more than one agent. For more information, see [Using multiple agents for your transfer]. // // [Using multiple agents for your transfer]: https://docs.aws.amazon.com/datasync/latest/userguide/multiple-agents.html AgentArns []string // Specifies the authentication method DataSync uses to access your Azure Blob // Storage. DataSync can access blob storage using a shared access signature (SAS). AuthenticationType types.AzureBlobAuthenticationType // Specifies the type of blob that you want your objects or files to be when // transferring them into Azure Blob Storage. Currently, DataSync only supports // moving data into Azure Blob Storage as block blobs. For more information on blob // types, see the [Azure Blob Storage documentation]. // // [Azure Blob Storage documentation]: https://learn.microsoft.com/en-us/rest/api/storageservices/understanding-block-blobs--append-blobs--and-page-blobs BlobType types.AzureBlobType // Specifies the SAS configuration that allows DataSync to access your Azure Blob // Storage. SasConfiguration *types.AzureBlobSasConfiguration // Specifies path segments if you want to limit your transfer to a virtual // directory in your container (for example, /my/images ). Subdirectory *string // contains filtered or unexported fields }
type UpdateLocationAzureBlobOutput ¶
type UpdateLocationAzureBlobOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type UpdateLocationHdfsInput ¶
type UpdateLocationHdfsInput struct { // The Amazon Resource Name (ARN) of the source HDFS cluster location. // // This member is required. LocationArn *string // The ARNs of the agents that are used to connect to the HDFS cluster. AgentArns []string // The type of authentication used to determine the identity of the user. AuthenticationType types.HdfsAuthenticationType // The size of the data blocks to write into the HDFS cluster. BlockSize *int32 // The Kerberos key table (keytab) that contains mappings between the defined // Kerberos principal and the encrypted keys. You can load the keytab from a file // by providing the file's address. If you use the CLI, it performs base64 encoding // for you. Otherwise, provide the base64-encoded text. KerberosKeytab []byte // The krb5.conf file that contains the Kerberos configuration information. You // can load the krb5.conf file by providing the file's address. If you're using // the CLI, it performs the base64 encoding for you. Otherwise, provide the // base64-encoded text. KerberosKrb5Conf []byte // The Kerberos principal with access to the files and folders on the HDFS // cluster. KerberosPrincipal *string // The URI of the HDFS cluster's Key Management Server (KMS). KmsKeyProviderUri *string // The NameNode that manages the HDFS namespace. The NameNode performs operations // such as opening, closing, and renaming files and directories. The NameNode // contains the information to map blocks of data to the DataNodes. You can use // only one NameNode. NameNodes []types.HdfsNameNode // The Quality of Protection (QOP) configuration specifies the Remote Procedure // Call (RPC) and data transfer privacy settings configured on the Hadoop // Distributed File System (HDFS) cluster. QopConfiguration *types.QopConfiguration // The number of DataNodes to replicate the data to when writing to the HDFS // cluster. ReplicationFactor *int32 // The user name used to identify the client on the host operating system. SimpleUser *string // A subdirectory in the HDFS cluster. This subdirectory is used to read data from // or write data to the HDFS cluster. Subdirectory *string // contains filtered or unexported fields }
type UpdateLocationHdfsOutput ¶
type UpdateLocationHdfsOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type UpdateLocationNfsInput ¶
type UpdateLocationNfsInput struct { // Specifies the Amazon Resource Name (ARN) of the NFS transfer location that you // want to update. // // This member is required. LocationArn *string // Specifies how DataSync can access a location using the NFS protocol. MountOptions *types.NfsMountOptions // The DataSync agents that are connecting to a Network File System (NFS) location. OnPremConfig *types.OnPremConfig // Specifies the export path in your NFS file server that you want DataSync to // mount. // // This path (or a subdirectory of the path) is where DataSync transfers data to // or from. For information on configuring an export for DataSync, see [Accessing NFS file servers]. // // [Accessing NFS file servers]: https://docs.aws.amazon.com/datasync/latest/userguide/create-nfs-location.html#accessing-nfs Subdirectory *string // contains filtered or unexported fields }
type UpdateLocationNfsOutput ¶
type UpdateLocationNfsOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type UpdateLocationObjectStorageInput ¶
type UpdateLocationObjectStorageInput struct { // Specifies the ARN of the object storage system location that you're updating. // // This member is required. LocationArn *string // Specifies the access key (for example, a user name) if credentials are required // to authenticate with the object storage server. AccessKey *string // Specifies the Amazon Resource Names (ARNs) of the DataSync agents that can // securely connect with your location. AgentArns []string // Specifies the secret key (for example, a password) if credentials are required // to authenticate with the object storage server. SecretKey *string // Specifies a certificate chain for DataSync to authenticate with your object // storage system if the system uses a private or self-signed certificate authority // (CA). You must specify a single .pem file with a full certificate chain (for // example, file:///home/user/.ssh/object_storage_certificates.pem ). // // The certificate chain might include: // // - The object storage system's certificate // // - All intermediate certificates (if there are any) // // - The root certificate of the signing CA // // You can concatenate your certificates into a .pem file (which can be up to // 32768 bytes before base64 encoding). The following example cat command creates // an object_storage_certificates.pem file that includes three certificates: // // cat object_server_certificate.pem intermediate_certificate.pem // ca_root_certificate.pem > object_storage_certificates.pem // // To use this parameter, configure ServerProtocol to HTTPS . // // Updating this parameter doesn't interfere with tasks that you have in progress. ServerCertificate []byte // Specifies the port that your object storage server accepts inbound network // traffic on (for example, port 443). ServerPort *int32 // Specifies the protocol that your object storage server uses to communicate. ServerProtocol types.ObjectStorageServerProtocol // Specifies the object prefix for your object storage server. If this is a source // location, DataSync only copies objects with this prefix. If this is a // destination location, DataSync writes all objects with this prefix. Subdirectory *string // contains filtered or unexported fields }
type UpdateLocationObjectStorageOutput ¶
type UpdateLocationObjectStorageOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type UpdateLocationSmbInput ¶
type UpdateLocationSmbInput struct { // Specifies the ARN of the SMB location that you want to update. // // This member is required. LocationArn *string // Specifies the DataSync agent (or agents) which you want to connect to your SMB // file server. You specify an agent by using its Amazon Resource Name (ARN). AgentArns []string // Specifies the Windows domain name that your SMB file server belongs to. // // If you have multiple domains in your environment, configuring this parameter // makes sure that DataSync connects to the right file server. // // For more information, see [required permissions] for SMB locations. // // [required permissions]: https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions Domain *string // Specifies the version of the Server Message Block (SMB) protocol that DataSync // uses to access an SMB file server. MountOptions *types.SmbMountOptions // Specifies the password of the user who can mount your SMB file server and has // permission to access the files and folders involved in your transfer. // // For more information, see [required permissions] for SMB locations. // // [required permissions]: https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions Password *string // Specifies the name of the share exported by your SMB file server where DataSync // will read or write data. You can include a subdirectory in the share path (for // example, /path/to/subdirectory ). Make sure that other SMB clients in your // network can also mount this path. // // To copy all data in the specified subdirectory, DataSync must be able to mount // the SMB share and access all of its data. For more information, see [required permissions]for SMB // locations. // // [required permissions]: https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions Subdirectory *string // Specifies the user name that can mount your SMB file server and has permission // to access the files and folders involved in your transfer. // // For information about choosing a user with the right level of access for your // transfer, see [required permissions]for SMB locations. // // [required permissions]: https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb-permissions User *string // contains filtered or unexported fields }
type UpdateLocationSmbOutput ¶
type UpdateLocationSmbOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type UpdateStorageSystemInput ¶
type UpdateStorageSystemInput struct { // Specifies the ARN of the on-premises storage system that you want reconfigure. // // This member is required. StorageSystemArn *string // Specifies the Amazon Resource Name (ARN) of the DataSync agent that connects to // and reads your on-premises storage system. You can only specify one ARN. AgentArns []string // Specifies the ARN of the Amazon CloudWatch log group for monitoring and logging // discovery job events. CloudWatchLogGroupArn *string // Specifies the user name and password for accessing your on-premises storage // system's management interface. Credentials *types.Credentials // Specifies a familiar name for your on-premises storage system. Name *string // Specifies the server name and network port required to connect with your // on-premises storage system's management interface. ServerConfiguration *types.DiscoveryServerConfiguration // contains filtered or unexported fields }
type UpdateStorageSystemOutput ¶
type UpdateStorageSystemOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type UpdateTaskExecutionInput ¶
type UpdateTaskExecutionInput struct { // Indicates how your transfer task is configured. These options include how // DataSync handles files, objects, and their associated metadata during your // transfer. You also can specify how to verify data integrity, set bandwidth // limits for your task, among other options. // // Each option has a default value. Unless you need to, you don't have to // configure any option before calling [StartTaskExecution]. // // You also can override your task options for each task execution. For example, // you might want to adjust the LogLevel for an individual execution. // // [StartTaskExecution]: https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html // // This member is required. Options *types.Options // Specifies the Amazon Resource Name (ARN) of the task execution that you're // updating. // // This member is required. TaskExecutionArn *string // contains filtered or unexported fields }
type UpdateTaskExecutionOutput ¶
type UpdateTaskExecutionOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
type UpdateTaskInput ¶
type UpdateTaskInput struct { // Specifies the ARN of the task that you want to update. // // This member is required. TaskArn *string // Specifies the Amazon Resource Name (ARN) of an Amazon CloudWatch log group for // monitoring your task. CloudWatchLogGroupArn *string // Specifies exclude filters that define the files, objects, and folders in your // source location that you don't want DataSync to transfer. For more information // and examples, see [Specifying what DataSync transfers by using filters]. // // [Specifying what DataSync transfers by using filters]: https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html Excludes []types.FilterRule // Specifies include filters define the files, objects, and folders in your source // location that you want DataSync to transfer. For more information and examples, // see [Specifying what DataSync transfers by using filters]. // // [Specifying what DataSync transfers by using filters]: https://docs.aws.amazon.com/datasync/latest/userguide/filtering.html Includes []types.FilterRule // Configures a manifest, which is a list of files or objects that you want // DataSync to transfer. For more information and configuration examples, see [Specifying what DataSync transfers by using a manifest]. // // When using this parameter, your caller identity (the IAM role that you're using // DataSync with) must have the iam:PassRole permission. The [AWSDataSyncFullAccess] policy includes this // permission. // // To remove a manifest configuration, specify this parameter as empty. // // [AWSDataSyncFullAccess]: https://docs.aws.amazon.com/datasync/latest/userguide/security-iam-awsmanpol.html#security-iam-awsmanpol-awsdatasyncfullaccess // [Specifying what DataSync transfers by using a manifest]: https://docs.aws.amazon.com/datasync/latest/userguide/transferring-with-manifest.html ManifestConfig *types.ManifestConfig // Specifies the name of your task. Name *string // Indicates how your transfer task is configured. These options include how // DataSync handles files, objects, and their associated metadata during your // transfer. You also can specify how to verify data integrity, set bandwidth // limits for your task, among other options. // // Each option has a default value. Unless you need to, you don't have to // configure any option before calling [StartTaskExecution]. // // You also can override your task options for each task execution. For example, // you might want to adjust the LogLevel for an individual execution. // // [StartTaskExecution]: https://docs.aws.amazon.com/datasync/latest/userguide/API_StartTaskExecution.html Options *types.Options // Specifies a schedule for when you want your task to run. For more information, // see [Scheduling your task]. // // [Scheduling your task]: https://docs.aws.amazon.com/datasync/latest/userguide/task-scheduling.html Schedule *types.TaskSchedule // Specifies how you want to configure a task report, which provides detailed // information about your DataSync transfer. For more information, see [Monitoring your DataSync transfers with task reports]. // // When using this parameter, your caller identity (the IAM role that you're using // DataSync with) must have the iam:PassRole permission. The [AWSDataSyncFullAccess] policy includes this // permission. // // To remove a task report configuration, specify this parameter as empty. // // [AWSDataSyncFullAccess]: https://docs.aws.amazon.com/datasync/latest/userguide/security-iam-awsmanpol.html#security-iam-awsmanpol-awsdatasyncfullaccess // [Monitoring your DataSync transfers with task reports]: https://docs.aws.amazon.com/datasync/latest/userguide/task-reports.html TaskReportConfig *types.TaskReportConfig // contains filtered or unexported fields }
UpdateTaskResponse
type UpdateTaskOutput ¶
type UpdateTaskOutput struct { // Metadata pertaining to the operation's result. ResultMetadata middleware.Metadata // contains filtered or unexported fields }
Source Files
¶
- api_client.go
- api_op_AddStorageSystem.go
- api_op_CancelTaskExecution.go
- api_op_CreateAgent.go
- api_op_CreateLocationAzureBlob.go
- api_op_CreateLocationEfs.go
- api_op_CreateLocationFsxLustre.go
- api_op_CreateLocationFsxOntap.go
- api_op_CreateLocationFsxOpenZfs.go
- api_op_CreateLocationFsxWindows.go
- api_op_CreateLocationHdfs.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_DescribeDiscoveryJob.go
- api_op_DescribeLocationAzureBlob.go
- api_op_DescribeLocationEfs.go
- api_op_DescribeLocationFsxLustre.go
- api_op_DescribeLocationFsxOntap.go
- api_op_DescribeLocationFsxOpenZfs.go
- api_op_DescribeLocationFsxWindows.go
- api_op_DescribeLocationHdfs.go
- api_op_DescribeLocationNfs.go
- api_op_DescribeLocationObjectStorage.go
- api_op_DescribeLocationS3.go
- api_op_DescribeLocationSmb.go
- api_op_DescribeStorageSystem.go
- api_op_DescribeStorageSystemResourceMetrics.go
- api_op_DescribeStorageSystemResources.go
- api_op_DescribeTask.go
- api_op_DescribeTaskExecution.go
- api_op_GenerateRecommendations.go
- api_op_ListAgents.go
- api_op_ListDiscoveryJobs.go
- api_op_ListLocations.go
- api_op_ListStorageSystems.go
- api_op_ListTagsForResource.go
- api_op_ListTaskExecutions.go
- api_op_ListTasks.go
- api_op_RemoveStorageSystem.go
- api_op_StartDiscoveryJob.go
- api_op_StartTaskExecution.go
- api_op_StopDiscoveryJob.go
- api_op_TagResource.go
- api_op_UntagResource.go
- api_op_UpdateAgent.go
- api_op_UpdateDiscoveryJob.go
- api_op_UpdateLocationAzureBlob.go
- api_op_UpdateLocationHdfs.go
- api_op_UpdateLocationNfs.go
- api_op_UpdateLocationObjectStorage.go
- api_op_UpdateLocationSmb.go
- api_op_UpdateStorageSystem.go
- api_op_UpdateTask.go
- api_op_UpdateTaskExecution.go
- auth.go
- deserializers.go
- doc.go
- endpoints.go
- go_module_metadata.go
- options.go
- serializers.go
- validators.go