v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1442228254.5 KB

Returns information about an intent. In addition to the intent name, you must specify the intent version.

This operation requires permissions to perform the lex:GetIntent action.

get/intents/{name}/versions/{version}

Path parameters

namestring required

The name of the intent. The name is case sensitive.

versionstring required

The version of the intent.

Response

Success

namestring

The name of the intent.

descriptionstring

A description of the intent.

sampleUtterancesUtterance[]

An array of sample utterances configured for the intent.

parentIntentSignaturestring

A unique identifier for a built-in intent.

lastUpdatedDatestring date-time

The date that the intent was updated. When you create a resource, the creation date and the last updated date are the same.

createdDatestring date-time

The date that the intent was created.

versionstring

The version of the intent.

checksumstring

Checksum of the intent.

Example response

{
  "version": "$LATEST",
  "name": "DocOrderPizza",
  "checksum": "ca9bc13d-afc8-4706-bbaf-091f7a5935d6",
  "conclusionStatement": {
    "messages": [
      {
        "content": "All right, I ordered  you a {Crust} crust {Type} pizza with {Sauce} sauce.",
        "contentType": "PlainText"
      },
      {
        "content": "OK, your {Crust} crust {Type} pizza with {Sauce} sauce is on the way.",
        "contentType": "PlainText"
      }
    ],
    "responseCard": "foo"
  },
  "confirmationPrompt": {
    "maxAttempts": 1,
    "messages": [
      {
        "content": "Should I order  your {Crust} crust {Type} pizza with {Sauce} sauce?",
        "contentType": "PlainText"
      }
    ]
  },
  "createdDate": 1494359783.453,
  "description": "Order a pizza from a local pizzeria.",
  "fulfillmentActivity": {
    "type": "ReturnIntent"
  },
  "lastUpdatedDate": 1494359783.453,
  "rejectionStatement": {
    "messages": [
      {
        "content": "Ok, I'll cancel your order.",
        "contentType": "PlainText"
      },
      {
        "content": "I cancelled your order.",
        "contentType": "PlainText"
      }
    ]
  },
  "sampleUtterances": [
    "Order me a pizza.",
    "Order me a {Type} pizza.",
    "I want a {Crust} crust {Type} pizza",
    "I want a {Crust} crust {Type} pizza with {Sauce} sauce."
  ],
  "slots": [
    {
      "name": "Type",
      "description": "The type of pizza to order.",
      "priority": 1,
      "sampleUtterances": [
        "Get me a {Type} pizza.",
        "A {Type} pizza please.",
        "I'd like a {Type} pizza."
      ],
      "slotConstraint": "Required",
      "slotType": "DocPizzaType",
      "slotTypeVersion": "$LATEST",
      "valueElicitationPrompt": {
        "maxAttempts": 1,
        "messages": [
          {
            "content": "What type of pizza would you like?",
            "contentType": "PlainText"
          },
          {
            "content": "Vegie or cheese pizza?",
            "contentType": "PlainText"
          },
          {
            "content": "I can get you a vegie or a cheese pizza.",
            "contentType": "PlainText"
          }
        ]
      }
    },
    {
      "name": "Crust",
      "description": "The type of pizza crust to order.",
      "priority": 2,
      "sampleUtterances": [
        "Make it a {Crust} crust.",
        "I'd like a {Crust} crust."
      ],
      "slotConstraint": "Required",
      "slotType": "DocPizzaCrustType",
      "slotTypeVersion": "$LATEST",
      "valueElicitationPrompt": {
        "maxAttempts": 1,
        "messages": [
          {
            "content": "What type of crust would you like?",
            "contentType": "PlainText"
          },
          {
            "content": "Thick or thin crust?",
            "contentType": "PlainText"
          }
        ]
      }
    },
    {
      "name": "Sauce",
      "description": "The type of sauce to use on the pizza.",
      "priority": 3,
      "sampleUtterances": [
        "Make it {Sauce} sauce.",
        "I'd like {Sauce} sauce."
      ],
      "slotConstraint": "Required",
      "slotType": "DocPizzaSauceType",
      "slotTypeVersion": "$LATEST",
      "valueElicitationPrompt": {
        "maxAttempts": 1,
        "messages": [
          {
            "content": "White or red sauce?",
            "contentType": "PlainText"
          },
          {
            "content": "Garlic or tomato sauce?",
            "contentType": "PlainText"
          }
        ]
      }
    }
  ]
}