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 . pi ]

get-resource-metadata

Description

Retrieve the metadata for different features. For example, the metadata might indicate that a feature is turned on or off on a specific DB instance.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  get-resource-metadata
--service-type <value>
--identifier <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--service-type (string)

The Amazon Web Services service for which Performance Insights returns metrics.

Possible values:

  • RDS
  • DOCDB

--identifier (string)

An immutable identifier for a data source that is unique for an Amazon Web Services Region. Performance Insights gathers metrics from this data source. To use a DB instance as a data source, specify its DbiResourceId value. For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VW2X .

--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.

--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.

See 'aws help' for descriptions of global parameters.

Output

Identifier -> (string)

An immutable identifier for a data source that is unique for an Amazon Web Services Region. Performance Insights gathers metrics from this data source. To use a DB instance as a data source, specify its DbiResourceId value. For example, specify db-ABCDEFGHIJKLMNOPQRSTU1VW2X .

Features -> (map)

The metadata for different features. For example, the metadata might indicate that a feature is turned on or off on a specific DB instance.

key -> (string)

value -> (structure)

The metadata for a feature. For example, the metadata might indicate that a feature is turned on or off on a specific DB instance.

Status -> (string)

The status of the feature on the DB instance. Possible values include the following:

  • ENABLED - The feature is enabled on the instance.
  • DISABLED - The feature is disabled on the instance.
  • UNSUPPORTED - The feature isn't supported on the instance.
  • ENABLED_PENDING_REBOOT - The feature is enabled on the instance but requires a reboot to take effect.
  • DISABLED_PENDING_REBOOT - The feature is disabled on the instance but requires a reboot to take effect.
  • UNKNOWN - The feature status couldn't be determined.