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.
SendInvitation
Sends an enrollment invitation email with a URL to a user. The URL is valid for 30 days or until you call this operation again, whichever comes first.
Request Syntax
{ "UserArn": "string" }
Request Parameters
For information about the parameters that are common to all actions, see Common Parameters.
The request accepts the following data in JSON format.
- UserArn
-
The ARN of the user to whom to send an invitation. Required.
Type: String
Pattern:
arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}Required: No
Response Elements
If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body.
Errors
For information about the errors that are common to all actions, see Common Errors.
- ConcurrentModificationException
-
There is a concurrent modification of resources.
HTTP Status Code: 400
- InvalidUserStatusException
-
The attempt to update a user is invalid due to the user's current status.
HTTP Status Code: 400
- 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:
