Alexa For Business

2019/02/28 - Alexa For Business - 2 new api methods

Changes  This release adds the PutInvitationConfiguration API to configure the user invitation email template with custom attributes, and the GetInvitationConfiguration API to retrieve the configured values.

PutInvitationConfiguration (new) Link ¶

Configures the email template for the user enrollment invitation with the specified attributes.

See also: AWS API Documentation

Request Syntax

client.put_invitation_configuration(
    OrganizationName='string',
    ContactEmail='string',
    PrivateSkillIds=[
        'string',
    ]
)
type OrganizationName

string

param OrganizationName

[REQUIRED]

The name of the organization sending the enrollment invite to a user.

type ContactEmail

string

param ContactEmail

The email ID of the organization or individual contact that the enrolled user can use.

type PrivateSkillIds

list

param PrivateSkillIds

The list of private skill IDs that you want to recommend to the user to enable in the invitation.

  • (string) --

rtype

dict

returns

Response Syntax

{}

Response Structure

  • (dict) --

GetInvitationConfiguration (new) Link ¶

Retrieves the configured values for the user enrollment invitation email template.

See also: AWS API Documentation

Request Syntax

client.get_invitation_configuration()
rtype

dict

returns

Response Syntax

{
    'OrganizationName': 'string',
    'ContactEmail': 'string',
    'PrivateSkillIds': [
        'string',
    ]
}

Response Structure

  • (dict) --

    • OrganizationName (string) --

      The name of the organization sending the enrollment invite to a user.

    • ContactEmail (string) --

      The email ID of the organization or individual contact that the enrolled user can use.

    • PrivateSkillIds (list) --

      The list of private skill IDs that you want to recommend to the user to enable in the invitation.

      • (string) --