CloudWatchLogs / Client / describe_deliveries - missing fields in response

[RhysRedbearIT]

Describe the issue

https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/logs/client/describe_deliveries.html

Documentation shows 9 fields that should exist in the response in the deliveries list. We only get 4.

Is this a documentation mistake? Are these fields considered optional or only shown if special? Our test is an S3 output, but no deliveryDestinationType in the response, and no s3DeliveryConfiguration even though we have it set.

Example in documentation:

'deliveries': [
        {
            'id': 'string',
            'arn': 'string',
            'deliverySourceName': 'string',
            'deliveryDestinationArn': 'string',
            'deliveryDestinationType': 'S3'|'CWL'|'FH'|'XRAY',
            'recordFields': [
                'string',
            ],
            'fieldDelimiter': 'string',
            's3DeliveryConfiguration': {
                'suffixPath': 'string',
                'enableHiveCompatiblePath': True|False
            },
            'tags': {
                'string': 'string'
            }
        },

Python response:

'deliveries': [
    {
        'id': 'xx',
        'arn': 'arn:aws:logs:us-east-1:xx:delivery:xx',
        'deliverySourceName': 'CreatedByCloudFront-xx',
        'deliveryDestinationArn': 'arn:aws:logs:us-east-1:xx:delivery-destination:rbit-cloudfront-s3-destination-xx'
    },

Links

https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/logs/client/describe_deliveries.html

[RhysRedbearIT]

After a long struggle with Postman and AWS API (these are not well documented to use together), I've managed to get the raw data from the API for this call. This is the JSON response to https://logs.us-east-1.amazonaws.com/ Logs_20140328.DescribeDeliveries

{ "deliveries": [ { "arn": "arn:aws:logs:us-east-1:xx:delivery:xx", "deliveryDestinationArn": "arn:aws:logs:us-east-1:xx:delivery-destination:xx", "deliverySourceName": "CreatedByCloudFront-xx", "id": "xx" }, { "arn": "arn:aws:logs:us-east-1:xx:delivery:xx", "deliveryDestinationArn": "arn:aws:logs:us-east-1:xx:delivery-destination:xx", "deliverySourceName": "rbit-cloudfront-xx", "id": "xx" }, { "arn": "arn:aws:logs:us-east-1:xx:delivery:xx", "deliveryDestinationArn": "arn:aws:logs:us-east-1:xx:delivery-destination:xx", "deliverySourceName": "rbit-cloudfront-xx", "id": "xx" } ] }

https://docs.aws.amazon.com/AmazonCloudWatchLogs/latest/APIReference/API_DescribeDeliveries.html

This looks to me to be more likely an API bug rather than Boto3 ?

[RyanFitzSimmonsAK]

Hi @RhysRedbearIT, thanks for reaching out. The service team is aware that DescribeDeliveries only returns minimal information. Users are intended to use GetDelivery when more detail is required.

Regarding the documentation, this is a common nuance of AWS documentation in general. When an operation returns a structure (in this case, Delivery), the documentation is rendered as if the operation returns every parameter of that structure. This happens because the structure is reused across several other operations that might use that parameter. Please let me know if you have any follow-up questions.

[RhysRedbearIT]

Hey @RyanFitzSimmonsAK , yes we're looking at moving to GetDelivery for further information now.

However I'd say since this function (and the API) doesn't return the documented response, the documentation is incorrect and should be updated.

This is the actual reference documentation for the function (and API), and it says we should get that data back and we don't. If it never provides it, it can't be in the documentation.

[RyanFitzSimmonsAK]

However I'd say since this function (and the API) doesn't return the documented response, the documentation is incorrect and should be updated.

I'd definitely agree, but unfortunately this isn't something the Boto3 team is able to change; it's a technical limitation. Other operations with this issue often get around this by including this information in parameter documentation, examples, or a note. I can check about documenting it in one of those ways, but unfortunately, we can't change the Response Syntax.