View a markdown version of this page

AgentSummary - Amazon Quick Sight
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).

AgentSummary

A summary of an agent, including its identifier, name, and metadata.

Contents

Note

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

AgentId

The unique identifier for the agent.

Type: String

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

Pattern: [0-9a-zA-Z-_.+]+

Required: Yes

Arn

The Amazon Resource Name (ARN) of the agent.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1284.

Pattern: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}

Required: Yes

CreatedAt

The date and time that the agent was created.

Type: Timestamp

Required: Yes

Name

The name of the agent.

Type: String

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

Pattern: (?!\s*$).+

Required: Yes

UpdatedAt

The date and time that the agent was last updated.

Type: Timestamp

Required: Yes

Description

A description of the agent.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 1000.

Pattern: \P{C}*

Required: No

IconId

The icon identifier for the agent.

Type: String

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

Required: No

See Also

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