❤
npm
Sign UpSign In

@datafire/amazonaws_models_lex

5.0.0 • Public • Published

@datafire/amazonaws_models_lex

Client library for Amazon Lex Model Building Service

Installation and Usage

npm install --save @datafire/amazonaws_models_lex
let amazonaws_models_lex = require('@datafire/amazonaws_models_lex').create({
  accessKeyId: "",
  secretAccessKey: "",
  region: ""
});

amazonaws_models_lex.GetBots({}).then(data => {
  console.log(data);
});

Description

Amazon Lex Build-Time Actions

Amazon Lex is an AWS service for building conversational voice and text interfaces. Use these actions to create, update, and delete conversational bots for new and existing client applications.

Actions

GetBots

amazonaws_models_lex.GetBots({}, context)

Input

  • input object
    • maxResults string
    • nextToken string

Output

GetBotAliases

amazonaws_models_lex.GetBotAliases({
  "botName": ""
}, context)

Input

  • input object
    • maxResults string
    • nextToken string
    • botName required string

Output

GetBotChannelAssociations

amazonaws_models_lex.GetBotChannelAssociations({
  "botName": "",
  "aliasName": ""
}, context)

Input

  • input object
    • maxResults string
    • nextToken string
    • botName required string
    • aliasName required string

Output

DeleteBotChannelAssociation

amazonaws_models_lex.DeleteBotChannelAssociation({
  "name": "",
  "botName": "",
  "aliasName": ""
}, context)

Input

  • input object
    • name required string
    • botName required string
    • aliasName required string

Output

Output schema unknown

GetBotChannelAssociation

amazonaws_models_lex.GetBotChannelAssociation({
  "name": "",
  "botName": "",
  "aliasName": ""
}, context)

Input

  • input object
    • name required string
    • botName required string
    • aliasName required string

Output

DeleteBotAlias

amazonaws_models_lex.DeleteBotAlias({
  "name": "",
  "botName": ""
}, context)

Input

  • input object
    • name required string
    • botName required string

Output

Output schema unknown

GetBotAlias

amazonaws_models_lex.GetBotAlias({
  "name": "",
  "botName": ""
}, context)

Input

  • input object
    • name required string
    • botName required string

Output

PutBotAlias

amazonaws_models_lex.PutBotAlias({
  "name": "",
  "botName": "",
  "botVersion": ""
}, context)

Input

  • input object

Output

DeleteUtterances

amazonaws_models_lex.DeleteUtterances({
  "botName": "",
  "userId": ""
}, context)

Input

  • input object
    • botName required string
    • userId required string

Output

Output schema unknown

GetUtterancesView

amazonaws_models_lex.GetUtterancesView({
  "botname": ""
}, context)

Input

  • input object
    • botname required string

Output

DeleteBot

amazonaws_models_lex.DeleteBot({
  "name": ""
}, context)

Input

  • input object
    • name required string

Output

Output schema unknown

CreateBotVersion

amazonaws_models_lex.CreateBotVersion({
  "name": ""
}, context)

Input

  • input object
    • name required string
    • checksum String

Output

Output schema unknown

GetBotVersions

amazonaws_models_lex.GetBotVersions({
  "name": ""
}, context)

Input

  • input object
    • maxResults string
    • nextToken string
    • name required string

Output

PutBot

amazonaws_models_lex.PutBot({
  "name": "",
  "locale": "",
  "childDirected": true
}, context)

Input

Output

GetBot

amazonaws_models_lex.GetBot({
  "name": "",
  "versionoralias": ""
}, context)

Input

  • input object
    • name required string
    • versionoralias required string

Output

DeleteBotVersion

amazonaws_models_lex.DeleteBotVersion({
  "name": "",
  "version": ""
}, context)

Input

  • input object
    • name required string
    • version required string

Output

Output schema unknown

GetBuiltinIntents

amazonaws_models_lex.GetBuiltinIntents({}, context)

Input

  • input object
    • maxResults string
    • nextToken string

Output

GetBuiltinIntent

amazonaws_models_lex.GetBuiltinIntent({
  "signature": ""
}, context)

Input

  • input object
    • signature required string

Output

GetBuiltinSlotTypes

amazonaws_models_lex.GetBuiltinSlotTypes({}, context)

Input

  • input object
    • maxResults string
    • nextToken string

Output

GetExport

amazonaws_models_lex.GetExport({}, context)

Input

  • input object

Output

StartImport

amazonaws_models_lex.StartImport({
  "payload": "",
  "resourceType": "",
  "mergeStrategy": ""
}, context)

Input

Output

Output schema unknown

GetImport

amazonaws_models_lex.GetImport({
  "importId": ""
}, context)

Input

  • input object
    • importId required string

Output

GetIntents

amazonaws_models_lex.GetIntents({}, context)

Input

  • input object
    • maxResults string
    • nextToken string

Output

DeleteIntent

amazonaws_models_lex.DeleteIntent({
  "name": ""
}, context)

Input

  • input object
    • name required string

Output

Output schema unknown

CreateIntentVersion

amazonaws_models_lex.CreateIntentVersion({
  "name": ""
}, context)

Input

  • input object
    • name required string
    • checksum String

Output

Output schema unknown

GetIntentVersions

amazonaws_models_lex.GetIntentVersions({
  "name": ""
}, context)

Input

  • input object
    • maxResults string
    • nextToken string
    • name required string

Output

PutIntent

amazonaws_models_lex.PutIntent({
  "name": ""
}, context)

Input

Output

DeleteIntentVersion

amazonaws_models_lex.DeleteIntentVersion({
  "name": "",
  "version": ""
}, context)

Input

  • input object
    • name required string
    • version required string

Output

Output schema unknown

GetIntent

amazonaws_models_lex.GetIntent({
  "name": "",
  "version": ""
}, context)

Input

  • input object
    • name required string
    • version required string

Output

GetSlotTypes

amazonaws_models_lex.GetSlotTypes({}, context)

Input

  • input object
    • maxResults string
    • nextToken string

Output

DeleteSlotType

amazonaws_models_lex.DeleteSlotType({
  "name": ""
}, context)

Input

  • input object
    • name required string

Output

Output schema unknown

DeleteSlotTypeVersion

amazonaws_models_lex.DeleteSlotTypeVersion({
  "name": "",
  "version": ""
}, context)

Input

  • input object
    • name required string
    • version required string

Output

Output schema unknown

CreateSlotTypeVersion

amazonaws_models_lex.CreateSlotTypeVersion({
  "name": ""
}, context)

Input

  • input object
    • name required string
    • checksum String

Output

Output schema unknown

GetSlotTypeVersions

amazonaws_models_lex.GetSlotTypeVersions({
  "name": ""
}, context)

Input

  • input object
    • maxResults string
    • nextToken string
    • name required string

Output

PutSlotType

amazonaws_models_lex.PutSlotType({
  "name": ""
}, context)

Input

Output

GetSlotType

amazonaws_models_lex.GetSlotType({
  "name": "",
  "version": ""
}, context)

Input

  • input object
    • name required string
    • version required string

Output

Definitions

AliasName

  • AliasName string

AliasNameOrListAll

  • AliasNameOrListAll string

BadRequestException

  • BadRequestException object: The request is not well formed. For example, a value is invalid or a required field is missing. Check the field values, and try again.

Blob

  • Blob string

Boolean

  • Boolean boolean

BotAliasMetadata

BotAliasMetadataList

BotChannelAssociation

BotChannelAssociationList

BotChannelName

  • BotChannelName string

BotMetadata

BotMetadataList

BotName

  • BotName string

BotVersions

BuiltinIntentMetadata

BuiltinIntentMetadataList

BuiltinIntentSignature

  • BuiltinIntentSignature string

BuiltinIntentSlot

  • BuiltinIntentSlot object: Provides information about a slot used in a built-in intent.

BuiltinIntentSlotList

BuiltinSlotTypeMetadata

BuiltinSlotTypeMetadataList

BuiltinSlotTypeSignature

  • BuiltinSlotTypeSignature string

ChannelConfigurationMap

  • ChannelConfigurationMap array

ChannelStatus

  • ChannelStatus string (values: IN_PROGRESS, CREATED, FAILED)

ChannelType

  • ChannelType string (values: Facebook, Slack, Twilio-Sms, Kik)

CodeHook

  • CodeHook object: Specifies a Lambda function that verifies requests to a bot or fulfills the user's request to a bot..

ConflictException

  • ConflictException object: There was a conflict processing the request. Try your request again.

ContentString

  • ContentString string

ContentType

  • ContentType string (values: PlainText, SSML, CustomPayload)

Count

  • Count integer

CreateBotVersionRequest

  • CreateBotVersionRequest object

CreateBotVersionResponse

CreateIntentVersionRequest

  • CreateIntentVersionRequest object

CreateIntentVersionResponse

CreateSlotTypeVersionRequest

  • CreateSlotTypeVersionRequest object

CreateSlotTypeVersionResponse

CustomOrBuiltinSlotTypeName

  • CustomOrBuiltinSlotTypeName string

DeleteBotAliasRequest

  • DeleteBotAliasRequest object

DeleteBotChannelAssociationRequest

  • DeleteBotChannelAssociationRequest object

DeleteBotRequest

  • DeleteBotRequest object

DeleteBotVersionRequest

  • DeleteBotVersionRequest object

DeleteIntentRequest

  • DeleteIntentRequest object

DeleteIntentVersionRequest

  • DeleteIntentVersionRequest object

DeleteSlotTypeRequest

  • DeleteSlotTypeRequest object

DeleteSlotTypeVersionRequest

  • DeleteSlotTypeVersionRequest object

DeleteUtterancesRequest

  • DeleteUtterancesRequest object

Description

  • Description string

EnumerationValue

  • EnumerationValue object:

    Each slot type can have a set of values. Each enumeration value represents a value the slot type can take.

    For example, a pizza ordering bot could have a slot type that specifies the type of crust that the pizza should have. The slot type could include the values

    • thick

    • thin

    • stuffed

EnumerationValues

ExportStatus

  • ExportStatus string (values: IN_PROGRESS, READY, FAILED)

ExportType

  • ExportType string (values: ALEXA_SKILLS_KIT, LEX)

FollowUpPrompt

  • FollowUpPrompt object: A prompt for additional activity after an intent is fulfilled. For example, after the OrderPizza intent is fulfilled, you might prompt the user to find out whether the user wants to order drinks.

FulfillmentActivity

  • FulfillmentActivity object:

    Describes how the intent is fulfilled after the user provides all of the information required for the intent. You can provide a Lambda function to process the intent, or you can return the intent information to the client application. We recommend that you use a Lambda function so that the relevant logic lives in the Cloud and limit the client-side code primarily to presentation. If you need to update the logic, you only update the Lambda function; you don't need to upgrade your client application.

    Consider the following examples:

    • In a pizza ordering application, after the user provides all of the information for placing an order, you use a Lambda function to place an order with a pizzeria.

    • In a gaming application, when a user says "pick up a rock," this information must go back to the client application so that it can perform the operation and update the graphics. In this case, you want Amazon Lex to return the intent data to the client.

FulfillmentActivityType

  • FulfillmentActivityType string (values: ReturnIntent, CodeHook)

GetBotAliasRequest

  • GetBotAliasRequest object

GetBotAliasResponse

GetBotAliasesRequest

  • GetBotAliasesRequest object

GetBotAliasesResponse

GetBotChannelAssociationRequest

  • GetBotChannelAssociationRequest object

GetBotChannelAssociationResponse

GetBotChannelAssociationsRequest

  • GetBotChannelAssociationsRequest object

GetBotChannelAssociationsResponse

GetBotRequest

  • GetBotRequest object

GetBotResponse

GetBotVersionsRequest

  • GetBotVersionsRequest object

GetBotVersionsResponse

GetBotsRequest

  • GetBotsRequest object

GetBotsResponse

GetBuiltinIntentRequest

  • GetBuiltinIntentRequest object

GetBuiltinIntentResponse

GetBuiltinIntentsRequest

  • GetBuiltinIntentsRequest object

GetBuiltinIntentsResponse

GetBuiltinSlotTypesRequest

  • GetBuiltinSlotTypesRequest object

GetBuiltinSlotTypesResponse

GetExportRequest

  • GetExportRequest object

GetExportResponse

GetImportRequest

  • GetImportRequest object

GetImportResponse

GetIntentRequest

  • GetIntentRequest object

GetIntentResponse

GetIntentVersionsRequest

  • GetIntentVersionsRequest object

GetIntentVersionsResponse

GetIntentsRequest

  • GetIntentsRequest object

GetIntentsResponse

GetSlotTypeRequest

  • GetSlotTypeRequest object

GetSlotTypeResponse

GetSlotTypeVersionsRequest

  • GetSlotTypeVersionsRequest object

GetSlotTypeVersionsResponse

GetSlotTypesRequest

  • GetSlotTypesRequest object

GetSlotTypesResponse

GetUtterancesViewRequest

  • GetUtterancesViewRequest object

GetUtterancesViewResponse

GroupNumber

  • GroupNumber integer

ImportStatus

  • ImportStatus string (values: IN_PROGRESS, COMPLETE, FAILED)

Intent

  • Intent object: Identifies the specific version of an intent.

IntentList

  • IntentList array

IntentMetadata

IntentMetadataList

IntentName

  • IntentName string

IntentUtteranceList

InternalFailureException

  • InternalFailureException object: An internal Amazon Lex error occurred. Try your request again.

LambdaARN

  • LambdaARN string

LimitExceededException

  • LimitExceededException object: The request exceeded a limit. Try your request again.

ListOfUtterance

ListsOfUtterances

Locale

  • Locale string (values: en-US, en-GB, de-DE)

LocaleList

  • LocaleList array

MaxResults

  • MaxResults integer

MergeStrategy

  • MergeStrategy string (values: OVERWRITE_LATEST, FAIL_ON_CONFLICT)

Message

MessageList

MessageVersion

  • MessageVersion string

Name

  • Name string

NextToken

  • NextToken string

NotFoundException

  • NotFoundException object: The resource specified in the request was not found. Check the resource and try again.

NumericalVersion

  • NumericalVersion string

PreconditionFailedException

  • PreconditionFailedException object: The checksum of the resource that you are trying to change does not match the checksum in the request. Check the resource's checksum and try again.

Priority

  • Priority integer

ProcessBehavior

  • ProcessBehavior string (values: SAVE, BUILD)

Prompt

  • Prompt object: Obtains information from the user. To define a prompt, provide one or more messages and specify the number of attempts to get information from the user. If you provide more than one message, Amazon Lex chooses one of the messages to use to prompt the user. For more information, see how-it-works.

PromptMaxAttempts

  • PromptMaxAttempts integer

PutBotAliasRequest

PutBotAliasResponse

PutBotRequest

PutBotResponse

PutIntentRequest

PutIntentResponse

PutSlotTypeRequest

PutSlotTypeResponse

ReferenceType

  • ReferenceType string (values: Intent, Bot, BotAlias, BotChannel)

ResourceInUseException

  • ResourceInUseException object:

    The resource that you are attempting to delete is referred to by another resource. Use this information to remove references to the resource that you are trying to delete.

    The body of the exception contains a JSON object that describes the resource.

    { "resourceType": BOT | BOTALIAS | BOTCHANNEL | INTENT,

    "resourceReference": {

    "name": string, "version": string } }

ResourceReference

  • ResourceReference object: Describes the resource that refers to the resource that you are attempting to delete. This object is returned as part of the ResourceInUseException exception.

ResourceType

  • ResourceType string (values: BOT, INTENT, SLOT_TYPE)

ResponseCard

  • ResponseCard string

SessionTTL

  • SessionTTL integer

Slot

SlotConstraint

  • SlotConstraint string (values: Required, Optional)

SlotList

  • SlotList array

SlotName

  • SlotName string

SlotTypeMetadata

SlotTypeMetadataList

SlotTypeName

  • SlotTypeName string

SlotUtteranceList

SlotValueSelectionStrategy

  • SlotValueSelectionStrategy string (values: ORIGINAL_VALUE, TOP_RESOLUTION)

StartImportRequest

StartImportResponse

Statement

  • Statement object: A collection of messages that convey information to the user. At runtime, Amazon Lex selects the message to convey.

Status

  • Status string (values: BUILDING, READY, FAILED, NOT_BUILT)

StatusType

  • StatusType string (values: Detected, Missed)

String

  • String string

StringList

  • StringList array

SynonymList

  • SynonymList array

Timestamp

  • Timestamp string

UserId

  • UserId string

Utterance

  • Utterance string

UtteranceData

UtteranceList

  • UtteranceList object: Provides a list of utterances that have been made to a specific version of your bot. The list contains a maximum of 100 utterances.

UtteranceString

  • UtteranceString string

Value

  • Value string

Version

  • Version string

Readme

Keywords

none

Package Sidebar

Install

npm i @datafire/amazonaws_models_lex

Repository

github.com/DataFire/integrations

Homepage

github.com/DataFire/integrations#readme

Weekly Downloads

0

Version

5.0.0

License

MIT

Unpacked Size

266 kB

Total Files

5

Last publish

Collaborators

  • datafire
Try on RunKit
Report malware