Try it now and let us know what you think. Switch to the new look >>
You can return to the original look by selecting English in the language selector above.
GetInvitationConfiguration
Retrieves the configured values for the user enrollment invitation email template.
Response Syntax
{ "ContactEmail": "string", "OrganizationName": "string", "PrivateSkillIds": [ "string" ] }
Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- ContactEmail
-
The email ID of the organization or individual contact that the enrolled user can use.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 128.
Pattern:
([0-9a-zA-Z]([+-.\w]*[0-9a-zA-Z])*@([0-9a-zA-Z][-\w]*[0-9a-zA-Z]\.)+[a-zA-Z]{2,9}) - OrganizationName
-
The name of the organization sending the enrollment invite to a user.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Pattern:
[\u0009\u000A\u000D\u0020-\u007E\u0085\u00A0-\uD7FF\uE000-\uFFFD\u10000-\u10FFFF]* - PrivateSkillIds
-
The list of private skill IDs that you want to recommend to the user to enable in the invitation.
Type: Array of strings
Array Members: Minimum number of 0 items. Maximum number of 3 items.
Pattern:
(^amzn1\.ask\.skill\.[0-9a-f\-]{1,200})|(^amzn1\.echo-sdk-ams\.app\.[0-9a-f\-]{1,200})
Errors
For information about the errors that are common to all actions, see Common Errors.
- NotFoundException
-
The resource is not found.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
