Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . datasync ]

describe-storage-system-resource-metrics¶

Description¶

Returns information, including performance data and capacity usage, which DataSync Discovery collects about a specific resource in your-premises storage system.

Synopsis¶

  describe-storage-system-resource-metrics
--discovery-job-arn <value>
--resource-type <value>
--resource-id <value>
[--start-time <value>]
[--end-time <value>]
[--cli-input-json <value>]
[--starting-token <value>]
[--page-size <value>]
[--max-items <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]

Options¶

--discovery-job-arn (string)

Specifies the Amazon Resource Name (ARN) of the discovery job that collects information about your on-premises storage system.

--resource-type (string)

Specifies the kind of storage system resource that you want information about.

Possible values:

SVM

VOLUME

CLUSTER

--resource-id (string)

Specifies the universally unique identifier (UUID) of the storage system resource that you want information about.

--start-time (timestamp)

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 .

--end-time (timestamp)

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 .

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--starting-token (string)

A token to specify where to start paginating. This is the NextToken from a previously truncated response.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--page-size (integer)

The size of each page to get in the AWS service call. This does not affect the number of items returned in the command's output. Setting a smaller page size results in more calls to the AWS service, retrieving fewer items in each call. This can help prevent the AWS service calls from timing out.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--max-items (integer)

The total number of items to return in the command's output. If the total number of items available is more than the value specified, a NextToken is provided in the command's output. To resume pagination, provide the NextToken value in the starting-token argument of a subsequent command. Do not use the NextToken response element directly outside of the AWS CLI.

For usage examples, see Pagination in the AWS Command Line Interface User Guide .

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

Global Options¶

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command's default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

json
text
table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

on
off
auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

Output¶

Metrics -> (list)

The details that your discovery job collected about your storage system resource.

(structure)

Information, including performance data and capacity usage, provided by DataSync Discovery about a resource in your on-premises storage system.

Timestamp -> (timestamp)

The time when DataSync Discovery collected this information from the resource.

P95Metrics -> (structure)

The types of performance data that DataSync Discovery collects about the on-premises storage system resource.

IOPS -> (structure)

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 -> (double)

Peak IOPS related to read operations.

Write -> (double)

Peak IOPS related to write operations.

Other -> (double)

Peak IOPS unrelated to read and write operations.

Total -> (double)

Peak total IOPS on your on-premises storage system resource.

Throughput -> (structure)

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 -> (double)

Peak throughput related to read operations.

Write -> (double)

Peak throughput related to write operations.

Other -> (double)

Peak throughput unrelated to read and write operations.

Total -> (double)

Peak total throughput on your on-premises storage system resource.

Latency -> (structure)

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 -> (double)

Peak latency for read operations.

Write -> (double)

Peak latency for write operations.

Other -> (double)

Peak latency for operations unrelated to read and write operations.

Capacity -> (structure)

The storage capacity of the on-premises storage system resource.

Used -> (long)

The amount of space that's being used in a storage system resource.

Provisioned -> (long)

The total amount of space available in a storage system resource.

LogicalUsed -> (long)

The amount of space that's being used in a storage system resource without accounting for compression or deduplication.

ClusterCloudStorageUsed -> (long)

The amount of space in the cluster that's in cloud storage (for example, if you're using data tiering).

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.

Table Of Contents

Feedback

User Guide