cloudwatch.Metric.put_data() docs inaccurate or incomplete?

I was looking at how to use the Metric resource in the cloudwatch namespace, and I was surprised to see that its put_data method doesn’t accept any arguments, according to the docs. I expect that this is a mistake, since the seemingly analogous put_metric_data client method does mention parameters in its docs. In fact, the two functions’ docstrings are identical, except that put_metric_data has **kwargs in its signature, and the example request reflects the required parameters.

I’m about to test this out, so I guess I’ll find out if I understand this right. 😃 Unfortunately, since boto3 is very meta-programmed, it’s very difficult for me to figure out how to call this function simply by looking at the source code.

[choughton85]

@brettdh, @boolafish, and @joguSD Here’s a code snippet I used:

import boto3
import datetime

cloudwatch = boto3.resource('cloudwatch')
metric = cloudwatch.Metric('Namespace', 'MetricName')
metric.put_data(
    Namespace=metric.namespace,
    MetricData=[
        {
            'MetricName': metric.metric_name,
            'Timestamp': datetime.datetime.utcnow(),
            'Value': 1,
            'Unit': 'None',
            'Dimensions': [
                {'Name': 'Environment',
                 'Value': 'dev'
                 }
            ]
        }
    ]
)

I think it pulls most of the structure directly from the API docs: https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_PutMetricData.html

[swetashre]

@choughton85 - Yes you are right. It pulls most of the structure directly from API docs. Boto3 resource documentation is definitely lacking all these parameter. We should update our documentation.

I would mark this as documentation and see what can i do to update the documentation.