interface ImageResponseCardProperty

Language	Type name
.NET	`Amazon.CDK.AWS.Lex.CfnBot.ImageResponseCardProperty`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awslex#CfnBot_ImageResponseCardProperty`
Java	`software.amazon.awscdk.services.lex.CfnBot.ImageResponseCardProperty`
Python	`aws_cdk.aws_lex.CfnBot.ImageResponseCardProperty`
TypeScript	`aws-cdk-lib` » `aws_lex` » `CfnBot` » `ImageResponseCardProperty`

A card that is shown to the user by a messaging platform.

You define the contents of the card, the card is displayed by the platform.

When you use a response card, the response from the user is constrained to the text associated with a button on the card.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_lex as lex } from 'aws-cdk-lib';
const imageResponseCardProperty: lex.CfnBot.ImageResponseCardProperty = {
  title: 'title',

  // the properties below are optional
  buttons: [{
    text: 'text',
    value: 'value',
  }],
  imageUrl: 'imageUrl',
  subtitle: 'subtitle',
};

Properties

Name	Type	Description
title	`string`	The title to display on the response card.
buttons?	`IResolvable` `\|` `IResolvable` `\|` `ButtonProperty[]`	A list of buttons that should be displayed on the response card.
imageUrl?	`string`	The URL of an image to display on the response card.
subtitle?	`string`	The subtitle to display on the response card.

title

Type: string

The title to display on the response card.

The format of the title is determined by the platform displaying the response card.

buttons?

Type: IResolvable | IResolvable | ButtonProperty[] (optional)

A list of buttons that should be displayed on the response card.

The arrangement of the buttons is determined by the platform that displays the button.

imageUrl?

Type: string (optional)

The URL of an image to display on the response card.

The image URL must be publicly available so that the platform displaying the response card has access to the image.

subtitle?

Type: string (optional)

The subtitle to display on the response card.

The format of the subtitle is determined by the platform displaying the response card.