SheetImage - Amazon QuickSight
Services or capabilities described in Amazon Web Services documentation might vary by Region. To see the differences applicable to the China Regions, see Getting Started with Amazon Web Services in China (PDF).

SheetImage

An image that is located on a sheet.

Contents

Note

In the following list, the required parameters are described first.

SheetImageId

The ID of the sheet image.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 512.

Pattern: [\w\-]+

Required: Yes

Source

The source of the image.

Type: SheetImageSource object

Required: Yes

Actions

A list of custom actions that are configured for an image.

Type: Array of ImageCustomAction objects

Array Members: Minimum number of 0 items. Maximum number of 10 items.

Required: No

ImageContentAltText

The alt text for the image.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Required: No

Interactions

The general image interactions setup for an image.

Type: ImageInteractionOptions object

Required: No

Scaling

Determines how the image is scaled.

Type: SheetImageScalingConfiguration object

Required: No

Tooltip

The tooltip to be shown when hovering over the image.

Type: SheetImageTooltipConfiguration object

Required: No

See Also

For more information about using this API in one of the language-specific Amazon SDKs, see the following: