View a markdown version of this page

ContextContent - AWS Well-Architected

ContextContent

Typed content structure for a context. Contains application-specific fields that describe the environment used during recommendation generation.

Contents

accountIds

The AWS account IDs associated with this application context.

Type: Array of strings

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

Length Constraints: Fixed length of 12.

Pattern: \d{12}

Required: No

additionalContext

Additional context not captured by other fields.

Type: String

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

Pattern: (?:(?!\$\{[a-zA-Z]+:)[\P{C}\r\n])*

Required: No

applicationOverview

A free-form overview of the application.

Type: String

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

Pattern: (?:(?!\$\{[a-zA-Z]+:)[\P{C}\r\n])*

Required: No

applicationType

The type of the application.

Type: String

Valid Values: SAS | DESKTOP_APPLICATION | OTHER

Required: No

architectureOverview

A free-form description of the application architecture.

Type: String

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

Pattern: (?:(?!\$\{[a-zA-Z]+:)[\P{C}\r\n])*

Required: No

awsServices

The AWS services used by this application.

Type: Array of strings

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

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

Pattern: [\P{C}]+

Required: No

criticality

The business criticality of the application.

Type: String

Valid Values: MISSION_CRITICAL | BUSINESS_CRITICAL | NON_CRITICAL | TEST_DEVELOPMENT

Required: No

industry

The industry vertical for this application.

Type: String

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

Pattern: (?:(?!\$\{[a-zA-Z]+:)[\P{C}\r\n])*

Required: No

organizationalUnitIds

The AWS Organizations organizational unit (OU) IDs associated with this application context. Valid only for organizational profiles; rejected for standard profiles.

Type: Array of strings

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

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

Pattern: (ou-[a-z0-9]{4,32}-[a-z0-9]{8,32}|r-[a-z0-9]{4,32})

Required: No

regions

The AWS Regions where this application operates.

Type: Array of strings

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

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

Pattern: [a-z]{2}(-gov)?-[a-z]+-\d+

Required: No

resourceTags

Resource tags used to scope this application context.

Type: Array of ContextResourceTag objects

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

Required: No

resourceTypes

The AWS resource types relevant to this application.

Type: Array of strings

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

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

Pattern: [\P{C}]+

Required: No

See Also

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