DataSync / Paginator / DescribeStorageSystemResourceMetrics
DescribeStorageSystemResourceMetrics#
- class DataSync.Paginator.DescribeStorageSystemResourceMetrics#
paginator = client.get_paginator('describe_storage_system_resource_metrics')
- paginate(**kwargs)#
Creates an iterator that will paginate through responses from
DataSync.Client.describe_storage_system_resource_metrics()
.See also: AWS API Documentation
Request Syntax
response_iterator = paginator.paginate( DiscoveryJobArn='string', ResourceType='SVM'|'VOLUME'|'CLUSTER', ResourceId='string', StartTime=datetime(2015, 1, 1), EndTime=datetime(2015, 1, 1), PaginationConfig={ 'MaxItems': 123, 'PageSize': 123, 'StartingToken': 'string' } )
- Parameters:
DiscoveryJobArn (string) –
[REQUIRED]
Specifies the Amazon Resource Name (ARN) of the discovery job that collects information about your on-premises storage system.
ResourceType (string) –
[REQUIRED]
Specifies the kind of storage system resource that you want information about.
ResourceId (string) –
[REQUIRED]
Specifies the universally unique identifier (UUID) of the storage system resource that you want information about.
StartTime (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
.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
.PaginationConfig (dict) –
A dictionary that provides parameters to control pagination.
MaxItems (integer) –
The total number of items to return. If the total number of items available is more than the value specified in max-items then a
NextToken
will be provided in the output that you can use to resume pagination.PageSize (integer) –
The size of each page.
StartingToken (string) –
A token to specify where to start paginating. This is the
NextToken
from a previous response.
- Return type:
dict
- Returns:
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' }, ], }
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.