Aws-sdk-js: pinpoint listTemplates method is not returning all documented fields

Created on 6 Dec 2019  ยท  7Comments  ยท  Source: aws/aws-sdk-js

Confirm by changing [ ] to [x] below to ensure that it's a bug:

Describe the bug
According to the pinpoint.listTemplates description in the docs it should return the following fields

Arn โ€” (String)
The Amazon Resource Name (ARN) of the message template.

CreationDate โ€” required โ€” (String)
The date when the message template was created.

DefaultSubstitutions โ€” (String)
The JSON object that specifies the default values that are used for message variables in the message template. This object is a set of key-value pairs. Each key defines a message variable in the template. The corresponding value defines the default value for that variable.

LastModifiedDate โ€” required โ€” (String)
The date when the message template was last modified.

tags โ€” (map<String>)
A string-to-string map of key-value pairs that identifies the tags that are associated with the message template. Each tag consists of a required tag key and an associated tag value.

TemplateDescription โ€” (String)
The custom description of the message template.

TemplateName โ€” required โ€” (String)
The name of the message template.

TemplateType โ€” required โ€” (String)
The type of channel that the message template is designed for.

Possible values include:
"EMAIL"
"SMS"
"VOICE"
"PUSH"

But in fact this method only returns:

CreationDate, LastModifiedDate, TemplateName, TemplateType

Is the issue in the browser/Node.js?
Node.js

If on Node.js, are you running this on AWS Lambda?
Yes

Details of the browser/Node.js version
12.x

SDK version number
Example: v2.466.0

  • For browsers, the SDK version number is in the script tag
    src=".../aws-sdk-2.466.0.min.js"
  • For Node.js, get SDK version by

    • running command npm list aws-sdk from your root directory

    • printing the output of AWS.VERSION in your code where AWS = require("aws-sdk");

v2.585.0

To Reproduce (observed behavior)
Steps to reproduce the behavior (please share code or minimal repo)

Run:

pinpoint.listTemplates()

Expected behavior
The request should return all documented fields

Screenshots
If applicable, add screenshots to help explain your problem.

Additional context
Add any other context about the problem here.

documentation service-api

Most helpful comment

@ajredniwja same thing needed here. need the tags!

All 7 comments

Hey @microapps-machine-user,

Thank-you for reaching out to us about the issue, I can reach out to the documentation and service teams to make the updates.

we actually need tags and TemplateDescription in the listTemplates call. Will it be implemented or the documentation is incorrect?

@microapps-machine-user I have reached out to both the teams, and will update you once I have feedback from them.

@ajredniwja hi, is there any update on this? Will those props be added to the api or this is just a documentation issue and we should not expect them?

@ajredniwja same thing needed here. need the tags!

Would need service team to audit this and make the changes, pinging them again.

Hi @ajredniwja any update on this issue? Having tags in pinpoint.listTemplates() would really simplify our lives.

Was this page helpful?
0 / 5 - 0 ratings