2023/04/25 - AWS DataSync - 13 new api methods
Changes This release adds 13 new APIs to support AWS DataSync Discovery GA.
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.
See also: AWS API Documentation
Request Syntax
client.list_discovery_jobs(
StorageSystemArn='string',
MaxResults=123,
NextToken='string'
)
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.
integer
Specifies how many results you want in the response.
string
Specifies an opaque string that indicates the position to begin the next list of results in the response.
dict
Response Syntax
{
'DiscoveryJobs': [
{
'DiscoveryJobArn': 'string',
'Status': 'RUNNING'|'WARNING'|'TERMINATED'|'FAILED'|'STOPPED'|'COMPLETED'|'COMPLETED_WITH_ISSUES'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
DiscoveryJobs (list) --
The discovery jobs that you've run.
(dict) --
The details about a specific DataSync discovery job.
DiscoveryJobArn (string) --
The Amazon Resource Name (ARN) of a discovery job.
Status (string) --
The status of a discovery job. For more information, see Discovery job statuses.
NextToken (string) --
The opaque string that indicates the position to begin the next list of results in the response.
Returns information, including performance data and capacity usage, which DataSync Discovery collects about a specific resource in your-premises storage system.
See also: AWS API Documentation
Request Syntax
client.describe_storage_system_resource_metrics(
DiscoveryJobArn='string',
ResourceType='SVM'|'VOLUME'|'CLUSTER',
ResourceId='string',
StartTime=datetime(2015, 1, 1),
EndTime=datetime(2015, 1, 1),
MaxResults=123,
NextToken='string'
)
string
[REQUIRED]
Specifies the Amazon Resource Name (ARN) of the discovery job that collects information about your on-premises storage system.
string
[REQUIRED]
Specifies the kind of storage system resource that you want information about.
string
[REQUIRED]
Specifies the universally unique identifier (UUID) of the storage system resource that you want information about.
datetime
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 .
datetime
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 .
integer
Specifies how many results that you want in the response.
string
Specifies an opaque string that indicates the position to begin the next list of results in the response.
dict
Response Syntax
{
'Metrics': [
{
'Timestamp': datetime(2015, 1, 1),
'P95Metrics': {
'IOPS': {
'Read': 123.0,
'Write': 123.0,
'Other': 123.0,
'Total': 123.0
},
'Throughput': {
'Read': 123.0,
'Write': 123.0,
'Other': 123.0,
'Total': 123.0
},
'Latency': {
'Read': 123.0,
'Write': 123.0,
'Other': 123.0
}
},
'Capacity': {
'Used': 123,
'Provisioned': 123,
'LogicalUsed': 123
},
'ResourceId': 'string',
'ResourceType': 'SVM'|'VOLUME'|'CLUSTER'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
Metrics (list) --
The details that your discovery job collected about your storage system resource.
(dict) --
Information, including performance data and capacity usage, provided by DataSync Discovery about a resource in your on-premises storage system.
Timestamp (datetime) --
The time when DataSync Discovery collected this information from the resource.
P95Metrics (dict) --
The types of performance data that DataSync Discovery collects about the on-premises storage system resource.
IOPS (dict) --
The IOPS peaks for an on-premises storage system resource. Each data point represents the 95th percentile peak value during a 1-hour interval.
Read (float) --
Peak IOPS related to read operations.
Write (float) --
Peak IOPS related to write operations.
Other (float) --
Peak IOPS unrelated to read and write operations.
Total (float) --
Peak total IOPS on your on-premises storage system resource.
Throughput (dict) --
The throughput peaks for an on-premises storage system resource. Each data point represents the 95th percentile peak value during a 1-hour interval.
Read (float) --
Peak throughput related to read operations.
Write (float) --
Peak throughput related to write operations.
Other (float) --
Peak throughput unrelated to read and write operations.
Total (float) --
Peak total throughput on your on-premises storage system resource.
Latency (dict) --
The latency peaks for an on-premises storage system resource. Each data point represents the 95th percentile peak value during a 1-hour interval.
Read (float) --
Peak latency for read operations.
Write (float) --
Peak latency for write operations.
Other (float) --
Peak latency for operations unrelated to read and write operations.
Capacity (dict) --
The storage capacity of the on-premises storage system resource.
Used (integer) --
The amount of space that's being used in a storage system resource.
Provisioned (integer) --
The total amount of space available in a storage system resource.
LogicalUsed (integer) --
The amount of space that's being used in a storage system resource without accounting for compression or deduplication.
ResourceId (string) --
The universally unique identifier (UUID) of the on-premises storage system resource.
ResourceType (string) --
The type of on-premises storage system resource.
NextToken (string) --
The opaque string that indicates the position to begin the next list of results in the response.
Returns information about an on-premises storage system that you're using with DataSync Discovery.
See also: AWS API Documentation
Request Syntax
client.describe_storage_system(
StorageSystemArn='string'
)
string
[REQUIRED]
Specifies the Amazon Resource Name (ARN) of an on-premises storage system that you're using with DataSync Discovery.
dict
Response Syntax
{
'StorageSystemArn': 'string',
'ServerConfiguration': {
'ServerHostname': 'string',
'ServerPort': 123
},
'SystemType': 'NetAppONTAP',
'AgentArns': [
'string',
],
'Name': 'string',
'ErrorMessage': 'string',
'ConnectivityStatus': 'PASS'|'FAIL'|'UNKNOWN',
'CloudWatchLogGroupArn': 'string',
'CreationTime': datetime(2015, 1, 1),
'SecretsManagerArn': 'string'
}
Response Structure
(dict) --
StorageSystemArn (string) --
The ARN of the on-premises storage system that the discovery job looked at.
ServerConfiguration (dict) --
The server name and network port required to connect with your on-premises storage system's management interface.
ServerHostname (string) --
The domain name or IP address of your storage system's management interface.
ServerPort (integer) --
The network port for accessing the storage system's management interface.
SystemType (string) --
The type of on-premises storage system.
Note
DataSync Discovery currently only supports NetApp Fabric-Attached Storage (FAS) and All Flash FAS (AFF) systems running ONTAP 9.7 or later.
AgentArns (list) --
The ARN of the DataSync agent that connects to and reads from your on-premises storage system.
(string) --
Name (string) --
The name that you gave your on-premises storage system when adding it to DataSync Discovery.
ErrorMessage (string) --
Describes the connectivity error that the DataSync agent is encountering with your on-premises storage system.
ConnectivityStatus (string) --
Indicates whether your DataSync agent can connect to your on-premises storage system.
CloudWatchLogGroupArn (string) --
The ARN of the Amazon CloudWatch log group that's used to monitor and log discovery job events.
CreationTime (datetime) --
The time when you added the on-premises storage system to DataSync Discovery.
SecretsManagerArn (string) --
The ARN of the secret that stores your on-premises storage system's credentials. DataSync Discovery stores these credentials in Secrets Manager.
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.
Note
If your discovery job completes successfully, you don't need to use this operation. DataSync Discovery generates the recommendations for you automatically.
See also: AWS API Documentation
Request Syntax
client.generate_recommendations(
DiscoveryJobArn='string',
ResourceIds=[
'string',
],
ResourceType='SVM'|'VOLUME'|'CLUSTER'
)
string
[REQUIRED]
Specifies the Amazon Resource Name (ARN) of the discovery job that collects information about your on-premises storage system.
list
[REQUIRED]
Specifies the universally unique identifiers (UUIDs) of the resources in your storage system that you want recommendations on.
(string) --
string
[REQUIRED]
Specifies the type of resource in your storage system that you want recommendations on.
dict
Response Syntax
{}
Response Structure
(dict) --
Lists the on-premises storage systems that you're using with DataSync Discovery.
See also: AWS API Documentation
Request Syntax
client.list_storage_systems(
MaxResults=123,
NextToken='string'
)
integer
Specifies how many results you want in the response.
string
Specifies an opaque string that indicates the position to begin the next list of results in the response.
dict
Response Syntax
{
'StorageSystems': [
{
'StorageSystemArn': 'string',
'Name': 'string'
},
],
'NextToken': 'string'
}
Response Structure
(dict) --
StorageSystems (list) --
The Amazon Resource Names ARNs) of the on-premises storage systems that you're using with DataSync Discovery.
(dict) --
Information that identifies an on-premises storage system that you're using with DataSync Discovery.
StorageSystemArn (string) --
The Amazon Resource Names (ARN) of an on-premises storage system that you added to DataSync Discovery.
Name (string) --
The name of an on-premises storage system that you added to DataSync Discovery.
NextToken (string) --
The opaque string that indicates the position to begin the next list of results in the response.
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 operation.
See also: AWS API Documentation
Request Syntax
client.stop_discovery_job(
DiscoveryJobArn='string'
)
string
[REQUIRED]
Specifies the Amazon Resource Name (ARN) of the discovery job that you want to stop.
dict
Response Syntax
{}
Response Structure
(dict) --
Returns information about a DataSync discovery job.
See also: AWS API Documentation
Request Syntax
client.describe_discovery_job(
DiscoveryJobArn='string'
)
string
[REQUIRED]
Specifies the Amazon Resource Name (ARN) of the discovery job that you want information about.
dict
Response Syntax
{
'StorageSystemArn': 'string',
'DiscoveryJobArn': 'string',
'CollectionDurationMinutes': 123,
'Status': 'RUNNING'|'WARNING'|'TERMINATED'|'FAILED'|'STOPPED'|'COMPLETED'|'COMPLETED_WITH_ISSUES',
'JobStartTime': datetime(2015, 1, 1),
'JobEndTime': datetime(2015, 1, 1)
}
Response Structure
(dict) --
StorageSystemArn (string) --
The ARN of the on-premises storage system you're running the discovery job on.
DiscoveryJobArn (string) --
The ARN of the discovery job.
CollectionDurationMinutes (integer) --
The number of minutes that the discovery job runs.
Status (string) --
Indicates the status of a discovery job. For more information, see Discovery job statuses.
JobStartTime (datetime) --
The time when the discovery job started.
JobEndTime (datetime) --
The time when the discovery job ended.
Returns information that DataSync Discovery collects about resources in your on-premises storage system.
See also: AWS API Documentation
Request Syntax
client.describe_storage_system_resources(
DiscoveryJobArn='string',
ResourceType='SVM'|'VOLUME'|'CLUSTER',
ResourceIds=[
'string',
],
Filter={
'string': [
'string',
]
},
MaxResults=123,
NextToken='string'
)
string
[REQUIRED]
Specifies the Amazon Resource Name (ARN) of the discovery job that's collecting data from your on-premises storage system.
string
[REQUIRED]
Specifies what kind of storage system resources that you want information about.
list
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.
(string) --
dict
Filters the storage system resources that you want returned. For example, this might be volumes associated with a specific storage virtual machine (SVM).
(string) --
(list) --
(string) --
integer
Specifies the maximum number of storage system resources that you want to list in a response.
string
Specifies an opaque string that indicates the position to begin the next list of results in the response.
dict
Response Syntax
{
'ResourceDetails': {
'NetAppONTAPSVMs': [
{
'ClusterUuid': 'string',
'ResourceId': 'string',
'SvmName': 'string',
'CifsShareCount': 123,
'EnabledProtocols': [
'string',
],
'TotalCapacityUsed': 123,
'TotalCapacityProvisioned': 123,
'TotalLogicalCapacityUsed': 123,
'MaxP95Performance': {
'IopsRead': 123.0,
'IopsWrite': 123.0,
'IopsOther': 123.0,
'IopsTotal': 123.0,
'ThroughputRead': 123.0,
'ThroughputWrite': 123.0,
'ThroughputOther': 123.0,
'ThroughputTotal': 123.0,
'LatencyRead': 123.0,
'LatencyWrite': 123.0,
'LatencyOther': 123.0
},
'Recommendations': [
{
'StorageType': 'string',
'StorageConfiguration': {
'string': 'string'
},
'EstimatedMonthlyStorageCost': 'string'
},
],
'NfsExportedVolumes': 123,
'RecommendationStatus': 'NONE'|'IN_PROGRESS'|'COMPLETED'|'FAILED',
'TotalSnapshotCapacityUsed': 123
},
],
'NetAppONTAPVolumes': [
{
'VolumeName': 'string',
'ResourceId': 'string',
'CifsShareCount': 123,
'SecurityStyle': 'string',
'SvmUuid': 'string',
'SvmName': 'string',
'CapacityUsed': 123,
'CapacityProvisioned': 123,
'LogicalCapacityUsed': 123,
'NfsExported': True|False,
'SnapshotCapacityUsed': 123,
'MaxP95Performance': {
'IopsRead': 123.0,
'IopsWrite': 123.0,
'IopsOther': 123.0,
'IopsTotal': 123.0,
'ThroughputRead': 123.0,
'ThroughputWrite': 123.0,
'ThroughputOther': 123.0,
'ThroughputTotal': 123.0,
'LatencyRead': 123.0,
'LatencyWrite': 123.0,
'LatencyOther': 123.0
},
'Recommendations': [
{
'StorageType': 'string',
'StorageConfiguration': {
'string': 'string'
},
'EstimatedMonthlyStorageCost': 'string'
},
],
'RecommendationStatus': 'NONE'|'IN_PROGRESS'|'COMPLETED'|'FAILED'
},
],
'NetAppONTAPClusters': [
{
'CifsShareCount': 123,
'NfsExportedVolumes': 123,
'ResourceId': 'string',
'ClusterName': 'string',
'MaxP95Performance': {
'IopsRead': 123.0,
'IopsWrite': 123.0,
'IopsOther': 123.0,
'IopsTotal': 123.0,
'ThroughputRead': 123.0,
'ThroughputWrite': 123.0,
'ThroughputOther': 123.0,
'ThroughputTotal': 123.0,
'LatencyRead': 123.0,
'LatencyWrite': 123.0,
'LatencyOther': 123.0
},
'ClusterBlockStorageSize': 123,
'ClusterBlockStorageUsed': 123,
'ClusterBlockStorageLogicalUsed': 123,
'Recommendations': [
{
'StorageType': 'string',
'StorageConfiguration': {
'string': 'string'
},
'EstimatedMonthlyStorageCost': 'string'
},
],
'RecommendationStatus': 'NONE'|'IN_PROGRESS'|'COMPLETED'|'FAILED'
},
]
},
'NextToken': 'string'
}
Response Structure
(dict) --
ResourceDetails (dict) --
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.
NetAppONTAPSVMs (list) --
The information that DataSync Discovery collects about storage virtual machines (SVMs) in your on-premises storage system.
(dict) --
The information that DataSync Discovery collects about a storage virtual machine (SVM) in your on-premises storage system.
ClusterUuid (string) --
The universally unique identifier (UUID) of the cluster associated with the SVM.
ResourceId (string) --
The UUID of the SVM.
SvmName (string) --
The name of the SVM
CifsShareCount (integer) --
The number of CIFS shares in the SVM.
EnabledProtocols (list) --
The data transfer protocols (such as NFS) configured for the SVM.
(string) --
TotalCapacityUsed (integer) --
The storage space that's being used in the SVM.
TotalCapacityProvisioned (integer) --
The total storage space that's available in the SVM.
TotalLogicalCapacityUsed (integer) --
The storage space that's being used in the SVM without accounting for compression or deduplication.
MaxP95Performance (dict) --
The performance data that DataSync Discovery collects about the SVM.
IopsRead (float) --
Peak IOPS related to read operations.
IopsWrite (float) --
Peak IOPS related to write operations.
IopsOther (float) --
Peak IOPS unrelated to read and write operations.
IopsTotal (float) --
Peak total IOPS on your on-premises storage system resource.
ThroughputRead (float) --
Peak throughput related to read operations.
ThroughputWrite (float) --
Peak throughput related to write operations.
ThroughputOther (float) --
Peak throughput unrelated to read and write operations.
ThroughputTotal (float) --
Peak total throughput on your on-premises storage system resource.
LatencyRead (float) --
Peak latency for read operations.
LatencyWrite (float) --
Peak latency for write operations.
LatencyOther (float) --
Peak latency for operations unrelated to read and write operations.
Recommendations (list) --
The Amazon Web Services storage services that DataSync Discovery recommends for the SVM. For more information, see Recommendations provided by DataSync Discovery.
(dict) --
The details about an Amazon Web Services storage service that DataSync Discovery recommends for a resource in your on-premises storage system.
For more information, see Recommendations provided by DataSync Discovery.
StorageType (string) --
A recommended Amazon Web Services storage service that you can migrate data to based on information that DataSync Discovery collects about your on-premises storage system.
StorageConfiguration (dict) --
Information about how you can set up a recommended Amazon Web Services storage service.
(string) --
(string) --
EstimatedMonthlyStorageCost (string) --
The estimated monthly cost of the recommended Amazon Web Services storage service.
NfsExportedVolumes (integer) --
The number of NFS volumes in the SVM.
RecommendationStatus (string) --
Indicates whether DataSync Discovery recommendations for the SVM are ready to view, incomplete, or can't be determined.
For more information, see Recommendation statuses.
TotalSnapshotCapacityUsed (integer) --
The amount of storage in the SVM that's being used for snapshots.
NetAppONTAPVolumes (list) --
The information that DataSync Discovery collects about volumes in your on-premises storage system.
(dict) --
The information that DataSync Discovery collects about a volume in your on-premises storage system.
VolumeName (string) --
The name of the volume.
ResourceId (string) --
The universally unique identifier (UUID) of the volume.
CifsShareCount (integer) --
The number of CIFS shares in the volume.
SecurityStyle (string) --
The volume's security style (such as Unix or NTFS).
SvmUuid (string) --
The UUID of the storage virtual machine (SVM) associated with the volume.
SvmName (string) --
The name of the SVM associated with the volume.
CapacityUsed (integer) --
The storage space that's being used in the volume.
CapacityProvisioned (integer) --
The total storage space that's available in the volume.
LogicalCapacityUsed (integer) --
The storage space that's being used in the volume without accounting for compression or deduplication.
NfsExported (boolean) --
The number of NFS volumes in the volume.
SnapshotCapacityUsed (integer) --
The amount of storage in the volume that's being used for snapshots.
MaxP95Performance (dict) --
The performance data that DataSync Discovery collects about the volume.
IopsRead (float) --
Peak IOPS related to read operations.
IopsWrite (float) --
Peak IOPS related to write operations.
IopsOther (float) --
Peak IOPS unrelated to read and write operations.
IopsTotal (float) --
Peak total IOPS on your on-premises storage system resource.
ThroughputRead (float) --
Peak throughput related to read operations.
ThroughputWrite (float) --
Peak throughput related to write operations.
ThroughputOther (float) --
Peak throughput unrelated to read and write operations.
ThroughputTotal (float) --
Peak total throughput on your on-premises storage system resource.
LatencyRead (float) --
Peak latency for read operations.
LatencyWrite (float) --
Peak latency for write operations.
LatencyOther (float) --
Peak latency for operations unrelated to read and write operations.
Recommendations (list) --
The Amazon Web Services storage services that DataSync Discovery recommends for the volume. For more information, see Recommendations provided by DataSync Discovery.
(dict) --
The details about an Amazon Web Services storage service that DataSync Discovery recommends for a resource in your on-premises storage system.
For more information, see Recommendations provided by DataSync Discovery.
StorageType (string) --
A recommended Amazon Web Services storage service that you can migrate data to based on information that DataSync Discovery collects about your on-premises storage system.
StorageConfiguration (dict) --
Information about how you can set up a recommended Amazon Web Services storage service.
(string) --
(string) --
EstimatedMonthlyStorageCost (string) --
The estimated monthly cost of the recommended Amazon Web Services storage service.
RecommendationStatus (string) --
Indicates whether DataSync Discovery recommendations for the volume are ready to view, incomplete, or can't be determined.
For more information, see Recommendation statuses.
NetAppONTAPClusters (list) --
The information that DataSync Discovery collects about the cluster in your on-premises storage system.
(dict) --
The information that DataSync Discovery collects about an on-premises storage system cluster.
CifsShareCount (integer) --
The number of CIFS shares in the cluster.
NfsExportedVolumes (integer) --
The number of NFS volumes in the cluster.
ResourceId (string) --
The universally unique identifier (UUID) of the cluster.
ClusterName (string) --
The name of the cluster.
MaxP95Performance (dict) --
The performance data that DataSync Discovery collects about the cluster.
IopsRead (float) --
Peak IOPS related to read operations.
IopsWrite (float) --
Peak IOPS related to write operations.
IopsOther (float) --
Peak IOPS unrelated to read and write operations.
IopsTotal (float) --
Peak total IOPS on your on-premises storage system resource.
ThroughputRead (float) --
Peak throughput related to read operations.
ThroughputWrite (float) --
Peak throughput related to write operations.
ThroughputOther (float) --
Peak throughput unrelated to read and write operations.
ThroughputTotal (float) --
Peak total throughput on your on-premises storage system resource.
LatencyRead (float) --
Peak latency for read operations.
LatencyWrite (float) --
Peak latency for write operations.
LatencyOther (float) --
Peak latency for operations unrelated to read and write operations.
ClusterBlockStorageSize (integer) --
The total storage space that's available in the cluster.
ClusterBlockStorageUsed (integer) --
The storage space that's being used in a cluster.
ClusterBlockStorageLogicalUsed (integer) --
The storage space that's being used in the cluster without accounting for compression or deduplication.
Recommendations (list) --
The Amazon Web Services storage services that DataSync Discovery recommends for the cluster. For more information, see Recommendations provided by DataSync Discovery.
(dict) --
The details about an Amazon Web Services storage service that DataSync Discovery recommends for a resource in your on-premises storage system.
For more information, see Recommendations provided by DataSync Discovery.
StorageType (string) --
A recommended Amazon Web Services storage service that you can migrate data to based on information that DataSync Discovery collects about your on-premises storage system.
StorageConfiguration (dict) --
Information about how you can set up a recommended Amazon Web Services storage service.
(string) --
(string) --
EstimatedMonthlyStorageCost (string) --
The estimated monthly cost of the recommended Amazon Web Services storage service.
RecommendationStatus (string) --
Indicates whether DataSync Discovery recommendations for the cluster are ready to view, incomplete, or can't be determined.
For more information, see Recommendation statuses.
NextToken (string) --
The opaque string that indicates the position to begin the next list of results in the response.
Creates an Amazon Web Services resource for an on-premises storage system that you want DataSync Discovery to collect information about.
See also: AWS API Documentation
Request Syntax
client.add_storage_system(
ServerConfiguration={
'ServerHostname': 'string',
'ServerPort': 123
},
SystemType='NetAppONTAP',
AgentArns=[
'string',
],
CloudWatchLogGroupArn='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
],
Name='string',
ClientToken='string',
Credentials={
'Username': 'string',
'Password': 'string'
}
)
dict
[REQUIRED]
Specifies the server name and network port required to connect with the management interface of your on-premises storage system.
ServerHostname (string) -- [REQUIRED]
The domain name or IP address of your storage system's management interface.
ServerPort (integer) --
The network port for accessing the storage system's management interface.
string
[REQUIRED]
Specifies the type of on-premises storage system that you want DataSync Discovery to collect information about.
Note
DataSync Discovery currently supports NetApp Fabric-Attached Storage (FAS) and All Flash FAS (AFF) systems running ONTAP 9.7 or later.
list
[REQUIRED]
Specifies the Amazon Resource Name (ARN) of the DataSync agent that connects to and reads from your on-premises storage system's management interface.
(string) --
string
Specifies the ARN of the Amazon CloudWatch log group for monitoring and logging discovery job events.
list
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.
(dict) --
A key-value pair representing a single tag that's been applied to an Amazon Web Services resource.
Key (string) -- [REQUIRED]
The key for an Amazon Web Services resource tag.
Value (string) --
The value for an Amazon Web Services resource tag.
string
Specifies a familiar name for your on-premises storage system.
string
[REQUIRED]
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 field is autopopulated if not provided.
dict
[REQUIRED]
Specifies the user name and password for accessing your on-premises storage system's management interface.
Username (string) -- [REQUIRED]
Specifies the user name for your storage system's management interface.
Password (string) -- [REQUIRED]
Specifies the password for your storage system's management interface.
dict
Response Syntax
{
'StorageSystemArn': 'string'
}
Response Structure
(dict) --
StorageSystemArn (string) --
The ARN of the on-premises storage system that you can use with DataSync Discovery.
Permanently removes a storage system resource from DataSync Discovery, including the associated discovery jobs, collected data, and recommendations.
See also: AWS API Documentation
Request Syntax
client.remove_storage_system(
StorageSystemArn='string'
)
string
[REQUIRED]
Specifies the Amazon Resource Name (ARN) of the storage system that you want to permanently remove from DataSync Discovery.
dict
Response Syntax
{}
Response Structure
(dict) --
Modifies some configurations of an on-premises storage system resource that you're using with DataSync Discovery.
See also: AWS API Documentation
Request Syntax
client.update_storage_system(
StorageSystemArn='string',
ServerConfiguration={
'ServerHostname': 'string',
'ServerPort': 123
},
AgentArns=[
'string',
],
Name='string',
CloudWatchLogGroupArn='string',
Credentials={
'Username': 'string',
'Password': 'string'
}
)
string
[REQUIRED]
Specifies the ARN of the on-premises storage system that you want reconfigure.
dict
Specifies the server name and network port required to connect with your on-premises storage system's management interface.
ServerHostname (string) -- [REQUIRED]
The domain name or IP address of your storage system's management interface.
ServerPort (integer) --
The network port for accessing the storage system's management interface.
list
Specifies the Amazon Resource Name (ARN) of the DataSync agent that connects to and reads your on-premises storage system.
(string) --
string
Specifies a familiar name for your on-premises storage system.
string
Specifies the ARN of the Amazon CloudWatch log group for monitoring and logging discovery job events.
dict
Specifies the user name and password for accessing your on-premises storage system's management interface.
Username (string) -- [REQUIRED]
Specifies the user name for your storage system's management interface.
Password (string) -- [REQUIRED]
Specifies the password for your storage system's management interface.
dict
Response Syntax
{}
Response Structure
(dict) --
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 operation.
See also: AWS API Documentation
Request Syntax
client.start_discovery_job(
StorageSystemArn='string',
CollectionDurationMinutes=123,
ClientToken='string',
Tags=[
{
'Key': 'string',
'Value': 'string'
},
]
)
string
[REQUIRED]
Specifies the Amazon Resource Name (ARN) of the on-premises storage system that you want to run the discovery job on.
integer
[REQUIRED]
Specifies in minutes how long you want the discovery job to run.
Note
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.
string
[REQUIRED]
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 field is autopopulated if not provided.
list
Specifies labels that help you categorize, filter, and search for your Amazon Web Services resources.
(dict) --
A key-value pair representing a single tag that's been applied to an Amazon Web Services resource.
Key (string) -- [REQUIRED]
The key for an Amazon Web Services resource tag.
Value (string) --
The value for an Amazon Web Services resource tag.
dict
Response Syntax
{
'DiscoveryJobArn': 'string'
}
Response Structure
(dict) --
DiscoveryJobArn (string) --
The ARN of the discovery job that you started.
Edits a DataSync discovery job configuration.
See also: AWS API Documentation
Request Syntax
client.update_discovery_job(
DiscoveryJobArn='string',
CollectionDurationMinutes=123
)
string
[REQUIRED]
Specifies the Amazon Resource Name (ARN) of the discovery job that you want to update.
integer
[REQUIRED]
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.)
dict
Response Syntax
{}
Response Structure
(dict) --