Select your cookie preferences

We use cookies and similar tools to enhance your experience, provide our services, deliver relevant advertising, and make improvements. Approved third parties also use these tools to help us deliver advertising and provide certain site features.

get_resource_metadata

get_resource_metadata(**kwargs)

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

Request Syntax

response = client.get_resource_metadata(
    ServiceType='RDS'|'DOCDB',
    Identifier='string'
)
Parameters
  • ServiceType (string) --

    [REQUIRED]

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

  • Identifier (string) --

    [REQUIRED]

    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 .

Return type

dict

Returns

Response Syntax

{
    'Identifier': 'string',
    'Features': {
        'string': {
            'Status': 'ENABLED'|'DISABLED'|'UNSUPPORTED'|'ENABLED_PENDING_REBOOT'|'DISABLED_PENDING_REBOOT'|'UNKNOWN'
        }
    }
}

Response Structure

  • (dict) --

    • 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 (dict) --

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

      • (string) --

        • (dict) --

          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.

Exceptions

  • PI.Client.exceptions.InvalidArgumentException
  • PI.Client.exceptions.InternalServiceError
  • PI.Client.exceptions.NotAuthorizedException