# WARNING: DO NOT EDIT, AUTO-GENERATED CODE!
# See https://github.com/aws-beam/aws-codegen for more details.
defmodule AWS.DataSync do
@moduledoc """
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](https://docs.aws.amazon.com/datasync/latest/userguide/what-is-datasync.html)
*.
"""
alias AWS.Client
alias AWS.Request
@typedoc """
## Example:
update_location_azure_blob_request() :: %{
optional("AccessTier") => list(any()),
optional("AgentArns") => list(String.t()()),
optional("AuthenticationType") => list(any()),
optional("BlobType") => list(any()),
optional("SasConfiguration") => azure_blob_sas_configuration(),
optional("Subdirectory") => String.t(),
required("LocationArn") => String.t()
}
"""
@type update_location_azure_blob_request() :: %{String.t() => any()}
@typedoc """
## Example:
start_task_execution_response() :: %{
"TaskExecutionArn" => String.t()
}
"""
@type start_task_execution_response() :: %{String.t() => any()}
@typedoc """
## Example:
private_link_config() :: %{
"PrivateLinkEndpoint" => String.t(),
"SecurityGroupArns" => list(String.t()()),
"SubnetArns" => list(String.t()()),
"VpcEndpointId" => String.t()
}
"""
@type private_link_config() :: %{String.t() => any()}
@typedoc """
## Example:
create_location_object_storage_request() :: %{
optional("AccessKey") => String.t(),
optional("SecretKey") => String.t(),
optional("ServerCertificate") => binary(),
optional("ServerPort") => integer(),
optional("ServerProtocol") => list(any()),
optional("Subdirectory") => String.t(),
optional("Tags") => list(tag_list_entry()()),
required("AgentArns") => list(String.t()()),
required("BucketName") => String.t(),
required("ServerHostname") => String.t()
}
"""
@type create_location_object_storage_request() :: %{String.t() => any()}
@typedoc """
## Example:
add_storage_system_request() :: %{
optional("CloudWatchLogGroupArn") => String.t(),
optional("Name") => String.t(),
optional("Tags") => list(tag_list_entry()()),
required("AgentArns") => list(String.t()()),
required("ClientToken") => String.t(),
required("Credentials") => credentials(),
required("ServerConfiguration") => discovery_server_configuration(),
required("SystemType") => list(any())
}
"""
@type add_storage_system_request() :: %{String.t() => any()}
@typedoc """
## Example:
task_execution_files_failed_detail() :: %{
"Delete" => float(),
"Prepare" => float(),
"Transfer" => float(),
"Verify" => float()
}
"""
@type task_execution_files_failed_detail() :: %{String.t() => any()}
@typedoc """
## Example:
fsx_protocol_nfs() :: %{
"MountOptions" => nfs_mount_options()
}
"""
@type fsx_protocol_nfs() :: %{String.t() => any()}
@typedoc """
## Example:
task_schedule_details() :: %{
"DisabledBy" => list(any()),
"DisabledReason" => String.t(),
"StatusUpdateTime" => non_neg_integer()
}
"""
@type task_schedule_details() :: %{String.t() => any()}
@typedoc """
## Example:
tag_resource_request() :: %{
required("ResourceArn") => String.t(),
required("Tags") => list(tag_list_entry()())
}
"""
@type tag_resource_request() :: %{String.t() => any()}
@typedoc """
## Example:
describe_location_fsx_open_zfs_request() :: %{
required("LocationArn") => String.t()
}
"""
@type describe_location_fsx_open_zfs_request() :: %{String.t() => any()}
@typedoc """
## Example:
describe_task_request() :: %{
required("TaskArn") => String.t()
}
"""
@type describe_task_request() :: %{String.t() => any()}
@typedoc """
## Example:
cancel_task_execution_request() :: %{
required("TaskExecutionArn") => String.t()
}
"""
@type cancel_task_execution_request() :: %{String.t() => any()}
@typedoc """
## Example:
create_location_fsx_lustre_response() :: %{
"LocationArn" => String.t()
}
"""
@type create_location_fsx_lustre_response() :: %{String.t() => any()}
@typedoc """
## Example:
list_agents_request() :: %{
optional("MaxResults") => integer(),
optional("NextToken") => String.t()
}
"""
@type list_agents_request() :: %{String.t() => any()}
@typedoc """
## Example:
nfs_mount_options() :: %{
"Version" => list(any())
}
"""
@type nfs_mount_options() :: %{String.t() => any()}
@typedoc """
## Example:
update_task_execution_request() :: %{
required("Options") => options(),
required("TaskExecutionArn") => String.t()
}
"""
@type update_task_execution_request() :: %{String.t() => any()}
@typedoc """
## Example:
untag_resource_response() :: %{}
"""
@type untag_resource_response() :: %{}
@typedoc """
## Example:
describe_location_fsx_windows_response() :: %{
"CreationTime" => non_neg_integer(),
"Domain" => String.t(),
"LocationArn" => String.t(),
"LocationUri" => String.t(),
"SecurityGroupArns" => list(String.t()()),
"User" => String.t()
}
"""
@type describe_location_fsx_windows_response() :: %{String.t() => any()}
@typedoc """
## Example:
describe_location_nfs_request() :: %{
required("LocationArn") => String.t()
}
"""
@type describe_location_nfs_request() :: %{String.t() => any()}
@typedoc """
## Example:
list_agents_response() :: %{
"Agents" => list(agent_list_entry()()),
"NextToken" => String.t()
}
"""
@type list_agents_response() :: %{String.t() => any()}
@typedoc """
## Example:
describe_storage_system_response() :: %{
"AgentArns" => list(String.t()()),
"CloudWatchLogGroupArn" => String.t(),
"ConnectivityStatus" => list(any()),
"CreationTime" => non_neg_integer(),
"ErrorMessage" => String.t(),
"Name" => String.t(),
"SecretsManagerArn" => String.t(),
"ServerConfiguration" => discovery_server_configuration(),
"StorageSystemArn" => String.t(),
"SystemType" => list(any())
}
"""
@type describe_storage_system_response() :: %{String.t() => any()}
@typedoc """
## Example:
describe_storage_system_resources_response() :: %{
"NextToken" => String.t(),
"ResourceDetails" => resource_details()
}
"""
@type describe_storage_system_resources_response() :: %{String.t() => any()}
@typedoc """
## Example:
filter_rule() :: %{
"FilterType" => list(any()),
"Value" => String.t()
}
"""
@type filter_rule() :: %{String.t() => any()}
@typedoc """
## Example:
create_agent_request() :: %{
optional("AgentName") => String.t(),
optional("SecurityGroupArns") => list(String.t()()),
optional("SubnetArns") => list(String.t()()),
optional("Tags") => list(tag_list_entry()()),
optional("VpcEndpointId") => String.t(),
required("ActivationKey") => String.t()
}
"""
@type create_agent_request() :: %{String.t() => any()}
@typedoc """
## Example:
remove_storage_system_response() :: %{}
"""
@type remove_storage_system_response() :: %{}
@typedoc """
## Example:
generate_recommendations_response() :: %{}
"""
@type generate_recommendations_response() :: %{}
@typedoc """
## Example:
net_app_o_n_t_a_p_volume() :: %{
"CapacityProvisioned" => float(),
"CapacityUsed" => float(),
"CifsShareCount" => float(),
"LogicalCapacityUsed" => float(),
"LunCount" => float(),
"MaxP95Performance" => max_p95_performance(),
"NfsExported" => boolean(),
"RecommendationStatus" => list(any()),
"Recommendations" => list(recommendation()()),
"ResourceId" => String.t(),
"SecurityStyle" => String.t(),
"SnapshotCapacityUsed" => float(),
"SvmName" => String.t(),
"SvmUuid" => String.t(),
"VolumeName" => String.t()
}
"""
@type net_app_o_n_t_a_p_volume() :: %{String.t() => any()}
@typedoc """
## Example:
report_destination() :: %{
"S3" => report_destination_s3()
}
"""
@type report_destination() :: %{String.t() => any()}
@typedoc """
## Example:
create_location_nfs_request() :: %{
optional("MountOptions") => nfs_mount_options(),
optional("Tags") => list(tag_list_entry()()),
required("OnPremConfig") => on_prem_config(),
required("ServerHostname") => String.t(),
required("Subdirectory") => String.t()
}
"""
@type create_location_nfs_request() :: %{String.t() => any()}
@typedoc """
## Example:
describe_location_fsx_ontap_request() :: %{
required("LocationArn") => String.t()
}
"""
@type describe_location_fsx_ontap_request() :: %{String.t() => any()}
@typedoc """
## Example:
credentials() :: %{
"Password" => String.t(),
"Username" => String.t()
}
"""
@type credentials() :: %{String.t() => any()}
@typedoc """
## Example:
update_location_hdfs_request() :: %{
optional("AgentArns") => list(String.t()()),
optional("AuthenticationType") => list(any()),
optional("BlockSize") => integer(),
optional("KerberosKeytab") => binary(),
optional("KerberosKrb5Conf") => binary(),
optional("KerberosPrincipal") => String.t(),
optional("KmsKeyProviderUri") => String.t(),
optional("NameNodes") => list(hdfs_name_node()()),
optional("QopConfiguration") => qop_configuration(),
optional("ReplicationFactor") => integer(),
optional("SimpleUser") => String.t(),
optional("Subdirectory") => String.t(),
required("LocationArn") => String.t()
}
"""
@type update_location_hdfs_request() :: %{String.t() => any()}
@typedoc """
## Example:
location_filter() :: %{
"Name" => list(any()),
"Operator" => list(any()),
"Values" => list(String.t()())
}
"""
@type location_filter() :: %{String.t() => any()}
@typedoc """
## Example:
create_task_request() :: %{
optional("CloudWatchLogGroupArn") => String.t(),
optional("Excludes") => list(filter_rule()()),
optional("Includes") => list(filter_rule()()),
optional("ManifestConfig") => manifest_config(),
optional("Name") => String.t(),
optional("Options") => options(),
optional("Schedule") => task_schedule(),
optional("Tags") => list(tag_list_entry()()),
optional("TaskMode") => list(any()),
optional("TaskReportConfig") => task_report_config(),
required("DestinationLocationArn") => String.t(),
required("SourceLocationArn") => String.t()
}
"""
@type create_task_request() :: %{String.t() => any()}
@typedoc """
## Example:
task_schedule() :: %{
"ScheduleExpression" => String.t(),
"Status" => list(any())
}
"""
@type task_schedule() :: %{String.t() => any()}
@typedoc """
## Example:
report_result() :: %{
"ErrorCode" => String.t(),
"ErrorDetail" => String.t(),
"Status" => list(any())
}
"""
@type report_result() :: %{String.t() => any()}
@typedoc """
## Example:
task_list_entry() :: %{
"Name" => String.t(),
"Status" => list(any()),
"TaskArn" => String.t(),
"TaskMode" => list(any())
}
"""
@type task_list_entry() :: %{String.t() => any()}
@typedoc """
## Example:
cancel_task_execution_response() :: %{}
"""
@type cancel_task_execution_response() :: %{}
@typedoc """
## Example:
delete_location_request() :: %{
required("LocationArn") => String.t()
}
"""
@type delete_location_request() :: %{String.t() => any()}
@typedoc """
## Example:
describe_location_object_storage_request() :: %{
required("LocationArn") => String.t()
}
"""
@type describe_location_object_storage_request() :: %{String.t() => any()}
@typedoc """
## Example:
discovery_job_list_entry() :: %{
"DiscoveryJobArn" => String.t(),
"Status" => list(any())
}
"""
@type discovery_job_list_entry() :: %{String.t() => any()}
@typedoc """
## Example:
update_location_nfs_response() :: %{}
"""
@type update_location_nfs_response() :: %{}
@typedoc """
## Example:
describe_storage_system_resource_metrics_response() :: %{
"Metrics" => list(resource_metrics()()),
"NextToken" => String.t()
}
"""
@type describe_storage_system_resource_metrics_response() :: %{String.t() => any()}
@typedoc """
## Example:
describe_location_fsx_lustre_response() :: %{
"CreationTime" => non_neg_integer(),
"LocationArn" => String.t(),
"LocationUri" => String.t(),
"SecurityGroupArns" => list(String.t()())
}
"""
@type describe_location_fsx_lustre_response() :: %{String.t() => any()}
@typedoc """
## Example:
task_execution_result_detail() :: %{
"ErrorCode" => String.t(),
"ErrorDetail" => String.t(),
"PrepareDuration" => float(),
"PrepareStatus" => list(any()),
"TotalDuration" => float(),
"TransferDuration" => float(),
"TransferStatus" => list(any()),
"VerifyDuration" => float(),
"VerifyStatus" => list(any())
}
"""
@type task_execution_result_detail() :: %{String.t() => any()}
@typedoc """
## Example:
untag_resource_request() :: %{
required("Keys") => list(String.t()()),
required("ResourceArn") => String.t()
}
"""
@type untag_resource_request() :: %{String.t() => any()}
@typedoc """
## Example:
describe_location_efs_response() :: %{
"AccessPointArn" => String.t(),
"CreationTime" => non_neg_integer(),
"Ec2Config" => ec2_config(),
"FileSystemAccessRoleArn" => String.t(),
"InTransitEncryption" => list(any()),
"LocationArn" => String.t(),
"LocationUri" => String.t()
}
"""
@type describe_location_efs_response() :: %{String.t() => any()}
@typedoc """
## Example:
p95_metrics() :: %{
"IOPS" => i_o_p_s(),
"Latency" => latency(),
"Throughput" => throughput()
}
"""
@type p95_metrics() :: %{String.t() => any()}
@typedoc """
## Example:
capacity() :: %{
"ClusterCloudStorageUsed" => float(),
"LogicalUsed" => float(),
"Provisioned" => float(),
"Used" => float()
}
"""
@type capacity() :: %{String.t() => any()}
@typedoc """
## Example:
qop_configuration() :: %{
"DataTransferProtection" => list(any()),
"RpcProtection" => list(any())
}
"""
@type qop_configuration() :: %{String.t() => any()}
@typedoc """
## Example:
update_location_smb_response() :: %{}
"""
@type update_location_smb_response() :: %{}
@typedoc """
## Example:
fsx_protocol() :: %{
"NFS" => fsx_protocol_nfs(),
"SMB" => fsx_protocol_smb()
}
"""
@type fsx_protocol() :: %{String.t() => any()}
@typedoc """
## Example:
describe_storage_system_request() :: %{
required("StorageSystemArn") => String.t()
}
"""
@type describe_storage_system_request() :: %{String.t() => any()}
@typedoc """
## Example:
report_overrides() :: %{
"Deleted" => report_override(),
"Skipped" => report_override(),
"Transferred" => report_override(),
"Verified" => report_override()
}
"""
@type report_overrides() :: %{String.t() => any()}
@typedoc """
## Example:
update_discovery_job_request() :: %{
required("CollectionDurationMinutes") => integer(),
required("DiscoveryJobArn") => String.t()
}
"""
@type update_discovery_job_request() :: %{String.t() => any()}
@typedoc """
## Example:
agent_list_entry() :: %{
"AgentArn" => String.t(),
"Name" => String.t(),
"Platform" => platform(),
"Status" => list(any())
}
"""
@type agent_list_entry() :: %{String.t() => any()}
@typedoc """
## Example:
create_location_azure_blob_request() :: %{
optional("AccessTier") => list(any()),
optional("BlobType") => list(any()),
optional("SasConfiguration") => azure_blob_sas_configuration(),
optional("Subdirectory") => String.t(),
optional("Tags") => list(tag_list_entry()()),
required("AgentArns") => list(String.t()()),
required("AuthenticationType") => list(any()),
required("ContainerUrl") => String.t()
}
"""
@type create_location_azure_blob_request() :: %{String.t() => any()}
@typedoc """
## Example:
describe_agent_response() :: %{
"AgentArn" => String.t(),
"CreationTime" => non_neg_integer(),
"EndpointType" => list(any()),
"LastConnectionTime" => non_neg_integer(),
"Name" => String.t(),
"Platform" => platform(),
"PrivateLinkConfig" => private_link_config(),
"Status" => list(any())
}
"""
@type describe_agent_response() :: %{String.t() => any()}
@typedoc """
## Example:
options() :: %{
"Atime" => list(any()),
"BytesPerSecond" => float(),
"Gid" => list(any()),
"LogLevel" => list(any()),
"Mtime" => list(any()),
"ObjectTags" => list(any()),
"OverwriteMode" => list(any()),
"PosixPermissions" => list(any()),
"PreserveDeletedFiles" => list(any()),
"PreserveDevices" => list(any()),
"SecurityDescriptorCopyFlags" => list(any()),
"TaskQueueing" => list(any()),
"TransferMode" => list(any()),
"Uid" => list(any()),
"VerifyMode" => list(any())
}
"""
@type options() :: %{String.t() => any()}
@typedoc """
## Example:
task_report_config() :: %{
"Destination" => report_destination(),
"ObjectVersionIds" => list(any()),
"OutputType" => list(any()),
"Overrides" => report_overrides(),
"ReportLevel" => list(any())
}
"""
@type task_report_config() :: %{String.t() => any()}
@typedoc """
## Example:
list_storage_systems_request() :: %{
optional("MaxResults") => integer(),
optional("NextToken") => String.t()
}
"""
@type list_storage_systems_request() :: %{String.t() => any()}
@typedoc """
## Example:
describe_storage_system_resource_metrics_request() :: %{
optional("EndTime") => non_neg_integer(),
optional("MaxResults") => integer(),
optional("NextToken") => String.t(),
optional("StartTime") => non_neg_integer(),
required("DiscoveryJobArn") => String.t(),
required("ResourceId") => String.t(),
required("ResourceType") => list(any())
}
"""
@type describe_storage_system_resource_metrics_request() :: %{String.t() => any()}
@typedoc """
## Example:
s3_manifest_config() :: %{
"BucketAccessRoleArn" => String.t(),
"ManifestObjectPath" => String.t(),
"ManifestObjectVersionId" => String.t(),
"S3BucketArn" => String.t()
}
"""
@type s3_manifest_config() :: %{String.t() => any()}
@typedoc """
## Example:
update_location_smb_request() :: %{
optional("AgentArns") => list(String.t()()),
optional("Domain") => String.t(),
optional("MountOptions") => smb_mount_options(),
optional("Password") => String.t(),
optional("Subdirectory") => String.t(),
optional("User") => String.t(),
required("LocationArn") => String.t()
}
"""
@type update_location_smb_request() :: %{String.t() => any()}
@typedoc """
## Example:
create_agent_response() :: %{
"AgentArn" => String.t()
}
"""
@type create_agent_response() :: %{String.t() => any()}
@typedoc """
## Example:
create_location_azure_blob_response() :: %{
"LocationArn" => String.t()
}
"""
@type create_location_azure_blob_response() :: %{String.t() => any()}
@typedoc """
## Example:
create_location_nfs_response() :: %{
"LocationArn" => String.t()
}
"""
@type create_location_nfs_response() :: %{String.t() => any()}
@typedoc """
## Example:
describe_location_fsx_ontap_response() :: %{
"CreationTime" => non_neg_integer(),
"FsxFilesystemArn" => String.t(),
"LocationArn" => String.t(),
"LocationUri" => String.t(),
"Protocol" => fsx_protocol(),
"SecurityGroupArns" => list(String.t()()),
"StorageVirtualMachineArn" => String.t()
}
"""
@type describe_location_fsx_ontap_response() :: %{String.t() => any()}
@typedoc """
## Example:
tag_list_entry() :: %{
"Key" => String.t(),
"Value" => String.t()
}
"""
@type tag_list_entry() :: %{String.t() => any()}
@typedoc """
## Example:
update_task_response() :: %{}
"""
@type update_task_response() :: %{}
@typedoc """
## Example:
update_agent_response() :: %{}
"""
@type update_agent_response() :: %{}
@typedoc """
## Example:
report_override() :: %{
"ReportLevel" => list(any())
}
"""
@type report_override() :: %{String.t() => any()}
@typedoc """
## Example:
invalid_request_exception() :: %{
"datasyncErrorCode" => String.t(),
"errorCode" => String.t(),
"message" => String.t()
}
"""
@type invalid_request_exception() :: %{String.t() => any()}
@typedoc """
## Example:
list_task_executions_response() :: %{
"NextToken" => String.t(),
"TaskExecutions" => list(task_execution_list_entry()())
}
"""
@type list_task_executions_response() :: %{String.t() => any()}
@typedoc """
## Example:
on_prem_config() :: %{
"AgentArns" => list(String.t()())
}
"""
@type on_prem_config() :: %{String.t() => any()}
@typedoc """
## Example:
platform() :: %{
"Version" => String.t()
}
"""
@type platform() :: %{String.t() => any()}
@typedoc """
## Example:
create_location_fsx_open_zfs_response() :: %{
"LocationArn" => String.t()
}
"""
@type create_location_fsx_open_zfs_response() :: %{String.t() => any()}
@typedoc """
## Example:
s3_config() :: %{
"BucketAccessRoleArn" => String.t()
}
"""
@type s3_config() :: %{String.t() => any()}
@typedoc """
## Example:
list_task_executions_request() :: %{
optional("MaxResults") => integer(),
optional("NextToken") => String.t(),
optional("TaskArn") => String.t()
}
"""
@type list_task_executions_request() :: %{String.t() => any()}
@typedoc """
## Example:
create_location_fsx_ontap_request() :: %{
optional("Subdirectory") => String.t(),
optional("Tags") => list(tag_list_entry()()),
required("Protocol") => fsx_protocol(),
required("SecurityGroupArns") => list(String.t()()),
required("StorageVirtualMachineArn") => String.t()
}
"""
@type create_location_fsx_ontap_request() :: %{String.t() => any()}
@typedoc """
## Example:
discovery_server_configuration() :: %{
"ServerHostname" => String.t(),
"ServerPort" => integer()
}
"""
@type discovery_server_configuration() :: %{String.t() => any()}
@typedoc """
## Example:
recommendation() :: %{
"EstimatedMonthlyStorageCost" => String.t(),
"StorageConfiguration" => map(),
"StorageType" => String.t()
}
"""
@type recommendation() :: %{String.t() => any()}
@typedoc """
## Example:
create_location_hdfs_response() :: %{
"LocationArn" => String.t()
}
"""
@type create_location_hdfs_response() :: %{String.t() => any()}
@typedoc """
## Example:
storage_system_list_entry() :: %{
"Name" => String.t(),
"StorageSystemArn" => String.t()
}
"""
@type storage_system_list_entry() :: %{String.t() => any()}
@typedoc """
## Example:
describe_task_response() :: %{
"CloudWatchLogGroupArn" => String.t(),
"CreationTime" => non_neg_integer(),
"CurrentTaskExecutionArn" => String.t(),
"DestinationLocationArn" => String.t(),
"DestinationNetworkInterfaceArns" => list(String.t()()),
"ErrorCode" => String.t(),
"ErrorDetail" => String.t(),
"Excludes" => list(filter_rule()()),
"Includes" => list(filter_rule()()),
"ManifestConfig" => manifest_config(),
"Name" => String.t(),
"Options" => options(),
"Schedule" => task_schedule(),
"ScheduleDetails" => task_schedule_details(),
"SourceLocationArn" => String.t(),
"SourceNetworkInterfaceArns" => list(String.t()()),
"Status" => list(any()),
"TaskArn" => String.t(),
"TaskMode" => list(any()),
"TaskReportConfig" => task_report_config()
}
"""
@type describe_task_response() :: %{String.t() => any()}
@typedoc """
## Example:
create_location_smb_response() :: %{
"LocationArn" => String.t()
}
"""
@type create_location_smb_response() :: %{String.t() => any()}
@typedoc """
## Example:
describe_location_fsx_lustre_request() :: %{
required("LocationArn") => String.t()
}
"""
@type describe_location_fsx_lustre_request() :: %{String.t() => any()}
@typedoc """
## Example:
create_location_s3_response() :: %{
"LocationArn" => String.t()
}
"""
@type create_location_s3_response() :: %{String.t() => any()}
@typedoc """
## Example:
task_execution_list_entry() :: %{
"Status" => list(any()),
"TaskExecutionArn" => String.t(),
"TaskMode" => list(any())
}
"""
@type task_execution_list_entry() :: %{String.t() => any()}
@typedoc """
## Example:
net_app_o_n_t_a_p_cluster() :: %{
"CifsShareCount" => float(),
"ClusterBlockStorageLogicalUsed" => float(),
"ClusterBlockStorageSize" => float(),
"ClusterBlockStorageUsed" => float(),
"ClusterCloudStorageUsed" => float(),
"ClusterName" => String.t(),
"LunCount" => float(),
"MaxP95Performance" => max_p95_performance(),
"NfsExportedVolumes" => float(),
"RecommendationStatus" => list(any()),
"Recommendations" => list(recommendation()()),
"ResourceId" => String.t()
}
"""
@type net_app_o_n_t_a_p_cluster() :: %{String.t() => any()}
@typedoc """
## Example:
stop_discovery_job_request() :: %{
required("DiscoveryJobArn") => String.t()
}
"""
@type stop_discovery_job_request() :: %{String.t() => any()}
@typedoc """
## Example:
update_location_object_storage_response() :: %{}
"""
@type update_location_object_storage_response() :: %{}
@typedoc """
## Example:
describe_location_nfs_response() :: %{
"CreationTime" => non_neg_integer(),
"LocationArn" => String.t(),
"LocationUri" => String.t(),
"MountOptions" => nfs_mount_options(),
"OnPremConfig" => on_prem_config()
}
"""
@type describe_location_nfs_response() :: %{String.t() => any()}
@typedoc """
## Example:
list_tags_for_resource_response() :: %{
"NextToken" => String.t(),
"Tags" => list(tag_list_entry()())
}
"""
@type list_tags_for_resource_response() :: %{String.t() => any()}
@typedoc """
## Example:
update_discovery_job_response() :: %{}
"""
@type update_discovery_job_response() :: %{}
@typedoc """
## Example:
max_p95_performance() :: %{
"IopsOther" => float(),
"IopsRead" => float(),
"IopsTotal" => float(),
"IopsWrite" => float(),
"LatencyOther" => float(),
"LatencyRead" => float(),
"LatencyWrite" => float(),
"ThroughputOther" => float(),
"ThroughputRead" => float(),
"ThroughputTotal" => float(),
"ThroughputWrite" => float()
}
"""
@type max_p95_performance() :: %{String.t() => any()}
@typedoc """
## Example:
describe_location_fsx_open_zfs_response() :: %{
"CreationTime" => non_neg_integer(),
"LocationArn" => String.t(),
"LocationUri" => String.t(),
"Protocol" => fsx_protocol(),
"SecurityGroupArns" => list(String.t()())
}
"""
@type describe_location_fsx_open_zfs_response() :: %{String.t() => any()}
@typedoc """
## Example:
list_locations_request() :: %{
optional("Filters") => list(location_filter()()),
optional("MaxResults") => integer(),
optional("NextToken") => String.t()
}
"""
@type list_locations_request() :: %{String.t() => any()}
@typedoc """
## Example:
remove_storage_system_request() :: %{
required("StorageSystemArn") => String.t()
}
"""
@type remove_storage_system_request() :: %{String.t() => any()}
@typedoc """
## Example:
start_discovery_job_request() :: %{
optional("Tags") => list(tag_list_entry()()),
required("ClientToken") => String.t(),
required("CollectionDurationMinutes") => integer(),
required("StorageSystemArn") => String.t()
}
"""
@type start_discovery_job_request() :: %{String.t() => any()}
@typedoc """
## Example:
create_location_s3_request() :: %{
optional("AgentArns") => list(String.t()()),
optional("S3StorageClass") => list(any()),
optional("Subdirectory") => String.t(),
optional("Tags") => list(tag_list_entry()()),
required("S3BucketArn") => String.t(),
required("S3Config") => s3_config()
}
"""
@type create_location_s3_request() :: %{String.t() => any()}
@typedoc """
## Example:
create_location_efs_request() :: %{
optional("AccessPointArn") => String.t(),
optional("FileSystemAccessRoleArn") => String.t(),
optional("InTransitEncryption") => list(any()),
optional("Subdirectory") => String.t(),
optional("Tags") => list(tag_list_entry()()),
required("Ec2Config") => ec2_config(),
required("EfsFilesystemArn") => String.t()
}
"""
@type create_location_efs_request() :: %{String.t() => any()}
@typedoc """
## Example:
delete_agent_response() :: %{}
"""
@type delete_agent_response() :: %{}
@typedoc """
## Example:
update_task_request() :: %{
optional("CloudWatchLogGroupArn") => String.t(),
optional("Excludes") => list(filter_rule()()),
optional("Includes") => list(filter_rule()()),
optional("ManifestConfig") => manifest_config(),
optional("Name") => String.t(),
optional("Options") => options(),
optional("Schedule") => task_schedule(),
optional("TaskReportConfig") => task_report_config(),
required("TaskArn") => String.t()
}
"""
@type update_task_request() :: %{String.t() => any()}
@typedoc """
## Example:
update_location_azure_blob_response() :: %{}
"""
@type update_location_azure_blob_response() :: %{}
@typedoc """
## Example:
source_manifest_config() :: %{
"S3" => s3_manifest_config()
}
"""
@type source_manifest_config() :: %{String.t() => any()}
@typedoc """
## Example:
task_execution_files_listed_detail() :: %{
"AtDestinationForDelete" => float(),
"AtSource" => float()
}
"""
@type task_execution_files_listed_detail() :: %{String.t() => any()}
@typedoc """
## Example:
describe_location_smb_request() :: %{
required("LocationArn") => String.t()
}
"""
@type describe_location_smb_request() :: %{String.t() => any()}
@typedoc """
## Example:
create_location_fsx_open_zfs_request() :: %{
optional("Subdirectory") => String.t(),
optional("Tags") => list(tag_list_entry()()),
required("FsxFilesystemArn") => String.t(),
required("Protocol") => fsx_protocol(),
required("SecurityGroupArns") => list(String.t()())
}
"""
@type create_location_fsx_open_zfs_request() :: %{String.t() => any()}
@typedoc """
## Example:
describe_task_execution_response() :: %{
"BytesCompressed" => float(),
"BytesTransferred" => float(),
"BytesWritten" => float(),
"EstimatedBytesToTransfer" => float(),
"EstimatedFilesToDelete" => float(),
"EstimatedFilesToTransfer" => float(),
"Excludes" => list(filter_rule()()),
"FilesDeleted" => float(),
"FilesFailed" => task_execution_files_failed_detail(),
"FilesListed" => task_execution_files_listed_detail(),
"FilesPrepared" => float(),
"FilesSkipped" => float(),
"FilesTransferred" => float(),
"FilesVerified" => float(),
"Includes" => list(filter_rule()()),
"ManifestConfig" => manifest_config(),
"Options" => options(),
"ReportResult" => report_result(),
"Result" => task_execution_result_detail(),
"StartTime" => non_neg_integer(),
"Status" => list(any()),
"TaskExecutionArn" => String.t(),
"TaskMode" => list(any()),
"TaskReportConfig" => task_report_config()
}
"""
@type describe_task_execution_response() :: %{String.t() => any()}
@typedoc """
## Example:
create_location_fsx_windows_response() :: %{
"LocationArn" => String.t()
}
"""
@type create_location_fsx_windows_response() :: %{String.t() => any()}
@typedoc """
## Example:
latency() :: %{
"Other" => float(),
"Read" => float(),
"Write" => float()
}
"""
@type latency() :: %{String.t() => any()}
@typedoc """
## Example:
describe_discovery_job_response() :: %{
"CollectionDurationMinutes" => integer(),
"DiscoveryJobArn" => String.t(),
"JobEndTime" => non_neg_integer(),
"JobStartTime" => non_neg_integer(),
"Status" => list(any()),
"StorageSystemArn" => String.t()
}
"""
@type describe_discovery_job_response() :: %{String.t() => any()}
@typedoc """
## Example:
update_storage_system_response() :: %{}
"""
@type update_storage_system_response() :: %{}
@typedoc """
## Example:
create_location_fsx_windows_request() :: %{
optional("Domain") => String.t(),
optional("Subdirectory") => String.t(),
optional("Tags") => list(tag_list_entry()()),
required("FsxFilesystemArn") => String.t(),
required("Password") => String.t(),
required("SecurityGroupArns") => list(String.t()()),
required("User") => String.t()
}
"""
@type create_location_fsx_windows_request() :: %{String.t() => any()}
@typedoc """
## Example:
update_task_execution_response() :: %{}
"""
@type update_task_execution_response() :: %{}
@typedoc """
## Example:
create_location_smb_request() :: %{
optional("Domain") => String.t(),
optional("MountOptions") => smb_mount_options(),
optional("Tags") => list(tag_list_entry()()),
required("AgentArns") => list(String.t()()),
required("Password") => String.t(),
required("ServerHostname") => String.t(),
required("Subdirectory") => String.t(),
required("User") => String.t()
}
"""
@type create_location_smb_request() :: %{String.t() => any()}
@typedoc """
## Example:
delete_location_response() :: %{}
"""
@type delete_location_response() :: %{}
@typedoc """
## Example:
describe_agent_request() :: %{
required("AgentArn") => String.t()
}
"""
@type describe_agent_request() :: %{String.t() => any()}
@typedoc """
## Example:
report_destination_s3() :: %{
"BucketAccessRoleArn" => String.t(),
"S3BucketArn" => String.t(),
"Subdirectory" => String.t()
}
"""
@type report_destination_s3() :: %{String.t() => any()}
@typedoc """
## Example:
describe_discovery_job_request() :: %{
required("DiscoveryJobArn") => String.t()
}
"""
@type describe_discovery_job_request() :: %{String.t() => any()}
@typedoc """
## Example:
describe_storage_system_resources_request() :: %{
optional("Filter") => map(),
optional("MaxResults") => integer(),
optional("NextToken") => String.t(),
optional("ResourceIds") => list(String.t()()),
required("DiscoveryJobArn") => String.t(),
required("ResourceType") => list(any())
}
"""
@type describe_storage_system_resources_request() :: %{String.t() => any()}
@typedoc """
## Example:
describe_location_azure_blob_request() :: %{
required("LocationArn") => String.t()
}
"""
@type describe_location_azure_blob_request() :: %{String.t() => any()}
@typedoc """
## Example:
azure_blob_sas_configuration() :: %{
"Token" => String.t()
}
"""
@type azure_blob_sas_configuration() :: %{String.t() => any()}
@typedoc """
## Example:
location_list_entry() :: %{
"LocationArn" => String.t(),
"LocationUri" => String.t()
}
"""
@type location_list_entry() :: %{String.t() => any()}
@typedoc """
## Example:
internal_exception() :: %{
"errorCode" => String.t(),
"message" => String.t()
}
"""
@type internal_exception() :: %{String.t() => any()}
@typedoc """
## Example:
describe_location_s3_request() :: %{
required("LocationArn") => String.t()
}
"""
@type describe_location_s3_request() :: %{String.t() => any()}
@typedoc """
## Example:
throughput() :: %{
"Other" => float(),
"Read" => float(),
"Total" => float(),
"Write" => float()
}
"""
@type throughput() :: %{String.t() => any()}
@typedoc """
## Example:
list_storage_systems_response() :: %{
"NextToken" => String.t(),
"StorageSystems" => list(storage_system_list_entry()())
}
"""
@type list_storage_systems_response() :: %{String.t() => any()}
@typedoc """
## Example:
tag_resource_response() :: %{}
"""
@type tag_resource_response() :: %{}
@typedoc """
## Example:
create_location_hdfs_request() :: %{
optional("BlockSize") => integer(),
optional("KerberosKeytab") => binary(),
optional("KerberosKrb5Conf") => binary(),
optional("KerberosPrincipal") => String.t(),
optional("KmsKeyProviderUri") => String.t(),
optional("QopConfiguration") => qop_configuration(),
optional("ReplicationFactor") => integer(),
optional("SimpleUser") => String.t(),
optional("Subdirectory") => String.t(),
optional("Tags") => list(tag_list_entry()()),
required("AgentArns") => list(String.t()()),
required("AuthenticationType") => list(any()),
required("NameNodes") => list(hdfs_name_node()())
}
"""
@type create_location_hdfs_request() :: %{String.t() => any()}
@typedoc """
## Example:
update_location_hdfs_response() :: %{}
"""
@type update_location_hdfs_response() :: %{}
@typedoc """
## Example:
update_agent_request() :: %{
optional("Name") => String.t(),
required("AgentArn") => String.t()
}
"""
@type update_agent_request() :: %{String.t() => any()}
@typedoc """
## Example:
delete_agent_request() :: %{
required("AgentArn") => String.t()
}
"""
@type delete_agent_request() :: %{String.t() => any()}
@typedoc """
## Example:
delete_task_request() :: %{
required("TaskArn") => String.t()
}
"""
@type delete_task_request() :: %{String.t() => any()}
@typedoc """
## Example:
update_location_nfs_request() :: %{
optional("MountOptions") => nfs_mount_options(),
optional("OnPremConfig") => on_prem_config(),
optional("Subdirectory") => String.t(),
required("LocationArn") => String.t()
}
"""
@type update_location_nfs_request() :: %{String.t() => any()}
@typedoc """
## Example:
i_o_p_s() :: %{
"Other" => float(),
"Read" => float(),
"Total" => float(),
"Write" => float()
}
"""
@type i_o_p_s() :: %{String.t() => any()}
@typedoc """
## Example:
create_location_fsx_lustre_request() :: %{
optional("Subdirectory") => String.t(),
optional("Tags") => list(tag_list_entry()()),
required("FsxFilesystemArn") => String.t(),
required("SecurityGroupArns") => list(String.t()())
}
"""
@type create_location_fsx_lustre_request() :: %{String.t() => any()}
@typedoc """
## Example:
list_tags_for_resource_request() :: %{
optional("MaxResults") => integer(),
optional("NextToken") => String.t(),
required("ResourceArn") => String.t()
}
"""
@type list_tags_for_resource_request() :: %{String.t() => any()}
@typedoc """
## Example:
create_task_response() :: %{
"TaskArn" => String.t()
}
"""
@type create_task_response() :: %{String.t() => any()}
@typedoc """
## Example:
resource_metrics() :: %{
"Capacity" => capacity(),
"P95Metrics" => p95_metrics(),
"ResourceId" => String.t(),
"ResourceType" => list(any()),
"Timestamp" => non_neg_integer()
}
"""
@type resource_metrics() :: %{String.t() => any()}
@typedoc """
## Example:
update_storage_system_request() :: %{
optional("AgentArns") => list(String.t()()),
optional("CloudWatchLogGroupArn") => String.t(),
optional("Credentials") => credentials(),
optional("Name") => String.t(),
optional("ServerConfiguration") => discovery_server_configuration(),
required("StorageSystemArn") => String.t()
}
"""
@type update_storage_system_request() :: %{String.t() => any()}
@typedoc """
## Example:
start_discovery_job_response() :: %{
"DiscoveryJobArn" => String.t()
}
"""
@type start_discovery_job_response() :: %{String.t() => any()}
@typedoc """
## Example:
update_location_object_storage_request() :: %{
optional("AccessKey") => String.t(),
optional("AgentArns") => list(String.t()()),
optional("SecretKey") => String.t(),
optional("ServerCertificate") => binary(),
optional("ServerPort") => integer(),
optional("ServerProtocol") => list(any()),
optional("Subdirectory") => String.t(),
required("LocationArn") => String.t()
}
"""
@type update_location_object_storage_request() :: %{String.t() => any()}
@typedoc """
## Example:
net_app_o_n_t_a_p_s_v_m() :: %{
"CifsShareCount" => float(),
"ClusterUuid" => String.t(),
"EnabledProtocols" => list(String.t()()),
"LunCount" => float(),
"MaxP95Performance" => max_p95_performance(),
"NfsExportedVolumes" => float(),
"RecommendationStatus" => list(any()),
"Recommendations" => list(recommendation()()),
"ResourceId" => String.t(),
"SvmName" => String.t(),
"TotalCapacityProvisioned" => float(),
"TotalCapacityUsed" => float(),
"TotalLogicalCapacityUsed" => float(),
"TotalSnapshotCapacityUsed" => float()
}
"""
@type net_app_o_n_t_a_p_s_v_m() :: %{String.t() => any()}
@typedoc """
## Example:
list_tasks_request() :: %{
optional("Filters") => list(task_filter()()),
optional("MaxResults") => integer(),
optional("NextToken") => String.t()
}
"""
@type list_tasks_request() :: %{String.t() => any()}
@typedoc """
## Example:
fsx_protocol_smb() :: %{
"Domain" => String.t(),
"MountOptions" => smb_mount_options(),
"Password" => String.t(),
"User" => String.t()
}
"""
@type fsx_protocol_smb() :: %{String.t() => any()}
@typedoc """
## Example:
add_storage_system_response() :: %{
"StorageSystemArn" => String.t()
}
"""
@type add_storage_system_response() :: %{String.t() => any()}
@typedoc """
## Example:
describe_task_execution_request() :: %{
required("TaskExecutionArn") => String.t()
}
"""
@type describe_task_execution_request() :: %{String.t() => any()}
@typedoc """
## Example:
hdfs_name_node() :: %{
"Hostname" => String.t(),
"Port" => integer()
}
"""
@type hdfs_name_node() :: %{String.t() => any()}
@typedoc """
## Example:
smb_mount_options() :: %{
"Version" => list(any())
}
"""
@type smb_mount_options() :: %{String.t() => any()}
@typedoc """
## Example:
list_locations_response() :: %{
"Locations" => list(location_list_entry()()),
"NextToken" => String.t()
}
"""
@type list_locations_response() :: %{String.t() => any()}
@typedoc """
## Example:
list_discovery_jobs_request() :: %{
optional("MaxResults") => integer(),
optional("NextToken") => String.t(),
optional("StorageSystemArn") => String.t()
}
"""
@type list_discovery_jobs_request() :: %{String.t() => any()}
@typedoc """
## Example:
describe_location_hdfs_request() :: %{
required("LocationArn") => String.t()
}
"""
@type describe_location_hdfs_request() :: %{String.t() => any()}
@typedoc """
## Example:
describe_location_efs_request() :: %{
required("LocationArn") => String.t()
}
"""
@type describe_location_efs_request() :: %{String.t() => any()}
@typedoc """
## Example:
resource_details() :: %{
"NetAppONTAPClusters" => list(net_app_o_n_t_a_p_cluster()()),
"NetAppONTAPSVMs" => list(net_app_o_n_t_a_p_s_v_m()()),
"NetAppONTAPVolumes" => list(net_app_o_n_t_a_p_volume()())
}
"""
@type resource_details() :: %{String.t() => any()}
@typedoc """
## Example:
list_tasks_response() :: %{
"NextToken" => String.t(),
"Tasks" => list(task_list_entry()())
}
"""
@type list_tasks_response() :: %{String.t() => any()}
@typedoc """
## Example:
describe_location_azure_blob_response() :: %{
"AccessTier" => list(any()),
"AgentArns" => list(String.t()()),
"AuthenticationType" => list(any()),
"BlobType" => list(any()),
"CreationTime" => non_neg_integer(),
"LocationArn" => String.t(),
"LocationUri" => String.t()
}
"""
@type describe_location_azure_blob_response() :: %{String.t() => any()}
@typedoc """
## Example:
create_location_efs_response() :: %{
"LocationArn" => String.t()
}
"""
@type create_location_efs_response() :: %{String.t() => any()}
@typedoc """
## Example:
task_filter() :: %{
"Name" => list(any()),
"Operator" => list(any()),
"Values" => list(String.t()())
}
"""
@type task_filter() :: %{String.t() => any()}
@typedoc """
## Example:
ec2_config() :: %{
"SecurityGroupArns" => list(String.t()()),
"SubnetArn" => String.t()
}
"""
@type ec2_config() :: %{String.t() => any()}
@typedoc """
## Example:
describe_location_hdfs_response() :: %{
"AgentArns" => list(String.t()()),
"AuthenticationType" => list(any()),
"BlockSize" => integer(),
"CreationTime" => non_neg_integer(),
"KerberosPrincipal" => String.t(),
"KmsKeyProviderUri" => String.t(),
"LocationArn" => String.t(),
"LocationUri" => String.t(),
"NameNodes" => list(hdfs_name_node()()),
"QopConfiguration" => qop_configuration(),
"ReplicationFactor" => integer(),
"SimpleUser" => String.t()
}
"""
@type describe_location_hdfs_response() :: %{String.t() => any()}
@typedoc """
## Example:
describe_location_fsx_windows_request() :: %{
required("LocationArn") => String.t()
}
"""
@type describe_location_fsx_windows_request() :: %{String.t() => any()}
@typedoc """
## Example:
list_discovery_jobs_response() :: %{
"DiscoveryJobs" => list(discovery_job_list_entry()()),
"NextToken" => String.t()
}
"""
@type list_discovery_jobs_response() :: %{String.t() => any()}
@typedoc """
## Example:
generate_recommendations_request() :: %{
required("DiscoveryJobArn") => String.t(),
required("ResourceIds") => list(String.t()()),
required("ResourceType") => list(any())
}
"""
@type generate_recommendations_request() :: %{String.t() => any()}
@typedoc """
## Example:
create_location_object_storage_response() :: %{
"LocationArn" => String.t()
}
"""
@type create_location_object_storage_response() :: %{String.t() => any()}
@typedoc """
## Example:
describe_location_object_storage_response() :: %{
"AccessKey" => String.t(),
"AgentArns" => list(String.t()()),
"CreationTime" => non_neg_integer(),
"LocationArn" => String.t(),
"LocationUri" => String.t(),
"ServerCertificate" => binary(),
"ServerPort" => integer(),
"ServerProtocol" => list(any())
}
"""
@type describe_location_object_storage_response() :: %{String.t() => any()}
@typedoc """
## Example:
describe_location_smb_response() :: %{
"AgentArns" => list(String.t()()),
"CreationTime" => non_neg_integer(),
"Domain" => String.t(),
"LocationArn" => String.t(),
"LocationUri" => String.t(),
"MountOptions" => smb_mount_options(),
"User" => String.t()
}
"""
@type describe_location_smb_response() :: %{String.t() => any()}
@typedoc """
## Example:
manifest_config() :: %{
"Action" => list(any()),
"Format" => list(any()),
"Source" => source_manifest_config()
}
"""
@type manifest_config() :: %{String.t() => any()}
@typedoc """
## Example:
delete_task_response() :: %{}
"""
@type delete_task_response() :: %{}
@typedoc """
## Example:
describe_location_s3_response() :: %{
"AgentArns" => list(String.t()()),
"CreationTime" => non_neg_integer(),
"LocationArn" => String.t(),
"LocationUri" => String.t(),
"S3Config" => s3_config(),
"S3StorageClass" => list(any())
}
"""
@type describe_location_s3_response() :: %{String.t() => any()}
@typedoc """
## Example:
stop_discovery_job_response() :: %{}
"""
@type stop_discovery_job_response() :: %{}
@typedoc """
## Example:
start_task_execution_request() :: %{
optional("Excludes") => list(filter_rule()()),
optional("Includes") => list(filter_rule()()),
optional("ManifestConfig") => manifest_config(),
optional("OverrideOptions") => options(),
optional("Tags") => list(tag_list_entry()()),
optional("TaskReportConfig") => task_report_config(),
required("TaskArn") => String.t()
}
"""
@type start_task_execution_request() :: %{String.t() => any()}
@typedoc """
## Example:
create_location_fsx_ontap_response() :: %{
"LocationArn" => String.t()
}
"""
@type create_location_fsx_ontap_response() :: %{String.t() => any()}
@type add_storage_system_errors() :: internal_exception() | invalid_request_exception()
@type cancel_task_execution_errors() :: internal_exception() | invalid_request_exception()
@type create_agent_errors() :: internal_exception() | invalid_request_exception()
@type create_location_azure_blob_errors() :: internal_exception() | invalid_request_exception()
@type create_location_efs_errors() :: internal_exception() | invalid_request_exception()
@type create_location_fsx_lustre_errors() :: internal_exception() | invalid_request_exception()
@type create_location_fsx_ontap_errors() :: internal_exception() | invalid_request_exception()
@type create_location_fsx_open_zfs_errors() ::
internal_exception() | invalid_request_exception()
@type create_location_fsx_windows_errors() :: internal_exception() | invalid_request_exception()
@type create_location_hdfs_errors() :: internal_exception() | invalid_request_exception()
@type create_location_nfs_errors() :: internal_exception() | invalid_request_exception()
@type create_location_object_storage_errors() ::
internal_exception() | invalid_request_exception()
@type create_location_s3_errors() :: internal_exception() | invalid_request_exception()
@type create_location_smb_errors() :: internal_exception() | invalid_request_exception()
@type create_task_errors() :: internal_exception() | invalid_request_exception()
@type delete_agent_errors() :: internal_exception() | invalid_request_exception()
@type delete_location_errors() :: internal_exception() | invalid_request_exception()
@type delete_task_errors() :: internal_exception() | invalid_request_exception()
@type describe_agent_errors() :: internal_exception() | invalid_request_exception()
@type describe_discovery_job_errors() :: internal_exception() | invalid_request_exception()
@type describe_location_azure_blob_errors() ::
internal_exception() | invalid_request_exception()
@type describe_location_efs_errors() :: internal_exception() | invalid_request_exception()
@type describe_location_fsx_lustre_errors() ::
internal_exception() | invalid_request_exception()
@type describe_location_fsx_ontap_errors() :: internal_exception() | invalid_request_exception()
@type describe_location_fsx_open_zfs_errors() ::
internal_exception() | invalid_request_exception()
@type describe_location_fsx_windows_errors() ::
internal_exception() | invalid_request_exception()
@type describe_location_hdfs_errors() :: internal_exception() | invalid_request_exception()
@type describe_location_nfs_errors() :: internal_exception() | invalid_request_exception()
@type describe_location_object_storage_errors() ::
internal_exception() | invalid_request_exception()
@type describe_location_s3_errors() :: internal_exception() | invalid_request_exception()
@type describe_location_smb_errors() :: internal_exception() | invalid_request_exception()
@type describe_storage_system_errors() :: internal_exception() | invalid_request_exception()
@type describe_storage_system_resource_metrics_errors() ::
internal_exception() | invalid_request_exception()
@type describe_storage_system_resources_errors() ::
internal_exception() | invalid_request_exception()
@type describe_task_errors() :: internal_exception() | invalid_request_exception()
@type describe_task_execution_errors() :: internal_exception() | invalid_request_exception()
@type generate_recommendations_errors() :: internal_exception() | invalid_request_exception()
@type list_agents_errors() :: internal_exception() | invalid_request_exception()
@type list_discovery_jobs_errors() :: internal_exception() | invalid_request_exception()
@type list_locations_errors() :: internal_exception() | invalid_request_exception()
@type list_storage_systems_errors() :: internal_exception() | invalid_request_exception()
@type list_tags_for_resource_errors() :: internal_exception() | invalid_request_exception()
@type list_task_executions_errors() :: internal_exception() | invalid_request_exception()
@type list_tasks_errors() :: internal_exception() | invalid_request_exception()
@type remove_storage_system_errors() :: internal_exception() | invalid_request_exception()
@type start_discovery_job_errors() :: internal_exception() | invalid_request_exception()
@type start_task_execution_errors() :: internal_exception() | invalid_request_exception()
@type stop_discovery_job_errors() :: internal_exception() | invalid_request_exception()
@type tag_resource_errors() :: internal_exception() | invalid_request_exception()
@type untag_resource_errors() :: internal_exception() | invalid_request_exception()
@type update_agent_errors() :: internal_exception() | invalid_request_exception()
@type update_discovery_job_errors() :: internal_exception() | invalid_request_exception()
@type update_location_azure_blob_errors() :: internal_exception() | invalid_request_exception()
@type update_location_hdfs_errors() :: internal_exception() | invalid_request_exception()
@type update_location_nfs_errors() :: internal_exception() | invalid_request_exception()
@type update_location_object_storage_errors() ::
internal_exception() | invalid_request_exception()
@type update_location_smb_errors() :: internal_exception() | invalid_request_exception()
@type update_storage_system_errors() :: internal_exception() | invalid_request_exception()
@type update_task_errors() :: internal_exception() | invalid_request_exception()
@type update_task_execution_errors() :: internal_exception() | invalid_request_exception()
def metadata do
%{
api_version: "2018-11-09",
content_type: "application/x-amz-json-1.1",
credential_scope: nil,
endpoint_prefix: "datasync",
global?: false,
hostname: nil,
protocol: "json",
service_id: "DataSync",
signature_version: "v4",
signing_name: "datasync",
target_prefix: "FmrsService"
}
end
@doc """
Creates an Amazon Web Services resource for an on-premises storage system that
you want DataSync Discovery to collect
information about.
"""
@spec add_storage_system(map(), add_storage_system_request(), list()) ::
{:ok, add_storage_system_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, add_storage_system_errors()}
def add_storage_system(%Client{} = client, input, options \\ []) do
meta = metadata() |> Map.put_new(:host_prefix, "discovery-")
Request.request_post(client, meta, "AddStorageSystem", input, options)
end
@doc """
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.
"""
@spec cancel_task_execution(map(), cancel_task_execution_request(), list()) ::
{:ok, cancel_task_execution_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, cancel_task_execution_errors()}
def cancel_task_execution(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "CancelTaskExecution", input, options)
end
@doc """
Activates an DataSync agent that you deploy 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 [Do I need a DataSync agent?](https://docs.aws.amazon.com/datasync/latest/userguide/do-i-need-datasync-agent.html)
"""
@spec create_agent(map(), create_agent_request(), list()) ::
{:ok, create_agent_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, create_agent_errors()}
def create_agent(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "CreateAgent", input, options)
end
@doc """
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](https://docs.aws.amazon.com/datasync/latest/userguide/creating-azure-blob-location.html#azure-blob-access)
and works with [access tiers](https://docs.aws.amazon.com/datasync/latest/userguide/creating-azure-blob-location.html#azure-blob-access-tiers)
and [blob types](https://docs.aws.amazon.com/datasync/latest/userguide/creating-azure-blob-location.html#blob-types).
You also need a [DataSync agent](https://docs.aws.amazon.com/datasync/latest/userguide/creating-azure-blob-location.html#azure-blob-creating-agent)
that can connect to your
container.
"""
@spec create_location_azure_blob(map(), create_location_azure_blob_request(), list()) ::
{:ok, create_location_azure_blob_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, create_location_azure_blob_errors()}
def create_location_azure_blob(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "CreateLocationAzureBlob", input, options)
end
@doc """
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](https://docs.aws.amazon.com/datasync/latest/userguide/create-efs-location.html#create-efs-location-access).
"""
@spec create_location_efs(map(), create_location_efs_request(), list()) ::
{:ok, create_location_efs_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, create_location_efs_errors()}
def create_location_efs(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "CreateLocationEfs", input, options)
end
@doc """
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](https://docs.aws.amazon.com/datasync/latest/userguide/create-lustre-location.html#create-lustre-location-access).
"""
@spec create_location_fsx_lustre(map(), create_location_fsx_lustre_request(), list()) ::
{:ok, create_location_fsx_lustre_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, create_location_fsx_lustre_errors()}
def create_location_fsx_lustre(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "CreateLocationFsxLustre", input, options)
end
@doc """
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](https://docs.aws.amazon.com/datasync/latest/userguide/create-ontap-location.html#create-ontap-location-access).
"""
@spec create_location_fsx_ontap(map(), create_location_fsx_ontap_request(), list()) ::
{:ok, create_location_fsx_ontap_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, create_location_fsx_ontap_errors()}
def create_location_fsx_ontap(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "CreateLocationFsxOntap", input, options)
end
@doc """
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](https://docs.aws.amazon.com/datasync/latest/userguide/create-openzfs-location.html#create-openzfs-access).
Request parameters related to `SMB` aren't supported with the
`CreateLocationFsxOpenZfs` operation.
"""
@spec create_location_fsx_open_zfs(map(), create_location_fsx_open_zfs_request(), list()) ::
{:ok, create_location_fsx_open_zfs_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, create_location_fsx_open_zfs_errors()}
def create_location_fsx_open_zfs(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "CreateLocationFsxOpenZfs", input, options)
end
@doc """
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](https://docs.aws.amazon.com/datasync/latest/userguide/create-fsx-location.html#create-fsx-location-access).
"""
@spec create_location_fsx_windows(map(), create_location_fsx_windows_request(), list()) ::
{:ok, create_location_fsx_windows_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, create_location_fsx_windows_errors()}
def create_location_fsx_windows(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "CreateLocationFsxWindows", input, options)
end
@doc """
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](https://docs.aws.amazon.com/datasync/latest/userguide/create-hdfs-location.html#accessing-hdfs).
"""
@spec create_location_hdfs(map(), create_location_hdfs_request(), list()) ::
{:ok, create_location_hdfs_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, create_location_hdfs_errors()}
def create_location_hdfs(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "CreateLocationHdfs", input, options)
end
@doc """
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](https://docs.aws.amazon.com/datasync/latest/userguide/create-nfs-location.html#accessing-nfs).
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](https://docs.aws.amazon.com/datasync/latest/userguide/nfs-on-snowcone.html).
"""
@spec create_location_nfs(map(), create_location_nfs_request(), list()) ::
{:ok, create_location_nfs_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, create_location_nfs_errors()}
def create_location_nfs(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "CreateLocationNfs", input, options)
end
@doc """
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](https://docs.aws.amazon.com/datasync/latest/userguide/create-object-location.html#create-object-location-prerequisites)
for DataSync to work with object storage systems.
"""
@spec create_location_object_storage(map(), create_location_object_storage_request(), list()) ::
{:ok, create_location_object_storage_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, create_location_object_storage_errors()}
def create_location_object_storage(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "CreateLocationObjectStorage", input, options)
end
@doc """
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](https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#using-storage-classes)
[Evaluating S3 request costs when using DataSync](https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#create-s3-location-s3-requests)
For more information, see [Configuring transfers with Amazon S3](https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html).
"""
@spec create_location_s3(map(), create_location_s3_request(), list()) ::
{:ok, create_location_s3_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, create_location_s3_errors()}
def create_location_s3(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "CreateLocationS3", input, options)
end
@doc """
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](https://docs.aws.amazon.com/datasync/latest/userguide/create-smb-location.html#configuring-smb).
"""
@spec create_location_smb(map(), create_location_smb_request(), list()) ::
{:ok, create_location_smb_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, create_location_smb_errors()}
def create_location_smb(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "CreateLocationSmb", input, options)
end
@doc """
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](https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#create-s3-location-s3-requests)
and the [DataSync pricing page](http://aws.amazon.com/datasync/pricing/) before
you begin.
"""
@spec create_task(map(), create_task_request(), list()) ::
{:ok, create_task_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, create_task_errors()}
def create_task(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "CreateTask", input, options)
end
@doc """
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](https://docs.aws.amazon.com/datasync/latest/userguide/activate-agent.html).
"""
@spec delete_agent(map(), delete_agent_request(), list()) ::
{:ok, delete_agent_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, delete_agent_errors()}
def delete_agent(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DeleteAgent", input, options)
end
@doc """
Deletes a transfer location resource from DataSync.
"""
@spec delete_location(map(), delete_location_request(), list()) ::
{:ok, delete_location_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, delete_location_errors()}
def delete_location(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DeleteLocation", input, options)
end
@doc """
Deletes a transfer task resource from DataSync.
"""
@spec delete_task(map(), delete_task_request(), list()) ::
{:ok, delete_task_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, delete_task_errors()}
def delete_task(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DeleteTask", input, options)
end
@doc """
Returns information about an DataSync agent, such as its name, service endpoint
type, and status.
"""
@spec describe_agent(map(), describe_agent_request(), list()) ::
{:ok, describe_agent_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, describe_agent_errors()}
def describe_agent(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DescribeAgent", input, options)
end
@doc """
Returns information about a DataSync discovery job.
"""
@spec describe_discovery_job(map(), describe_discovery_job_request(), list()) ::
{:ok, describe_discovery_job_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, describe_discovery_job_errors()}
def describe_discovery_job(%Client{} = client, input, options \\ []) do
meta = metadata() |> Map.put_new(:host_prefix, "discovery-")
Request.request_post(client, meta, "DescribeDiscoveryJob", input, options)
end
@doc """
Provides details about how an DataSync transfer location for Microsoft Azure
Blob Storage is configured.
"""
@spec describe_location_azure_blob(map(), describe_location_azure_blob_request(), list()) ::
{:ok, describe_location_azure_blob_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, describe_location_azure_blob_errors()}
def describe_location_azure_blob(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DescribeLocationAzureBlob", input, options)
end
@doc """
Provides details about how an DataSync transfer location for an Amazon EFS file
system is configured.
"""
@spec describe_location_efs(map(), describe_location_efs_request(), list()) ::
{:ok, describe_location_efs_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, describe_location_efs_errors()}
def describe_location_efs(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DescribeLocationEfs", input, options)
end
@doc """
Provides details about how an DataSync transfer location for an Amazon FSx for
Lustre file system is configured.
"""
@spec describe_location_fsx_lustre(map(), describe_location_fsx_lustre_request(), list()) ::
{:ok, describe_location_fsx_lustre_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, describe_location_fsx_lustre_errors()}
def describe_location_fsx_lustre(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DescribeLocationFsxLustre", input, options)
end
@doc """
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`.
"""
@spec describe_location_fsx_ontap(map(), describe_location_fsx_ontap_request(), list()) ::
{:ok, describe_location_fsx_ontap_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, describe_location_fsx_ontap_errors()}
def describe_location_fsx_ontap(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DescribeLocationFsxOntap", input, options)
end
@doc """
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.
"""
@spec describe_location_fsx_open_zfs(map(), describe_location_fsx_open_zfs_request(), list()) ::
{:ok, describe_location_fsx_open_zfs_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, describe_location_fsx_open_zfs_errors()}
def describe_location_fsx_open_zfs(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DescribeLocationFsxOpenZfs", input, options)
end
@doc """
Provides details about how an DataSync transfer location for an Amazon FSx for
Windows File Server file system is configured.
"""
@spec describe_location_fsx_windows(map(), describe_location_fsx_windows_request(), list()) ::
{:ok, describe_location_fsx_windows_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, describe_location_fsx_windows_errors()}
def describe_location_fsx_windows(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DescribeLocationFsxWindows", input, options)
end
@doc """
Provides details about how an DataSync transfer location for a Hadoop
Distributed File System (HDFS) is configured.
"""
@spec describe_location_hdfs(map(), describe_location_hdfs_request(), list()) ::
{:ok, describe_location_hdfs_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, describe_location_hdfs_errors()}
def describe_location_hdfs(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DescribeLocationHdfs", input, options)
end
@doc """
Provides details about how an DataSync transfer location for a Network
File System (NFS) file server is configured.
"""
@spec describe_location_nfs(map(), describe_location_nfs_request(), list()) ::
{:ok, describe_location_nfs_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, describe_location_nfs_errors()}
def describe_location_nfs(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DescribeLocationNfs", input, options)
end
@doc """
Provides details about how an DataSync transfer location for an object
storage system is configured.
"""
@spec describe_location_object_storage(
map(),
describe_location_object_storage_request(),
list()
) ::
{:ok, describe_location_object_storage_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, describe_location_object_storage_errors()}
def describe_location_object_storage(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DescribeLocationObjectStorage", input, options)
end
@doc """
Provides details about how an DataSync transfer location for an S3 bucket
is configured.
"""
@spec describe_location_s3(map(), describe_location_s3_request(), list()) ::
{:ok, describe_location_s3_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, describe_location_s3_errors()}
def describe_location_s3(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DescribeLocationS3", input, options)
end
@doc """
Provides details about how an DataSync transfer location for a Server
Message Block (SMB) file server is configured.
"""
@spec describe_location_smb(map(), describe_location_smb_request(), list()) ::
{:ok, describe_location_smb_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, describe_location_smb_errors()}
def describe_location_smb(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DescribeLocationSmb", input, options)
end
@doc """
Returns information about an on-premises storage system that you're using with
DataSync Discovery.
"""
@spec describe_storage_system(map(), describe_storage_system_request(), list()) ::
{:ok, describe_storage_system_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, describe_storage_system_errors()}
def describe_storage_system(%Client{} = client, input, options \\ []) do
meta = metadata() |> Map.put_new(:host_prefix, "discovery-")
Request.request_post(client, meta, "DescribeStorageSystem", input, options)
end
@doc """
Returns information, including performance data and capacity usage, which
DataSync Discovery
collects about a specific resource in your-premises storage system.
"""
@spec describe_storage_system_resource_metrics(
map(),
describe_storage_system_resource_metrics_request(),
list()
) ::
{:ok, describe_storage_system_resource_metrics_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, describe_storage_system_resource_metrics_errors()}
def describe_storage_system_resource_metrics(%Client{} = client, input, options \\ []) do
meta = metadata() |> Map.put_new(:host_prefix, "discovery-")
Request.request_post(client, meta, "DescribeStorageSystemResourceMetrics", input, options)
end
@doc """
Returns information that DataSync Discovery collects about resources in your
on-premises storage
system.
"""
@spec describe_storage_system_resources(
map(),
describe_storage_system_resources_request(),
list()
) ::
{:ok, describe_storage_system_resources_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, describe_storage_system_resources_errors()}
def describe_storage_system_resources(%Client{} = client, input, options \\ []) do
meta = metadata() |> Map.put_new(:host_prefix, "discovery-")
Request.request_post(client, meta, "DescribeStorageSystemResources", input, options)
end
@doc """
Provides information about a *task*, which defines where and how DataSync
transfers your data.
"""
@spec describe_task(map(), describe_task_request(), list()) ::
{:ok, describe_task_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, describe_task_errors()}
def describe_task(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DescribeTask", input, options)
end
@doc """
Provides information about an execution of your DataSync task.
You can
use this operation to help monitor the progress of an ongoing data transfer or
check the
results of the transfer.
Some `DescribeTaskExecution` response elements are only relevant to a
specific task mode. For information, see [Understanding task mode differences](https://docs.aws.amazon.com/datasync/latest/userguide/choosing-task-mode.html#task-mode-differences)
and [Understanding data transfer performance
counters](https://docs.aws.amazon.com/datasync/latest/userguide/transfer-performance-counters.html).
"""
@spec describe_task_execution(map(), describe_task_execution_request(), list()) ::
{:ok, describe_task_execution_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, describe_task_execution_errors()}
def describe_task_execution(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "DescribeTaskExecution", input, options)
end
@doc """
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](https://docs.aws.amazon.com/datasync/latest/userguide/discovery-understand-recommendations.html).
Once generated, you can view your recommendations by using the
[DescribeStorageSystemResources](https://docs.aws.amazon.com/datasync/latest/userguide/API_DescribeStorageSystemResources.html)
operation.
"""
@spec generate_recommendations(map(), generate_recommendations_request(), list()) ::
{:ok, generate_recommendations_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, generate_recommendations_errors()}
def generate_recommendations(%Client{} = client, input, options \\ []) do
meta = metadata() |> Map.put_new(:host_prefix, "discovery-")
Request.request_post(client, meta, "GenerateRecommendations", input, options)
end
@doc """
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
[CreateAgent](https://docs.aws.amazon.com/datasync/latest/userguide/API_CreateAgent.html) and 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](https://docs.aws.amazon.com/datasync/latest/userguide/API_DescribeAgent.html).
"""
@spec list_agents(map(), list_agents_request(), list()) ::
{:ok, list_agents_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, list_agents_errors()}
def list_agents(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "ListAgents", input, options)
end
@doc """
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.
"""
@spec list_discovery_jobs(map(), list_discovery_jobs_request(), list()) ::
{:ok, list_discovery_jobs_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, list_discovery_jobs_errors()}
def list_discovery_jobs(%Client{} = client, input, options \\ []) do
meta = metadata() |> Map.put_new(:host_prefix, "discovery-")
Request.request_post(client, meta, "ListDiscoveryJobs", input, options)
end
@doc """
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.
"""
@spec list_locations(map(), list_locations_request(), list()) ::
{:ok, list_locations_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, list_locations_errors()}
def list_locations(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "ListLocations", input, options)
end
@doc """
Lists the on-premises storage systems that you're using with DataSync Discovery.
"""
@spec list_storage_systems(map(), list_storage_systems_request(), list()) ::
{:ok, list_storage_systems_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, list_storage_systems_errors()}
def list_storage_systems(%Client{} = client, input, options \\ []) do
meta = metadata() |> Map.put_new(:host_prefix, "discovery-")
Request.request_post(client, meta, "ListStorageSystems", input, options)
end
@doc """
Returns all the tags associated with an Amazon Web Services resource.
"""
@spec list_tags_for_resource(map(), list_tags_for_resource_request(), list()) ::
{:ok, list_tags_for_resource_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, list_tags_for_resource_errors()}
def list_tags_for_resource(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "ListTagsForResource", input, options)
end
@doc """
Returns a list of executions for an DataSync transfer task.
"""
@spec list_task_executions(map(), list_task_executions_request(), list()) ::
{:ok, list_task_executions_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, list_task_executions_errors()}
def list_task_executions(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "ListTaskExecutions", input, options)
end
@doc """
Returns a list of the DataSync tasks you created.
"""
@spec list_tasks(map(), list_tasks_request(), list()) ::
{:ok, list_tasks_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, list_tasks_errors()}
def list_tasks(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "ListTasks", input, options)
end
@doc """
Permanently removes a storage system resource from DataSync Discovery, including
the associated
discovery jobs, collected data, and recommendations.
"""
@spec remove_storage_system(map(), remove_storage_system_request(), list()) ::
{:ok, remove_storage_system_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, remove_storage_system_errors()}
def remove_storage_system(%Client{} = client, input, options \\ []) do
meta = metadata() |> Map.put_new(:host_prefix, "discovery-")
Request.request_post(client, meta, "RemoveStorageSystem", input, options)
end
@doc """
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
[AddStorageSystem](https://docs.aws.amazon.com/datasync/latest/userguide/API_AddStorageSystem.html)
operation.
"""
@spec start_discovery_job(map(), start_discovery_job_request(), list()) ::
{:ok, start_discovery_job_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, start_discovery_job_errors()}
def start_discovery_job(%Client{} = client, input, options \\ []) do
meta = metadata() |> Map.put_new(:host_prefix, "discovery-")
Request.request_post(client, meta, "StartDiscoveryJob", input, options)
end
@doc """
Starts an DataSync transfer task.
For each task, you can only run one task
execution at a time.
There are several steps to a task execution. For more information, see [Task execution
statuses](https://docs.aws.amazon.com/datasync/latest/userguide/working-with-task-executions.html#understand-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](https://docs.aws.amazon.com/datasync/latest/userguide/create-s3-location.html#create-s3-location-s3-requests)
and the [DataSync pricing page](http://aws.amazon.com/datasync/pricing/) before
you begin.
"""
@spec start_task_execution(map(), start_task_execution_request(), list()) ::
{:ok, start_task_execution_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, start_task_execution_errors()}
def start_task_execution(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "StartTaskExecution", input, options)
end
@doc """
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
[GenerateRecommendations](https://docs.aws.amazon.com/datasync/latest/userguide/API_GenerateRecommendations.html)
operation.
"""
@spec stop_discovery_job(map(), stop_discovery_job_request(), list()) ::
{:ok, stop_discovery_job_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, stop_discovery_job_errors()}
def stop_discovery_job(%Client{} = client, input, options \\ []) do
meta = metadata() |> Map.put_new(:host_prefix, "discovery-")
Request.request_post(client, meta, "StopDiscoveryJob", input, options)
end
@doc """
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.
"""
@spec tag_resource(map(), tag_resource_request(), list()) ::
{:ok, tag_resource_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, tag_resource_errors()}
def tag_resource(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "TagResource", input, options)
end
@doc """
Removes tags from an Amazon Web Services resource.
"""
@spec untag_resource(map(), untag_resource_request(), list()) ::
{:ok, untag_resource_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, untag_resource_errors()}
def untag_resource(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "UntagResource", input, options)
end
@doc """
Updates the name of an DataSync agent.
"""
@spec update_agent(map(), update_agent_request(), list()) ::
{:ok, update_agent_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, update_agent_errors()}
def update_agent(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "UpdateAgent", input, options)
end
@doc """
Edits a DataSync discovery job configuration.
"""
@spec update_discovery_job(map(), update_discovery_job_request(), list()) ::
{:ok, update_discovery_job_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, update_discovery_job_errors()}
def update_discovery_job(%Client{} = client, input, options \\ []) do
meta = metadata() |> Map.put_new(:host_prefix, "discovery-")
Request.request_post(client, meta, "UpdateDiscoveryJob", input, options)
end
@doc """
Modifies some configurations of the Microsoft Azure Blob Storage transfer
location that you're using with DataSync.
"""
@spec update_location_azure_blob(map(), update_location_azure_blob_request(), list()) ::
{:ok, update_location_azure_blob_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, update_location_azure_blob_errors()}
def update_location_azure_blob(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "UpdateLocationAzureBlob", input, options)
end
@doc """
Updates some parameters of a previously created location for a Hadoop
Distributed File
System cluster.
"""
@spec update_location_hdfs(map(), update_location_hdfs_request(), list()) ::
{:ok, update_location_hdfs_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, update_location_hdfs_errors()}
def update_location_hdfs(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "UpdateLocationHdfs", input, options)
end
@doc """
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](https://docs.aws.amazon.com/datasync/latest/userguide/create-nfs-location.html).
"""
@spec update_location_nfs(map(), update_location_nfs_request(), list()) ::
{:ok, update_location_nfs_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, update_location_nfs_errors()}
def update_location_nfs(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "UpdateLocationNfs", input, options)
end
@doc """
Updates some parameters of an existing DataSync location for an object
storage system.
"""
@spec update_location_object_storage(map(), update_location_object_storage_request(), list()) ::
{:ok, update_location_object_storage_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, update_location_object_storage_errors()}
def update_location_object_storage(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "UpdateLocationObjectStorage", input, options)
end
@doc """
Updates some of the parameters of a Server Message Block
(SMB) file server location that you can use for DataSync transfers.
"""
@spec update_location_smb(map(), update_location_smb_request(), list()) ::
{:ok, update_location_smb_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, update_location_smb_errors()}
def update_location_smb(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "UpdateLocationSmb", input, options)
end
@doc """
Modifies some configurations of an on-premises storage system resource that
you're using
with DataSync Discovery.
"""
@spec update_storage_system(map(), update_storage_system_request(), list()) ::
{:ok, update_storage_system_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, update_storage_system_errors()}
def update_storage_system(%Client{} = client, input, options \\ []) do
meta = metadata() |> Map.put_new(:host_prefix, "discovery-")
Request.request_post(client, meta, "UpdateStorageSystem", input, options)
end
@doc """
Updates the configuration of a *task*, which defines where and how DataSync
transfers your data.
"""
@spec update_task(map(), update_task_request(), list()) ::
{:ok, update_task_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, update_task_errors()}
def update_task(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "UpdateTask", input, options)
end
@doc """
Updates the configuration of a running DataSync task execution.
Currently, the only `Option` that you can modify with
`UpdateTaskExecution` is
```
[BytesPerSecond](https://docs.aws.amazon.com/datasync/latest/userguide/API_Options.html#DataSync-Type-Options-BytesPerSecond)
```
, which throttles bandwidth for a running or queued
task execution.
"""
@spec update_task_execution(map(), update_task_execution_request(), list()) ::
{:ok, update_task_execution_response(), any()}
| {:error, {:unexpected_response, any()}}
| {:error, update_task_execution_errors()}
def update_task_execution(%Client{} = client, input, options \\ []) do
meta = metadata()
Request.request_post(client, meta, "UpdateTaskExecution", input, options)
end
end
