{ "smithy": "2.0", "shapes": { "com.amazonaws.wellarchitected#AccessDeniedException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.wellarchitected#ExceptionMessage", "traits": { "smithy.api#clientOptional": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

User does not have sufficient access to perform this action.

", "smithy.api#error": "client", "smithy.api#httpError": 403 } }, "com.amazonaws.wellarchitected#AccountId": { "type": "string", "traits": { "smithy.api#pattern": "^\\d{12}$" } }, "com.amazonaws.wellarchitected#AccountJiraConfigurationInput": { "type": "structure", "members": { "IssueManagementStatus": { "target": "com.amazonaws.wellarchitected#AccountJiraIssueManagementStatus", "traits": { "smithy.api#documentation": "

Account-level: Jira issue management status.

" } }, "IssueManagementType": { "target": "com.amazonaws.wellarchitected#IssueManagementType", "traits": { "smithy.api#documentation": "

Account-level: Jira issue management type.

" } }, "JiraProjectKey": { "target": "com.amazonaws.wellarchitected#JiraProjectKey", "traits": { "smithy.api#documentation": "

Account-level: Jira project key to sync workloads to.

" } }, "IntegrationStatus": { "target": "com.amazonaws.wellarchitected#IntegrationStatusInput", "traits": { "smithy.api#documentation": "

Account-level: Configuration status of the Jira integration.

" } } }, "traits": { "smithy.api#documentation": "

Account-level: Input for the Jira configuration.

" } }, "com.amazonaws.wellarchitected#AccountJiraConfigurationOutput": { "type": "structure", "members": { "IntegrationStatus": { "target": "com.amazonaws.wellarchitected#IntegrationStatus", "traits": { "smithy.api#documentation": "

Account-level: Configuration status of the Jira integration.

" } }, "IssueManagementStatus": { "target": "com.amazonaws.wellarchitected#AccountJiraIssueManagementStatus", "traits": { "smithy.api#documentation": "

Account-level: Jira issue management status.

" } }, "IssueManagementType": { "target": "com.amazonaws.wellarchitected#IssueManagementType", "traits": { "smithy.api#documentation": "

Account-level: Jira issue management type.

" } }, "Subdomain": { "target": "com.amazonaws.wellarchitected#Subdomain", "traits": { "smithy.api#documentation": "

Account-level: Jira subdomain URL.

" } }, "JiraProjectKey": { "target": "com.amazonaws.wellarchitected#JiraProjectKey", "traits": { "smithy.api#documentation": "

Account-level: Jira project key to sync workloads to.

" } }, "StatusMessage": { "target": "com.amazonaws.wellarchitected#StatusMessage", "traits": { "smithy.api#documentation": "

Account-level: Status message on configuration of the Jira integration.

" } } }, "traits": { "smithy.api#documentation": "

Account-level: Output configuration of the Jira integration.

" } }, "com.amazonaws.wellarchitected#AccountJiraIssueManagementStatus": { "type": "enum", "members": { "ENABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ENABLED" } }, "DISABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DISABLED" } } } }, "com.amazonaws.wellarchitected#AccountSummary": { "type": "map", "key": { "target": "com.amazonaws.wellarchitected#CheckStatus" }, "value": { "target": "com.amazonaws.wellarchitected#CheckStatusCount" }, "traits": { "smithy.api#documentation": "

Account summary for a Well-Architected best practice in relation to Trusted Advisor checks.

" } }, "com.amazonaws.wellarchitected#AdditionalResourceType": { "type": "enum", "members": { "HELPFUL_RESOURCE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "HELPFUL_RESOURCE" } }, "IMPROVEMENT_PLAN": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "IMPROVEMENT_PLAN" } } } }, "com.amazonaws.wellarchitected#AdditionalResources": { "type": "structure", "members": { "Type": { "target": "com.amazonaws.wellarchitected#AdditionalResourceType", "traits": { "smithy.api#documentation": "

Type of additional resource for a custom lens.

" } }, "Content": { "target": "com.amazonaws.wellarchitected#Urls", "traits": { "smithy.api#documentation": "

The URLs for additional resources, either helpful resources or improvement plans, for a custom lens. Up to five additional URLs can be specified.

" } } }, "traits": { "smithy.api#documentation": "

The choice level additional resources for a custom lens.

This field does not apply to Amazon Web Services official lenses.

" } }, "com.amazonaws.wellarchitected#AdditionalResourcesList": { "type": "list", "member": { "target": "com.amazonaws.wellarchitected#AdditionalResources" } }, "com.amazonaws.wellarchitected#AgentProfileArn": { "type": "string", "traits": { "smithy.api#length": { "max": 2048 }, "smithy.api#pattern": "^arn:aws([a-z0-9-]+)?:wellarchitected:[a-z0-9-]{6,64}:\\d{12}:agent-profile/([a-zA-Z0-9_-]+)$" } }, "com.amazonaws.wellarchitected#AgentProfileSummaries": { "type": "list", "member": { "target": "com.amazonaws.wellarchitected#AgentProfileSummary" }, "traits": { "smithy.api#uniqueItems": {} } }, "com.amazonaws.wellarchitected#AgentProfileSummary": { "type": "structure", "members": { "name": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The system name of the profile.

", "smithy.api#length": { "min": 3, "max": 128 }, "smithy.api#pattern": "^[a-zA-Z0-9_-]+$", "smithy.api#required": {} } }, "displayName": { "target": "com.amazonaws.wellarchitected#SensitiveString", "traits": { "smithy.api#documentation": "

The display name of the profile shown to users.

", "smithy.api#length": { "min": 3, "max": 128 }, "smithy.api#pattern": "^(?:(?!\\$\\{[a-zA-Z]+:)[\\P{C}])+$" } }, "description": { "target": "com.amazonaws.wellarchitected#SensitiveString", "traits": { "smithy.api#documentation": "

A description of the profile.

", "smithy.api#length": { "max": 512 }, "smithy.api#pattern": "^(?:(?!\\$\\{[a-zA-Z]+:)[\\P{C}])*$" } }, "businessOverview": { "target": "com.amazonaws.wellarchitected#SensitiveString", "traits": { "smithy.api#documentation": "

The business overview for this profile.

", "smithy.api#length": { "max": 512 }, "smithy.api#pattern": "^(?:(?!\\$\\{[a-zA-Z]+:)[\\P{C}])*$" } }, "pillars": { "target": "com.amazonaws.wellarchitected#Pillars", "traits": { "smithy.api#documentation": "

The Amazon Web Services Well-Architected Framework pillars associated with this profile. Not present for basic profiles.

" } }, "deletionProtection": { "target": "smithy.api#Boolean", "traits": { "smithy.api#default": true, "smithy.api#documentation": "

Indicates whether deletion protection is enabled for the profile.

" } }, "profileType": { "target": "com.amazonaws.wellarchitected#ProfileType", "traits": { "smithy.api#documentation": "

The type of the profile.

" } }, "executionRoleArn": { "target": "com.amazonaws.wellarchitected#RoleArn", "traits": { "smithy.api#documentation": "

The ARN of the IAM execution role used for recommendation actions. Not present for basic profiles.

" } }, "aggregationConfiguration": { "target": "com.amazonaws.wellarchitected#AggregationConfigurations", "traits": { "smithy.api#documentation": "

The aggregation configuration that defines which Amazon Web Services accounts and Regions to analyze. Not present for basic profiles.

" } }, "arn": { "target": "com.amazonaws.wellarchitected#AgentProfileArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the optimization profile.

", "smithy.api#required": {} } }, "eligibleForScheduledGeneration": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "

Indicates whether the profile is valid for scheduled recommendation generation.

" } }, "eligibleForArchitectureGeneration": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "

Indicates whether the profile is valid for manual architecture generation.

" } }, "fieldErrors": { "target": "com.amazonaws.wellarchitected#FieldErrors", "traits": { "smithy.api#documentation": "

A map of field paths to error messages for invalid or missing input fields.

" } }, "createdBy": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The identifier of the user or system that created this profile.

", "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#required": {} } }, "createdAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The timestamp when the profile was created.

", "smithy.api#required": {}, "smithy.api#timestampFormat": "date-time" } }, "lastModifiedBy": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The identifier of the user or system that last modified this profile.

", "smithy.api#length": { "min": 1, "max": 128 } } }, "lastModifiedAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The timestamp when the profile was last modified.

", "smithy.api#timestampFormat": "date-time" } }, "organizationalAggregationConfiguration": { "target": "com.amazonaws.wellarchitected#OrganizationalAggregationConfiguration", "traits": { "smithy.api#documentation": "

The organizational monitoring boundary. Present only for organizational profiles.

" } } }, "traits": { "smithy.api#documentation": "

Summary of an optimization profile, including its configuration, metadata, and audit information.

" } }, "com.amazonaws.wellarchitected#AgentRecommendationArn": { "type": "string", "traits": { "smithy.api#length": { "max": 2048 }, "smithy.api#pattern": "^arn:aws([a-z0-9-]+)?:wellarchitected:[a-z0-9-]{6,64}:\\d{12}:agent-recommendation/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } }, "com.amazonaws.wellarchitected#AgentRecommendationGenerationSummaries": { "type": "list", "member": { "target": "com.amazonaws.wellarchitected#AgentRecommendationGenerationSummary" } }, "com.amazonaws.wellarchitected#AgentRecommendationGenerationSummary": { "type": "structure", "members": { "id": { "target": "com.amazonaws.wellarchitected#UUID", "traits": { "smithy.api#documentation": "

The unique identifier of the recommendation generation.

", "smithy.api#required": {} } }, "profileArn": { "target": "com.amazonaws.wellarchitected#AgentProfileArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the profile used for this generation.

", "smithy.api#required": {} } }, "name": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The name of the recommendation generation.

" } }, "status": { "target": "com.amazonaws.wellarchitected#GenerationStatus", "traits": { "smithy.api#documentation": "

The current status of the recommendation generation.

", "smithy.api#required": {} } }, "estimatedCompletionTime": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The estimated time for the generation to complete.

", "smithy.api#timestampFormat": "date-time" } }, "createdBy": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The identifier of the user or system that started this generation.

", "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#required": {} } }, "createdAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The timestamp when the generation was started.

", "smithy.api#required": {}, "smithy.api#timestampFormat": "date-time" } }, "lastModifiedBy": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The identifier of the user or system that last modified this generation.

", "smithy.api#length": { "min": 1, "max": 128 } } }, "lastModifiedAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The timestamp when the generation was last modified.

", "smithy.api#timestampFormat": "date-time" } }, "generationType": { "target": "com.amazonaws.wellarchitected#GenerationType", "traits": { "smithy.api#documentation": "

How the generation was started.

" } }, "generationRecommendationTypes": { "target": "com.amazonaws.wellarchitected#GenerationRecommendationTypes", "traits": { "smithy.api#documentation": "

The recommendation types the generation covers.

" } }, "startedAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The timestamp when the recommendation generation process started.

", "smithy.api#timestampFormat": "date-time" } }, "endedAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The timestamp when the recommendation generation process completed.

", "smithy.api#timestampFormat": "date-time" } }, "errorDetails": { "target": "com.amazonaws.wellarchitected#ErrorDetails", "traits": { "smithy.api#documentation": "

Details about the error if the generation status is ERROR.

" } } }, "traits": { "smithy.api#documentation": "

Summary of a recommendation generation process initiated through the agent API.

" } }, "com.amazonaws.wellarchitected#AgentRecommendationItemSummaries": { "type": "list", "member": { "target": "com.amazonaws.wellarchitected#AgentRecommendationItemSummary" } }, "com.amazonaws.wellarchitected#AgentRecommendationItemSummary": { "type": "structure", "members": { "id": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The unique identifier of the recommendation item.

", "smithy.api#required": {} } }, "recommendationArn": { "target": "com.amazonaws.wellarchitected#RecommendationArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the associated recommendation.

", "smithy.api#required": {} } }, "type": { "target": "com.amazonaws.wellarchitected#RecommendationItemType", "traits": { "smithy.api#documentation": "

The type of the recommendation item.

", "smithy.api#required": {} } }, "metadata": { "target": "smithy.api#Document", "traits": { "smithy.api#documentation": "

Metadata containing a snapshot of the resource or recommendation at the time of generation.

", "smithy.api#required": {} } }, "createdBy": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The identifier of the user or system that created this recommendation item.

", "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#required": {} } }, "createdAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The timestamp when the recommendation item was created.

", "smithy.api#required": {}, "smithy.api#timestampFormat": "date-time" } }, "lastModifiedBy": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The identifier of the user or system that last modified this recommendation item.

", "smithy.api#length": { "min": 1, "max": 128 } } }, "lastModifiedAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The timestamp when the recommendation item was last modified.

", "smithy.api#timestampFormat": "date-time" } }, "autoRemediation": { "target": "com.amazonaws.wellarchitected#AutoRemediation", "traits": { "smithy.api#documentation": "

The optional per-resource auto-remediation for this affected resource, representing an SSM runbook execution. Present only when the item's check is backed by an SSM automation runbook.

" } } }, "traits": { "smithy.api#documentation": "

Summary of an agent recommendation item, representing an Amazon Web Services resource or recommendation affected by the optimization recommendation.

" } }, "com.amazonaws.wellarchitected#AgentRecommendationRemediation": { "type": "structure", "members": { "recommendationArn": { "target": "com.amazonaws.wellarchitected#RecommendationArn", "traits": { "smithy.api#documentation": "

The ARN of the recommendation that this remediation belongs to.

", "smithy.api#required": {} } }, "type": { "target": "com.amazonaws.wellarchitected#RemediationType", "traits": { "smithy.api#documentation": "

The remediation method.

", "smithy.api#required": {} } }, "steps": { "target": "com.amazonaws.wellarchitected#RemediationSteps", "traits": { "smithy.api#documentation": "

The procedural steps to perform the remediation.

", "smithy.api#required": {} } }, "resourceLinks": { "target": "com.amazonaws.wellarchitected#ResourceLinks", "traits": { "smithy.api#documentation": "

External references associated with the steps.

" } }, "createdBy": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The identifier of the user or system that created this remediation.

", "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#required": {} } }, "createdAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The timestamp when the remediation was created.

", "smithy.api#required": {}, "smithy.api#timestampFormat": "date-time" } }, "lastModifiedBy": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The identifier of the user or system that last modified this remediation.

", "smithy.api#length": { "min": 1, "max": 128 } } }, "lastModifiedAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The timestamp when the remediation was last modified.

", "smithy.api#timestampFormat": "date-time" } } }, "traits": { "smithy.api#documentation": "

The core fields for a remediation.

" } }, "com.amazonaws.wellarchitected#AgentRecommendationRemediations": { "type": "list", "member": { "target": "com.amazonaws.wellarchitected#AgentRecommendationRemediation" } }, "com.amazonaws.wellarchitected#AgentRecommendationSummaries": { "type": "list", "member": { "target": "com.amazonaws.wellarchitected#AgentRecommendationSummary" } }, "com.amazonaws.wellarchitected#AgentRecommendationSummary": { "type": "structure", "members": { "recommendationArn": { "target": "com.amazonaws.wellarchitected#RecommendationArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the recommendation.

", "smithy.api#required": {} } }, "profileArn": { "target": "com.amazonaws.wellarchitected#AgentProfileArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the associated profile.

", "smithy.api#required": {} } }, "generationId": { "target": "com.amazonaws.wellarchitected#UUID", "traits": { "smithy.api#documentation": "

The identifier of the generation that produced this recommendation.

" } }, "title": { "target": "com.amazonaws.wellarchitected#SensitiveString", "traits": { "smithy.api#documentation": "

The title of the recommendation.

", "smithy.api#length": { "min": 3, "max": 120 }, "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.wellarchitected#SensitiveString", "traits": { "smithy.api#documentation": "

A description of the recommendation.

", "smithy.api#length": { "min": 80, "max": 500 }, "smithy.api#required": {} } }, "type": { "target": "com.amazonaws.wellarchitected#RecommendationType", "traits": { "smithy.api#documentation": "

The type of the recommendation.

", "smithy.api#required": {} } }, "pillar": { "target": "com.amazonaws.wellarchitected#Pillar", "traits": { "smithy.api#documentation": "

The Amazon Web Services Well-Architected Framework pillar that the recommendation addresses.

", "smithy.api#required": {} } }, "priority": { "target": "com.amazonaws.wellarchitected#Priority", "traits": { "smithy.api#documentation": "

The priority of the recommendation.

", "smithy.api#required": {} } }, "effort": { "target": "com.amazonaws.wellarchitected#Effort", "traits": { "smithy.api#documentation": "

The effort required to implement the recommendation.

", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.wellarchitected#RecommendationStatus", "traits": { "smithy.api#documentation": "

The current status of the recommendation.

", "smithy.api#required": {} } }, "state": { "target": "com.amazonaws.wellarchitected#RecommendationState", "traits": { "smithy.api#documentation": "

The current state of the recommendation.

", "smithy.api#required": {} } }, "updateReason": { "target": "com.amazonaws.wellarchitected#SensitiveString", "traits": { "smithy.api#documentation": "

The free-text reason associated with the recommendation's most recent status update.

", "smithy.api#length": { "min": 1, "max": 4096 } } }, "impact": { "target": "com.amazonaws.wellarchitected#ImpactCategory", "traits": { "smithy.api#documentation": "

The severity of the recommendation's impact.

", "smithy.api#required": {} } }, "roi": { "target": "com.amazonaws.wellarchitected#Roi", "traits": { "smithy.api#documentation": "

The return on investment estimate for the recommendation.

", "smithy.api#required": {} } }, "numberOfResources": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "

The number of Amazon Web Services resources this recommendation affects.

" } }, "awsServices": { "target": "com.amazonaws.wellarchitected#StringList", "traits": { "smithy.api#documentation": "

The Amazon Web Services services that the recommendation applies to.

" } }, "businessUnits": { "target": "com.amazonaws.wellarchitected#StringList", "traits": { "smithy.api#documentation": "

The business units that own the affected resources.

" } }, "applications": { "target": "com.amazonaws.wellarchitected#StringList", "traits": { "smithy.api#documentation": "

The applications that the recommendation targets.

" } }, "createdBy": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The identifier of the user or system that created this recommendation.

", "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#required": {} } }, "createdAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The timestamp when the recommendation was created.

", "smithy.api#required": {}, "smithy.api#timestampFormat": "date-time" } }, "lastModifiedBy": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The identifier of the user or system that last modified this recommendation.

", "smithy.api#length": { "min": 1, "max": 128 } } }, "lastModifiedAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The timestamp when the recommendation was last modified.

", "smithy.api#timestampFormat": "date-time" } } }, "traits": { "smithy.api#documentation": "

Summary of an agent optimization recommendation returned by list operations.

" } }, "com.amazonaws.wellarchitected#AggregationConfiguration": { "type": "structure", "members": { "accountId": { "target": "com.amazonaws.wellarchitected#AccountId", "traits": { "smithy.api#documentation": "

The Amazon Web Services account ID to analyze.

", "smithy.api#required": {} } }, "regions": { "target": "com.amazonaws.wellarchitected#Regions", "traits": { "smithy.api#documentation": "

A list of Amazon Web Services Regions to include in the analysis.

", "smithy.api#required": {} } }, "accessRoleArn": { "target": "com.amazonaws.wellarchitected#RoleArn", "traits": { "smithy.api#documentation": "

The ARN of an IAM role to assume for resource analysis in this account.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Configuration settings that define the scope of Amazon Web Services resources to analyze for optimization recommendations.

" } }, "com.amazonaws.wellarchitected#AggregationConfigurations": { "type": "list", "member": { "target": "com.amazonaws.wellarchitected#AggregationConfiguration" }, "traits": { "smithy.api#length": { "min": 0, "max": 1000 }, "smithy.api#uniqueItems": {} } }, "com.amazonaws.wellarchitected#Answer": { "type": "structure", "members": { "QuestionId": { "target": "com.amazonaws.wellarchitected#QuestionId" }, "PillarId": { "target": "com.amazonaws.wellarchitected#PillarId" }, "QuestionTitle": { "target": "com.amazonaws.wellarchitected#QuestionTitle" }, "QuestionDescription": { "target": "com.amazonaws.wellarchitected#QuestionDescription" }, "ImprovementPlanUrl": { "target": "com.amazonaws.wellarchitected#ImprovementPlanUrl" }, "HelpfulResourceUrl": { "target": "com.amazonaws.wellarchitected#HelpfulResourceUrl" }, "HelpfulResourceDisplayText": { "target": "com.amazonaws.wellarchitected#DisplayText", "traits": { "smithy.api#documentation": "

The helpful resource text to be displayed for a custom lens.

This field does not apply to Amazon Web Services official lenses.

" } }, "Choices": { "target": "com.amazonaws.wellarchitected#Choices" }, "SelectedChoices": { "target": "com.amazonaws.wellarchitected#SelectedChoices" }, "ChoiceAnswers": { "target": "com.amazonaws.wellarchitected#ChoiceAnswers", "traits": { "smithy.api#documentation": "

A list of selected choices to a question in your workload.

" } }, "IsApplicable": { "target": "com.amazonaws.wellarchitected#IsApplicable" }, "Risk": { "target": "com.amazonaws.wellarchitected#Risk" }, "Notes": { "target": "com.amazonaws.wellarchitected#Notes" }, "Reason": { "target": "com.amazonaws.wellarchitected#AnswerReason", "traits": { "smithy.api#documentation": "

The reason why the question is not applicable to your workload.

" } }, "JiraConfiguration": { "target": "com.amazonaws.wellarchitected#JiraConfiguration", "traits": { "smithy.api#documentation": "

Configuration of the Jira integration.

" } } }, "traits": { "smithy.api#documentation": "

An answer of the question.

" } }, "com.amazonaws.wellarchitected#AnswerReason": { "type": "enum", "members": { "OUT_OF_SCOPE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "OUT_OF_SCOPE" } }, "BUSINESS_PRIORITIES": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "BUSINESS_PRIORITIES" } }, "ARCHITECTURE_CONSTRAINTS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ARCHITECTURE_CONSTRAINTS" } }, "OTHER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "OTHER" } }, "NONE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NONE" } } } }, "com.amazonaws.wellarchitected#AnswerSummaries": { "type": "list", "member": { "target": "com.amazonaws.wellarchitected#AnswerSummary" }, "traits": { "smithy.api#documentation": "

List of answer summaries of lens review in a workload.

" } }, "com.amazonaws.wellarchitected#AnswerSummary": { "type": "structure", "members": { "QuestionId": { "target": "com.amazonaws.wellarchitected#QuestionId" }, "PillarId": { "target": "com.amazonaws.wellarchitected#PillarId" }, "QuestionTitle": { "target": "com.amazonaws.wellarchitected#QuestionTitle" }, "Choices": { "target": "com.amazonaws.wellarchitected#Choices" }, "SelectedChoices": { "target": "com.amazonaws.wellarchitected#SelectedChoices" }, "ChoiceAnswerSummaries": { "target": "com.amazonaws.wellarchitected#ChoiceAnswerSummaries", "traits": { "smithy.api#documentation": "

A list of selected choices to a question in your workload.

" } }, "IsApplicable": { "target": "com.amazonaws.wellarchitected#IsApplicable" }, "Risk": { "target": "com.amazonaws.wellarchitected#Risk" }, "Reason": { "target": "com.amazonaws.wellarchitected#AnswerReason", "traits": { "smithy.api#documentation": "

The reason why a choice is non-applicable to a question in your workload.

" } }, "QuestionType": { "target": "com.amazonaws.wellarchitected#QuestionType", "traits": { "smithy.api#documentation": "

The type of the question.

" } }, "JiraConfiguration": { "target": "com.amazonaws.wellarchitected#JiraConfiguration", "traits": { "smithy.api#documentation": "

Configuration of the Jira integration.

" } } }, "traits": { "smithy.api#documentation": "

An answer summary of a lens review in a workload.

" } }, "com.amazonaws.wellarchitected#ApplicationArn": { "type": "string", "traits": { "smithy.api#length": { "max": 2084 }, "smithy.api#pattern": "^arn:aws[-a-z]*:servicecatalog:[a-z]{2}(-gov)?-[a-z]+-\\d:\\d{12}:/applications/[a-z0-9]+$" } }, "com.amazonaws.wellarchitected#ApplicationType": { "type": "enum", "members": { "SAS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SAS" } }, "DESKTOP_APPLICATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DESKTOP_APPLICATION" } }, "OTHER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "OTHER" } } }, "traits": { "smithy.api#documentation": "

The type of application described by an application context.

" } }, "com.amazonaws.wellarchitected#AssociateLenses": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#AssociateLensesInput" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" }, { "target": "com.amazonaws.wellarchitected#ConflictException" }, { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, { "target": "com.amazonaws.wellarchitected#ValidationException" } ], "traits": { "smithy.api#documentation": "

Associate a lens to a workload.

Up to 10 lenses can be associated with a workload in a single API operation. A maximum of 20 lenses can be associated with a workload.

Disclaimer

By accessing and/or applying custom lenses created by another Amazon Web Services user or account, you acknowledge that custom lenses created by other users and shared with you are Third Party Content as defined in the Amazon Web Services Customer Agreement.

", "smithy.api#http": { "method": "PATCH", "uri": "/workloads/{WorkloadId}/associateLenses", "code": 200 }, "smithy.api#tags": [ "WA" ] } }, "com.amazonaws.wellarchitected#AssociateLensesInput": { "type": "structure", "members": { "WorkloadId": { "target": "com.amazonaws.wellarchitected#WorkloadId", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "LensAliases": { "target": "com.amazonaws.wellarchitected#LensAliases", "traits": { "smithy.api#clientOptional": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Input to associate lens reviews.

", "smithy.api#input": {} } }, "com.amazonaws.wellarchitected#AssociateProfiles": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#AssociateProfilesInput" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" }, { "target": "com.amazonaws.wellarchitected#ConflictException" }, { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, { "target": "com.amazonaws.wellarchitected#ValidationException" } ], "traits": { "smithy.api#documentation": "

Associate a profile with a workload.

", "smithy.api#http": { "method": "PATCH", "uri": "/workloads/{WorkloadId}/associateProfiles", "code": 200 }, "smithy.api#tags": [ "WA" ] } }, "com.amazonaws.wellarchitected#AssociateProfilesInput": { "type": "structure", "members": { "WorkloadId": { "target": "com.amazonaws.wellarchitected#WorkloadId", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "ProfileArns": { "target": "com.amazonaws.wellarchitected#ProfileArns", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The list of profile ARNs to associate with the workload.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.wellarchitected#AutoRemediation": { "type": "structure", "members": { "deepLink": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

A deep link to the SSM runbook execution page in the AWS Management Console for this resource, with the execution parameters prefilled.

", "smithy.api#length": { "min": 1, "max": 2048 } } }, "cliCommand": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The AWS CLI command that triggers the same SSM runbook execution for this resource. You can copy and run this command as-is.

", "smithy.api#length": { "min": 1, "max": 4096 } } } }, "traits": { "smithy.api#documentation": "

The per-resource auto-remediation for a single affected resource. Represents one AWS Systems Manager (SSM) runbook execution that targets the resource. Present only when the resource's check is backed by an SSM automation runbook.

" } }, "com.amazonaws.wellarchitected#AwsAccountId": { "type": "string", "traits": { "smithy.api#documentation": "

An Amazon Web Services account ID.

", "smithy.api#length": { "min": 12, "max": 12 }, "smithy.api#pattern": "^[0-9]{12}$" } }, "com.amazonaws.wellarchitected#AwsRegion": { "type": "string", "traits": { "smithy.api#documentation": "

An Amazon Web Services Region, for example, us-west-2 or ap-northeast-1.

", "smithy.api#length": { "max": 100 } } }, "com.amazonaws.wellarchitected#Base64String": { "type": "string", "traits": { "smithy.api#documentation": "

The Base64-encoded string representation of a lens review report.

This data can be used to create a PDF file.

Only returned by GetConsolidatedReport when PDF format is requested.

" } }, "com.amazonaws.wellarchitected#BestPractice": { "type": "structure", "members": { "ChoiceId": { "target": "com.amazonaws.wellarchitected#ChoiceId" }, "ChoiceTitle": { "target": "com.amazonaws.wellarchitected#ChoiceTitle" } }, "traits": { "smithy.api#documentation": "

A best practice, or question choice, that has been identified as a risk in this question.

" } }, "com.amazonaws.wellarchitected#BestPractices": { "type": "list", "member": { "target": "com.amazonaws.wellarchitected#BestPractice" } }, "com.amazonaws.wellarchitected#CheckDescription": { "type": "string" }, "com.amazonaws.wellarchitected#CheckDetail": { "type": "structure", "members": { "Id": { "target": "com.amazonaws.wellarchitected#CheckId", "traits": { "smithy.api#documentation": "

Trusted Advisor check ID.

" } }, "Name": { "target": "com.amazonaws.wellarchitected#CheckName", "traits": { "smithy.api#documentation": "

Trusted Advisor check name.

" } }, "Description": { "target": "com.amazonaws.wellarchitected#CheckDescription", "traits": { "smithy.api#documentation": "

Trusted Advisor check description.

" } }, "Provider": { "target": "com.amazonaws.wellarchitected#CheckProvider", "traits": { "smithy.api#documentation": "

Provider of the check related to the best practice.

" } }, "LensArn": { "target": "com.amazonaws.wellarchitected#LensArn", "traits": { "smithy.api#documentation": "

Well-Architected Lens ARN associated to the check.

" } }, "PillarId": { "target": "com.amazonaws.wellarchitected#PillarId" }, "QuestionId": { "target": "com.amazonaws.wellarchitected#QuestionId" }, "ChoiceId": { "target": "com.amazonaws.wellarchitected#ChoiceId" }, "Status": { "target": "com.amazonaws.wellarchitected#CheckStatus", "traits": { "smithy.api#documentation": "

Status associated to the check.

" } }, "AccountId": { "target": "com.amazonaws.wellarchitected#AwsAccountId" }, "FlaggedResources": { "target": "com.amazonaws.wellarchitected#FlaggedResources", "traits": { "smithy.api#documentation": "

Count of flagged resources associated to the check.

" } }, "Reason": { "target": "com.amazonaws.wellarchitected#CheckFailureReason", "traits": { "smithy.api#documentation": "

Reason associated to the check.

" } }, "UpdatedAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The date and time when the check was last updated.

" } } }, "traits": { "smithy.api#documentation": "

Account details for a Well-Architected best practice in relation to Trusted Advisor checks.

" } }, "com.amazonaws.wellarchitected#CheckDetails": { "type": "list", "member": { "target": "com.amazonaws.wellarchitected#CheckDetail" } }, "com.amazonaws.wellarchitected#CheckFailureReason": { "type": "enum", "members": { "ASSUME_ROLE_ERROR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ASSUME_ROLE_ERROR" } }, "ACCESS_DENIED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACCESS_DENIED" } }, "UNKNOWN_ERROR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UNKNOWN_ERROR" } }, "PREMIUM_SUPPORT_REQUIRED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PREMIUM_SUPPORT_REQUIRED" } } } }, "com.amazonaws.wellarchitected#CheckId": { "type": "string" }, "com.amazonaws.wellarchitected#CheckName": { "type": "string" }, "com.amazonaws.wellarchitected#CheckProvider": { "type": "enum", "members": { "TRUSTED_ADVISOR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "TRUSTED_ADVISOR" } } } }, "com.amazonaws.wellarchitected#CheckStatus": { "type": "enum", "members": { "OKAY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "OKAY" } }, "WARNING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "WARNING" } }, "ERROR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ERROR" } }, "NOT_AVAILABLE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NOT_AVAILABLE" } }, "FETCH_FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FETCH_FAILED" } } } }, "com.amazonaws.wellarchitected#CheckStatusCount": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 101 } } }, "com.amazonaws.wellarchitected#CheckSummaries": { "type": "list", "member": { "target": "com.amazonaws.wellarchitected#CheckSummary" } }, "com.amazonaws.wellarchitected#CheckSummary": { "type": "structure", "members": { "Id": { "target": "com.amazonaws.wellarchitected#CheckId", "traits": { "smithy.api#documentation": "

Trusted Advisor check ID.

" } }, "Name": { "target": "com.amazonaws.wellarchitected#CheckName", "traits": { "smithy.api#documentation": "

Trusted Advisor check name.

" } }, "Provider": { "target": "com.amazonaws.wellarchitected#CheckProvider", "traits": { "smithy.api#documentation": "

Provider of the check related to the best practice.

" } }, "Description": { "target": "com.amazonaws.wellarchitected#CheckDescription", "traits": { "smithy.api#documentation": "

Trusted Advisor check description.

" } }, "UpdatedAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The date and time when the check summary was last updated.

" } }, "LensArn": { "target": "com.amazonaws.wellarchitected#LensArn", "traits": { "smithy.api#documentation": "

Well-Architected Lens ARN associated to the check.

" } }, "PillarId": { "target": "com.amazonaws.wellarchitected#PillarId" }, "QuestionId": { "target": "com.amazonaws.wellarchitected#QuestionId" }, "ChoiceId": { "target": "com.amazonaws.wellarchitected#ChoiceId" }, "Status": { "target": "com.amazonaws.wellarchitected#CheckStatus", "traits": { "smithy.api#documentation": "

Status associated to the check.

" } }, "AccountSummary": { "target": "com.amazonaws.wellarchitected#AccountSummary", "traits": { "smithy.api#documentation": "

Account summary associated to the check.

" } } }, "traits": { "smithy.api#documentation": "

Trusted Advisor check summary.

" } }, "com.amazonaws.wellarchitected#Choice": { "type": "structure", "members": { "ChoiceId": { "target": "com.amazonaws.wellarchitected#ChoiceId" }, "Title": { "target": "com.amazonaws.wellarchitected#ChoiceTitle" }, "Description": { "target": "com.amazonaws.wellarchitected#ChoiceDescription" }, "HelpfulResource": { "target": "com.amazonaws.wellarchitected#ChoiceContent", "traits": { "smithy.api#documentation": "

The helpful resource (both text and URL) for a particular choice.

This field only applies to custom lenses. Each choice can have only one helpful resource.

" } }, "ImprovementPlan": { "target": "com.amazonaws.wellarchitected#ChoiceContent", "traits": { "smithy.api#documentation": "

The improvement plan (both text and URL) for a particular choice.

This field only applies to custom lenses. Each choice can have only one improvement plan.

" } }, "AdditionalResources": { "target": "com.amazonaws.wellarchitected#AdditionalResourcesList", "traits": { "smithy.api#documentation": "

The additional resources for a choice in a custom lens.

A choice can have up to two additional resources: one of type HELPFUL_RESOURCE, one of type IMPROVEMENT_PLAN, or both.

" } } }, "traits": { "smithy.api#documentation": "

A choice available to answer question.

" } }, "com.amazonaws.wellarchitected#ChoiceAnswer": { "type": "structure", "members": { "ChoiceId": { "target": "com.amazonaws.wellarchitected#ChoiceId" }, "Status": { "target": "com.amazonaws.wellarchitected#ChoiceStatus", "traits": { "smithy.api#documentation": "

The status of a choice.

" } }, "Reason": { "target": "com.amazonaws.wellarchitected#ChoiceReason", "traits": { "smithy.api#documentation": "

The reason why a choice is non-applicable to a question in your workload.

" } }, "Notes": { "target": "com.amazonaws.wellarchitected#ChoiceNotes", "traits": { "smithy.api#documentation": "

The notes associated with a choice.

" } } }, "traits": { "smithy.api#documentation": "

A choice that has been answered on a question in your workload.

" } }, "com.amazonaws.wellarchitected#ChoiceAnswerSummaries": { "type": "list", "member": { "target": "com.amazonaws.wellarchitected#ChoiceAnswerSummary" } }, "com.amazonaws.wellarchitected#ChoiceAnswerSummary": { "type": "structure", "members": { "ChoiceId": { "target": "com.amazonaws.wellarchitected#ChoiceId" }, "Status": { "target": "com.amazonaws.wellarchitected#ChoiceStatus", "traits": { "smithy.api#documentation": "

The status of a choice.

" } }, "Reason": { "target": "com.amazonaws.wellarchitected#ChoiceReason", "traits": { "smithy.api#documentation": "

The reason why a choice is non-applicable to a question in your workload.

" } } }, "traits": { "smithy.api#documentation": "

A choice summary that has been answered on a question in your workload.

" } }, "com.amazonaws.wellarchitected#ChoiceAnswers": { "type": "list", "member": { "target": "com.amazonaws.wellarchitected#ChoiceAnswer" } }, "com.amazonaws.wellarchitected#ChoiceContent": { "type": "structure", "members": { "DisplayText": { "target": "com.amazonaws.wellarchitected#ChoiceContentDisplayText", "traits": { "smithy.api#documentation": "

The display text for the choice content.

" } }, "Url": { "target": "com.amazonaws.wellarchitected#ChoiceContentUrl", "traits": { "smithy.api#documentation": "

The URL for the choice content.

" } } }, "traits": { "smithy.api#documentation": "

The choice content.

" } }, "com.amazonaws.wellarchitected#ChoiceContentDisplayText": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 1024 } } }, "com.amazonaws.wellarchitected#ChoiceContentUrl": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 1024 } } }, "com.amazonaws.wellarchitected#ChoiceDescription": { "type": "string", "traits": { "smithy.api#documentation": "

The description of a choice.

", "smithy.api#length": { "min": 1, "max": 1024 } } }, "com.amazonaws.wellarchitected#ChoiceId": { "type": "string", "traits": { "smithy.api#documentation": "

The ID of a choice.

", "smithy.api#length": { "min": 1, "max": 64 } } }, "com.amazonaws.wellarchitected#ChoiceImprovementPlan": { "type": "structure", "members": { "ChoiceId": { "target": "com.amazonaws.wellarchitected#ChoiceId" }, "DisplayText": { "target": "com.amazonaws.wellarchitected#DisplayText", "traits": { "smithy.api#documentation": "

The display text for the improvement plan.

" } }, "ImprovementPlanUrl": { "target": "com.amazonaws.wellarchitected#ImprovementPlanUrl" } }, "traits": { "smithy.api#documentation": "

The choice level improvement plan.

This value is only applicable to custom lenses.

" } }, "com.amazonaws.wellarchitected#ChoiceImprovementPlans": { "type": "list", "member": { "target": "com.amazonaws.wellarchitected#ChoiceImprovementPlan" } }, "com.amazonaws.wellarchitected#ChoiceNotes": { "type": "string", "traits": { "smithy.api#length": { "max": 250 } } }, "com.amazonaws.wellarchitected#ChoiceReason": { "type": "enum", "members": { "OUT_OF_SCOPE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "OUT_OF_SCOPE" } }, "BUSINESS_PRIORITIES": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "BUSINESS_PRIORITIES" } }, "ARCHITECTURE_CONSTRAINTS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ARCHITECTURE_CONSTRAINTS" } }, "OTHER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "OTHER" } }, "NONE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NONE" } } } }, "com.amazonaws.wellarchitected#ChoiceStatus": { "type": "enum", "members": { "SELECTED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SELECTED" } }, "NOT_APPLICABLE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NOT_APPLICABLE" } }, "UNSELECTED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UNSELECTED" } } } }, "com.amazonaws.wellarchitected#ChoiceTitle": { "type": "string", "traits": { "smithy.api#documentation": "

The title of a choice.

", "smithy.api#length": { "min": 1, "max": 512 } } }, "com.amazonaws.wellarchitected#ChoiceUpdate": { "type": "structure", "members": { "Status": { "target": "com.amazonaws.wellarchitected#ChoiceStatus", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The status of a choice.

", "smithy.api#required": {} } }, "Reason": { "target": "com.amazonaws.wellarchitected#ChoiceReason", "traits": { "smithy.api#documentation": "

The reason why a choice is non-applicable to a question in your workload.

" } }, "Notes": { "target": "com.amazonaws.wellarchitected#ChoiceNotes", "traits": { "smithy.api#documentation": "

The notes associated with a choice.

" } } }, "traits": { "smithy.api#documentation": "

A list of choices to be updated.

" } }, "com.amazonaws.wellarchitected#ChoiceUpdates": { "type": "map", "key": { "target": "com.amazonaws.wellarchitected#ChoiceId" }, "value": { "target": "com.amazonaws.wellarchitected#ChoiceUpdate" } }, "com.amazonaws.wellarchitected#Choices": { "type": "list", "member": { "target": "com.amazonaws.wellarchitected#Choice" }, "traits": { "smithy.api#documentation": "

List of choices available for a question.

" } }, "com.amazonaws.wellarchitected#ClientRequestToken": { "type": "string", "traits": { "smithy.api#documentation": "

A unique case-sensitive string used to ensure that this request is idempotent (executes only once).

You should not reuse the same token for other requests. If you retry a request with the same client request token and the same parameters after the original request has completed successfully, the result of the original request is returned.

This token is listed as required, however, if you do not specify it, the Amazon Web Services SDKs automatically generate one for you. If you are not using the Amazon Web Services SDK or the CLI, you must provide this token or the request will fail.

", "smithy.api#length": { "min": 1, "max": 2048 }, "smithy.api#pattern": "^[\\x00-\\x7F]*$" } }, "com.amazonaws.wellarchitected#ConflictException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.wellarchitected#ExceptionMessage", "traits": { "smithy.api#clientOptional": {}, "smithy.api#required": {} } }, "ResourceId": { "target": "com.amazonaws.wellarchitected#ExceptionResourceId", "traits": { "smithy.api#clientOptional": {}, "smithy.api#required": {} } }, "ResourceType": { "target": "com.amazonaws.wellarchitected#ExceptionResourceType", "traits": { "smithy.api#clientOptional": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The resource has already been processed, was deleted, or is too large.

", "smithy.api#error": "client", "smithy.api#httpError": 409 } }, "com.amazonaws.wellarchitected#ConsolidatedReportMetric": { "type": "structure", "members": { "MetricType": { "target": "com.amazonaws.wellarchitected#MetricType", "traits": { "smithy.api#documentation": "

The metric type of a metric in the consolidated report. Currently only WORKLOAD metric types are supported.

" } }, "RiskCounts": { "target": "com.amazonaws.wellarchitected#RiskCounts" }, "WorkloadId": { "target": "com.amazonaws.wellarchitected#WorkloadId" }, "WorkloadName": { "target": "com.amazonaws.wellarchitected#WorkloadName" }, "WorkloadArn": { "target": "com.amazonaws.wellarchitected#WorkloadArn" }, "UpdatedAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The date and time when the consolidated report metric was last updated.

" } }, "Lenses": { "target": "com.amazonaws.wellarchitected#LensMetrics", "traits": { "smithy.api#documentation": "

The metrics for the lenses in the workload.

" } }, "LensesAppliedCount": { "target": "com.amazonaws.wellarchitected#LensesAppliedCount", "traits": { "smithy.api#documentation": "

The total number of lenses applied to the workload.

" } } }, "traits": { "smithy.api#documentation": "

A metric that contributes to the consolidated report.

" } }, "com.amazonaws.wellarchitected#ConsolidatedReportMetrics": { "type": "list", "member": { "target": "com.amazonaws.wellarchitected#ConsolidatedReportMetric" } }, "com.amazonaws.wellarchitected#ContextAccountIdList": { "type": "list", "member": { "target": "smithy.api#String", "traits": { "smithy.api#length": { "min": 12, "max": 12 }, "smithy.api#pattern": "^\\d{12}$" } } }, "com.amazonaws.wellarchitected#ContextAwsServiceList": { "type": "list", "member": { "target": "smithy.api#String", "traits": { "smithy.api#length": { "min": 1, "max": 256 }, "smithy.api#pattern": "^[\\P{C}]+$" } } }, "com.amazonaws.wellarchitected#ContextContent": { "type": "structure", "members": { "accountIds": { "target": "com.amazonaws.wellarchitected#ContextAccountIdList", "traits": { "smithy.api#documentation": "

The Amazon Web Services account IDs associated with this application context.

", "smithy.api#length": { "max": 1000 } } }, "regions": { "target": "com.amazonaws.wellarchitected#ContextRegionList", "traits": { "smithy.api#documentation": "

The Amazon Web Services Regions where this application operates.

", "smithy.api#length": { "max": 50 } } }, "awsServices": { "target": "com.amazonaws.wellarchitected#ContextAwsServiceList", "traits": { "smithy.api#documentation": "

The Amazon Web Services services used by this application.

", "smithy.api#length": { "max": 300 } } }, "resourceTypes": { "target": "com.amazonaws.wellarchitected#ContextResourceTypeList", "traits": { "smithy.api#documentation": "

The Amazon Web Services resource types relevant to this application.

", "smithy.api#length": { "max": 1500 } } }, "resourceTags": { "target": "com.amazonaws.wellarchitected#ContextResourceTagList", "traits": { "smithy.api#documentation": "

Resource tags used to scope this application context.

", "smithy.api#length": { "max": 20 } } }, "organizationalUnitIds": { "target": "com.amazonaws.wellarchitected#ContextOrganizationalUnitIdList", "traits": { "smithy.api#documentation": "

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

", "smithy.api#length": { "max": 2500 } } }, "applicationOverview": { "target": "com.amazonaws.wellarchitected#SensitiveString", "traits": { "smithy.api#documentation": "

A free-form overview of the application.

", "smithy.api#length": { "max": 10000 }, "smithy.api#pattern": "^(?:(?!\\$\\{[a-zA-Z]+:)[\\P{C}\\r\\n])*$" } }, "industry": { "target": "com.amazonaws.wellarchitected#SensitiveString", "traits": { "smithy.api#documentation": "

The industry vertical for this application.

", "smithy.api#length": { "max": 1000 }, "smithy.api#pattern": "^(?:(?!\\$\\{[a-zA-Z]+:)[\\P{C}\\r\\n])*$" } }, "applicationType": { "target": "com.amazonaws.wellarchitected#ApplicationType", "traits": { "smithy.api#documentation": "

The type of the application.

" } }, "criticality": { "target": "com.amazonaws.wellarchitected#Criticality", "traits": { "smithy.api#documentation": "

The business criticality of the application.

" } }, "architectureOverview": { "target": "com.amazonaws.wellarchitected#SensitiveString", "traits": { "smithy.api#documentation": "

A free-form description of the application architecture.

", "smithy.api#length": { "max": 10000 }, "smithy.api#pattern": "^(?:(?!\\$\\{[a-zA-Z]+:)[\\P{C}\\r\\n])*$" } }, "additionalContext": { "target": "com.amazonaws.wellarchitected#SensitiveString", "traits": { "smithy.api#documentation": "

Additional context not captured by other fields.

", "smithy.api#length": { "max": 10000 }, "smithy.api#pattern": "^(?:(?!\\$\\{[a-zA-Z]+:)[\\P{C}\\r\\n])*$" } } }, "traits": { "smithy.api#documentation": "

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

" } }, "com.amazonaws.wellarchitected#ContextOrganizationalUnitIdList": { "type": "list", "member": { "target": "smithy.api#String", "traits": { "smithy.api#length": { "min": 1, "max": 68 }, "smithy.api#pattern": "^(ou-[a-z0-9]{4,32}-[a-z0-9]{8,32}|r-[a-z0-9]{4,32})$" } } }, "com.amazonaws.wellarchitected#ContextRegionList": { "type": "list", "member": { "target": "smithy.api#String", "traits": { "smithy.api#length": { "min": 1, "max": 64 }, "smithy.api#pattern": "^[a-z]{2}(-gov)?-[a-z]+-\\d+$" } } }, "com.amazonaws.wellarchitected#ContextResourceTag": { "type": "structure", "members": { "key": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The tag key.

", "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^(?:(?!\\$\\{[a-zA-Z]+:)[\\P{C}])+$", "smithy.api#required": {} } }, "value": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The tag value.

", "smithy.api#length": { "min": 0, "max": 256 }, "smithy.api#pattern": "^(?:(?!\\$\\{[a-zA-Z]+:)[\\P{C}])*$", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

A key-value pair representing a resource tag used to scope context content.

" } }, "com.amazonaws.wellarchitected#ContextResourceTagList": { "type": "list", "member": { "target": "com.amazonaws.wellarchitected#ContextResourceTag" } }, "com.amazonaws.wellarchitected#ContextResourceTypeList": { "type": "list", "member": { "target": "smithy.api#String", "traits": { "smithy.api#length": { "min": 1, "max": 256 }, "smithy.api#pattern": "^[\\P{C}]+$" } } }, "com.amazonaws.wellarchitected#ContextSummaries": { "type": "list", "member": { "target": "com.amazonaws.wellarchitected#ContextSummary" } }, "com.amazonaws.wellarchitected#ContextSummary": { "type": "structure", "members": { "id": { "target": "com.amazonaws.wellarchitected#UUID", "traits": { "smithy.api#documentation": "

The unique identifier of the context.

", "smithy.api#required": {} } }, "profileArn": { "target": "com.amazonaws.wellarchitected#AgentProfileArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the associated profile.

", "smithy.api#required": {} } }, "title": { "target": "com.amazonaws.wellarchitected#SensitiveString", "traits": { "smithy.api#documentation": "

The title of the context.

", "smithy.api#length": { "min": 1, "max": 1000 }, "smithy.api#pattern": "^(?:(?!\\$\\{[a-zA-Z]+:)[\\P{C}])+$", "smithy.api#required": {} } }, "contextType": { "target": "com.amazonaws.wellarchitected#ContextType", "traits": { "smithy.api#documentation": "

The type of the context.

", "smithy.api#required": {} } }, "content": { "target": "com.amazonaws.wellarchitected#ContextContent", "traits": { "smithy.api#documentation": "

The typed content of the context, containing application-specific fields such as account IDs, Regions, services, and resource types.

", "smithy.api#required": {} } }, "applicationType": { "target": "com.amazonaws.wellarchitected#ApplicationType", "traits": { "smithy.api#documentation": "

The type of application described by this context.

" } }, "criticality": { "target": "com.amazonaws.wellarchitected#Criticality", "traits": { "smithy.api#documentation": "

The business criticality of the application described by this context.

" } }, "createdBy": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The identifier of the user or system that created this context.

", "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#required": {} } }, "createdAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The timestamp when the context was created.

", "smithy.api#required": {}, "smithy.api#timestampFormat": "date-time" } }, "lastModifiedBy": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The identifier of the user or system that last modified this context.

", "smithy.api#length": { "min": 1, "max": 128 } } }, "lastModifiedAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The timestamp when the context was last modified.

", "smithy.api#timestampFormat": "date-time" } } }, "traits": { "smithy.api#documentation": "

Summary of a context associated with a profile, representing application or environment information used during recommendation generation.

" } }, "com.amazonaws.wellarchitected#ContextType": { "type": "enum", "members": { "APPLICATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "APPLICATION" } } }, "traits": { "smithy.api#documentation": "

The type of a context, describing the kind of application or environment metadata it carries.

" } }, "com.amazonaws.wellarchitected#Count": { "type": "integer", "traits": { "smithy.api#documentation": "

A non-negative integer that denotes how many.

", "smithy.api#range": { "min": 0 } } }, "com.amazonaws.wellarchitected#CoverageSummary": { "type": "structure", "members": { "totalAccountsInScope": { "target": "smithy.api#Long", "traits": { "smithy.api#documentation": "

Total number of accounts that were in scope for the report after applying all filters and AWS Organizations membership validation.

", "smithy.api#required": {} } }, "accountsWithProfile": { "target": "smithy.api#Long", "traits": { "smithy.api#documentation": "

Number of in-scope accounts that had an Agent Profile and were successfully processed.

", "smithy.api#required": {} } }, "accountsWithoutProfile": { "target": "smithy.api#Long", "traits": { "smithy.api#documentation": "

Number of in-scope accounts that had no Agent Profile at the time of the snapshot.

", "smithy.api#required": {} } }, "failedAccountCount": { "target": "smithy.api#Long", "traits": { "smithy.api#documentation": "

Number of in-scope accounts that errored during processing. Equal to the length of failedAccounts.

", "smithy.api#required": {} } }, "totalProfiles": { "target": "smithy.api#Long", "traits": { "smithy.api#documentation": "

Total number of Agent Profiles contributing to the report.

", "smithy.api#required": {} } }, "totalRecommendations": { "target": "smithy.api#Long", "traits": { "smithy.api#documentation": "

Total number of recommendations included in the report across all profiles and all pillars.

", "smithy.api#required": {} } }, "recommendationCountByPillar": { "target": "com.amazonaws.wellarchitected#PillarCountList", "traits": { "smithy.api#documentation": "

Recommendation count grouped by Well-Architected pillar. Each entry pairs a Pillar enum value with a non-negative long. The counts sum to totalRecommendations.

" } }, "recommendationCountByPriority": { "target": "com.amazonaws.wellarchitected#PriorityCountList", "traits": { "smithy.api#documentation": "

Recommendation count grouped by Priority. Each entry pairs a Priority enum value with a non-negative long. The counts sum to totalRecommendations.

" } }, "failedAccounts": { "target": "com.amazonaws.wellarchitected#FailedAccountList", "traits": { "smithy.api#documentation": "

Accounts that errored during processing and the reason they failed.

" } }, "failedOrganizationalUnits": { "target": "com.amazonaws.wellarchitected#FailedOrganizationalUnitList", "traits": { "smithy.api#documentation": "

Organizational units named in the report's filters that could not be expanded into their member accounts, along with the reason each failed. A failed OU means the report is missing whatever accounts it contained. Absent or empty when every requested OU expanded successfully.

" } } }, "traits": { "smithy.api#documentation": "

Counts describing the coverage of a completed Organizational Report. Includes the number of accounts in scope, how many had a profile, how many failed, and aggregated recommendation counts by pillar and priority. Returned only by GetAgentOrganizationalReport after the report reaches COMPLETED status. Not returned on the list response.

" } }, "com.amazonaws.wellarchitected#CreateAgentBasicProfile": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#CreateAgentBasicProfileRequest" }, "output": { "target": "com.amazonaws.wellarchitected#CreateAgentBasicProfileResponse" }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" }, { "target": "com.amazonaws.wellarchitected#ConflictException" }, { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ServiceQuotaExceededException" }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, { "target": "com.amazonaws.wellarchitected#ValidationException" } ], "traits": { "smithy.api#documentation": "

Creates a Basic profile for the calling account. No configuration input is required because the account and region are inferred from the caller. The profile uses the reserved name basic. This operation is idempotent. Calling it twice returns the same ARN. Each account can have at most one Basic profile.

", "smithy.api#http": { "method": "POST", "uri": "/api/v1/agent-basic-profile", "code": 201 }, "smithy.api#idempotent": {}, "smithy.api#tags": [ "AGENT" ], "smithy.rules#staticContextParams": { "SubServiceType": { "value": "AGENT" } }, "smithy.test#smokeTests": [ { "id": "CreateAgentBasicProfile", "params": {}, "expect": { "failure": {} }, "vendorParamsShape": "aws.test#AwsVendorParams", "vendorParams": { "region": "us-west-2" } } ] } }, "com.amazonaws.wellarchitected#CreateAgentBasicProfileRequest": { "type": "structure", "members": { "tags": { "target": "com.amazonaws.wellarchitected#Tags", "traits": { "smithy.api#documentation": "

Tags to apply to the Basic profile at creation time.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.wellarchitected#CreateAgentBasicProfileResponse": { "type": "structure", "members": { "createdBy": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The identifier of the user or system that created this resource.

", "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#required": {} } }, "createdAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The timestamp when the resource was created.

", "smithy.api#required": {}, "smithy.api#timestampFormat": "date-time" } }, "lastModifiedBy": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The identifier of the user or system that last modified this resource.

", "smithy.api#length": { "min": 1, "max": 128 } } }, "lastModifiedAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The timestamp when the resource was last modified.

", "smithy.api#timestampFormat": "date-time" } }, "arn": { "target": "com.amazonaws.wellarchitected#AgentProfileArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the created Basic profile.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.wellarchitected#CreateAgentContext": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#CreateAgentContextRequest" }, "output": { "target": "com.amazonaws.wellarchitected#CreateAgentContextResponse" }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" }, { "target": "com.amazonaws.wellarchitected#ConflictException" }, { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" }, { "target": "com.amazonaws.wellarchitected#ServiceQuotaExceededException" }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, { "target": "com.amazonaws.wellarchitected#ValidationException" } ], "traits": { "smithy.api#documentation": "

Creates a context associated with an optimization profile. Contexts provide application and environment information used during recommendation generation.

", "smithy.api#http": { "method": "POST", "uri": "/api/v1/agent-profiles/{profileArn}/contexts" }, "smithy.api#idempotent": {}, "smithy.api#tags": [ "AGENT" ], "smithy.rules#staticContextParams": { "SubServiceType": { "value": "AGENT" } }, "smithy.test#smokeTests": [ { "id": "CreateAgentContext", "params": { "profileArn": "arn:aws:wellarchitected:us-west-2:123456789012:agent-profile/test-profile", "title": "smoke-test-context", "contextType": "APPLICATION", "content": {} }, "expect": { "failure": {} }, "vendorParamsShape": "aws.test#AwsVendorParams", "vendorParams": { "region": "us-west-2" } } ] } }, "com.amazonaws.wellarchitected#CreateAgentContextRequest": { "type": "structure", "members": { "clientToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

", "smithy.api#idempotencyToken": {}, "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^[\\x21-\\x7E]+$" } }, "profileArn": { "target": "com.amazonaws.wellarchitected#AgentProfileArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the profile to associate the context with.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "title": { "target": "com.amazonaws.wellarchitected#SensitiveString", "traits": { "smithy.api#documentation": "

The title of the context.

", "smithy.api#length": { "min": 1, "max": 1000 }, "smithy.api#pattern": "^(?:(?!\\$\\{[a-zA-Z]+:)[\\P{C}])+$", "smithy.api#required": {} } }, "contextType": { "target": "com.amazonaws.wellarchitected#ContextType", "traits": { "smithy.api#documentation": "

The type of the context.

", "smithy.api#required": {} } }, "content": { "target": "com.amazonaws.wellarchitected#ContextContent", "traits": { "smithy.api#documentation": "

The typed content of the context. The structure contains application-specific fields such as account IDs, Regions, services, and resource types.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.wellarchitected#CreateAgentContextResponse": { "type": "structure", "members": { "context": { "target": "com.amazonaws.wellarchitected#ContextSummary", "traits": { "smithy.api#documentation": "

The created context summary.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.wellarchitected#CreateAgentGoal": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#CreateAgentGoalRequest" }, "output": { "target": "com.amazonaws.wellarchitected#CreateAgentGoalResponse" }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" }, { "target": "com.amazonaws.wellarchitected#ConflictException" }, { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" }, { "target": "com.amazonaws.wellarchitected#ServiceQuotaExceededException" }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, { "target": "com.amazonaws.wellarchitected#ValidationException" } ], "traits": { "smithy.api#documentation": "

Creates an optimization goal associated with a profile. Goals define specific targets and objectives for the optimization process.

", "smithy.api#http": { "method": "POST", "uri": "/api/v1/agent-profiles/{profileArn}/goals" }, "smithy.api#idempotent": {}, "smithy.api#tags": [ "AGENT" ], "smithy.rules#staticContextParams": { "SubServiceType": { "value": "AGENT" } }, "smithy.test#smokeTests": [ { "id": "CreateAgentGoal", "params": { "profileArn": "arn:aws:wellarchitected:us-west-2:123456789012:agent-profile/test-profile", "pillars": [ "COST_OPTIMIZATION" ], "title": "smoke-test-goal" }, "expect": { "failure": {} }, "vendorParamsShape": "aws.test#AwsVendorParams", "vendorParams": { "region": "us-west-2" } } ] } }, "com.amazonaws.wellarchitected#CreateAgentGoalRequest": { "type": "structure", "members": { "clientToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

", "smithy.api#idempotencyToken": {}, "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^[\\x21-\\x7E]+$" } }, "profileArn": { "target": "com.amazonaws.wellarchitected#AgentProfileArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the profile to associate the goal with.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "pillars": { "target": "com.amazonaws.wellarchitected#Pillars", "traits": { "smithy.api#documentation": "

The Amazon Web Services Well-Architected Framework pillars to associate with this goal.

", "smithy.api#required": {} } }, "title": { "target": "com.amazonaws.wellarchitected#SensitiveString", "traits": { "smithy.api#documentation": "

The title of the goal.

", "smithy.api#length": { "min": 1, "max": 1000 }, "smithy.api#pattern": "^(?:(?!\\$\\{[a-zA-Z]+:)[\\P{C}])+$", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.wellarchitected#SensitiveString", "traits": { "smithy.api#documentation": "

A description of the goal.

", "smithy.api#length": { "min": 1, "max": 4000 }, "smithy.api#pattern": "^(?:(?!\\$\\{[a-zA-Z]+:)[\\P{C}])+$" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.wellarchitected#CreateAgentGoalResponse": { "type": "structure", "members": { "goal": { "target": "com.amazonaws.wellarchitected#GoalSummary", "traits": { "smithy.api#documentation": "

The created goal summary.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.wellarchitected#CreateAgentOrganizationalProfile": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#CreateAgentOrganizationalProfileRequest" }, "output": { "target": "com.amazonaws.wellarchitected#CreateAgentOrganizationalProfileResponse" }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" }, { "target": "com.amazonaws.wellarchitected#ConflictException" }, { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" }, { "target": "com.amazonaws.wellarchitected#ServiceQuotaExceededException" }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, { "target": "com.amazonaws.wellarchitected#ValidationException" } ], "traits": { "smithy.api#documentation": "

Creates an Organizational Profile for use with AWS Organizations integration. Organizational Profiles are scoped to an AWS Organization and do not require an execution role or aggregation configuration. The organization is inferred from the caller's identity.

", "smithy.api#http": { "method": "POST", "uri": "/api/v1/agent-organizational-profiles" }, "smithy.api#idempotent": {}, "smithy.api#tags": [ "AGENT" ], "smithy.rules#staticContextParams": { "SubServiceType": { "value": "AGENT" } }, "smithy.test#smokeTests": [ { "id": "CreateAgentOrganizationalProfile", "params": { "clientToken": "smoke-test-client-token", "name": "smoke-test-organizational-profile", "pillars": [ "COST_OPTIMIZATION" ], "organizationalAggregationConfiguration": { "accounts": [ { "accountId": "123456789012", "regions": [ "us-west-2" ] } ] } }, "expect": { "failure": {} }, "vendorParamsShape": "aws.test#AwsVendorParams", "vendorParams": { "region": "us-west-2" } } ] } }, "com.amazonaws.wellarchitected#CreateAgentOrganizationalProfileRequest": { "type": "structure", "members": { "name": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The system name of the organizational profile.

", "smithy.api#length": { "min": 3, "max": 128 }, "smithy.api#pattern": "^[a-zA-Z0-9_-]+$", "smithy.api#required": {} } }, "displayName": { "target": "com.amazonaws.wellarchitected#SensitiveString", "traits": { "smithy.api#documentation": "

The display name of the organizational profile shown to users.

", "smithy.api#length": { "min": 3, "max": 128 }, "smithy.api#pattern": "^(?:(?!\\$\\{[a-zA-Z]+:)[\\P{C}])+$" } }, "description": { "target": "com.amazonaws.wellarchitected#SensitiveString", "traits": { "smithy.api#documentation": "

A description of the organizational profile.

", "smithy.api#length": { "max": 512 }, "smithy.api#pattern": "^(?:(?!\\$\\{[a-zA-Z]+:)[\\P{C}])*$" } }, "businessOverview": { "target": "com.amazonaws.wellarchitected#SensitiveString", "traits": { "smithy.api#documentation": "

The business overview for this organizational profile.

", "smithy.api#length": { "max": 512 }, "smithy.api#pattern": "^(?:(?!\\$\\{[a-zA-Z]+:)[\\P{C}])*$" } }, "pillars": { "target": "com.amazonaws.wellarchitected#Pillars", "traits": { "smithy.api#documentation": "

The Amazon Web Services Well-Architected Framework pillars to associate with this organizational profile.

", "smithy.api#required": {} } }, "deletionProtection": { "target": "smithy.api#Boolean", "traits": { "smithy.api#default": true, "smithy.api#documentation": "

Indicates whether deletion protection is enabled for the organizational profile.

" } }, "clientToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

", "smithy.api#idempotencyToken": {}, "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^[\\x21-\\x7E]+$" } }, "organizationalAggregationConfiguration": { "target": "com.amazonaws.wellarchitected#OrganizationalAggregationConfiguration", "traits": { "smithy.api#documentation": "

The organizational monitoring boundary. Contains organizational unit or root entries and individual account entries that define the scope for the profile.

" } }, "tags": { "target": "com.amazonaws.wellarchitected#Tags", "traits": { "smithy.api#documentation": "

The tags to associate with the organizational profile.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.wellarchitected#CreateAgentOrganizationalProfileResponse": { "type": "structure", "members": { "name": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The system name of the created organizational profile.

", "smithy.api#length": { "min": 3, "max": 128 }, "smithy.api#pattern": "^[a-zA-Z0-9_-]+$", "smithy.api#required": {} } }, "displayName": { "target": "com.amazonaws.wellarchitected#SensitiveString", "traits": { "smithy.api#documentation": "

The display name of the created organizational profile.

", "smithy.api#length": { "min": 3, "max": 128 }, "smithy.api#pattern": "^(?:(?!\\$\\{[a-zA-Z]+:)[\\P{C}])+$" } }, "description": { "target": "com.amazonaws.wellarchitected#SensitiveString", "traits": { "smithy.api#documentation": "

A description of the created organizational profile.

", "smithy.api#length": { "max": 512 }, "smithy.api#pattern": "^(?:(?!\\$\\{[a-zA-Z]+:)[\\P{C}])*$" } }, "businessOverview": { "target": "com.amazonaws.wellarchitected#SensitiveString", "traits": { "smithy.api#documentation": "

The business overview of the created organizational profile.

", "smithy.api#length": { "max": 512 }, "smithy.api#pattern": "^(?:(?!\\$\\{[a-zA-Z]+:)[\\P{C}])*$" } }, "pillars": { "target": "com.amazonaws.wellarchitected#Pillars", "traits": { "smithy.api#documentation": "

The Amazon Web Services Well-Architected Framework pillars associated with the created organizational profile.

", "smithy.api#required": {} } }, "deletionProtection": { "target": "smithy.api#Boolean", "traits": { "smithy.api#default": true, "smithy.api#documentation": "

Indicates whether deletion protection is enabled.

" } }, "organizationId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The identifier of the Amazon Web Services Organization this profile belongs to.

", "smithy.api#required": {} } }, "organizationalAggregationConfiguration": { "target": "com.amazonaws.wellarchitected#OrganizationalAggregationConfiguration", "traits": { "smithy.api#documentation": "

The organizational monitoring boundary for the created profile. Present only for organizational profiles.

" } }, "arn": { "target": "com.amazonaws.wellarchitected#AgentProfileArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the created organizational profile.

", "smithy.api#required": {} } }, "eligibleForScheduledGeneration": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "

Indicates whether the profile is valid for scheduled recommendation generation.

" } }, "eligibleForArchitectureGeneration": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "

Indicates whether the profile is valid for manual architecture generation.

" } }, "fieldErrors": { "target": "com.amazonaws.wellarchitected#FieldErrors", "traits": { "smithy.api#documentation": "

A map of field paths to error messages for invalid or missing input fields.

" } }, "tags": { "target": "com.amazonaws.wellarchitected#Tags", "traits": { "smithy.api#documentation": "

The tags associated with the created organizational profile.

" } }, "createdBy": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The identifier of the user or system that created this organizational profile.

", "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#required": {} } }, "createdAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The timestamp when the organizational profile was created.

", "smithy.api#required": {}, "smithy.api#timestampFormat": "date-time" } }, "lastModifiedBy": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The identifier of the user or system that last modified this organizational profile.

", "smithy.api#length": { "min": 1, "max": 128 } } }, "lastModifiedAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The timestamp when the organizational profile was last modified.

", "smithy.api#timestampFormat": "date-time" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.wellarchitected#CreateAgentOrganizationalReport": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#CreateAgentOrganizationalReportRequest" }, "output": { "target": "com.amazonaws.wellarchitected#CreateAgentOrganizationalReportResponse" }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" }, { "target": "com.amazonaws.wellarchitected#ConflictException" }, { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ServiceQuotaExceededException" }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, { "target": "com.amazonaws.wellarchitected#ValidationException" } ], "traits": { "smithy.api#documentation": "

Creates an Organizational Report, which is an asynchronously-materialized, point-in-time snapshot of recommendations across all Agent Profiles within the caller's AWS Organization. You can optionally narrow the scope with filters. The operation is idempotent on the caller-supplied clientToken. The AWS Organization the report belongs to is inferred from the caller's authorization context. Reports are retained for 90 days from creation, after which they are automatically deleted. Use DeleteAgentOrganizationalReport to delete a report earlier.

", "smithy.api#http": { "method": "POST", "uri": "/api/v1/agent-organizational-reports", "code": 202 }, "smithy.api#idempotent": {}, "smithy.api#tags": [ "AGENT" ], "smithy.rules#staticContextParams": { "SubServiceType": { "value": "AGENT" } }, "smithy.test#smokeTests": [ { "id": "CreateAgentOrganizationalReport", "params": { "clientToken": "smoke-test-client-token", "label": "smoke-test-organizational-report", "filters": { "accountIds": [ "123456789012" ], "pillars": [ "COST_OPTIMIZATION" ] } }, "expect": { "failure": {} }, "vendorParamsShape": "aws.test#AwsVendorParams", "vendorParams": { "region": "us-west-2" } } ] } }, "com.amazonaws.wellarchitected#CreateAgentOrganizationalReportRequest": { "type": "structure", "members": { "clientToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

A caller-supplied idempotency token. Two create calls sharing the same token within the service's idempotency window return the same reportId.

", "smithy.api#idempotencyToken": {}, "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^[\\x21-\\x7E]+$" } }, "label": { "target": "com.amazonaws.wellarchitected#ReportLabel", "traits": { "smithy.api#documentation": "

Optional human-readable label (1-500 characters) that helps callers distinguish reports created with the same filters. Carried through list and get responses.

" } }, "filters": { "target": "com.amazonaws.wellarchitected#OrganizationalReportFilters", "traits": { "smithy.api#documentation": "

Optional filters narrowing the report's scope. Absent means the report covers the whole organization.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.wellarchitected#CreateAgentOrganizationalReportResponse": { "type": "structure", "members": { "reportId": { "target": "com.amazonaws.wellarchitected#UUID", "traits": { "smithy.api#documentation": "

Unique identifier assigned to the newly-created report.

", "smithy.api#required": {} } }, "state": { "target": "com.amazonaws.wellarchitected#OrganizationalReportState", "traits": { "smithy.api#documentation": "

Lifecycle state of the report at the moment the create call returned. For a freshly-created report this is typically DISCOVERING.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.wellarchitected#CreateAgentProfile": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#CreateAgentProfileRequest" }, "output": { "target": "com.amazonaws.wellarchitected#CreateAgentProfileResponse" }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" }, { "target": "com.amazonaws.wellarchitected#ConflictException" }, { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ServiceQuotaExceededException" }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, { "target": "com.amazonaws.wellarchitected#ValidationException" } ], "traits": { "smithy.api#documentation": "

Creates an optimization profile that defines the scope and configuration for generating recommendations. A profile specifies the execution role, target pillars, and aggregation settings for analyzing your Amazon Web Services resources.

", "smithy.api#http": { "method": "POST", "uri": "/api/v1/agent-profiles" }, "smithy.api#idempotent": {}, "smithy.api#tags": [ "AGENT" ], "smithy.rules#staticContextParams": { "SubServiceType": { "value": "AGENT" } }, "smithy.test#smokeTests": [ { "id": "CreateAgentProfile", "params": { "name": "smoke-test-profile", "executionRoleArn": "arn:aws:iam::123456789012:role/test-role", "aggregationConfiguration": [ { "accountId": "123456789012", "regions": [ "us-west-2" ], "accessRoleArn": "arn:aws:iam::123456789012:role/COINAccessRole" } ], "pillars": [ "COST_OPTIMIZATION" ], "tags": [ { "key": "test-key", "value": "test-value" } ] }, "expect": { "failure": {} }, "vendorParamsShape": "aws.test#AwsVendorParams", "vendorParams": { "region": "us-west-2" } } ] } }, "com.amazonaws.wellarchitected#CreateAgentProfileRequest": { "type": "structure", "members": { "name": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The system name of the profile.

", "smithy.api#length": { "min": 3, "max": 128 }, "smithy.api#pattern": "^[a-zA-Z0-9_-]+$", "smithy.api#required": {} } }, "displayName": { "target": "com.amazonaws.wellarchitected#SensitiveString", "traits": { "smithy.api#documentation": "

The display name of the profile shown to users.

", "smithy.api#length": { "min": 3, "max": 128 }, "smithy.api#pattern": "^(?:(?!\\$\\{[a-zA-Z]+:)[\\P{C}])+$" } }, "description": { "target": "com.amazonaws.wellarchitected#SensitiveString", "traits": { "smithy.api#documentation": "

A description of the profile.

", "smithy.api#length": { "max": 512 }, "smithy.api#pattern": "^(?:(?!\\$\\{[a-zA-Z]+:)[\\P{C}])*$" } }, "businessOverview": { "target": "com.amazonaws.wellarchitected#SensitiveString", "traits": { "smithy.api#documentation": "

The business overview for this profile.

", "smithy.api#length": { "max": 512 }, "smithy.api#pattern": "^(?:(?!\\$\\{[a-zA-Z]+:)[\\P{C}])*$" } }, "pillars": { "target": "com.amazonaws.wellarchitected#Pillars", "traits": { "smithy.api#documentation": "

The Amazon Web Services Well-Architected Framework pillars to associate with this profile.

", "smithy.api#required": {} } }, "deletionProtection": { "target": "smithy.api#Boolean", "traits": { "smithy.api#default": true, "smithy.api#documentation": "

Indicates whether deletion protection is enabled for the profile.

" } }, "executionRoleArn": { "target": "com.amazonaws.wellarchitected#RoleArn", "traits": { "smithy.api#documentation": "

The ARN of the IAM execution role used for recommendation actions.

", "smithy.api#required": {} } }, "aggregationConfiguration": { "target": "com.amazonaws.wellarchitected#AggregationConfigurations", "traits": { "smithy.api#documentation": "

The aggregation configuration that defines which Amazon Web Services accounts and Regions to analyze.

", "smithy.api#required": {} } }, "clientToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

", "smithy.api#idempotencyToken": {}, "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^[\\x21-\\x7E]+$" } }, "tags": { "target": "com.amazonaws.wellarchitected#Tags", "traits": { "smithy.api#documentation": "

The tags to associate with the profile.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.wellarchitected#CreateAgentProfileResponse": { "type": "structure", "members": { "name": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The system name of the created profile.

", "smithy.api#length": { "min": 3, "max": 128 }, "smithy.api#pattern": "^[a-zA-Z0-9_-]+$", "smithy.api#required": {} } }, "displayName": { "target": "com.amazonaws.wellarchitected#SensitiveString", "traits": { "smithy.api#documentation": "

The display name of the created profile.

", "smithy.api#length": { "min": 3, "max": 128 }, "smithy.api#pattern": "^(?:(?!\\$\\{[a-zA-Z]+:)[\\P{C}])+$" } }, "description": { "target": "com.amazonaws.wellarchitected#SensitiveString", "traits": { "smithy.api#documentation": "

A description of the created profile.

", "smithy.api#length": { "max": 512 }, "smithy.api#pattern": "^(?:(?!\\$\\{[a-zA-Z]+:)[\\P{C}])*$" } }, "businessOverview": { "target": "com.amazonaws.wellarchitected#SensitiveString", "traits": { "smithy.api#documentation": "

The business overview of the created profile.

", "smithy.api#length": { "max": 512 }, "smithy.api#pattern": "^(?:(?!\\$\\{[a-zA-Z]+:)[\\P{C}])*$" } }, "pillars": { "target": "com.amazonaws.wellarchitected#Pillars", "traits": { "smithy.api#documentation": "

The Amazon Web Services Well-Architected Framework pillars associated with the created profile.

", "smithy.api#required": {} } }, "deletionProtection": { "target": "smithy.api#Boolean", "traits": { "smithy.api#default": true, "smithy.api#documentation": "

Indicates whether deletion protection is enabled.

" } }, "executionRoleArn": { "target": "com.amazonaws.wellarchitected#RoleArn", "traits": { "smithy.api#documentation": "

The ARN of the IAM execution role.

", "smithy.api#required": {} } }, "aggregationConfiguration": { "target": "com.amazonaws.wellarchitected#AggregationConfigurations", "traits": { "smithy.api#documentation": "

The aggregation configuration.

", "smithy.api#required": {} } }, "arn": { "target": "com.amazonaws.wellarchitected#AgentProfileArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the created profile.

", "smithy.api#required": {} } }, "eligibleForScheduledGeneration": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "

Indicates whether the profile is valid for scheduled recommendation generation.

" } }, "eligibleForArchitectureGeneration": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "

Indicates whether the profile is valid for manual architecture generation.

" } }, "fieldErrors": { "target": "com.amazonaws.wellarchitected#FieldErrors", "traits": { "smithy.api#documentation": "

A map of field paths to error messages for invalid or missing input fields.

" } }, "tags": { "target": "com.amazonaws.wellarchitected#Tags", "traits": { "smithy.api#documentation": "

The tags associated with the created profile.

" } }, "createdBy": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The identifier of the user or system that created this profile.

", "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#required": {} } }, "createdAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The timestamp when the profile was created.

", "smithy.api#required": {}, "smithy.api#timestampFormat": "date-time" } }, "lastModifiedBy": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The identifier of the user or system that last modified this profile.

", "smithy.api#length": { "min": 1, "max": 128 } } }, "lastModifiedAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The timestamp when the profile was last modified.

", "smithy.api#timestampFormat": "date-time" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.wellarchitected#CreateLensShare": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#CreateLensShareInput" }, "output": { "target": "com.amazonaws.wellarchitected#CreateLensShareOutput" }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" }, { "target": "com.amazonaws.wellarchitected#ConflictException" }, { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" }, { "target": "com.amazonaws.wellarchitected#ServiceQuotaExceededException" }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, { "target": "com.amazonaws.wellarchitected#ValidationException" } ], "traits": { "smithy.api#documentation": "

Create a lens share.

The owner of a lens can share it with other Amazon Web Services accounts, users, an organization, and organizational units (OUs) in the same Amazon Web Services Region. Lenses provided by Amazon Web Services (Amazon Web Services Official Content) cannot be shared.

Shared access to a lens is not removed until the lens invitation is deleted.

If you share a lens with an organization or OU, all accounts in the organization or OU are granted access to the lens.

For more information, see Sharing a custom lens in the Well-Architected Tool User Guide.

Disclaimer

By sharing your custom lenses with other Amazon Web Services accounts, you acknowledge that Amazon Web Services will make your custom lenses available to those other accounts. Those other accounts may continue to access and use your shared custom lenses even if you delete the custom lenses from your own Amazon Web Services account or terminate your Amazon Web Services account.

", "smithy.api#http": { "method": "POST", "uri": "/lenses/{LensAlias}/shares", "code": 200 }, "smithy.api#tags": [ "WA" ] } }, "com.amazonaws.wellarchitected#CreateLensShareInput": { "type": "structure", "members": { "LensAlias": { "target": "com.amazonaws.wellarchitected#LensAlias", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "SharedWith": { "target": "com.amazonaws.wellarchitected#SharedWith", "traits": { "smithy.api#clientOptional": {}, "smithy.api#required": {} } }, "ClientRequestToken": { "target": "com.amazonaws.wellarchitected#ClientRequestToken", "traits": { "smithy.api#clientOptional": {}, "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.wellarchitected#CreateLensShareOutput": { "type": "structure", "members": { "ShareId": { "target": "com.amazonaws.wellarchitected#ShareId" } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.wellarchitected#CreateLensVersion": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#CreateLensVersionInput" }, "output": { "target": "com.amazonaws.wellarchitected#CreateLensVersionOutput" }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" }, { "target": "com.amazonaws.wellarchitected#ConflictException" }, { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" }, { "target": "com.amazonaws.wellarchitected#ServiceQuotaExceededException" }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, { "target": "com.amazonaws.wellarchitected#ValidationException" } ], "traits": { "smithy.api#documentation": "

Create a new lens version.

A lens can have up to 100 versions.

Use this operation to publish a new lens version after you have imported a lens. The LensAlias is used to identify the lens to be published. The owner of a lens can share the lens with other Amazon Web Services accounts and users in the same Amazon Web Services Region. Only the owner of a lens can delete it.

", "smithy.api#http": { "method": "POST", "uri": "/lenses/{LensAlias}/versions", "code": 200 }, "smithy.api#tags": [ "WA" ] } }, "com.amazonaws.wellarchitected#CreateLensVersionInput": { "type": "structure", "members": { "LensAlias": { "target": "com.amazonaws.wellarchitected#LensAlias", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "LensVersion": { "target": "com.amazonaws.wellarchitected#LensVersion", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The version of the lens being created.

", "smithy.api#required": {} } }, "IsMajorVersion": { "target": "com.amazonaws.wellarchitected#IsMajorVersion", "traits": { "smithy.api#documentation": "

Set to true if this new major lens version.

" } }, "ClientRequestToken": { "target": "com.amazonaws.wellarchitected#ClientRequestToken", "traits": { "smithy.api#clientOptional": {}, "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.wellarchitected#CreateLensVersionOutput": { "type": "structure", "members": { "LensArn": { "target": "com.amazonaws.wellarchitected#LensArn", "traits": { "smithy.api#documentation": "

The ARN for the lens.

" } }, "LensVersion": { "target": "com.amazonaws.wellarchitected#LensVersion", "traits": { "smithy.api#documentation": "

The version of the lens.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.wellarchitected#CreateMilestone": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#CreateMilestoneInput" }, "output": { "target": "com.amazonaws.wellarchitected#CreateMilestoneOutput" }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" }, { "target": "com.amazonaws.wellarchitected#ConflictException" }, { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" }, { "target": "com.amazonaws.wellarchitected#ServiceQuotaExceededException" }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, { "target": "com.amazonaws.wellarchitected#ValidationException" } ], "traits": { "smithy.api#documentation": "

Create a milestone for an existing workload.

", "smithy.api#http": { "method": "POST", "uri": "/workloads/{WorkloadId}/milestones", "code": 200 }, "smithy.api#tags": [ "WA" ] } }, "com.amazonaws.wellarchitected#CreateMilestoneInput": { "type": "structure", "members": { "WorkloadId": { "target": "com.amazonaws.wellarchitected#WorkloadId", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "MilestoneName": { "target": "com.amazonaws.wellarchitected#MilestoneName", "traits": { "smithy.api#clientOptional": {}, "smithy.api#required": {} } }, "ClientRequestToken": { "target": "com.amazonaws.wellarchitected#ClientRequestToken", "traits": { "smithy.api#clientOptional": {}, "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Input for milestone creation.

", "smithy.api#input": {} } }, "com.amazonaws.wellarchitected#CreateMilestoneOutput": { "type": "structure", "members": { "WorkloadId": { "target": "com.amazonaws.wellarchitected#WorkloadId" }, "MilestoneNumber": { "target": "com.amazonaws.wellarchitected#MilestoneNumber" } }, "traits": { "smithy.api#documentation": "

Output of a create milestone call.

", "smithy.api#output": {} } }, "com.amazonaws.wellarchitected#CreateProfile": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#CreateProfileInput" }, "output": { "target": "com.amazonaws.wellarchitected#CreateProfileOutput" }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" }, { "target": "com.amazonaws.wellarchitected#ConflictException" }, { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ServiceQuotaExceededException" }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, { "target": "com.amazonaws.wellarchitected#ValidationException" } ], "traits": { "smithy.api#documentation": "

Create a profile.

", "smithy.api#http": { "method": "POST", "uri": "/profiles", "code": 200 }, "smithy.api#tags": [ "WA" ] } }, "com.amazonaws.wellarchitected#CreateProfileInput": { "type": "structure", "members": { "ProfileName": { "target": "com.amazonaws.wellarchitected#ProfileName", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

Name of the profile.

", "smithy.api#required": {} } }, "ProfileDescription": { "target": "com.amazonaws.wellarchitected#ProfileDescription", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The profile description.

", "smithy.api#required": {} } }, "ProfileQuestions": { "target": "com.amazonaws.wellarchitected#ProfileQuestionUpdates", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The profile questions.

", "smithy.api#required": {} } }, "ClientRequestToken": { "target": "com.amazonaws.wellarchitected#ClientRequestToken", "traits": { "smithy.api#clientOptional": {}, "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.wellarchitected#TagMap", "traits": { "smithy.api#documentation": "

The tags assigned to the profile.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.wellarchitected#CreateProfileOutput": { "type": "structure", "members": { "ProfileArn": { "target": "com.amazonaws.wellarchitected#ProfileArn", "traits": { "smithy.api#documentation": "

The profile ARN.

" } }, "ProfileVersion": { "target": "com.amazonaws.wellarchitected#ProfileVersion", "traits": { "smithy.api#documentation": "

Version of the profile.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.wellarchitected#CreateProfileShare": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#CreateProfileShareInput" }, "output": { "target": "com.amazonaws.wellarchitected#CreateProfileShareOutput" }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" }, { "target": "com.amazonaws.wellarchitected#ConflictException" }, { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" }, { "target": "com.amazonaws.wellarchitected#ServiceQuotaExceededException" }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, { "target": "com.amazonaws.wellarchitected#ValidationException" } ], "traits": { "smithy.api#documentation": "

Create a profile share.

", "smithy.api#http": { "method": "POST", "uri": "/profiles/{ProfileArn}/shares", "code": 200 }, "smithy.api#tags": [ "WA" ] } }, "com.amazonaws.wellarchitected#CreateProfileShareInput": { "type": "structure", "members": { "ProfileArn": { "target": "com.amazonaws.wellarchitected#ProfileArn", "traits": { "smithy.api#documentation": "

The profile ARN.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "SharedWith": { "target": "com.amazonaws.wellarchitected#SharedWith", "traits": { "smithy.api#clientOptional": {}, "smithy.api#required": {} } }, "ClientRequestToken": { "target": "com.amazonaws.wellarchitected#ClientRequestToken", "traits": { "smithy.api#clientOptional": {}, "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.wellarchitected#CreateProfileShareOutput": { "type": "structure", "members": { "ShareId": { "target": "com.amazonaws.wellarchitected#ShareId" }, "ProfileArn": { "target": "com.amazonaws.wellarchitected#ProfileArn", "traits": { "smithy.api#documentation": "

The profile ARN.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.wellarchitected#CreateReviewTemplate": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#CreateReviewTemplateInput" }, "output": { "target": "com.amazonaws.wellarchitected#CreateReviewTemplateOutput" }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" }, { "target": "com.amazonaws.wellarchitected#ConflictException" }, { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" }, { "target": "com.amazonaws.wellarchitected#ServiceQuotaExceededException" }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, { "target": "com.amazonaws.wellarchitected#ValidationException" } ], "traits": { "smithy.api#documentation": "

Create a review template.

Disclaimer

Do not include or gather personal identifiable information (PII) of end users or other identifiable individuals in or via your review templates. If your review template or those shared with you and used in your account do include or collect PII you are responsible for: ensuring that the included PII is processed in accordance with applicable law, providing adequate privacy notices, and obtaining necessary consents for processing such data.

", "smithy.api#http": { "method": "POST", "uri": "/reviewTemplates", "code": 200 }, "smithy.api#tags": [ "WA" ] } }, "com.amazonaws.wellarchitected#CreateReviewTemplateInput": { "type": "structure", "members": { "TemplateName": { "target": "com.amazonaws.wellarchitected#TemplateName", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

Name of the review template.

", "smithy.api#required": {} } }, "Description": { "target": "com.amazonaws.wellarchitected#TemplateDescription", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The review template description.

", "smithy.api#required": {} } }, "Lenses": { "target": "com.amazonaws.wellarchitected#ReviewTemplateLenses", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

Lenses applied to the review template.

", "smithy.api#required": {} } }, "Notes": { "target": "com.amazonaws.wellarchitected#Notes" }, "Tags": { "target": "com.amazonaws.wellarchitected#TagMap", "traits": { "smithy.api#documentation": "

The tags assigned to the review template.

" } }, "ClientRequestToken": { "target": "com.amazonaws.wellarchitected#ClientRequestToken", "traits": { "smithy.api#clientOptional": {}, "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.wellarchitected#CreateReviewTemplateOutput": { "type": "structure", "members": { "TemplateArn": { "target": "com.amazonaws.wellarchitected#TemplateArn", "traits": { "smithy.api#documentation": "

The review template ARN.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.wellarchitected#CreateTemplateShare": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#CreateTemplateShareInput" }, "output": { "target": "com.amazonaws.wellarchitected#CreateTemplateShareOutput" }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" }, { "target": "com.amazonaws.wellarchitected#ConflictException" }, { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" }, { "target": "com.amazonaws.wellarchitected#ServiceQuotaExceededException" }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, { "target": "com.amazonaws.wellarchitected#ValidationException" } ], "traits": { "smithy.api#documentation": "

Create a review template share.

The owner of a review template can share it with other Amazon Web Services accounts, users, an organization, and organizational units (OUs) in the same Amazon Web Services Region.

Shared access to a review template is not removed until the review template share invitation is deleted.

If you share a review template with an organization or OU, all accounts in the organization or OU are granted access to the review template.

Disclaimer

By sharing your review template with other Amazon Web Services accounts, you acknowledge that Amazon Web Services will make your review template available to those other accounts.

", "smithy.api#http": { "method": "POST", "uri": "/templates/shares/{TemplateArn}", "code": 200 }, "smithy.api#tags": [ "WA" ] } }, "com.amazonaws.wellarchitected#CreateTemplateShareInput": { "type": "structure", "members": { "TemplateArn": { "target": "com.amazonaws.wellarchitected#TemplateArn", "traits": { "smithy.api#documentation": "

The review template ARN.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "SharedWith": { "target": "com.amazonaws.wellarchitected#SharedWith", "traits": { "smithy.api#clientOptional": {}, "smithy.api#required": {} } }, "ClientRequestToken": { "target": "com.amazonaws.wellarchitected#ClientRequestToken", "traits": { "smithy.api#clientOptional": {}, "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.wellarchitected#CreateTemplateShareOutput": { "type": "structure", "members": { "TemplateArn": { "target": "com.amazonaws.wellarchitected#TemplateArn", "traits": { "smithy.api#documentation": "

The review template ARN.

" } }, "ShareId": { "target": "com.amazonaws.wellarchitected#ShareId" } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.wellarchitected#CreateWorkload": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#CreateWorkloadInput" }, "output": { "target": "com.amazonaws.wellarchitected#CreateWorkloadOutput" }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" }, { "target": "com.amazonaws.wellarchitected#ConflictException" }, { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" }, { "target": "com.amazonaws.wellarchitected#ServiceQuotaExceededException" }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, { "target": "com.amazonaws.wellarchitected#ValidationException" } ], "traits": { "smithy.api#documentation": "

Create a new workload.

The owner of a workload can share the workload with other Amazon Web Services accounts, users, an organization, and organizational units (OUs) in the same Amazon Web Services Region. Only the owner of a workload can delete it.

For more information, see Defining a Workload in the Well-Architected Tool User Guide.

Either AwsRegions, NonAwsRegions, or both must be specified when creating a workload.

You also must specify ReviewOwner, even though the parameter is listed as not being required in the following section.

When creating a workload using a review template, you must have the following IAM permissions:

", "smithy.api#http": { "method": "POST", "uri": "/workloads", "code": 200 }, "smithy.api#tags": [ "WA" ] } }, "com.amazonaws.wellarchitected#CreateWorkloadInput": { "type": "structure", "members": { "WorkloadName": { "target": "com.amazonaws.wellarchitected#WorkloadName", "traits": { "smithy.api#clientOptional": {}, "smithy.api#required": {} } }, "Description": { "target": "com.amazonaws.wellarchitected#WorkloadDescription", "traits": { "smithy.api#clientOptional": {}, "smithy.api#required": {} } }, "Environment": { "target": "com.amazonaws.wellarchitected#WorkloadEnvironment", "traits": { "smithy.api#clientOptional": {}, "smithy.api#required": {} } }, "AccountIds": { "target": "com.amazonaws.wellarchitected#WorkloadAccountIds" }, "AwsRegions": { "target": "com.amazonaws.wellarchitected#WorkloadAwsRegions" }, "NonAwsRegions": { "target": "com.amazonaws.wellarchitected#WorkloadNonAwsRegions" }, "PillarPriorities": { "target": "com.amazonaws.wellarchitected#WorkloadPillarPriorities" }, "ArchitecturalDesign": { "target": "com.amazonaws.wellarchitected#WorkloadArchitecturalDesign" }, "ReviewOwner": { "target": "com.amazonaws.wellarchitected#WorkloadReviewOwner" }, "IndustryType": { "target": "com.amazonaws.wellarchitected#WorkloadIndustryType" }, "Industry": { "target": "com.amazonaws.wellarchitected#WorkloadIndustry" }, "Lenses": { "target": "com.amazonaws.wellarchitected#WorkloadLenses", "traits": { "smithy.api#clientOptional": {}, "smithy.api#required": {} } }, "Notes": { "target": "com.amazonaws.wellarchitected#Notes" }, "ClientRequestToken": { "target": "com.amazonaws.wellarchitected#ClientRequestToken", "traits": { "smithy.api#clientOptional": {}, "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.wellarchitected#TagMap", "traits": { "smithy.api#documentation": "

The tags to be associated with the workload.

" } }, "DiscoveryConfig": { "target": "com.amazonaws.wellarchitected#WorkloadDiscoveryConfig", "traits": { "smithy.api#documentation": "

Well-Architected discovery configuration settings associated to the workload.

" } }, "Applications": { "target": "com.amazonaws.wellarchitected#WorkloadApplications", "traits": { "smithy.api#documentation": "

List of AppRegistry application ARNs associated to the workload.

" } }, "ProfileArns": { "target": "com.amazonaws.wellarchitected#WorkloadProfileArns", "traits": { "smithy.api#documentation": "

The list of profile ARNs associated with the workload.

" } }, "ReviewTemplateArns": { "target": "com.amazonaws.wellarchitected#ReviewTemplateArns", "traits": { "smithy.api#documentation": "

The list of review template ARNs to associate with the workload.

" } }, "JiraConfiguration": { "target": "com.amazonaws.wellarchitected#WorkloadJiraConfigurationInput", "traits": { "smithy.api#documentation": "

Jira configuration settings when creating a workload.

" } } }, "traits": { "smithy.api#documentation": "

Input for workload creation.

", "smithy.api#input": {} } }, "com.amazonaws.wellarchitected#CreateWorkloadOutput": { "type": "structure", "members": { "WorkloadId": { "target": "com.amazonaws.wellarchitected#WorkloadId" }, "WorkloadArn": { "target": "com.amazonaws.wellarchitected#WorkloadArn" } }, "traits": { "smithy.api#documentation": "

Output of a create workload call.

", "smithy.api#output": {} } }, "com.amazonaws.wellarchitected#CreateWorkloadShare": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#CreateWorkloadShareInput" }, "output": { "target": "com.amazonaws.wellarchitected#CreateWorkloadShareOutput" }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" }, { "target": "com.amazonaws.wellarchitected#ConflictException" }, { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" }, { "target": "com.amazonaws.wellarchitected#ServiceQuotaExceededException" }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, { "target": "com.amazonaws.wellarchitected#ValidationException" } ], "traits": { "smithy.api#documentation": "

Create a workload share.

The owner of a workload can share it with other Amazon Web Services accounts and users in the same Amazon Web Services Region. Shared access to a workload is not removed until the workload invitation is deleted.

If you share a workload with an organization or OU, all accounts in the organization or OU are granted access to the workload.

For more information, see Sharing a workload in the Well-Architected Tool User Guide.

", "smithy.api#http": { "method": "POST", "uri": "/workloads/{WorkloadId}/shares", "code": 200 }, "smithy.api#tags": [ "WA" ] } }, "com.amazonaws.wellarchitected#CreateWorkloadShareInput": { "type": "structure", "members": { "WorkloadId": { "target": "com.amazonaws.wellarchitected#WorkloadId", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "SharedWith": { "target": "com.amazonaws.wellarchitected#SharedWith", "traits": { "smithy.api#clientOptional": {}, "smithy.api#required": {} } }, "PermissionType": { "target": "com.amazonaws.wellarchitected#PermissionType", "traits": { "smithy.api#clientOptional": {}, "smithy.api#required": {} } }, "ClientRequestToken": { "target": "com.amazonaws.wellarchitected#ClientRequestToken", "traits": { "smithy.api#clientOptional": {}, "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Input for Create Workload Share

", "smithy.api#input": {} } }, "com.amazonaws.wellarchitected#CreateWorkloadShareOutput": { "type": "structure", "members": { "WorkloadId": { "target": "com.amazonaws.wellarchitected#WorkloadId" }, "ShareId": { "target": "com.amazonaws.wellarchitected#ShareId" } }, "traits": { "smithy.api#documentation": "

Input for Create Workload Share

", "smithy.api#output": {} } }, "com.amazonaws.wellarchitected#Criticality": { "type": "enum", "members": { "MISSION_CRITICAL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MISSION_CRITICAL" } }, "BUSINESS_CRITICAL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "BUSINESS_CRITICAL" } }, "NON_CRITICAL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NON_CRITICAL" } }, "TEST_DEVELOPMENT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "TEST_DEVELOPMENT" } } }, "traits": { "smithy.api#documentation": "

The business criticality of an application context.

" } }, "com.amazonaws.wellarchitected#CrossPillarBenefit": { "type": "structure", "members": { "pillar": { "target": "com.amazonaws.wellarchitected#Pillar", "traits": { "smithy.api#documentation": "

The pillar that would be positively impacted.

", "smithy.api#required": {} } }, "title": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

A short phrase describing the outcome.

", "smithy.api#length": { "min": 3, "max": 80 }, "smithy.api#required": {} } }, "description": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

A description of what changes and why it matters.

", "smithy.api#length": { "min": 30, "max": 300 }, "smithy.api#required": {} } }, "impact": { "target": "com.amazonaws.wellarchitected#ImpactCategory", "traits": { "smithy.api#documentation": "

The severity of the benefit.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

A benefit on a different pillar from acting on the recommendation.

" } }, "com.amazonaws.wellarchitected#CrossPillarBenefits": { "type": "list", "member": { "target": "com.amazonaws.wellarchitected#CrossPillarBenefit" } }, "com.amazonaws.wellarchitected#DefinitionType": { "type": "enum", "members": { "WORKLOAD_METADATA": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "WORKLOAD_METADATA" } }, "APP_REGISTRY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "APP_REGISTRY" } } } }, "com.amazonaws.wellarchitected#DeleteAgentContext": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#DeleteAgentContextRequest" }, "output": { "target": "com.amazonaws.wellarchitected#DeleteAgentContextResponse" }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" }, { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, { "target": "com.amazonaws.wellarchitected#ValidationException" } ], "traits": { "smithy.api#documentation": "

Deletes a context associated with a profile.

", "smithy.api#http": { "method": "DELETE", "uri": "/api/v1/agent-profiles/{profileArn}/contexts/{id}" }, "smithy.api#idempotent": {}, "smithy.api#tags": [ "AGENT" ], "smithy.rules#staticContextParams": { "SubServiceType": { "value": "AGENT" } }, "smithy.test#smokeTests": [ { "id": "DeleteAgentContext", "params": { "profileArn": "arn:aws:wellarchitected:us-west-2:123456789012:agent-profile/test-profile", "id": "f6b5df15-3409-483f-b796-45d0e590222c" }, "expect": { "failure": {} }, "vendorParamsShape": "aws.test#AwsVendorParams", "vendorParams": { "region": "us-west-2" } } ] } }, "com.amazonaws.wellarchitected#DeleteAgentContextRequest": { "type": "structure", "members": { "profileArn": { "target": "com.amazonaws.wellarchitected#AgentProfileArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the profile containing the context.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "id": { "target": "com.amazonaws.wellarchitected#UUID", "traits": { "smithy.api#documentation": "

The unique identifier of the context to delete.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.wellarchitected#DeleteAgentContextResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.wellarchitected#DeleteAgentGoal": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#DeleteAgentGoalRequest" }, "output": { "target": "com.amazonaws.wellarchitected#DeleteAgentGoalResponse" }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" }, { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, { "target": "com.amazonaws.wellarchitected#ValidationException" } ], "traits": { "smithy.api#documentation": "

Deletes an optimization goal from a profile.

", "smithy.api#http": { "method": "DELETE", "uri": "/api/v1/agent-profiles/{profileArn}/goals/{id}" }, "smithy.api#idempotent": {}, "smithy.api#tags": [ "AGENT" ], "smithy.rules#staticContextParams": { "SubServiceType": { "value": "AGENT" } }, "smithy.test#smokeTests": [ { "id": "DeleteAgentGoal", "params": { "profileArn": "arn:aws:wellarchitected:us-west-2:123456789012:agent-profile/test-profile", "id": "f6b5df15-3409-483f-b796-45d0e590222c" }, "expect": { "failure": {} }, "vendorParamsShape": "aws.test#AwsVendorParams", "vendorParams": { "region": "us-west-2" } } ] } }, "com.amazonaws.wellarchitected#DeleteAgentGoalRequest": { "type": "structure", "members": { "profileArn": { "target": "com.amazonaws.wellarchitected#AgentProfileArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the profile containing the goal.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "id": { "target": "com.amazonaws.wellarchitected#UUID", "traits": { "smithy.api#documentation": "

The unique identifier of the goal to delete.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.wellarchitected#DeleteAgentGoalResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.wellarchitected#DeleteAgentOrganizationalReport": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#DeleteAgentOrganizationalReportRequest" }, "output": { "target": "com.amazonaws.wellarchitected#DeleteAgentOrganizationalReportResponse" }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" }, { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, { "target": "com.amazonaws.wellarchitected#ValidationException" } ], "traits": { "smithy.api#documentation": "

Deletes an Organizational Report and its associated artifacts. The operation is idempotent, so repeated calls for a report that has already been deleted return success.

", "smithy.api#http": { "method": "DELETE", "uri": "/api/v1/agent-organizational-reports/{reportId}", "code": 204 }, "smithy.api#idempotent": {}, "smithy.api#tags": [ "AGENT" ], "smithy.rules#staticContextParams": { "SubServiceType": { "value": "AGENT" } }, "smithy.test#smokeTests": [ { "id": "DeleteAgentOrganizationalReport", "params": { "reportId": "f6b5df15-3409-483f-b796-45d0e590222c" }, "expect": { "failure": {} }, "vendorParamsShape": "aws.test#AwsVendorParams", "vendorParams": { "region": "us-west-2" } } ] } }, "com.amazonaws.wellarchitected#DeleteAgentOrganizationalReportRequest": { "type": "structure", "members": { "reportId": { "target": "com.amazonaws.wellarchitected#UUID", "traits": { "smithy.api#documentation": "

Identifier of the report to delete.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.wellarchitected#DeleteAgentOrganizationalReportResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.wellarchitected#DeleteAgentProfile": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#DeleteAgentProfileRequest" }, "output": { "target": "com.amazonaws.wellarchitected#DeleteAgentProfileResponse" }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" }, { "target": "com.amazonaws.wellarchitected#ConflictException" }, { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, { "target": "com.amazonaws.wellarchitected#ValidationException" } ], "traits": { "smithy.api#documentation": "

Deletes an optimization profile and its associated configuration. This action cannot be undone.

", "smithy.api#http": { "method": "DELETE", "uri": "/api/v1/agent-profiles/{profileArn}" }, "smithy.api#idempotent": {}, "smithy.api#tags": [ "AGENT" ], "smithy.rules#staticContextParams": { "SubServiceType": { "value": "AGENT" } }, "smithy.test#smokeTests": [ { "id": "DeleteAgentProfile", "params": { "profileArn": "arn:aws:wellarchitected:us-west-2:123456789012:agent-profile/test-profile" }, "expect": { "failure": {} }, "vendorParamsShape": "aws.test#AwsVendorParams", "vendorParams": { "region": "us-west-2" } } ] } }, "com.amazonaws.wellarchitected#DeleteAgentProfilePolicy": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#DeleteAgentProfilePolicyRequest" }, "output": { "target": "com.amazonaws.wellarchitected#DeleteAgentProfilePolicyResponse" }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" }, { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, { "target": "com.amazonaws.wellarchitected#ValidationException" } ], "traits": { "smithy.api#documentation": "

Removes the resource-based policy from an Agent Profile. This revokes all cross-account access previously granted by the policy. Only the profile owner can call this operation.

", "smithy.api#http": { "method": "DELETE", "uri": "/api/v1/agent-profiles/{profileArn}/policy", "code": 204 }, "smithy.api#idempotent": {}, "smithy.api#tags": [ "AGENT" ], "smithy.rules#staticContextParams": { "SubServiceType": { "value": "AGENT" } }, "smithy.test#smokeTests": [ { "id": "DeleteAgentProfilePolicy", "params": { "profileArn": "arn:aws:wellarchitected:us-west-2:123456789012:agent-profile/test-profile" }, "expect": { "failure": {} }, "vendorParamsShape": "aws.test#AwsVendorParams", "vendorParams": { "region": "us-west-2" } } ] } }, "com.amazonaws.wellarchitected#DeleteAgentProfilePolicyRequest": { "type": "structure", "members": { "profileArn": { "target": "com.amazonaws.wellarchitected#AgentProfileArn", "traits": { "smithy.api#documentation": "

The ARN of the Agent Profile whose policy to delete.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.wellarchitected#DeleteAgentProfilePolicyResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.wellarchitected#DeleteAgentProfileRequest": { "type": "structure", "members": { "profileArn": { "target": "com.amazonaws.wellarchitected#AgentProfileArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the profile to delete.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.wellarchitected#DeleteAgentProfileResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.wellarchitected#DeleteAgentRecommendationPolicy": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#DeleteAgentRecommendationPolicyRequest" }, "output": { "target": "com.amazonaws.wellarchitected#DeleteAgentRecommendationPolicyResponse" }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" }, { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, { "target": "com.amazonaws.wellarchitected#ValidationException" } ], "traits": { "smithy.api#documentation": "

Removes the resource-based policy from an individual Agent Recommendation. This revokes all cross-account access previously granted by the policy. The recommendation owner or any principal with profile write access on the parent profile can call this operation.

", "smithy.api#http": { "method": "DELETE", "uri": "/api/v1/agent-recommendations/{recommendationArn}/policy", "code": 204 }, "smithy.api#idempotent": {}, "smithy.api#tags": [ "AGENT" ], "smithy.rules#staticContextParams": { "SubServiceType": { "value": "AGENT" } }, "smithy.test#smokeTests": [ { "id": "DeleteAgentRecommendationPolicy", "params": { "recommendationArn": "arn:aws:wellarchitected:us-west-2:123456789012:agent-recommendation/f6b5df15-3409-483f-b796-45d0e590222c" }, "expect": { "failure": {} }, "vendorParamsShape": "aws.test#AwsVendorParams", "vendorParams": { "region": "us-west-2" } } ] } }, "com.amazonaws.wellarchitected#DeleteAgentRecommendationPolicyRequest": { "type": "structure", "members": { "recommendationArn": { "target": "com.amazonaws.wellarchitected#AgentRecommendationArn", "traits": { "smithy.api#documentation": "

The ARN of the Agent Recommendation whose policy to delete.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.wellarchitected#DeleteAgentRecommendationPolicyResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.wellarchitected#DeleteLens": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#DeleteLensInput" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" }, { "target": "com.amazonaws.wellarchitected#ConflictException" }, { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, { "target": "com.amazonaws.wellarchitected#ValidationException" } ], "traits": { "smithy.api#documentation": "

Delete an existing lens.

Only the owner of a lens can delete it. After the lens is deleted, Amazon Web Services accounts and users that you shared the lens with can continue to use it, but they will no longer be able to apply it to new workloads.

Disclaimer

By sharing your custom lenses with other Amazon Web Services accounts, you acknowledge that Amazon Web Services will make your custom lenses available to those other accounts. Those other accounts may continue to access and use your shared custom lenses even if you delete the custom lenses from your own Amazon Web Services account or terminate your Amazon Web Services account.

", "smithy.api#http": { "method": "DELETE", "uri": "/lenses/{LensAlias}", "code": 200 }, "smithy.api#tags": [ "WA" ] } }, "com.amazonaws.wellarchitected#DeleteLensInput": { "type": "structure", "members": { "LensAlias": { "target": "com.amazonaws.wellarchitected#LensAlias", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "ClientRequestToken": { "target": "com.amazonaws.wellarchitected#ClientRequestToken", "traits": { "smithy.api#clientOptional": {}, "smithy.api#httpQuery": "ClientRequestToken", "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } }, "LensStatus": { "target": "com.amazonaws.wellarchitected#LensStatusType", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The status of the lens to be deleted.

", "smithy.api#httpQuery": "LensStatus", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.wellarchitected#DeleteLensShare": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#DeleteLensShareInput" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" }, { "target": "com.amazonaws.wellarchitected#ConflictException" }, { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, { "target": "com.amazonaws.wellarchitected#ValidationException" } ], "traits": { "smithy.api#documentation": "

Delete a lens share.

After the lens share is deleted, Amazon Web Services accounts, users, organizations, and organizational units (OUs) that you shared the lens with can continue to use it, but they will no longer be able to apply it to new workloads.

Disclaimer

By sharing your custom lenses with other Amazon Web Services accounts, you acknowledge that Amazon Web Services will make your custom lenses available to those other accounts. Those other accounts may continue to access and use your shared custom lenses even if you delete the custom lenses from your own Amazon Web Services account or terminate your Amazon Web Services account.

", "smithy.api#http": { "method": "DELETE", "uri": "/lenses/{LensAlias}/shares/{ShareId}", "code": 200 }, "smithy.api#tags": [ "WA" ] } }, "com.amazonaws.wellarchitected#DeleteLensShareInput": { "type": "structure", "members": { "ShareId": { "target": "com.amazonaws.wellarchitected#ShareId", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "LensAlias": { "target": "com.amazonaws.wellarchitected#LensAlias", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "ClientRequestToken": { "target": "com.amazonaws.wellarchitected#ClientRequestToken", "traits": { "smithy.api#clientOptional": {}, "smithy.api#httpQuery": "ClientRequestToken", "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.wellarchitected#DeleteProfile": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#DeleteProfileInput" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" }, { "target": "com.amazonaws.wellarchitected#ConflictException" }, { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, { "target": "com.amazonaws.wellarchitected#ValidationException" } ], "traits": { "smithy.api#documentation": "

Delete a profile.

Disclaimer

By sharing your profile with other Amazon Web Services accounts, you acknowledge that Amazon Web Services will make your profile available to those other accounts. Those other accounts may continue to access and use your shared profile even if you delete the profile from your own Amazon Web Services account or terminate your Amazon Web Services account.

", "smithy.api#http": { "method": "DELETE", "uri": "/profiles/{ProfileArn}", "code": 200 }, "smithy.api#tags": [ "WA" ] } }, "com.amazonaws.wellarchitected#DeleteProfileInput": { "type": "structure", "members": { "ProfileArn": { "target": "com.amazonaws.wellarchitected#ProfileArn", "traits": { "smithy.api#documentation": "

The profile ARN.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "ClientRequestToken": { "target": "com.amazonaws.wellarchitected#ClientRequestToken", "traits": { "smithy.api#clientOptional": {}, "smithy.api#httpQuery": "ClientRequestToken", "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.wellarchitected#DeleteProfileShare": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#DeleteProfileShareInput" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" }, { "target": "com.amazonaws.wellarchitected#ConflictException" }, { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, { "target": "com.amazonaws.wellarchitected#ValidationException" } ], "traits": { "smithy.api#documentation": "

Delete a profile share.

", "smithy.api#http": { "method": "DELETE", "uri": "/profiles/{ProfileArn}/shares/{ShareId}", "code": 200 }, "smithy.api#tags": [ "WA" ] } }, "com.amazonaws.wellarchitected#DeleteProfileShareInput": { "type": "structure", "members": { "ShareId": { "target": "com.amazonaws.wellarchitected#ShareId", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "ProfileArn": { "target": "com.amazonaws.wellarchitected#ProfileArn", "traits": { "smithy.api#documentation": "

The profile ARN.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "ClientRequestToken": { "target": "com.amazonaws.wellarchitected#ClientRequestToken", "traits": { "smithy.api#clientOptional": {}, "smithy.api#httpQuery": "ClientRequestToken", "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.wellarchitected#DeleteReviewTemplate": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#DeleteReviewTemplateInput" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" }, { "target": "com.amazonaws.wellarchitected#ConflictException" }, { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, { "target": "com.amazonaws.wellarchitected#ValidationException" } ], "traits": { "smithy.api#documentation": "

Delete a review template.

Only the owner of a review template can delete it.

After the review template is deleted, Amazon Web Services accounts, users, organizations, and organizational units (OUs) that you shared the review template with will no longer be able to apply it to new workloads.

", "smithy.api#http": { "method": "DELETE", "uri": "/reviewTemplates/{TemplateArn}", "code": 200 }, "smithy.api#tags": [ "WA" ] } }, "com.amazonaws.wellarchitected#DeleteReviewTemplateInput": { "type": "structure", "members": { "TemplateArn": { "target": "com.amazonaws.wellarchitected#TemplateArn", "traits": { "smithy.api#documentation": "

The review template ARN.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "ClientRequestToken": { "target": "com.amazonaws.wellarchitected#ClientRequestToken", "traits": { "smithy.api#clientOptional": {}, "smithy.api#httpQuery": "ClientRequestToken", "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.wellarchitected#DeleteTemplateShare": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#DeleteTemplateShareInput" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" }, { "target": "com.amazonaws.wellarchitected#ConflictException" }, { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, { "target": "com.amazonaws.wellarchitected#ValidationException" } ], "traits": { "smithy.api#documentation": "

Delete a review template share.

After the review template share is deleted, Amazon Web Services accounts, users, organizations, and organizational units (OUs) that you shared the review template with will no longer be able to apply it to new workloads.

", "smithy.api#http": { "method": "DELETE", "uri": "/templates/shares/{TemplateArn}/{ShareId}", "code": 200 }, "smithy.api#tags": [ "WA" ] } }, "com.amazonaws.wellarchitected#DeleteTemplateShareInput": { "type": "structure", "members": { "ShareId": { "target": "com.amazonaws.wellarchitected#ShareId", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "TemplateArn": { "target": "com.amazonaws.wellarchitected#TemplateArn", "traits": { "smithy.api#documentation": "

The review template ARN.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "ClientRequestToken": { "target": "com.amazonaws.wellarchitected#ClientRequestToken", "traits": { "smithy.api#clientOptional": {}, "smithy.api#httpQuery": "ClientRequestToken", "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.wellarchitected#DeleteWorkload": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#DeleteWorkloadInput" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" }, { "target": "com.amazonaws.wellarchitected#ConflictException" }, { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, { "target": "com.amazonaws.wellarchitected#ValidationException" } ], "traits": { "smithy.api#documentation": "

Delete an existing workload.

", "smithy.api#http": { "method": "DELETE", "uri": "/workloads/{WorkloadId}", "code": 200 }, "smithy.api#tags": [ "WA" ] } }, "com.amazonaws.wellarchitected#DeleteWorkloadInput": { "type": "structure", "members": { "WorkloadId": { "target": "com.amazonaws.wellarchitected#WorkloadId", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "ClientRequestToken": { "target": "com.amazonaws.wellarchitected#ClientRequestToken", "traits": { "smithy.api#clientOptional": {}, "smithy.api#httpQuery": "ClientRequestToken", "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Input for workload deletion.

", "smithy.api#input": {} } }, "com.amazonaws.wellarchitected#DeleteWorkloadShare": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#DeleteWorkloadShareInput" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" }, { "target": "com.amazonaws.wellarchitected#ConflictException" }, { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, { "target": "com.amazonaws.wellarchitected#ValidationException" } ], "traits": { "smithy.api#documentation": "

Delete a workload share.

", "smithy.api#http": { "method": "DELETE", "uri": "/workloads/{WorkloadId}/shares/{ShareId}", "code": 200 }, "smithy.api#tags": [ "WA" ] } }, "com.amazonaws.wellarchitected#DeleteWorkloadShareInput": { "type": "structure", "members": { "ShareId": { "target": "com.amazonaws.wellarchitected#ShareId", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "WorkloadId": { "target": "com.amazonaws.wellarchitected#WorkloadId", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "ClientRequestToken": { "target": "com.amazonaws.wellarchitected#ClientRequestToken", "traits": { "smithy.api#clientOptional": {}, "smithy.api#httpQuery": "ClientRequestToken", "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Input for Delete Workload Share

", "smithy.api#input": {} } }, "com.amazonaws.wellarchitected#DifferenceStatus": { "type": "enum", "members": { "UPDATED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UPDATED" } }, "NEW": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NEW" } }, "DELETED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DELETED" } } } }, "com.amazonaws.wellarchitected#DisassociateLenses": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#DisassociateLensesInput" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" }, { "target": "com.amazonaws.wellarchitected#ConflictException" }, { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, { "target": "com.amazonaws.wellarchitected#ValidationException" } ], "traits": { "smithy.api#documentation": "

Disassociate a lens from a workload.

Up to 10 lenses can be disassociated from a workload in a single API operation.

The Amazon Web Services Well-Architected Framework lens (wellarchitected) cannot be removed from a workload.

", "smithy.api#http": { "method": "PATCH", "uri": "/workloads/{WorkloadId}/disassociateLenses", "code": 200 }, "smithy.api#tags": [ "WA" ] } }, "com.amazonaws.wellarchitected#DisassociateLensesInput": { "type": "structure", "members": { "WorkloadId": { "target": "com.amazonaws.wellarchitected#WorkloadId", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "LensAliases": { "target": "com.amazonaws.wellarchitected#LensAliases", "traits": { "smithy.api#clientOptional": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Input to disassociate lens reviews.

", "smithy.api#input": {} } }, "com.amazonaws.wellarchitected#DisassociateProfiles": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#DisassociateProfilesInput" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" }, { "target": "com.amazonaws.wellarchitected#ConflictException" }, { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, { "target": "com.amazonaws.wellarchitected#ValidationException" } ], "traits": { "smithy.api#documentation": "

Disassociate a profile from a workload.

", "smithy.api#http": { "method": "PATCH", "uri": "/workloads/{WorkloadId}/disassociateProfiles", "code": 200 }, "smithy.api#tags": [ "WA" ] } }, "com.amazonaws.wellarchitected#DisassociateProfilesInput": { "type": "structure", "members": { "WorkloadId": { "target": "com.amazonaws.wellarchitected#WorkloadId", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "ProfileArns": { "target": "com.amazonaws.wellarchitected#ProfileArns", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The list of profile ARNs to disassociate from the workload.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.wellarchitected#DiscoveryIntegrationStatus": { "type": "enum", "members": { "ENABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ENABLED" } }, "DISABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DISABLED" } } } }, "com.amazonaws.wellarchitected#DisplayText": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 64 } } }, "com.amazonaws.wellarchitected#Effort": { "type": "enum", "members": { "LARGE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "LARGE" } }, "MEDIUM": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MEDIUM" } }, "SMALL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SMALL" } } }, "traits": { "smithy.api#documentation": "

The level of effort required to implement a recommendation.

" } }, "com.amazonaws.wellarchitected#ErrorDetails": { "type": "structure", "members": { "code": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The status code identifying the type of error.

", "smithy.api#required": {} } }, "message": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

A human-readable description of the error.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Details about an error that occurred during recommendation generation.

" } }, "com.amazonaws.wellarchitected#ExceptionMessage": { "type": "string", "traits": { "smithy.api#documentation": "

Description of the error.

" } }, "com.amazonaws.wellarchitected#ExceptionResourceId": { "type": "string", "traits": { "smithy.api#documentation": "

Identifier of the resource affected.

" } }, "com.amazonaws.wellarchitected#ExceptionResourceType": { "type": "string", "traits": { "smithy.api#documentation": "

Type of the resource affected.

" } }, "com.amazonaws.wellarchitected#ExportLens": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#ExportLensInput" }, "output": { "target": "com.amazonaws.wellarchitected#ExportLensOutput" }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" }, { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, { "target": "com.amazonaws.wellarchitected#ValidationException" } ], "traits": { "smithy.api#documentation": "

Export an existing lens.

Only the owner of a lens can export it. Lenses provided by Amazon Web Services (Amazon Web Services Official Content) cannot be exported.

Lenses are defined in JSON. For more information, see JSON format specification in the Well-Architected Tool User Guide.

Disclaimer

Do not include or gather personal identifiable information (PII) of end users or other identifiable individuals in or via your custom lenses. If your custom lens or those shared with you and used in your account do include or collect PII you are responsible for: ensuring that the included PII is processed in accordance with applicable law, providing adequate privacy notices, and obtaining necessary consents for processing such data.

", "smithy.api#http": { "method": "GET", "uri": "/lenses/{LensAlias}/export", "code": 200 }, "smithy.api#tags": [ "WA" ] } }, "com.amazonaws.wellarchitected#ExportLensInput": { "type": "structure", "members": { "LensAlias": { "target": "com.amazonaws.wellarchitected#LensAlias", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "LensVersion": { "target": "com.amazonaws.wellarchitected#LensVersion", "traits": { "smithy.api#documentation": "

The lens version to be exported.

", "smithy.api#httpQuery": "LensVersion" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.wellarchitected#ExportLensOutput": { "type": "structure", "members": { "LensJSON": { "target": "com.amazonaws.wellarchitected#LensJSON", "traits": { "smithy.api#documentation": "

The JSON representation of a lens.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.wellarchitected#FailedAccount": { "type": "structure", "members": { "accountId": { "target": "com.amazonaws.wellarchitected#AccountId", "traits": { "smithy.api#documentation": "

The AWS account ID that failed.

", "smithy.api#required": {} } }, "reason": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

A human-readable explanation of why the account could not be processed.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

An account that was in scope for an Organizational Report but could not be processed, along with the reason for the failure.

" } }, "com.amazonaws.wellarchitected#FailedAccountList": { "type": "list", "member": { "target": "com.amazonaws.wellarchitected#FailedAccount" }, "traits": { "smithy.api#length": { "max": 1000 } } }, "com.amazonaws.wellarchitected#FailedOrganizationalUnit": { "type": "structure", "members": { "organizationalUnitId": { "target": "com.amazonaws.wellarchitected#OrganizationalUnitId", "traits": { "smithy.api#documentation": "

The AWS Organizations OU ID that could not be expanded.

", "smithy.api#required": {} } }, "reason": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

A human-readable explanation of why the organizational unit could not be expanded.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

An organizational unit that was requested in an Organizational Report's filters but could not be expanded into its member accounts. A failed OU means the report is missing the accounts it contained.

" } }, "com.amazonaws.wellarchitected#FailedOrganizationalUnitList": { "type": "list", "member": { "target": "com.amazonaws.wellarchitected#FailedOrganizationalUnit" }, "traits": { "smithy.api#length": { "max": 1000 } } }, "com.amazonaws.wellarchitected#FeedbackCategory": { "type": "enum", "members": { "OTHER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "OTHER" } }, "RECOMMENDATION_NOT_RELEVANT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RECOMMENDATION_NOT_RELEVANT" } }, "RESOURCE_NOT_IMPORTANT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RESOURCE_NOT_IMPORTANT" } }, "RESOURCE_TYPE_NOT_IMPORTANT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RESOURCE_TYPE_NOT_IMPORTANT" } }, "RECOMMENDATION_INCORRECT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RECOMMENDATION_INCORRECT" } } }, "traits": { "smithy.api#documentation": "

A category that classifies the specific nature of recommendation feedback. Used to provide structured feedback that the recommendation engine can act upon in subsequent generation cycles.

" } }, "com.amazonaws.wellarchitected#FieldErrorMessage": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 1024 } } }, "com.amazonaws.wellarchitected#FieldErrorPath": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 256 } } }, "com.amazonaws.wellarchitected#FieldErrors": { "type": "map", "key": { "target": "com.amazonaws.wellarchitected#FieldErrorPath" }, "value": { "target": "com.amazonaws.wellarchitected#FieldErrorMessage" }, "traits": { "smithy.api#length": { "max": 100 } } }, "com.amazonaws.wellarchitected#FlaggedResources": { "type": "integer", "traits": { "smithy.api#range": { "min": 1, "max": 9999 } } }, "com.amazonaws.wellarchitected#GenerationRecommendationTypes": { "type": "list", "member": { "target": "com.amazonaws.wellarchitected#RecommendationType" }, "traits": { "smithy.api#length": { "max": 3 }, "smithy.api#uniqueItems": {} } }, "com.amazonaws.wellarchitected#GenerationStatus": { "type": "enum", "members": { "QUEUED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "QUEUED" } }, "IN_PROGRESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "IN_PROGRESS" } }, "COMPLETED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "COMPLETED" } }, "ERROR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ERROR" } } }, "traits": { "smithy.api#documentation": "

The status of a recommendation generation process.

" } }, "com.amazonaws.wellarchitected#GenerationType": { "type": "enum", "members": { "ONDEMAND": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ONDEMAND" } }, "SCHEDULED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SCHEDULED" } }, "BASIC": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "BASIC" } } }, "traits": { "smithy.api#documentation": "

How a recommendation generation was started.

" } }, "com.amazonaws.wellarchitected#GetAgentContext": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#GetAgentContextRequest" }, "output": { "target": "com.amazonaws.wellarchitected#GetAgentContextResponse" }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" }, { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, { "target": "com.amazonaws.wellarchitected#ValidationException" } ], "traits": { "smithy.api#documentation": "

Retrieves detailed information about a specific context associated with a profile.

", "smithy.api#http": { "method": "GET", "uri": "/api/v1/agent-profiles/{profileArn}/contexts/{id}" }, "smithy.api#readonly": {}, "smithy.api#tags": [ "AGENT" ], "smithy.rules#staticContextParams": { "SubServiceType": { "value": "AGENT" } }, "smithy.test#smokeTests": [ { "id": "GetAgentContext", "params": { "profileArn": "arn:aws:wellarchitected:us-west-2:123456789012:agent-profile/test-profile", "id": "f6b5df15-3409-483f-b796-45d0e590222c" }, "expect": { "failure": {} }, "vendorParamsShape": "aws.test#AwsVendorParams", "vendorParams": { "region": "us-west-2" } } ] } }, "com.amazonaws.wellarchitected#GetAgentContextRequest": { "type": "structure", "members": { "profileArn": { "target": "com.amazonaws.wellarchitected#AgentProfileArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the profile containing the context.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "id": { "target": "com.amazonaws.wellarchitected#UUID", "traits": { "smithy.api#documentation": "

The unique identifier of the context to retrieve.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.wellarchitected#GetAgentContextResponse": { "type": "structure", "members": { "context": { "target": "com.amazonaws.wellarchitected#ContextSummary", "traits": { "smithy.api#documentation": "

The retrieved context summary.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.wellarchitected#GetAgentGoal": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#GetAgentGoalRequest" }, "output": { "target": "com.amazonaws.wellarchitected#GetAgentGoalResponse" }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" }, { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, { "target": "com.amazonaws.wellarchitected#ValidationException" } ], "traits": { "smithy.api#documentation": "

Retrieves detailed information about a specific optimization goal.

", "smithy.api#http": { "method": "GET", "uri": "/api/v1/agent-profiles/{profileArn}/goals/{id}" }, "smithy.api#readonly": {}, "smithy.api#tags": [ "AGENT" ], "smithy.rules#staticContextParams": { "SubServiceType": { "value": "AGENT" } }, "smithy.test#smokeTests": [ { "id": "GetAgentGoal", "params": { "profileArn": "arn:aws:wellarchitected:us-west-2:123456789012:agent-profile/test-profile", "id": "f6b5df15-3409-483f-b796-45d0e590222c" }, "expect": { "failure": {} }, "vendorParamsShape": "aws.test#AwsVendorParams", "vendorParams": { "region": "us-west-2" } } ] } }, "com.amazonaws.wellarchitected#GetAgentGoalRequest": { "type": "structure", "members": { "profileArn": { "target": "com.amazonaws.wellarchitected#AgentProfileArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the profile containing the goal.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "id": { "target": "com.amazonaws.wellarchitected#UUID", "traits": { "smithy.api#documentation": "

The unique identifier of the goal to retrieve.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.wellarchitected#GetAgentGoalResponse": { "type": "structure", "members": { "goal": { "target": "com.amazonaws.wellarchitected#GoalSummary", "traits": { "smithy.api#documentation": "

The retrieved goal summary.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.wellarchitected#GetAgentOrganizationalReport": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#GetAgentOrganizationalReportRequest" }, "output": { "target": "com.amazonaws.wellarchitected#GetAgentOrganizationalReportResponse" }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" }, { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, { "target": "com.amazonaws.wellarchitected#ValidationException" } ], "traits": { "smithy.api#documentation": "

Retrieves metadata and current state for a single Organizational Report. The coverageSummary is populated once the report reaches COMPLETED and is absent for reports still in progress or in a failed state.

", "smithy.api#http": { "method": "GET", "uri": "/api/v1/agent-organizational-reports/{reportId}", "code": 200 }, "smithy.api#readonly": {}, "smithy.api#tags": [ "AGENT" ], "smithy.rules#staticContextParams": { "SubServiceType": { "value": "AGENT" } }, "smithy.test#smokeTests": [ { "id": "GetAgentOrganizationalReport", "params": { "reportId": "f6b5df15-3409-483f-b796-45d0e590222c" }, "expect": { "failure": {} }, "vendorParamsShape": "aws.test#AwsVendorParams", "vendorParams": { "region": "us-west-2" } } ], "smithy.waiters#waitable": { "AgentOrganizationalReportCompleted": { "minDelay": 15, "maxDelay": 600, "acceptors": [ { "state": "success", "matcher": { "output": { "path": "state", "expected": "COMPLETED", "comparator": "stringEquals" } } }, { "state": "failure", "matcher": { "output": { "path": "state", "expected": "FAILED", "comparator": "stringEquals" } } }, { "state": "failure", "matcher": { "output": { "path": "state", "expected": "DELETING", "comparator": "stringEquals" } } } ] } } } }, "com.amazonaws.wellarchitected#GetAgentOrganizationalReportData": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#GetAgentOrganizationalReportDataRequest" }, "output": { "target": "com.amazonaws.wellarchitected#GetAgentOrganizationalReportDataResponse" }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" }, { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, { "target": "com.amazonaws.wellarchitected#ValidationException" } ], "traits": { "smithy.api#documentation": "

Retrieves the data artifact for a completed Organizational Report as a short-lived presigned S3 URL. The response contains the URL in downloadUrl and its expiration in expiresAt. To have the service write the artifact directly into a caller-owned bucket instead, use SendAgentOrganizationalReportDataToS3.

", "smithy.api#http": { "method": "GET", "uri": "/api/v1/agent-organizational-reports/{reportId}/data", "code": 200 }, "smithy.api#readonly": {}, "smithy.api#tags": [ "AGENT" ], "smithy.rules#staticContextParams": { "SubServiceType": { "value": "AGENT" } }, "smithy.test#smokeTests": [ { "id": "GetAgentOrganizationalReportData", "params": { "reportId": "f6b5df15-3409-483f-b796-45d0e590222c", "format": "JSON" }, "expect": { "failure": {} }, "vendorParamsShape": "aws.test#AwsVendorParams", "vendorParams": { "region": "us-west-2" } } ] } }, "com.amazonaws.wellarchitected#GetAgentOrganizationalReportDataRequest": { "type": "structure", "members": { "reportId": { "target": "com.amazonaws.wellarchitected#UUID", "traits": { "smithy.api#documentation": "

Identifier of the report whose data is being retrieved.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "format": { "target": "com.amazonaws.wellarchitected#OrganizationalReportFormat", "traits": { "smithy.api#documentation": "

Format of the returned artifact (CSV, JSON, or PARQUET).

", "smithy.api#httpQuery": "format", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.wellarchitected#GetAgentOrganizationalReportDataResponse": { "type": "structure", "members": { "downloadUrl": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

Presigned URL that can be used to download the artifact.

", "smithy.api#required": {} } }, "expiresAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

Expiration time of downloadUrl.

", "smithy.api#required": {}, "smithy.api#timestampFormat": "date-time" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.wellarchitected#GetAgentOrganizationalReportRequest": { "type": "structure", "members": { "reportId": { "target": "com.amazonaws.wellarchitected#UUID", "traits": { "smithy.api#documentation": "

Identifier of the report to retrieve.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.wellarchitected#GetAgentOrganizationalReportResponse": { "type": "structure", "members": { "reportId": { "target": "com.amazonaws.wellarchitected#UUID", "traits": { "smithy.api#documentation": "

Unique identifier of the Organizational Report assigned by the service at creation time.

", "smithy.api#required": {} } }, "ownerAccountId": { "target": "com.amazonaws.wellarchitected#AccountId", "traits": { "smithy.api#documentation": "

AWS account ID of the caller that created the report. Only this account or a delegated administrator of the same organization may retrieve or delete the report.

", "smithy.api#required": {} } }, "organizationId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

Identifier of the AWS Organization the report belongs to. Derived from the caller's authorization context at creation time and not accepted as a client-supplied input.

", "smithy.api#required": {} } }, "label": { "target": "com.amazonaws.wellarchitected#ReportLabel", "traits": { "smithy.api#documentation": "

Optional human-readable label supplied by the caller at creation time.

" } }, "state": { "target": "com.amazonaws.wellarchitected#OrganizationalReportState", "traits": { "smithy.api#documentation": "

Current lifecycle state of the report.

", "smithy.api#required": {} } }, "createdAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

Timestamp at which the report was created.

", "smithy.api#required": {}, "smithy.api#timestampFormat": "date-time" } }, "filters": { "target": "com.amazonaws.wellarchitected#OrganizationalReportFilters", "traits": { "smithy.api#documentation": "

Filters captured when the report was created. Absent when no filters were supplied (meaning the report covered the whole organization).

" } }, "coverageSummary": { "target": "com.amazonaws.wellarchitected#CoverageSummary", "traits": { "smithy.api#documentation": "

Coverage and aggregate counts for the report. Present only after the report reaches COMPLETED.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.wellarchitected#GetAgentPreferences": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#GetAgentPreferencesRequest" }, "output": { "target": "com.amazonaws.wellarchitected#GetAgentPreferencesResponse" }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" }, { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, { "target": "com.amazonaws.wellarchitected#ValidationException" } ], "traits": { "smithy.api#documentation": "

Returns the caller's complete set of Well-Architected Agent preferences with their current states.

", "smithy.api#http": { "method": "GET", "uri": "/api/v1/agent-preferences", "code": 200 }, "smithy.api#readonly": {}, "smithy.api#tags": [ "AGENT" ], "smithy.rules#staticContextParams": { "SubServiceType": { "value": "AGENT" } }, "smithy.test#smokeTests": [ { "id": "GetAgentPreferences", "params": {}, "expect": { "failure": {} }, "vendorParamsShape": "aws.test#AwsVendorParams", "vendorParams": { "region": "us-west-2" } } ] } }, "com.amazonaws.wellarchitected#GetAgentPreferencesRequest": { "type": "structure", "members": {}, "traits": { "smithy.api#input": {} } }, "com.amazonaws.wellarchitected#GetAgentPreferencesResponse": { "type": "structure", "members": { "preferences": { "target": "com.amazonaws.wellarchitected#PreferenceEntries", "traits": { "smithy.api#documentation": "

The caller's complete set of preferences.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.wellarchitected#GetAgentProfile": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#GetAgentProfileRequest" }, "output": { "target": "com.amazonaws.wellarchitected#GetAgentProfileResponse" }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" }, { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, { "target": "com.amazonaws.wellarchitected#ValidationException" } ], "traits": { "smithy.api#documentation": "

Retrieves detailed information about an optimization profile, including its configuration and metadata.

", "smithy.api#http": { "method": "GET", "uri": "/api/v1/agent-profiles/{profileArn}" }, "smithy.api#readonly": {}, "smithy.api#tags": [ "AGENT" ], "smithy.rules#staticContextParams": { "SubServiceType": { "value": "AGENT" } }, "smithy.test#smokeTests": [ { "id": "GetAgentProfile", "params": { "profileArn": "arn:aws:wellarchitected:us-west-2:123456789012:agent-profile/test-security-profile" }, "expect": { "failure": {} }, "vendorParamsShape": "aws.test#AwsVendorParams", "vendorParams": { "region": "us-west-2" } } ] } }, "com.amazonaws.wellarchitected#GetAgentProfilePolicy": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#GetAgentProfilePolicyRequest" }, "output": { "target": "com.amazonaws.wellarchitected#GetAgentProfilePolicyResponse" }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" }, { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, { "target": "com.amazonaws.wellarchitected#ValidationException" } ], "traits": { "smithy.api#documentation": "

Retrieves the resource-based policy attached to an Agent Profile. Only the profile owner can call this operation.

", "smithy.api#http": { "method": "GET", "uri": "/api/v1/agent-profiles/{profileArn}/policy" }, "smithy.api#readonly": {}, "smithy.api#tags": [ "AGENT" ], "smithy.rules#staticContextParams": { "SubServiceType": { "value": "AGENT" } }, "smithy.test#smokeTests": [ { "id": "GetAgentProfilePolicy", "params": { "profileArn": "arn:aws:wellarchitected:us-west-2:123456789012:agent-profile/test-profile" }, "expect": { "failure": {} }, "vendorParamsShape": "aws.test#AwsVendorParams", "vendorParams": { "region": "us-west-2" } } ] } }, "com.amazonaws.wellarchitected#GetAgentProfilePolicyRequest": { "type": "structure", "members": { "profileArn": { "target": "com.amazonaws.wellarchitected#AgentProfileArn", "traits": { "smithy.api#documentation": "

The ARN of the Agent Profile whose policy to retrieve.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.wellarchitected#GetAgentProfilePolicyResponse": { "type": "structure", "members": { "profileArn": { "target": "com.amazonaws.wellarchitected#AgentProfileArn", "traits": { "smithy.api#documentation": "

The ARN of the Agent Profile.

", "smithy.api#required": {} } }, "policy": { "target": "com.amazonaws.wellarchitected#ResourcePolicy", "traits": { "smithy.api#documentation": "

The IAM resource-based policy document in JSON format.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.wellarchitected#GetAgentProfileRequest": { "type": "structure", "members": { "profileArn": { "target": "com.amazonaws.wellarchitected#AgentProfileArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the optimization profile to retrieve.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.wellarchitected#GetAgentProfileResponse": { "type": "structure", "members": { "name": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The system name of the profile.

", "smithy.api#length": { "min": 3, "max": 128 }, "smithy.api#pattern": "^[a-zA-Z0-9_-]+$", "smithy.api#required": {} } }, "displayName": { "target": "com.amazonaws.wellarchitected#SensitiveString", "traits": { "smithy.api#documentation": "

The display name of the profile.

", "smithy.api#length": { "min": 3, "max": 128 }, "smithy.api#pattern": "^(?:(?!\\$\\{[a-zA-Z]+:)[\\P{C}])+$" } }, "description": { "target": "com.amazonaws.wellarchitected#SensitiveString", "traits": { "smithy.api#documentation": "

A description of the profile.

", "smithy.api#length": { "max": 512 }, "smithy.api#pattern": "^(?:(?!\\$\\{[a-zA-Z]+:)[\\P{C}])*$" } }, "businessOverview": { "target": "com.amazonaws.wellarchitected#SensitiveString", "traits": { "smithy.api#documentation": "

The business overview of the profile.

", "smithy.api#length": { "max": 512 }, "smithy.api#pattern": "^(?:(?!\\$\\{[a-zA-Z]+:)[\\P{C}])*$" } }, "pillars": { "target": "com.amazonaws.wellarchitected#Pillars", "traits": { "smithy.api#documentation": "

The Amazon Web Services Well-Architected Framework pillars associated with the profile. Not present for basic profiles.

" } }, "deletionProtection": { "target": "smithy.api#Boolean", "traits": { "smithy.api#default": true, "smithy.api#documentation": "

Indicates whether deletion protection is enabled.

" } }, "profileType": { "target": "com.amazonaws.wellarchitected#ProfileType", "traits": { "smithy.api#documentation": "

The type of the profile.

" } }, "executionRoleArn": { "target": "com.amazonaws.wellarchitected#RoleArn", "traits": { "smithy.api#documentation": "

The ARN of the IAM execution role. Not present for basic profiles.

" } }, "aggregationConfiguration": { "target": "com.amazonaws.wellarchitected#AggregationConfigurations", "traits": { "smithy.api#documentation": "

The aggregation configuration. Not present for basic profiles.

" } }, "arn": { "target": "com.amazonaws.wellarchitected#AgentProfileArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the profile.

", "smithy.api#required": {} } }, "eligibleForScheduledGeneration": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "

Indicates whether the profile is valid for scheduled recommendation generation.

" } }, "eligibleForArchitectureGeneration": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "

Indicates whether the profile is valid for manual architecture generation.

" } }, "fieldErrors": { "target": "com.amazonaws.wellarchitected#FieldErrors", "traits": { "smithy.api#documentation": "

A map of field paths to error messages for invalid or missing input fields.

" } }, "tags": { "target": "com.amazonaws.wellarchitected#Tags", "traits": { "smithy.api#documentation": "

The tags associated with the profile.

" } }, "createdBy": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The identifier of the user or system that created this profile.

", "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#required": {} } }, "createdAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The timestamp when the profile was created.

", "smithy.api#required": {}, "smithy.api#timestampFormat": "date-time" } }, "lastModifiedBy": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The identifier of the user or system that last modified this profile.

", "smithy.api#length": { "min": 1, "max": 128 } } }, "lastModifiedAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The timestamp when the profile was last modified.

", "smithy.api#timestampFormat": "date-time" } }, "organizationalAggregationConfiguration": { "target": "com.amazonaws.wellarchitected#OrganizationalAggregationConfiguration", "traits": { "smithy.api#documentation": "

The organizational monitoring boundary. Present only for organizational profiles.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.wellarchitected#GetAgentRecommendation": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#GetAgentRecommendationRequest" }, "output": { "target": "com.amazonaws.wellarchitected#GetAgentRecommendationResponse" }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" }, { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, { "target": "com.amazonaws.wellarchitected#ValidationException" } ], "traits": { "smithy.api#documentation": "

Application-level recommendations are a new recommendation format currently in beta. We are actively seeking customer feedback to improve their quality and relevance. As with any AI-generated content, please thoroughly review each recommendation before taking any action based on it.

Retrieves detailed information about a specific optimization recommendation, including its impact analysis, content, and implementation guidance.

", "smithy.api#http": { "method": "GET", "uri": "/api/v1/agent-recommendations/{recommendationArn}" }, "smithy.api#readonly": {}, "smithy.api#tags": [ "AGENT" ], "smithy.rules#staticContextParams": { "SubServiceType": { "value": "AGENT" } }, "smithy.test#smokeTests": [ { "id": "GetAgentRecommendation", "params": { "recommendationArn": "arn:aws:wellarchitected:us-west-2:123456789012:agent-recommendation/f6b5df15-3409-483f-b796-45d0e590222c" }, "expect": { "failure": {} }, "vendorParamsShape": "aws.test#AwsVendorParams", "vendorParams": { "region": "us-west-2" } } ] } }, "com.amazonaws.wellarchitected#GetAgentRecommendationGeneration": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#GetAgentRecommendationGenerationRequest" }, "output": { "target": "com.amazonaws.wellarchitected#GetAgentRecommendationGenerationResponse" }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" }, { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, { "target": "com.amazonaws.wellarchitected#ValidationException" } ], "traits": { "smithy.api#documentation": "

Application-level recommendations are a new recommendation format currently in beta. We are actively seeking customer feedback to improve their quality and relevance. As with any AI-generated content, please thoroughly review each recommendation before taking any action based on it.

Retrieves information about a recommendation generation process, including its status, progress, and results. Recommendation generation is asynchronous: poll this operation until status reaches a terminal value of COMPLETED (results are ready) or ERROR (see errorDetails). Intermediate values are QUEUED and IN_PROGRESS.

", "smithy.api#http": { "method": "GET", "uri": "/api/v1/agent-profiles/{profileArn}/generations/{generationId}" }, "smithy.api#readonly": {}, "smithy.api#tags": [ "AGENT" ], "smithy.rules#staticContextParams": { "SubServiceType": { "value": "AGENT" } } } }, "com.amazonaws.wellarchitected#GetAgentRecommendationGenerationRequest": { "type": "structure", "members": { "profileArn": { "target": "com.amazonaws.wellarchitected#AgentProfileArn", "traits": { "smithy.api#documentation": "

The ARN of the optimization profile associated with this generation.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "generationId": { "target": "com.amazonaws.wellarchitected#UUID", "traits": { "smithy.api#documentation": "

The unique identifier of the recommendation generation to retrieve.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.wellarchitected#GetAgentRecommendationGenerationResponse": { "type": "structure", "members": { "id": { "target": "com.amazonaws.wellarchitected#UUID", "traits": { "smithy.api#documentation": "

The unique identifier of the recommendation generation.

", "smithy.api#required": {} } }, "profileArn": { "target": "com.amazonaws.wellarchitected#AgentProfileArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the profile used for this generation.

", "smithy.api#required": {} } }, "name": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The name of the recommendation generation.

" } }, "status": { "target": "com.amazonaws.wellarchitected#GenerationStatus", "traits": { "smithy.api#documentation": "

The current status of the recommendation generation.

", "smithy.api#required": {} } }, "estimatedCompletionTime": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The estimated time for the generation to complete.

", "smithy.api#timestampFormat": "date-time" } }, "createdBy": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The identifier of the user or system that started this generation.

", "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#required": {} } }, "createdAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The timestamp when the generation was started.

", "smithy.api#required": {}, "smithy.api#timestampFormat": "date-time" } }, "lastModifiedBy": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The identifier of the user or system that last modified this generation.

", "smithy.api#length": { "min": 1, "max": 128 } } }, "lastModifiedAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The timestamp when the generation was last modified.

", "smithy.api#timestampFormat": "date-time" } }, "generationType": { "target": "com.amazonaws.wellarchitected#GenerationType", "traits": { "smithy.api#documentation": "

How the generation was started.

" } }, "generationRecommendationTypes": { "target": "com.amazonaws.wellarchitected#GenerationRecommendationTypes", "traits": { "smithy.api#documentation": "

The recommendation types the generation covers.

" } }, "startedAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The timestamp when the recommendation generation process started.

", "smithy.api#timestampFormat": "date-time" } }, "endedAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The timestamp when the recommendation generation process completed.

", "smithy.api#timestampFormat": "date-time" } }, "errorDetails": { "target": "com.amazonaws.wellarchitected#ErrorDetails", "traits": { "smithy.api#documentation": "

Details about the error if the generation status is ERROR.

" } }, "additionalContext": { "target": "com.amazonaws.wellarchitected#SensitiveDocument", "traits": { "smithy.api#documentation": "

The additional context that was provided when the generation was started. For ARCHITECTURE generations, this includes the location of the reviewed IaC template and the lenses used.

" } }, "scope": { "target": "com.amazonaws.wellarchitected#Scope", "traits": { "smithy.api#documentation": "

The scope configuration that defines which pillars and goals to focus on during generation.

" } }, "progress": { "target": "com.amazonaws.wellarchitected#Progress", "traits": { "smithy.api#documentation": "

Current progress information including steps completed and completion percentage.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.wellarchitected#GetAgentRecommendationPolicy": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#GetAgentRecommendationPolicyRequest" }, "output": { "target": "com.amazonaws.wellarchitected#GetAgentRecommendationPolicyResponse" }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" }, { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, { "target": "com.amazonaws.wellarchitected#ValidationException" } ], "traits": { "smithy.api#documentation": "

Retrieves the resource-based policy attached to an individual Agent Recommendation. The recommendation owner or any principal with profile write access on the parent profile can call this operation.

", "smithy.api#http": { "method": "GET", "uri": "/api/v1/agent-recommendations/{recommendationArn}/policy" }, "smithy.api#readonly": {}, "smithy.api#tags": [ "AGENT" ], "smithy.rules#staticContextParams": { "SubServiceType": { "value": "AGENT" } }, "smithy.test#smokeTests": [ { "id": "GetAgentRecommendationPolicy", "params": { "recommendationArn": "arn:aws:wellarchitected:us-west-2:123456789012:agent-recommendation/f6b5df15-3409-483f-b796-45d0e590222c" }, "expect": { "failure": {} }, "vendorParamsShape": "aws.test#AwsVendorParams", "vendorParams": { "region": "us-west-2" } } ] } }, "com.amazonaws.wellarchitected#GetAgentRecommendationPolicyRequest": { "type": "structure", "members": { "recommendationArn": { "target": "com.amazonaws.wellarchitected#AgentRecommendationArn", "traits": { "smithy.api#documentation": "

The ARN of the Agent Recommendation whose policy to retrieve.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.wellarchitected#GetAgentRecommendationPolicyResponse": { "type": "structure", "members": { "recommendationArn": { "target": "com.amazonaws.wellarchitected#AgentRecommendationArn", "traits": { "smithy.api#documentation": "

The ARN of the Agent Recommendation.

", "smithy.api#required": {} } }, "policy": { "target": "com.amazonaws.wellarchitected#ResourcePolicy", "traits": { "smithy.api#documentation": "

The IAM resource-based policy document in JSON format.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.wellarchitected#GetAgentRecommendationRequest": { "type": "structure", "members": { "recommendationArn": { "target": "com.amazonaws.wellarchitected#AgentRecommendationArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the recommendation to retrieve.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "remediationType": { "target": "com.amazonaws.wellarchitected#RemediationType", "traits": { "smithy.api#documentation": "

Optional filter on remediation type.

", "smithy.api#httpQuery": "remediationType" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.wellarchitected#GetAgentRecommendationResponse": { "type": "structure", "members": { "recommendationArn": { "target": "com.amazonaws.wellarchitected#RecommendationArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the recommendation.

", "smithy.api#required": {} } }, "profileArn": { "target": "com.amazonaws.wellarchitected#AgentProfileArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the associated profile.

", "smithy.api#required": {} } }, "generationId": { "target": "com.amazonaws.wellarchitected#UUID", "traits": { "smithy.api#documentation": "

The identifier of the generation that produced this recommendation.

" } }, "title": { "target": "com.amazonaws.wellarchitected#SensitiveString", "traits": { "smithy.api#documentation": "

The title of the recommendation.

", "smithy.api#length": { "min": 3, "max": 120 }, "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.wellarchitected#SensitiveString", "traits": { "smithy.api#documentation": "

A description of the recommendation.

", "smithy.api#length": { "min": 80, "max": 500 }, "smithy.api#required": {} } }, "type": { "target": "com.amazonaws.wellarchitected#RecommendationType", "traits": { "smithy.api#documentation": "

The type of the recommendation.

", "smithy.api#required": {} } }, "pillar": { "target": "com.amazonaws.wellarchitected#Pillar", "traits": { "smithy.api#documentation": "

The Amazon Web Services Well-Architected Framework pillar that the recommendation addresses.

", "smithy.api#required": {} } }, "priority": { "target": "com.amazonaws.wellarchitected#Priority", "traits": { "smithy.api#documentation": "

The priority of the recommendation.

", "smithy.api#required": {} } }, "effort": { "target": "com.amazonaws.wellarchitected#Effort", "traits": { "smithy.api#documentation": "

The effort required to implement the recommendation.

", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.wellarchitected#RecommendationStatus", "traits": { "smithy.api#documentation": "

The current status of the recommendation.

", "smithy.api#required": {} } }, "state": { "target": "com.amazonaws.wellarchitected#RecommendationState", "traits": { "smithy.api#documentation": "

The current state of the recommendation.

", "smithy.api#required": {} } }, "updateReason": { "target": "com.amazonaws.wellarchitected#SensitiveString", "traits": { "smithy.api#documentation": "

The free-text reason associated with the recommendation's most recent status update.

", "smithy.api#length": { "min": 1, "max": 4096 } } }, "impact": { "target": "com.amazonaws.wellarchitected#ImpactCategory", "traits": { "smithy.api#documentation": "

The severity of the recommendation's impact.

", "smithy.api#required": {} } }, "roi": { "target": "com.amazonaws.wellarchitected#Roi", "traits": { "smithy.api#documentation": "

The return on investment estimate for the recommendation.

", "smithy.api#required": {} } }, "numberOfResources": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "

The number of Amazon Web Services resources this recommendation affects.

" } }, "awsServices": { "target": "com.amazonaws.wellarchitected#StringList", "traits": { "smithy.api#documentation": "

The Amazon Web Services services that the recommendation applies to.

" } }, "businessUnits": { "target": "com.amazonaws.wellarchitected#StringList", "traits": { "smithy.api#documentation": "

The business units that own the affected resources.

" } }, "applications": { "target": "com.amazonaws.wellarchitected#StringList", "traits": { "smithy.api#documentation": "

The applications that the recommendation targets.

" } }, "impactDetails": { "target": "com.amazonaws.wellarchitected#ImpactDetails", "traits": { "smithy.api#documentation": "

Detailed impact information for the recommendation.

", "smithy.api#required": {} } }, "insights": { "target": "com.amazonaws.wellarchitected#InsightList", "traits": { "smithy.api#documentation": "

A list of insights about the recommendation.

", "smithy.api#required": {} } }, "highlights": { "target": "com.amazonaws.wellarchitected#Highlights", "traits": { "smithy.api#documentation": "

Highlights describing what was detected.

", "smithy.api#required": {} } }, "remediationSummary": { "target": "com.amazonaws.wellarchitected#RemediationSummary", "traits": { "smithy.api#documentation": "

A high-level summary of the recommended remediation.

", "smithy.api#required": {} } }, "crossPillarBenefits": { "target": "com.amazonaws.wellarchitected#CrossPillarBenefits", "traits": { "smithy.api#documentation": "

Cross-pillar benefits of acting on the recommendation.

" } }, "tradeOffs": { "target": "com.amazonaws.wellarchitected#TradeOffs", "traits": { "smithy.api#documentation": "

Trade-offs of acting on the recommendation.

" } }, "sources": { "target": "com.amazonaws.wellarchitected#RecommendationSourceList", "traits": { "smithy.api#documentation": "

Sources that generated this recommendation.

" } }, "goals": { "target": "com.amazonaws.wellarchitected#RecommendationGoals", "traits": { "smithy.api#documentation": "

Goals that this recommendation targets.

" } }, "tags": { "target": "com.amazonaws.wellarchitected#Tags", "traits": { "smithy.api#documentation": "

A set of key-value pairs associated with the recommendation, used for cost allocation and access control.

" } }, "createdBy": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The identifier of the user or system that created this recommendation.

", "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#required": {} } }, "createdAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The timestamp when the recommendation was created.

", "smithy.api#required": {}, "smithy.api#timestampFormat": "date-time" } }, "lastModifiedBy": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The identifier of the user or system that last modified this recommendation.

", "smithy.api#length": { "min": 1, "max": 128 } } }, "lastModifiedAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The timestamp when the recommendation was last modified.

", "smithy.api#timestampFormat": "date-time" } }, "remediations": { "target": "com.amazonaws.wellarchitected#AgentRecommendationRemediations", "traits": { "smithy.api#documentation": "

A list of remediations for the recommendation.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.wellarchitected#GetAnswer": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#GetAnswerInput" }, "output": { "target": "com.amazonaws.wellarchitected#GetAnswerOutput" }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" }, { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, { "target": "com.amazonaws.wellarchitected#ValidationException" } ], "traits": { "smithy.api#documentation": "

Get the answer to a specific question in a workload review.

", "smithy.api#http": { "method": "GET", "uri": "/workloads/{WorkloadId}/lensReviews/{LensAlias}/answers/{QuestionId}", "code": 200 }, "smithy.api#tags": [ "WA" ] } }, "com.amazonaws.wellarchitected#GetAnswerInput": { "type": "structure", "members": { "WorkloadId": { "target": "com.amazonaws.wellarchitected#WorkloadId", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "LensAlias": { "target": "com.amazonaws.wellarchitected#LensAlias", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "QuestionId": { "target": "com.amazonaws.wellarchitected#QuestionId", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "MilestoneNumber": { "target": "com.amazonaws.wellarchitected#MilestoneNumber", "traits": { "smithy.api#httpQuery": "MilestoneNumber" } } }, "traits": { "smithy.api#documentation": "

Input to get answer.

", "smithy.api#input": {} } }, "com.amazonaws.wellarchitected#GetAnswerOutput": { "type": "structure", "members": { "WorkloadId": { "target": "com.amazonaws.wellarchitected#WorkloadId" }, "MilestoneNumber": { "target": "com.amazonaws.wellarchitected#MilestoneNumber" }, "LensAlias": { "target": "com.amazonaws.wellarchitected#LensAlias" }, "LensArn": { "target": "com.amazonaws.wellarchitected#LensArn", "traits": { "smithy.api#documentation": "

The ARN for the lens.

" } }, "Answer": { "target": "com.amazonaws.wellarchitected#Answer" } }, "traits": { "smithy.api#documentation": "

Output of a get answer call.

", "smithy.api#output": {} } }, "com.amazonaws.wellarchitected#GetConsolidatedReport": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#GetConsolidatedReportInput" }, "output": { "target": "com.amazonaws.wellarchitected#GetConsolidatedReportOutput" }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" }, { "target": "com.amazonaws.wellarchitected#ConflictException" }, { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, { "target": "com.amazonaws.wellarchitected#ValidationException" } ], "traits": { "smithy.api#documentation": "

Get a consolidated report of your workloads.

You can optionally choose to include workloads that have been shared with you.

", "smithy.api#http": { "method": "GET", "uri": "/consolidatedReport", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults" }, "smithy.api#tags": [ "WA" ] } }, "com.amazonaws.wellarchitected#GetConsolidatedReportInput": { "type": "structure", "members": { "Format": { "target": "com.amazonaws.wellarchitected#ReportFormat", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The format of the consolidated report.

For PDF, Base64String is returned. For JSON, Metrics is returned.

", "smithy.api#httpQuery": "Format", "smithy.api#required": {} } }, "IncludeSharedResources": { "target": "com.amazonaws.wellarchitected#IncludeSharedResources", "traits": { "smithy.api#documentation": "

Set to true to have shared resources included in the report.

", "smithy.api#httpQuery": "IncludeSharedResources" } }, "NextToken": { "target": "com.amazonaws.wellarchitected#NextToken", "traits": { "smithy.api#httpQuery": "NextToken" } }, "MaxResults": { "target": "com.amazonaws.wellarchitected#MaxResults", "traits": { "smithy.api#documentation": "

The maximum number of results to return for this request.

", "smithy.api#httpQuery": "MaxResults", "smithy.api#range": { "min": 1, "max": 15 } } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.wellarchitected#GetConsolidatedReportOutput": { "type": "structure", "members": { "Metrics": { "target": "com.amazonaws.wellarchitected#ConsolidatedReportMetrics", "traits": { "smithy.api#documentation": "

The metrics that make up the consolidated report.

Only returned when JSON format is requested.

" } }, "NextToken": { "target": "com.amazonaws.wellarchitected#NextToken" }, "Base64String": { "target": "com.amazonaws.wellarchitected#Base64String" } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.wellarchitected#GetGlobalSettings": { "type": "operation", "input": { "target": "smithy.api#Unit" }, "output": { "target": "com.amazonaws.wellarchitected#GetGlobalSettingsOutput" }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" }, { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, { "target": "com.amazonaws.wellarchitected#ValidationException" } ], "traits": { "smithy.api#documentation": "

Global settings for all workloads.

", "smithy.api#http": { "method": "GET", "uri": "/global-settings", "code": 200 }, "smithy.api#tags": [ "WA" ] } }, "com.amazonaws.wellarchitected#GetGlobalSettingsOutput": { "type": "structure", "members": { "OrganizationSharingStatus": { "target": "com.amazonaws.wellarchitected#OrganizationSharingStatus", "traits": { "smithy.api#documentation": "

Amazon Web Services Organizations sharing status.

" } }, "DiscoveryIntegrationStatus": { "target": "com.amazonaws.wellarchitected#DiscoveryIntegrationStatus", "traits": { "smithy.api#documentation": "

Discovery integration status.

" } }, "JiraConfiguration": { "target": "com.amazonaws.wellarchitected#AccountJiraConfigurationOutput", "traits": { "smithy.api#documentation": "

Jira configuration status.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.wellarchitected#GetLens": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#GetLensInput" }, "output": { "target": "com.amazonaws.wellarchitected#GetLensOutput" }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" }, { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, { "target": "com.amazonaws.wellarchitected#ValidationException" } ], "traits": { "smithy.api#documentation": "

Get an existing lens.

", "smithy.api#http": { "method": "GET", "uri": "/lenses/{LensAlias}", "code": 200 }, "smithy.api#tags": [ "WA" ] } }, "com.amazonaws.wellarchitected#GetLensInput": { "type": "structure", "members": { "LensAlias": { "target": "com.amazonaws.wellarchitected#LensAlias", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "LensVersion": { "target": "com.amazonaws.wellarchitected#LensVersion", "traits": { "smithy.api#documentation": "

The lens version to be retrieved.

", "smithy.api#httpQuery": "LensVersion" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.wellarchitected#GetLensOutput": { "type": "structure", "members": { "Lens": { "target": "com.amazonaws.wellarchitected#Lens", "traits": { "smithy.api#documentation": "

A lens return object.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.wellarchitected#GetLensReview": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#GetLensReviewInput" }, "output": { "target": "com.amazonaws.wellarchitected#GetLensReviewOutput" }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" }, { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, { "target": "com.amazonaws.wellarchitected#ValidationException" } ], "traits": { "smithy.api#documentation": "

Get lens review.

", "smithy.api#http": { "method": "GET", "uri": "/workloads/{WorkloadId}/lensReviews/{LensAlias}", "code": 200 }, "smithy.api#tags": [ "WA" ] } }, "com.amazonaws.wellarchitected#GetLensReviewInput": { "type": "structure", "members": { "WorkloadId": { "target": "com.amazonaws.wellarchitected#WorkloadId", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "LensAlias": { "target": "com.amazonaws.wellarchitected#LensAlias", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "MilestoneNumber": { "target": "com.amazonaws.wellarchitected#MilestoneNumber", "traits": { "smithy.api#httpQuery": "MilestoneNumber" } } }, "traits": { "smithy.api#documentation": "

Input to get lens review.

", "smithy.api#input": {} } }, "com.amazonaws.wellarchitected#GetLensReviewOutput": { "type": "structure", "members": { "WorkloadId": { "target": "com.amazonaws.wellarchitected#WorkloadId" }, "MilestoneNumber": { "target": "com.amazonaws.wellarchitected#MilestoneNumber" }, "LensReview": { "target": "com.amazonaws.wellarchitected#LensReview" } }, "traits": { "smithy.api#documentation": "

Output of a get lens review call.

", "smithy.api#output": {} } }, "com.amazonaws.wellarchitected#GetLensReviewReport": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#GetLensReviewReportInput" }, "output": { "target": "com.amazonaws.wellarchitected#GetLensReviewReportOutput" }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" }, { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, { "target": "com.amazonaws.wellarchitected#ValidationException" } ], "traits": { "smithy.api#documentation": "

Get lens review report.

", "smithy.api#http": { "method": "GET", "uri": "/workloads/{WorkloadId}/lensReviews/{LensAlias}/report", "code": 200 }, "smithy.api#tags": [ "WA" ] } }, "com.amazonaws.wellarchitected#GetLensReviewReportInput": { "type": "structure", "members": { "WorkloadId": { "target": "com.amazonaws.wellarchitected#WorkloadId", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "LensAlias": { "target": "com.amazonaws.wellarchitected#LensAlias", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "MilestoneNumber": { "target": "com.amazonaws.wellarchitected#MilestoneNumber", "traits": { "smithy.api#httpQuery": "MilestoneNumber" } } }, "traits": { "smithy.api#documentation": "

Input to get lens review report.

", "smithy.api#input": {} } }, "com.amazonaws.wellarchitected#GetLensReviewReportOutput": { "type": "structure", "members": { "WorkloadId": { "target": "com.amazonaws.wellarchitected#WorkloadId" }, "MilestoneNumber": { "target": "com.amazonaws.wellarchitected#MilestoneNumber" }, "LensReviewReport": { "target": "com.amazonaws.wellarchitected#LensReviewReport" } }, "traits": { "smithy.api#documentation": "

Output of a get lens review report call.

", "smithy.api#output": {} } }, "com.amazonaws.wellarchitected#GetLensVersionDifference": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#GetLensVersionDifferenceInput" }, "output": { "target": "com.amazonaws.wellarchitected#GetLensVersionDifferenceOutput" }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" }, { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, { "target": "com.amazonaws.wellarchitected#ValidationException" } ], "traits": { "smithy.api#documentation": "

Get lens version differences.

", "smithy.api#http": { "method": "GET", "uri": "/lenses/{LensAlias}/versionDifference", "code": 200 }, "smithy.api#tags": [ "WA" ] } }, "com.amazonaws.wellarchitected#GetLensVersionDifferenceInput": { "type": "structure", "members": { "LensAlias": { "target": "com.amazonaws.wellarchitected#LensAlias", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "BaseLensVersion": { "target": "com.amazonaws.wellarchitected#LensVersion", "traits": { "smithy.api#documentation": "

The base version of the lens.

", "smithy.api#httpQuery": "BaseLensVersion" } }, "TargetLensVersion": { "target": "com.amazonaws.wellarchitected#LensVersion", "traits": { "smithy.api#documentation": "

The lens version to target a difference for.

", "smithy.api#httpQuery": "TargetLensVersion" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.wellarchitected#GetLensVersionDifferenceOutput": { "type": "structure", "members": { "LensAlias": { "target": "com.amazonaws.wellarchitected#LensAlias" }, "LensArn": { "target": "com.amazonaws.wellarchitected#LensArn", "traits": { "smithy.api#documentation": "

The ARN for the lens.

" } }, "BaseLensVersion": { "target": "com.amazonaws.wellarchitected#LensVersion", "traits": { "smithy.api#documentation": "

The base version of the lens.

" } }, "TargetLensVersion": { "target": "com.amazonaws.wellarchitected#LensVersion", "traits": { "smithy.api#documentation": "

The target lens version for the lens.

" } }, "LatestLensVersion": { "target": "com.amazonaws.wellarchitected#LensVersion", "traits": { "smithy.api#documentation": "

The latest version of the lens.

" } }, "VersionDifferences": { "target": "com.amazonaws.wellarchitected#VersionDifferences" } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.wellarchitected#GetMilestone": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#GetMilestoneInput" }, "output": { "target": "com.amazonaws.wellarchitected#GetMilestoneOutput" }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" }, { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, { "target": "com.amazonaws.wellarchitected#ValidationException" } ], "traits": { "smithy.api#documentation": "

Get a milestone for an existing workload.

", "smithy.api#http": { "method": "GET", "uri": "/workloads/{WorkloadId}/milestones/{MilestoneNumber}", "code": 200 }, "smithy.api#tags": [ "WA" ] } }, "com.amazonaws.wellarchitected#GetMilestoneInput": { "type": "structure", "members": { "WorkloadId": { "target": "com.amazonaws.wellarchitected#WorkloadId", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "MilestoneNumber": { "target": "com.amazonaws.wellarchitected#MilestoneNumber", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Input to get a milestone.

", "smithy.api#input": {} } }, "com.amazonaws.wellarchitected#GetMilestoneOutput": { "type": "structure", "members": { "WorkloadId": { "target": "com.amazonaws.wellarchitected#WorkloadId" }, "Milestone": { "target": "com.amazonaws.wellarchitected#Milestone" } }, "traits": { "smithy.api#documentation": "

Output of a get milestone call.

", "smithy.api#output": {} } }, "com.amazonaws.wellarchitected#GetProfile": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#GetProfileInput" }, "output": { "target": "com.amazonaws.wellarchitected#GetProfileOutput" }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" }, { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, { "target": "com.amazonaws.wellarchitected#ValidationException" } ], "traits": { "smithy.api#documentation": "

Get profile information.

", "smithy.api#http": { "method": "GET", "uri": "/profiles/{ProfileArn}", "code": 200 }, "smithy.api#tags": [ "WA" ] } }, "com.amazonaws.wellarchitected#GetProfileInput": { "type": "structure", "members": { "ProfileArn": { "target": "com.amazonaws.wellarchitected#ProfileArn", "traits": { "smithy.api#documentation": "

The profile ARN.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "ProfileVersion": { "target": "com.amazonaws.wellarchitected#ProfileVersion", "traits": { "smithy.api#documentation": "

The profile version.

", "smithy.api#httpQuery": "ProfileVersion" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.wellarchitected#GetProfileOutput": { "type": "structure", "members": { "Profile": { "target": "com.amazonaws.wellarchitected#Profile", "traits": { "smithy.api#documentation": "

The profile.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.wellarchitected#GetProfileTemplate": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#GetProfileTemplateInput" }, "output": { "target": "com.amazonaws.wellarchitected#GetProfileTemplateOutput" }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" }, { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, { "target": "com.amazonaws.wellarchitected#ValidationException" } ], "traits": { "smithy.api#documentation": "

Get profile template.

", "smithy.api#http": { "method": "GET", "uri": "/profileTemplate", "code": 200 }, "smithy.api#tags": [ "WA" ] } }, "com.amazonaws.wellarchitected#GetProfileTemplateInput": { "type": "structure", "members": {}, "traits": { "smithy.api#input": {} } }, "com.amazonaws.wellarchitected#GetProfileTemplateOutput": { "type": "structure", "members": { "ProfileTemplate": { "target": "com.amazonaws.wellarchitected#ProfileTemplate", "traits": { "smithy.api#documentation": "

The profile template.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.wellarchitected#GetReviewTemplate": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#GetReviewTemplateInput" }, "output": { "target": "com.amazonaws.wellarchitected#GetReviewTemplateOutput" }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" }, { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, { "target": "com.amazonaws.wellarchitected#ValidationException" } ], "traits": { "smithy.api#documentation": "

Get review template.

", "smithy.api#http": { "method": "GET", "uri": "/reviewTemplates/{TemplateArn}", "code": 200 }, "smithy.api#tags": [ "WA" ] } }, "com.amazonaws.wellarchitected#GetReviewTemplateAnswer": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#GetReviewTemplateAnswerInput" }, "output": { "target": "com.amazonaws.wellarchitected#GetReviewTemplateAnswerOutput" }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" }, { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, { "target": "com.amazonaws.wellarchitected#ValidationException" } ], "traits": { "smithy.api#documentation": "

Get review template answer.

", "smithy.api#http": { "method": "GET", "uri": "/reviewTemplates/{TemplateArn}/lensReviews/{LensAlias}/answers/{QuestionId}", "code": 200 }, "smithy.api#tags": [ "WA" ] } }, "com.amazonaws.wellarchitected#GetReviewTemplateAnswerInput": { "type": "structure", "members": { "TemplateArn": { "target": "com.amazonaws.wellarchitected#TemplateArn", "traits": { "smithy.api#documentation": "

The review template ARN.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "LensAlias": { "target": "com.amazonaws.wellarchitected#LensAlias", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "QuestionId": { "target": "com.amazonaws.wellarchitected#QuestionId", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.wellarchitected#GetReviewTemplateAnswerOutput": { "type": "structure", "members": { "TemplateArn": { "target": "com.amazonaws.wellarchitected#TemplateArn", "traits": { "smithy.api#documentation": "

The review template ARN.

" } }, "LensAlias": { "target": "com.amazonaws.wellarchitected#LensAlias" }, "Answer": { "target": "com.amazonaws.wellarchitected#ReviewTemplateAnswer", "traits": { "smithy.api#documentation": "

An answer of the question.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.wellarchitected#GetReviewTemplateInput": { "type": "structure", "members": { "TemplateArn": { "target": "com.amazonaws.wellarchitected#TemplateArn", "traits": { "smithy.api#documentation": "

The review template ARN.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.wellarchitected#GetReviewTemplateLensReview": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#GetReviewTemplateLensReviewInput" }, "output": { "target": "com.amazonaws.wellarchitected#GetReviewTemplateLensReviewOutput" }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" }, { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, { "target": "com.amazonaws.wellarchitected#ValidationException" } ], "traits": { "smithy.api#documentation": "

Get a lens review associated with a review template.

", "smithy.api#http": { "method": "GET", "uri": "/reviewTemplates/{TemplateArn}/lensReviews/{LensAlias}", "code": 200 }, "smithy.api#tags": [ "WA" ] } }, "com.amazonaws.wellarchitected#GetReviewTemplateLensReviewInput": { "type": "structure", "members": { "TemplateArn": { "target": "com.amazonaws.wellarchitected#TemplateArn", "traits": { "smithy.api#documentation": "

The review template ARN.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "LensAlias": { "target": "com.amazonaws.wellarchitected#LensAlias", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.wellarchitected#GetReviewTemplateLensReviewOutput": { "type": "structure", "members": { "TemplateArn": { "target": "com.amazonaws.wellarchitected#TemplateArn", "traits": { "smithy.api#documentation": "

The review template ARN.

" } }, "LensReview": { "target": "com.amazonaws.wellarchitected#ReviewTemplateLensReview", "traits": { "smithy.api#documentation": "

A lens review of a question.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.wellarchitected#GetReviewTemplateOutput": { "type": "structure", "members": { "ReviewTemplate": { "target": "com.amazonaws.wellarchitected#ReviewTemplate", "traits": { "smithy.api#documentation": "

The review template.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.wellarchitected#GetWorkload": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#GetWorkloadInput" }, "output": { "target": "com.amazonaws.wellarchitected#GetWorkloadOutput" }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" }, { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, { "target": "com.amazonaws.wellarchitected#ValidationException" } ], "traits": { "smithy.api#documentation": "

Get an existing workload.

", "smithy.api#http": { "method": "GET", "uri": "/workloads/{WorkloadId}", "code": 200 }, "smithy.api#tags": [ "WA" ] } }, "com.amazonaws.wellarchitected#GetWorkloadInput": { "type": "structure", "members": { "WorkloadId": { "target": "com.amazonaws.wellarchitected#WorkloadId", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Input to get a workload.

", "smithy.api#input": {} } }, "com.amazonaws.wellarchitected#GetWorkloadOutput": { "type": "structure", "members": { "Workload": { "target": "com.amazonaws.wellarchitected#Workload" } }, "traits": { "smithy.api#documentation": "

Output of a get workload call.

", "smithy.api#output": {} } }, "com.amazonaws.wellarchitected#GoalIdList": { "type": "list", "member": { "target": "com.amazonaws.wellarchitected#UUID" }, "traits": { "smithy.api#length": { "min": 1, "max": 10 }, "smithy.api#uniqueItems": {} } }, "com.amazonaws.wellarchitected#GoalSummaries": { "type": "list", "member": { "target": "com.amazonaws.wellarchitected#GoalSummary" } }, "com.amazonaws.wellarchitected#GoalSummary": { "type": "structure", "members": { "id": { "target": "com.amazonaws.wellarchitected#UUID", "traits": { "smithy.api#documentation": "

The unique identifier of the goal.

", "smithy.api#required": {} } }, "profileArn": { "target": "com.amazonaws.wellarchitected#AgentProfileArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the associated profile.

", "smithy.api#required": {} } }, "pillars": { "target": "com.amazonaws.wellarchitected#Pillars", "traits": { "smithy.api#documentation": "

The Amazon Web Services Well-Architected Framework pillars associated with this goal.

", "smithy.api#required": {} } }, "title": { "target": "com.amazonaws.wellarchitected#SensitiveString", "traits": { "smithy.api#documentation": "

The title of the goal.

", "smithy.api#length": { "min": 1, "max": 1000 }, "smithy.api#pattern": "^(?:(?!\\$\\{[a-zA-Z]+:)[\\P{C}])+$", "smithy.api#required": {} } }, "description": { "target": "com.amazonaws.wellarchitected#SensitiveString", "traits": { "smithy.api#documentation": "

A description of the goal.

", "smithy.api#length": { "min": 1, "max": 4000 }, "smithy.api#pattern": "^(?:(?!\\$\\{[a-zA-Z]+:)[\\P{C}])+$" } }, "createdBy": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The identifier of the user or system that created this goal.

", "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#required": {} } }, "createdAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The timestamp when the goal was created.

", "smithy.api#required": {}, "smithy.api#timestampFormat": "date-time" } }, "lastModifiedBy": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The identifier of the user or system that last modified this goal.

", "smithy.api#length": { "min": 1, "max": 128 } } }, "lastModifiedAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The timestamp when the goal was last modified.

", "smithy.api#timestampFormat": "date-time" } } }, "traits": { "smithy.api#documentation": "

Summary of an optimization goal associated with a profile.

" } }, "com.amazonaws.wellarchitected#HelpfulResourceUrl": { "type": "string", "traits": { "smithy.api#documentation": "

The helpful resource URL.

For Amazon Web Services official lenses, this is the helpful resource URL for a question or choice.

For custom lenses, this is the helpful resource URL for a question and is only provided if HelpfulResourceDisplayText was specified for the question.

", "smithy.api#length": { "min": 1, "max": 2048 } } }, "com.amazonaws.wellarchitected#Highlight": { "type": "string", "traits": { "smithy.api#length": { "min": 20, "max": 250 } } }, "com.amazonaws.wellarchitected#Highlights": { "type": "list", "member": { "target": "com.amazonaws.wellarchitected#Highlight" }, "traits": { "smithy.api#length": { "min": 1, "max": 5 } } }, "com.amazonaws.wellarchitected#ImpactCategory": { "type": "enum", "members": { "HIGH": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "HIGH" } }, "MEDIUM": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MEDIUM" } }, "LOW": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "LOW" } } }, "traits": { "smithy.api#documentation": "

The severity of a recommendation's impact.

" } }, "com.amazonaws.wellarchitected#ImpactDetail": { "type": "string", "traits": { "smithy.api#length": { "min": 10, "max": 100 } } }, "com.amazonaws.wellarchitected#ImpactDetails": { "type": "list", "member": { "target": "com.amazonaws.wellarchitected#ImpactDetail" }, "traits": { "smithy.api#length": { "min": 2, "max": 3 } } }, "com.amazonaws.wellarchitected#ImportLens": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#ImportLensInput" }, "output": { "target": "com.amazonaws.wellarchitected#ImportLensOutput" }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" }, { "target": "com.amazonaws.wellarchitected#ConflictException" }, { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" }, { "target": "com.amazonaws.wellarchitected#ServiceQuotaExceededException" }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, { "target": "com.amazonaws.wellarchitected#ValidationException" } ], "traits": { "smithy.api#documentation": "

Import a new custom lens or update an existing custom lens.

To update an existing custom lens, specify its ARN as the LensAlias. If no ARN is specified, a new custom lens is created.

The new or updated lens will have a status of DRAFT. The lens cannot be applied to workloads or shared with other Amazon Web Services accounts until it's published with CreateLensVersion.

Lenses are defined in JSON. For more information, see JSON format specification in the Well-Architected Tool User Guide.

A custom lens cannot exceed 500 KB in size.

Disclaimer

Do not include or gather personal identifiable information (PII) of end users or other identifiable individuals in or via your custom lenses. If your custom lens or those shared with you and used in your account do include or collect PII you are responsible for: ensuring that the included PII is processed in accordance with applicable law, providing adequate privacy notices, and obtaining necessary consents for processing such data.

", "smithy.api#http": { "method": "PUT", "uri": "/importLens", "code": 200 }, "smithy.api#tags": [ "WA" ] } }, "com.amazonaws.wellarchitected#ImportLensInput": { "type": "structure", "members": { "LensAlias": { "target": "com.amazonaws.wellarchitected#LensAlias" }, "JSONString": { "target": "com.amazonaws.wellarchitected#LensJSON", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The JSON representation of a lens.

", "smithy.api#required": {} } }, "ClientRequestToken": { "target": "com.amazonaws.wellarchitected#ClientRequestToken", "traits": { "smithy.api#clientOptional": {}, "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.wellarchitected#TagMap", "traits": { "smithy.api#documentation": "

Tags to associate to a lens.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.wellarchitected#ImportLensOutput": { "type": "structure", "members": { "LensArn": { "target": "com.amazonaws.wellarchitected#LensArn", "traits": { "smithy.api#documentation": "

The ARN for the lens that was created or updated.

" } }, "Status": { "target": "com.amazonaws.wellarchitected#ImportLensStatus", "traits": { "smithy.api#documentation": "

The status of the imported lens.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.wellarchitected#ImportLensStatus": { "type": "enum", "members": { "IN_PROGRESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "IN_PROGRESS" } }, "COMPLETE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "COMPLETE" } }, "ERROR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ERROR" } } } }, "com.amazonaws.wellarchitected#ImprovementPlanUrl": { "type": "string", "traits": { "smithy.api#documentation": "

The improvement plan URL for a question in an Amazon Web Services official lenses.

This value is only available if the question has been answered.

", "smithy.api#length": { "min": 1, "max": 2048 } } }, "com.amazonaws.wellarchitected#ImprovementSummaries": { "type": "list", "member": { "target": "com.amazonaws.wellarchitected#ImprovementSummary" }, "traits": { "smithy.api#documentation": "

List of improvement summaries of lens review in a workload.

" } }, "com.amazonaws.wellarchitected#ImprovementSummary": { "type": "structure", "members": { "QuestionId": { "target": "com.amazonaws.wellarchitected#QuestionId" }, "PillarId": { "target": "com.amazonaws.wellarchitected#PillarId" }, "QuestionTitle": { "target": "com.amazonaws.wellarchitected#QuestionTitle" }, "Risk": { "target": "com.amazonaws.wellarchitected#Risk" }, "ImprovementPlanUrl": { "target": "com.amazonaws.wellarchitected#ImprovementPlanUrl" }, "ImprovementPlans": { "target": "com.amazonaws.wellarchitected#ChoiceImprovementPlans", "traits": { "smithy.api#documentation": "

The improvement plan details.

This value is only applicable to custom lenses.

" } }, "JiraConfiguration": { "target": "com.amazonaws.wellarchitected#JiraConfiguration", "traits": { "smithy.api#documentation": "

Configuration of the Jira integration.

" } } }, "traits": { "smithy.api#documentation": "

An improvement summary of a lens review in a workload.

" } }, "com.amazonaws.wellarchitected#IncludeSharedResources": { "type": "boolean" }, "com.amazonaws.wellarchitected#Insight": { "type": "structure", "members": { "usagePattern": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

A description of the usage pattern.

", "smithy.api#length": { "min": 100, "max": 2000 }, "smithy.api#required": {} } }, "signalsDetected": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

A description of the signals detected.

", "smithy.api#length": { "min": 30, "max": 1500 } } } }, "traits": { "smithy.api#documentation": "

An insight describing a usage pattern and the signals detected.

" } }, "com.amazonaws.wellarchitected#InsightList": { "type": "list", "member": { "target": "com.amazonaws.wellarchitected#Insight" }, "traits": { "smithy.api#length": { "min": 1, "max": 5 } } }, "com.amazonaws.wellarchitected#IntegratingService": { "type": "enum", "members": { "JIRA": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "JIRA" } } } }, "com.amazonaws.wellarchitected#IntegrationStatus": { "type": "enum", "members": { "CONFIGURED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CONFIGURED" } }, "NOT_CONFIGURED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NOT_CONFIGURED" } } } }, "com.amazonaws.wellarchitected#IntegrationStatusInput": { "type": "enum", "members": { "NOT_CONFIGURED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NOT_CONFIGURED" } } } }, "com.amazonaws.wellarchitected#InternalServerException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.wellarchitected#ExceptionMessage", "traits": { "smithy.api#clientOptional": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

There is a problem with the Well-Architected Tool API service.

", "smithy.api#error": "server", "smithy.api#httpError": 500 } }, "com.amazonaws.wellarchitected#IsApplicable": { "type": "boolean", "traits": { "smithy.api#documentation": "

Defines whether this question is applicable to a lens review.

" } }, "com.amazonaws.wellarchitected#IsMajorVersion": { "type": "boolean" }, "com.amazonaws.wellarchitected#IsReviewOwnerUpdateAcknowledged": { "type": "boolean" }, "com.amazonaws.wellarchitected#IssueManagementType": { "type": "enum", "members": { "AUTO": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AUTO" } }, "MANUAL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MANUAL" } } } }, "com.amazonaws.wellarchitected#ItemId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 2048 } } }, "com.amazonaws.wellarchitected#ItemIds": { "type": "list", "member": { "target": "com.amazonaws.wellarchitected#ItemId" }, "traits": { "smithy.api#length": { "min": 1 } } }, "com.amazonaws.wellarchitected#JiraConfiguration": { "type": "structure", "members": { "JiraIssueUrl": { "target": "com.amazonaws.wellarchitected#JiraIssueUrl", "traits": { "smithy.api#documentation": "

The URL of the associated Jira issue.

" } }, "LastSyncedTime": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The date and time when the Jira configuration was last synced.

" } } }, "traits": { "smithy.api#documentation": "

Configuration of the Jira integration.

" } }, "com.amazonaws.wellarchitected#JiraIssueUrl": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 2048 } } }, "com.amazonaws.wellarchitected#JiraProjectKey": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 100 }, "smithy.api#pattern": "^[A-Z][A-Z0-9_]*$" } }, "com.amazonaws.wellarchitected#JiraSelectedQuestionConfiguration": { "type": "structure", "members": { "SelectedPillars": { "target": "com.amazonaws.wellarchitected#SelectedPillars", "traits": { "smithy.api#documentation": "

Selected pillars in the workload.

" } } }, "traits": { "smithy.api#documentation": "

Selected questions in the workload.

" } }, "com.amazonaws.wellarchitected#Lens": { "type": "structure", "members": { "LensArn": { "target": "com.amazonaws.wellarchitected#LensArn", "traits": { "smithy.api#documentation": "

The ARN of a lens.

" } }, "LensVersion": { "target": "com.amazonaws.wellarchitected#LensVersion", "traits": { "smithy.api#documentation": "

The version of a lens.

" } }, "Name": { "target": "com.amazonaws.wellarchitected#LensName" }, "Description": { "target": "com.amazonaws.wellarchitected#LensDescription" }, "Owner": { "target": "com.amazonaws.wellarchitected#LensOwner", "traits": { "smithy.api#documentation": "

The Amazon Web Services account ID that owns the lens.

" } }, "ShareInvitationId": { "target": "com.amazonaws.wellarchitected#ShareInvitationId", "traits": { "smithy.api#documentation": "

The ID assigned to the share invitation.

" } }, "Tags": { "target": "com.amazonaws.wellarchitected#TagMap", "traits": { "smithy.api#documentation": "

The tags assigned to the lens.

" } } }, "traits": { "smithy.api#documentation": "

A lens return object.

" } }, "com.amazonaws.wellarchitected#LensAlias": { "type": "string", "traits": { "smithy.api#documentation": "

The alias of the lens.

For Amazon Web Services official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses.

For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef.

Each lens is identified by its LensSummary$LensAlias.

", "smithy.api#length": { "min": 1, "max": 128 } } }, "com.amazonaws.wellarchitected#LensAliases": { "type": "list", "member": { "target": "com.amazonaws.wellarchitected#LensAlias" }, "traits": { "smithy.api#documentation": "

List of lens aliases to associate or disassociate with a workload. Up to 10 lenses can be specified.

Identify a lens using its LensSummary$LensAlias.

", "smithy.api#length": { "min": 1 } } }, "com.amazonaws.wellarchitected#LensArn": { "type": "string" }, "com.amazonaws.wellarchitected#LensDescription": { "type": "string", "traits": { "smithy.api#documentation": "

The description of the lens.

", "smithy.api#length": { "min": 1, "max": 1024 } } }, "com.amazonaws.wellarchitected#LensJSON": { "type": "string", "traits": { "smithy.api#length": { "min": 2, "max": 500000 } } }, "com.amazonaws.wellarchitected#LensMetric": { "type": "structure", "members": { "LensArn": { "target": "com.amazonaws.wellarchitected#LensArn", "traits": { "smithy.api#documentation": "

The lens ARN.

" } }, "Pillars": { "target": "com.amazonaws.wellarchitected#PillarMetrics", "traits": { "smithy.api#documentation": "

The metrics for the pillars in a lens.

" } }, "RiskCounts": { "target": "com.amazonaws.wellarchitected#RiskCounts" } }, "traits": { "smithy.api#documentation": "

A metric for a particular lens in a workload.

" } }, "com.amazonaws.wellarchitected#LensMetrics": { "type": "list", "member": { "target": "com.amazonaws.wellarchitected#LensMetric" } }, "com.amazonaws.wellarchitected#LensName": { "type": "string", "traits": { "smithy.api#documentation": "

The full name of the lens.

", "smithy.api#length": { "min": 1, "max": 128 } } }, "com.amazonaws.wellarchitected#LensNamePrefix": { "type": "string", "traits": { "smithy.api#length": { "max": 100 } } }, "com.amazonaws.wellarchitected#LensOwner": { "type": "string" }, "com.amazonaws.wellarchitected#LensReview": { "type": "structure", "members": { "LensAlias": { "target": "com.amazonaws.wellarchitected#LensAlias" }, "LensArn": { "target": "com.amazonaws.wellarchitected#LensArn", "traits": { "smithy.api#documentation": "

The ARN for the lens.

" } }, "LensVersion": { "target": "com.amazonaws.wellarchitected#LensVersion", "traits": { "smithy.api#documentation": "

The version of the lens.

" } }, "LensName": { "target": "com.amazonaws.wellarchitected#LensName" }, "LensStatus": { "target": "com.amazonaws.wellarchitected#LensStatus", "traits": { "smithy.api#documentation": "

The status of the lens.

" } }, "PillarReviewSummaries": { "target": "com.amazonaws.wellarchitected#PillarReviewSummaries" }, "JiraConfiguration": { "target": "com.amazonaws.wellarchitected#JiraSelectedQuestionConfiguration", "traits": { "smithy.api#documentation": "

Jira configuration status of the Lens review.

" } }, "UpdatedAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The date and time when the lens review was last updated.

" } }, "Notes": { "target": "com.amazonaws.wellarchitected#Notes" }, "RiskCounts": { "target": "com.amazonaws.wellarchitected#RiskCounts" }, "NextToken": { "target": "com.amazonaws.wellarchitected#NextToken" }, "Profiles": { "target": "com.amazonaws.wellarchitected#WorkloadProfiles", "traits": { "smithy.api#documentation": "

The profiles associated with the workload.

" } }, "PrioritizedRiskCounts": { "target": "com.amazonaws.wellarchitected#RiskCounts" } }, "traits": { "smithy.api#documentation": "

A lens review of a question.

" } }, "com.amazonaws.wellarchitected#LensReviewReport": { "type": "structure", "members": { "LensAlias": { "target": "com.amazonaws.wellarchitected#LensAlias" }, "LensArn": { "target": "com.amazonaws.wellarchitected#LensArn", "traits": { "smithy.api#documentation": "

The ARN for the lens.

" } }, "Base64String": { "target": "com.amazonaws.wellarchitected#Base64String" } }, "traits": { "smithy.api#documentation": "

A report of a lens review.

" } }, "com.amazonaws.wellarchitected#LensReviewSummaries": { "type": "list", "member": { "target": "com.amazonaws.wellarchitected#LensReviewSummary" }, "traits": { "smithy.api#documentation": "

List of lens summaries of lens reviews of a workload.

" } }, "com.amazonaws.wellarchitected#LensReviewSummary": { "type": "structure", "members": { "LensAlias": { "target": "com.amazonaws.wellarchitected#LensAlias" }, "LensArn": { "target": "com.amazonaws.wellarchitected#LensArn", "traits": { "smithy.api#documentation": "

The ARN for the lens.

" } }, "LensVersion": { "target": "com.amazonaws.wellarchitected#LensVersion", "traits": { "smithy.api#documentation": "

The version of the lens.

" } }, "LensName": { "target": "com.amazonaws.wellarchitected#LensName" }, "LensStatus": { "target": "com.amazonaws.wellarchitected#LensStatus", "traits": { "smithy.api#documentation": "

The status of the lens.

" } }, "UpdatedAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The date and time when the lens review was last updated.

" } }, "RiskCounts": { "target": "com.amazonaws.wellarchitected#RiskCounts" }, "Profiles": { "target": "com.amazonaws.wellarchitected#WorkloadProfiles", "traits": { "smithy.api#documentation": "

The profiles associated with the workload.

" } }, "PrioritizedRiskCounts": { "target": "com.amazonaws.wellarchitected#RiskCounts" } }, "traits": { "smithy.api#documentation": "

A lens review summary of a workload.

" } }, "com.amazonaws.wellarchitected#LensShareSummaries": { "type": "list", "member": { "target": "com.amazonaws.wellarchitected#LensShareSummary" } }, "com.amazonaws.wellarchitected#LensShareSummary": { "type": "structure", "members": { "ShareId": { "target": "com.amazonaws.wellarchitected#ShareId" }, "SharedWith": { "target": "com.amazonaws.wellarchitected#SharedWith" }, "Status": { "target": "com.amazonaws.wellarchitected#ShareStatus" }, "StatusMessage": { "target": "com.amazonaws.wellarchitected#StatusMessage", "traits": { "smithy.api#documentation": "

Optional message to compliment the Status field.

" } } }, "traits": { "smithy.api#documentation": "

A lens share summary return object.

" } }, "com.amazonaws.wellarchitected#LensStatus": { "type": "enum", "members": { "CURRENT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CURRENT" } }, "NOT_CURRENT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NOT_CURRENT" } }, "DEPRECATED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DEPRECATED" } }, "DELETED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DELETED" } }, "UNSHARED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UNSHARED" } } } }, "com.amazonaws.wellarchitected#LensStatusType": { "type": "enum", "members": { "ALL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ALL" } }, "DRAFT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DRAFT" } }, "PUBLISHED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PUBLISHED" } } } }, "com.amazonaws.wellarchitected#LensSummaries": { "type": "list", "member": { "target": "com.amazonaws.wellarchitected#LensSummary" }, "traits": { "smithy.api#documentation": "

List of lens summaries of available lenses.

" } }, "com.amazonaws.wellarchitected#LensSummary": { "type": "structure", "members": { "LensArn": { "target": "com.amazonaws.wellarchitected#LensArn", "traits": { "smithy.api#documentation": "

The ARN of the lens.

" } }, "LensAlias": { "target": "com.amazonaws.wellarchitected#LensAlias" }, "LensName": { "target": "com.amazonaws.wellarchitected#LensName" }, "LensType": { "target": "com.amazonaws.wellarchitected#LensType", "traits": { "smithy.api#documentation": "

The type of the lens.

" } }, "Description": { "target": "com.amazonaws.wellarchitected#LensDescription" }, "CreatedAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The date and time when the lens was created.

" } }, "UpdatedAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The date and time when the lens was last updated.

" } }, "LensVersion": { "target": "com.amazonaws.wellarchitected#LensVersion", "traits": { "smithy.api#documentation": "

The version of the lens.

" } }, "Owner": { "target": "com.amazonaws.wellarchitected#AwsAccountId" }, "LensStatus": { "target": "com.amazonaws.wellarchitected#LensStatus", "traits": { "smithy.api#documentation": "

The status of the lens.

" } } }, "traits": { "smithy.api#documentation": "

A lens summary of a lens.

" } }, "com.amazonaws.wellarchitected#LensType": { "type": "enum", "members": { "AWS_OFFICIAL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AWS_OFFICIAL" } }, "CUSTOM_SHARED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CUSTOM_SHARED" } }, "CUSTOM_SELF": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CUSTOM_SELF" } } } }, "com.amazonaws.wellarchitected#LensUpgradeSummary": { "type": "structure", "members": { "WorkloadId": { "target": "com.amazonaws.wellarchitected#WorkloadId" }, "WorkloadName": { "target": "com.amazonaws.wellarchitected#WorkloadName" }, "LensAlias": { "target": "com.amazonaws.wellarchitected#LensAlias" }, "LensArn": { "target": "com.amazonaws.wellarchitected#LensArn", "traits": { "smithy.api#documentation": "

The ARN for the lens.

" } }, "CurrentLensVersion": { "target": "com.amazonaws.wellarchitected#LensVersion", "traits": { "smithy.api#documentation": "

The current version of the lens.

" } }, "LatestLensVersion": { "target": "com.amazonaws.wellarchitected#LensVersion", "traits": { "smithy.api#documentation": "

The latest version of the lens.

" } }, "ResourceArn": { "target": "com.amazonaws.wellarchitected#ResourceArn", "traits": { "smithy.api#documentation": "

ResourceArn of the lens being upgraded

" } }, "ResourceName": { "target": "com.amazonaws.wellarchitected#WorkloadName" } }, "traits": { "smithy.api#documentation": "

Lens upgrade summary return object.

" } }, "com.amazonaws.wellarchitected#LensVersion": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 32 } } }, "com.amazonaws.wellarchitected#LensesAppliedCount": { "type": "integer", "traits": { "smithy.api#range": { "min": 0 } } }, "com.amazonaws.wellarchitected#ListAgentContexts": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#ListAgentContextsRequest" }, "output": { "target": "com.amazonaws.wellarchitected#ListAgentContextsResponse" }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" }, { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, { "target": "com.amazonaws.wellarchitected#ValidationException" } ], "traits": { "smithy.api#documentation": "

Lists contexts associated with a profile.

", "smithy.api#http": { "method": "GET", "uri": "/api/v1/agent-profiles/{profileArn}/contexts" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults", "items": "items" }, "smithy.api#readonly": {}, "smithy.api#tags": [ "AGENT" ], "smithy.rules#staticContextParams": { "SubServiceType": { "value": "AGENT" } }, "smithy.test#smokeTests": [ { "id": "ListAgentContexts", "params": { "profileArn": "arn:aws:wellarchitected:us-west-2:123456789012:agent-profile/test-profile" }, "expect": { "failure": {} }, "vendorParamsShape": "aws.test#AwsVendorParams", "vendorParams": { "region": "us-west-2" } } ] } }, "com.amazonaws.wellarchitected#ListAgentContextsRequest": { "type": "structure", "members": { "profileArn": { "target": "com.amazonaws.wellarchitected#AgentProfileArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the profile to list contexts for.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "maxResults": { "target": "com.amazonaws.wellarchitected#MaxResults", "traits": { "smithy.api#default": 100, "smithy.api#documentation": "

The maximum number of contexts to return in a single call. Default is 100.

", "smithy.api#httpQuery": "maxResults", "smithy.api#range": { "min": 1, "max": 1000 } } }, "nextToken": { "target": "com.amazonaws.wellarchitected#NextToken", "traits": { "smithy.api#documentation": "

A pagination token returned from a previous call to continue retrieving results.

", "smithy.api#httpQuery": "nextToken", "smithy.api#length": { "min": 1 } } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.wellarchitected#ListAgentContextsResponse": { "type": "structure", "members": { "items": { "target": "com.amazonaws.wellarchitected#ContextSummaries", "traits": { "smithy.api#documentation": "

A list of context summaries associated with the profile.

", "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.wellarchitected#NextToken", "traits": { "smithy.api#documentation": "

A pagination token to retrieve the next set of results, if available.

", "smithy.api#length": { "min": 1 } } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.wellarchitected#ListAgentGoals": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#ListAgentGoalsRequest" }, "output": { "target": "com.amazonaws.wellarchitected#ListAgentGoalsResponse" }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" }, { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, { "target": "com.amazonaws.wellarchitected#ValidationException" } ], "traits": { "smithy.api#documentation": "

Lists optimization goals associated with a specified profile. Goals define specific targets and objectives for the optimization process.

", "smithy.api#http": { "method": "GET", "uri": "/api/v1/agent-profiles/{profileArn}/goals" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults", "items": "items" }, "smithy.api#readonly": {}, "smithy.api#tags": [ "AGENT" ], "smithy.rules#staticContextParams": { "SubServiceType": { "value": "AGENT" } }, "smithy.test#smokeTests": [ { "id": "ListAgentGoals", "params": { "profileArn": "arn:aws:wellarchitected:us-west-2:123456789012:agent-profile/test-profile" }, "expect": { "failure": {} }, "vendorParamsShape": "aws.test#AwsVendorParams", "vendorParams": { "region": "us-west-2" } } ] } }, "com.amazonaws.wellarchitected#ListAgentGoalsRequest": { "type": "structure", "members": { "profileArn": { "target": "com.amazonaws.wellarchitected#AgentProfileArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the optimization profile to list goals for.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "maxResults": { "target": "com.amazonaws.wellarchitected#MaxResults", "traits": { "smithy.api#default": 100, "smithy.api#documentation": "

The maximum number of goals to return in a single response.

", "smithy.api#httpQuery": "maxResults", "smithy.api#range": { "min": 1, "max": 1000 } } }, "nextToken": { "target": "com.amazonaws.wellarchitected#NextToken", "traits": { "smithy.api#documentation": "

A pagination token returned from a previous call to continue retrieving results.

", "smithy.api#httpQuery": "nextToken", "smithy.api#length": { "min": 1 } } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.wellarchitected#ListAgentGoalsResponse": { "type": "structure", "members": { "items": { "target": "com.amazonaws.wellarchitected#GoalSummaries", "traits": { "smithy.api#documentation": "

A list of goal summaries associated with the profile.

", "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.wellarchitected#NextToken", "traits": { "smithy.api#documentation": "

A pagination token to retrieve the next set of results, if available.

", "smithy.api#length": { "min": 1 } } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.wellarchitected#ListAgentOrganizationalReports": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#ListAgentOrganizationalReportsRequest" }, "output": { "target": "com.amazonaws.wellarchitected#ListAgentOrganizationalReportsResponse" }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" }, { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, { "target": "com.amazonaws.wellarchitected#ValidationException" } ], "traits": { "smithy.api#documentation": "

Lists Organizational Reports owned by the caller's account within the caller's AWS Organization, ordered by most recently created first. Supports pagination and an optional state filter.

", "smithy.api#http": { "method": "GET", "uri": "/api/v1/agent-organizational-reports", "code": 200 }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults", "items": "items" }, "smithy.api#readonly": {}, "smithy.api#tags": [ "AGENT" ], "smithy.rules#staticContextParams": { "SubServiceType": { "value": "AGENT" } }, "smithy.test#smokeTests": [ { "id": "ListAgentOrganizationalReports", "params": {}, "expect": { "failure": {} }, "vendorParamsShape": "aws.test#AwsVendorParams", "vendorParams": { "region": "us-west-2" } } ] } }, "com.amazonaws.wellarchitected#ListAgentOrganizationalReportsRequest": { "type": "structure", "members": { "maxResults": { "target": "com.amazonaws.wellarchitected#MaxResults", "traits": { "smithy.api#default": 100, "smithy.api#documentation": "

Maximum number of items to return in a single page. Defaults to 100.

", "smithy.api#httpQuery": "maxResults", "smithy.api#range": { "min": 1, "max": 1000 } } }, "nextToken": { "target": "com.amazonaws.wellarchitected#NextToken", "traits": { "smithy.api#documentation": "

Pagination token from a previous ListAgentOrganizationalReports response. Absent on the first page.

", "smithy.api#httpQuery": "nextToken", "smithy.api#length": { "min": 1 } } }, "state": { "target": "com.amazonaws.wellarchitected#OrganizationalReportState", "traits": { "smithy.api#documentation": "

Optional filter restricting the response to reports in a single lifecycle state.

", "smithy.api#httpQuery": "state" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.wellarchitected#ListAgentOrganizationalReportsResponse": { "type": "structure", "members": { "items": { "target": "com.amazonaws.wellarchitected#OrganizationalReportSummaryList", "traits": { "smithy.api#documentation": "

Page of report summaries, most-recently-created first.

", "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.wellarchitected#NextToken", "traits": { "smithy.api#documentation": "

Pagination token to supply on the next request, or absent when there are no more pages.

", "smithy.api#length": { "min": 1 } } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.wellarchitected#ListAgentProfiles": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#ListAgentProfilesRequest" }, "output": { "target": "com.amazonaws.wellarchitected#ListAgentProfilesResponse" }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" }, { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, { "target": "com.amazonaws.wellarchitected#ValidationException" } ], "traits": { "smithy.api#documentation": "

Lists optimization profiles in your account. Profiles define the scope and configuration for generating optimization recommendations.

", "smithy.api#http": { "method": "GET", "uri": "/api/v1/agent-profiles" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults", "items": "items" }, "smithy.api#readonly": {}, "smithy.api#tags": [ "AGENT" ], "smithy.rules#staticContextParams": { "SubServiceType": { "value": "AGENT" } }, "smithy.test#smokeTests": [ { "id": "ListAgentProfiles", "params": {}, "expect": { "success": {} }, "vendorParamsShape": "aws.test#AwsVendorParams", "vendorParams": { "region": "us-west-2" } } ] } }, "com.amazonaws.wellarchitected#ListAgentProfilesRequest": { "type": "structure", "members": { "maxResults": { "target": "com.amazonaws.wellarchitected#MaxResults", "traits": { "smithy.api#default": 100, "smithy.api#documentation": "

The maximum number of profiles to return in a single call. Default is 100.

", "smithy.api#httpQuery": "maxResults", "smithy.api#range": { "min": 1, "max": 1000 } } }, "nextToken": { "target": "com.amazonaws.wellarchitected#NextToken", "traits": { "smithy.api#documentation": "

A pagination token returned from a previous call to continue retrieving results.

", "smithy.api#httpQuery": "nextToken", "smithy.api#length": { "min": 1 } } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.wellarchitected#ListAgentProfilesResponse": { "type": "structure", "members": { "items": { "target": "com.amazonaws.wellarchitected#AgentProfileSummaries", "traits": { "smithy.api#documentation": "

A list of profile summaries.

", "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.wellarchitected#NextToken", "traits": { "smithy.api#documentation": "

A pagination token to retrieve the next set of results, if available.

", "smithy.api#length": { "min": 1 } } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.wellarchitected#ListAgentRecommendationGenerations": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#ListAgentRecommendationGenerationsRequest" }, "output": { "target": "com.amazonaws.wellarchitected#ListAgentRecommendationGenerationsResponse" }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" }, { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, { "target": "com.amazonaws.wellarchitected#ValidationException" } ], "traits": { "smithy.api#documentation": "

Application-level recommendations are a new recommendation format currently in beta. We are actively seeking customer feedback to improve their quality and relevance. As with any AI-generated content, please thoroughly review each recommendation before taking any action based on it.

Lists recommendation generation processes for a specified profile.

", "smithy.api#http": { "method": "GET", "uri": "/api/v1/agent-profiles/{profileArn}/generations" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults", "items": "items" }, "smithy.api#readonly": {}, "smithy.api#tags": [ "AGENT" ], "smithy.rules#staticContextParams": { "SubServiceType": { "value": "AGENT" } } } }, "com.amazonaws.wellarchitected#ListAgentRecommendationGenerationsRequest": { "type": "structure", "members": { "profileArn": { "target": "com.amazonaws.wellarchitected#AgentProfileArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the optimization profile to list generation processes for.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "recommendationType": { "target": "com.amazonaws.wellarchitected#RecommendationType", "traits": { "smithy.api#documentation": "

Optional filter by recommendation type.

", "smithy.api#httpQuery": "RecommendationType" } }, "maxResults": { "target": "com.amazonaws.wellarchitected#MaxResults", "traits": { "smithy.api#default": 100, "smithy.api#documentation": "

The maximum number of generation processes to return in a single response.

", "smithy.api#httpQuery": "MaxResults", "smithy.api#range": { "min": 1, "max": 1000 } } }, "nextToken": { "target": "com.amazonaws.wellarchitected#NextToken", "traits": { "smithy.api#documentation": "

A pagination token returned from a previous call to continue retrieving results.

", "smithy.api#httpQuery": "NextToken", "smithy.api#length": { "min": 1 } } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.wellarchitected#ListAgentRecommendationGenerationsResponse": { "type": "structure", "members": { "items": { "target": "com.amazonaws.wellarchitected#AgentRecommendationGenerationSummaries", "traits": { "smithy.api#documentation": "

A list of recommendation generation summaries.

", "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.wellarchitected#NextToken", "traits": { "smithy.api#documentation": "

A pagination token to retrieve the next set of results, if available.

", "smithy.api#length": { "min": 1 } } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.wellarchitected#ListAgentRecommendationItems": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#ListAgentRecommendationItemsRequest" }, "output": { "target": "com.amazonaws.wellarchitected#ListAgentRecommendationItemsResponse" }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" }, { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, { "target": "com.amazonaws.wellarchitected#ValidationException" } ], "traits": { "smithy.api#documentation": "

Application-level recommendations are a new recommendation format currently in beta. We are actively seeking customer feedback to improve their quality and relevance. As with any AI-generated content, please thoroughly review each recommendation before taking any action based on it.

Lists recommendation items for a specific recommendation. Recommendation items provide detailed information about individual optimization opportunities.

", "smithy.api#http": { "method": "GET", "uri": "/api/v1/agent-recommendations/{recommendationArn}/items" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults", "items": "items" }, "smithy.api#readonly": {}, "smithy.api#tags": [ "AGENT" ], "smithy.rules#staticContextParams": { "SubServiceType": { "value": "AGENT" } }, "smithy.test#smokeTests": [ { "id": "ListAgentRecommendationItems", "params": { "recommendationArn": "arn:aws:wellarchitected:us-west-2:123456789012:agent-recommendation/f6b5df15-3409-483f-b796-45d0e590222c" }, "expect": { "failure": {} }, "vendorParamsShape": "aws.test#AwsVendorParams", "vendorParams": { "region": "us-west-2" } } ] } }, "com.amazonaws.wellarchitected#ListAgentRecommendationItemsRequest": { "type": "structure", "members": { "recommendationArn": { "target": "com.amazonaws.wellarchitected#AgentRecommendationArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the recommendation to list items for.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "type": { "target": "com.amazonaws.wellarchitected#RecommendationItemType", "traits": { "smithy.api#documentation": "

Optional filter to return only recommendation items of the specified type.

", "smithy.api#httpQuery": "type" } }, "maxResults": { "target": "com.amazonaws.wellarchitected#MaxResults", "traits": { "smithy.api#default": 100, "smithy.api#documentation": "

The maximum number of recommendation items to return in a single response.

", "smithy.api#httpQuery": "maxResults", "smithy.api#range": { "min": 1, "max": 1000 } } }, "nextToken": { "target": "com.amazonaws.wellarchitected#NextToken", "traits": { "smithy.api#documentation": "

A pagination token returned from a previous call to continue retrieving results.

", "smithy.api#httpQuery": "nextToken", "smithy.api#length": { "min": 1 } } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.wellarchitected#ListAgentRecommendationItemsResponse": { "type": "structure", "members": { "items": { "target": "com.amazonaws.wellarchitected#AgentRecommendationItemSummaries", "traits": { "smithy.api#documentation": "

A list of recommendation items with their detailed metadata and configuration information.

", "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.wellarchitected#NextToken", "traits": { "smithy.api#documentation": "

A pagination token to retrieve the next set of results, if available.

", "smithy.api#length": { "min": 1 } } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.wellarchitected#ListAgentRecommendations": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#ListAgentRecommendationsRequest" }, "output": { "target": "com.amazonaws.wellarchitected#ListAgentRecommendationsResponse" }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" }, { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, { "target": "com.amazonaws.wellarchitected#ValidationException" } ], "traits": { "smithy.api#documentation": "

Application-level recommendations are a new recommendation format currently in beta. We are actively seeking customer feedback to improve their quality and relevance. As with any AI-generated content, please thoroughly review each recommendation before taking any action based on it.

Lists active optimization recommendations for a specified profile with optional filtering by state.

", "smithy.api#http": { "method": "GET", "uri": "/api/v1/agent-profiles/{profileArn}/recommendations" }, "smithy.api#paginated": { "inputToken": "nextToken", "outputToken": "nextToken", "pageSize": "maxResults", "items": "items" }, "smithy.api#readonly": {}, "smithy.api#tags": [ "AGENT" ], "smithy.rules#staticContextParams": { "SubServiceType": { "value": "AGENT" } } } }, "com.amazonaws.wellarchitected#ListAgentRecommendationsRequest": { "type": "structure", "members": { "profileArn": { "target": "com.amazonaws.wellarchitected#AgentProfileArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the optimization profile to list recommendations for.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "maxResults": { "target": "com.amazonaws.wellarchitected#MaxResults", "traits": { "smithy.api#default": 100, "smithy.api#documentation": "

The maximum number of recommendations to return in a single response.

", "smithy.api#httpQuery": "maxResults", "smithy.api#range": { "min": 1, "max": 1000 } } }, "nextToken": { "target": "com.amazonaws.wellarchitected#NextToken", "traits": { "smithy.api#documentation": "

A pagination token returned from a previous call to continue retrieving results.

", "smithy.api#httpQuery": "nextToken", "smithy.api#length": { "min": 1 } } }, "state": { "target": "com.amazonaws.wellarchitected#RecommendationState", "traits": { "smithy.api#documentation": "

Optional filter to return only recommendations with the specified state (OPEN or CLOSED).

", "smithy.api#httpQuery": "state" } }, "pillar": { "target": "com.amazonaws.wellarchitected#Pillar", "traits": { "smithy.api#documentation": "

Optional filter to return only recommendations for the specified pillar.

", "smithy.api#httpQuery": "pillar" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.wellarchitected#ListAgentRecommendationsResponse": { "type": "structure", "members": { "items": { "target": "com.amazonaws.wellarchitected#AgentRecommendationSummaries", "traits": { "smithy.api#documentation": "

A list of recommendation summaries.

", "smithy.api#required": {} } }, "nextToken": { "target": "com.amazonaws.wellarchitected#NextToken", "traits": { "smithy.api#documentation": "

A pagination token to retrieve the next set of results, if available.

", "smithy.api#length": { "min": 1 } } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.wellarchitected#ListAnswers": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#ListAnswersInput" }, "output": { "target": "com.amazonaws.wellarchitected#ListAnswersOutput" }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" }, { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, { "target": "com.amazonaws.wellarchitected#ValidationException" } ], "traits": { "smithy.api#documentation": "

List of answers for a particular workload and lens.

", "smithy.api#http": { "method": "GET", "uri": "/workloads/{WorkloadId}/lensReviews/{LensAlias}/answers", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults" }, "smithy.api#tags": [ "WA" ] } }, "com.amazonaws.wellarchitected#ListAnswersInput": { "type": "structure", "members": { "WorkloadId": { "target": "com.amazonaws.wellarchitected#WorkloadId", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "LensAlias": { "target": "com.amazonaws.wellarchitected#LensAlias", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "PillarId": { "target": "com.amazonaws.wellarchitected#PillarId", "traits": { "smithy.api#httpQuery": "PillarId" } }, "MilestoneNumber": { "target": "com.amazonaws.wellarchitected#MilestoneNumber", "traits": { "smithy.api#httpQuery": "MilestoneNumber" } }, "NextToken": { "target": "com.amazonaws.wellarchitected#NextToken", "traits": { "smithy.api#httpQuery": "NextToken" } }, "MaxResults": { "target": "com.amazonaws.wellarchitected#MaxResults", "traits": { "smithy.api#documentation": "

The maximum number of results to return for this request.

", "smithy.api#httpQuery": "MaxResults", "smithy.api#range": { "min": 1, "max": 50 } } }, "QuestionPriority": { "target": "com.amazonaws.wellarchitected#QuestionPriority", "traits": { "smithy.api#documentation": "

The priority of the question.

", "smithy.api#httpQuery": "QuestionPriority" } } }, "traits": { "smithy.api#documentation": "

Input to list answers.

", "smithy.api#input": {} } }, "com.amazonaws.wellarchitected#ListAnswersOutput": { "type": "structure", "members": { "WorkloadId": { "target": "com.amazonaws.wellarchitected#WorkloadId" }, "MilestoneNumber": { "target": "com.amazonaws.wellarchitected#MilestoneNumber" }, "LensAlias": { "target": "com.amazonaws.wellarchitected#LensAlias" }, "LensArn": { "target": "com.amazonaws.wellarchitected#LensArn", "traits": { "smithy.api#documentation": "

The ARN for the lens.

" } }, "AnswerSummaries": { "target": "com.amazonaws.wellarchitected#AnswerSummaries" }, "NextToken": { "target": "com.amazonaws.wellarchitected#NextToken" } }, "traits": { "smithy.api#documentation": "

Output of a list answers call.

", "smithy.api#output": {} } }, "com.amazonaws.wellarchitected#ListCheckDetails": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#ListCheckDetailsInput" }, "output": { "target": "com.amazonaws.wellarchitected#ListCheckDetailsOutput" }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" }, { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, { "target": "com.amazonaws.wellarchitected#ValidationException" } ], "traits": { "smithy.api#documentation": "

List of Trusted Advisor check details by account related to the workload.

", "smithy.api#http": { "method": "POST", "uri": "/workloads/{WorkloadId}/checks", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults" }, "smithy.api#tags": [ "WA" ] } }, "com.amazonaws.wellarchitected#ListCheckDetailsInput": { "type": "structure", "members": { "WorkloadId": { "target": "com.amazonaws.wellarchitected#WorkloadId", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.wellarchitected#NextToken" }, "MaxResults": { "target": "com.amazonaws.wellarchitected#MaxResults", "traits": { "smithy.api#range": { "min": 1, "max": 50 } } }, "LensArn": { "target": "com.amazonaws.wellarchitected#LensArn", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

Well-Architected Lens ARN.

", "smithy.api#required": {} } }, "PillarId": { "target": "com.amazonaws.wellarchitected#PillarId", "traits": { "smithy.api#clientOptional": {}, "smithy.api#required": {} } }, "QuestionId": { "target": "com.amazonaws.wellarchitected#QuestionId", "traits": { "smithy.api#clientOptional": {}, "smithy.api#required": {} } }, "ChoiceId": { "target": "com.amazonaws.wellarchitected#ChoiceId", "traits": { "smithy.api#clientOptional": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.wellarchitected#ListCheckDetailsOutput": { "type": "structure", "members": { "CheckDetails": { "target": "com.amazonaws.wellarchitected#CheckDetails", "traits": { "smithy.api#documentation": "

The details about the Trusted Advisor checks related to the Well-Architected best practice.

" } }, "NextToken": { "target": "com.amazonaws.wellarchitected#NextToken" } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.wellarchitected#ListCheckSummaries": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#ListCheckSummariesInput" }, "output": { "target": "com.amazonaws.wellarchitected#ListCheckSummariesOutput" }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" }, { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, { "target": "com.amazonaws.wellarchitected#ValidationException" } ], "traits": { "smithy.api#documentation": "

List of Trusted Advisor checks summarized for all accounts related to the workload.

", "smithy.api#http": { "method": "POST", "uri": "/workloads/{WorkloadId}/checkSummaries", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults" }, "smithy.api#tags": [ "WA" ] } }, "com.amazonaws.wellarchitected#ListCheckSummariesInput": { "type": "structure", "members": { "WorkloadId": { "target": "com.amazonaws.wellarchitected#WorkloadId", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.wellarchitected#NextToken" }, "MaxResults": { "target": "com.amazonaws.wellarchitected#MaxResults", "traits": { "smithy.api#range": { "min": 1, "max": 50 } } }, "LensArn": { "target": "com.amazonaws.wellarchitected#LensArn", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

Well-Architected Lens ARN.

", "smithy.api#required": {} } }, "PillarId": { "target": "com.amazonaws.wellarchitected#PillarId", "traits": { "smithy.api#clientOptional": {}, "smithy.api#required": {} } }, "QuestionId": { "target": "com.amazonaws.wellarchitected#QuestionId", "traits": { "smithy.api#clientOptional": {}, "smithy.api#required": {} } }, "ChoiceId": { "target": "com.amazonaws.wellarchitected#ChoiceId", "traits": { "smithy.api#clientOptional": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.wellarchitected#ListCheckSummariesOutput": { "type": "structure", "members": { "CheckSummaries": { "target": "com.amazonaws.wellarchitected#CheckSummaries", "traits": { "smithy.api#documentation": "

List of Trusted Advisor summaries related to the Well-Architected best practice.

" } }, "NextToken": { "target": "com.amazonaws.wellarchitected#NextToken" } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.wellarchitected#ListLensReviewImprovements": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#ListLensReviewImprovementsInput" }, "output": { "target": "com.amazonaws.wellarchitected#ListLensReviewImprovementsOutput" }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" }, { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, { "target": "com.amazonaws.wellarchitected#ValidationException" } ], "traits": { "smithy.api#documentation": "

List the improvements of a particular lens review.

", "smithy.api#http": { "method": "GET", "uri": "/workloads/{WorkloadId}/lensReviews/{LensAlias}/improvements", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults" }, "smithy.api#tags": [ "WA" ] } }, "com.amazonaws.wellarchitected#ListLensReviewImprovementsInput": { "type": "structure", "members": { "WorkloadId": { "target": "com.amazonaws.wellarchitected#WorkloadId", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "LensAlias": { "target": "com.amazonaws.wellarchitected#LensAlias", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "PillarId": { "target": "com.amazonaws.wellarchitected#PillarId", "traits": { "smithy.api#httpQuery": "PillarId" } }, "MilestoneNumber": { "target": "com.amazonaws.wellarchitected#MilestoneNumber", "traits": { "smithy.api#httpQuery": "MilestoneNumber" } }, "NextToken": { "target": "com.amazonaws.wellarchitected#NextToken", "traits": { "smithy.api#httpQuery": "NextToken" } }, "MaxResults": { "target": "com.amazonaws.wellarchitected#MaxResults", "traits": { "smithy.api#documentation": "

The maximum number of results to return for this request.

", "smithy.api#httpQuery": "MaxResults", "smithy.api#range": { "min": 1, "max": 100 } } }, "QuestionPriority": { "target": "com.amazonaws.wellarchitected#QuestionPriority", "traits": { "smithy.api#documentation": "

The priority of the question.

", "smithy.api#httpQuery": "QuestionPriority" } } }, "traits": { "smithy.api#documentation": "

Input to list lens review improvements.

", "smithy.api#input": {} } }, "com.amazonaws.wellarchitected#ListLensReviewImprovementsOutput": { "type": "structure", "members": { "WorkloadId": { "target": "com.amazonaws.wellarchitected#WorkloadId" }, "MilestoneNumber": { "target": "com.amazonaws.wellarchitected#MilestoneNumber" }, "LensAlias": { "target": "com.amazonaws.wellarchitected#LensAlias" }, "LensArn": { "target": "com.amazonaws.wellarchitected#LensArn", "traits": { "smithy.api#documentation": "

The ARN for the lens.

" } }, "ImprovementSummaries": { "target": "com.amazonaws.wellarchitected#ImprovementSummaries" }, "NextToken": { "target": "com.amazonaws.wellarchitected#NextToken" } }, "traits": { "smithy.api#documentation": "

Output of a list lens review improvements call.

", "smithy.api#output": {} } }, "com.amazonaws.wellarchitected#ListLensReviews": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#ListLensReviewsInput" }, "output": { "target": "com.amazonaws.wellarchitected#ListLensReviewsOutput" }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" }, { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, { "target": "com.amazonaws.wellarchitected#ValidationException" } ], "traits": { "smithy.api#documentation": "

List lens reviews for a particular workload.

", "smithy.api#http": { "method": "GET", "uri": "/workloads/{WorkloadId}/lensReviews", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults" }, "smithy.api#tags": [ "WA" ] } }, "com.amazonaws.wellarchitected#ListLensReviewsInput": { "type": "structure", "members": { "WorkloadId": { "target": "com.amazonaws.wellarchitected#WorkloadId", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "MilestoneNumber": { "target": "com.amazonaws.wellarchitected#MilestoneNumber", "traits": { "smithy.api#httpQuery": "MilestoneNumber" } }, "NextToken": { "target": "com.amazonaws.wellarchitected#NextToken", "traits": { "smithy.api#httpQuery": "NextToken" } }, "MaxResults": { "target": "com.amazonaws.wellarchitected#MaxResults", "traits": { "smithy.api#httpQuery": "MaxResults", "smithy.api#range": { "min": 1, "max": 50 } } } }, "traits": { "smithy.api#documentation": "

Input to list lens reviews.

", "smithy.api#input": {} } }, "com.amazonaws.wellarchitected#ListLensReviewsOutput": { "type": "structure", "members": { "WorkloadId": { "target": "com.amazonaws.wellarchitected#WorkloadId" }, "MilestoneNumber": { "target": "com.amazonaws.wellarchitected#MilestoneNumber" }, "LensReviewSummaries": { "target": "com.amazonaws.wellarchitected#LensReviewSummaries" }, "NextToken": { "target": "com.amazonaws.wellarchitected#NextToken" } }, "traits": { "smithy.api#documentation": "

Output of a list lens reviews call.

", "smithy.api#output": {} } }, "com.amazonaws.wellarchitected#ListLensShares": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#ListLensSharesInput" }, "output": { "target": "com.amazonaws.wellarchitected#ListLensSharesOutput" }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" }, { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, { "target": "com.amazonaws.wellarchitected#ValidationException" } ], "traits": { "smithy.api#documentation": "

List the lens shares associated with the lens.

", "smithy.api#http": { "method": "GET", "uri": "/lenses/{LensAlias}/shares", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults" }, "smithy.api#tags": [ "WA" ] } }, "com.amazonaws.wellarchitected#ListLensSharesInput": { "type": "structure", "members": { "LensAlias": { "target": "com.amazonaws.wellarchitected#LensAlias", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "SharedWithPrefix": { "target": "com.amazonaws.wellarchitected#SharedWithPrefix", "traits": { "smithy.api#documentation": "

The Amazon Web Services account ID, organization ID, or organizational unit (OU) ID with which the lens is shared.

", "smithy.api#httpQuery": "SharedWithPrefix" } }, "NextToken": { "target": "com.amazonaws.wellarchitected#NextToken", "traits": { "smithy.api#httpQuery": "NextToken" } }, "MaxResults": { "target": "com.amazonaws.wellarchitected#MaxResults", "traits": { "smithy.api#documentation": "

The maximum number of results to return for this request.

", "smithy.api#httpQuery": "MaxResults", "smithy.api#range": { "min": 1, "max": 50 } } }, "Status": { "target": "com.amazonaws.wellarchitected#ShareStatus", "traits": { "smithy.api#httpQuery": "Status" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.wellarchitected#ListLensSharesOutput": { "type": "structure", "members": { "LensShareSummaries": { "target": "com.amazonaws.wellarchitected#LensShareSummaries", "traits": { "smithy.api#documentation": "

A list of lens share summaries.

" } }, "NextToken": { "target": "com.amazonaws.wellarchitected#NextToken" } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.wellarchitected#ListLenses": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#ListLensesInput" }, "output": { "target": "com.amazonaws.wellarchitected#ListLensesOutput" }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" }, { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, { "target": "com.amazonaws.wellarchitected#ValidationException" } ], "traits": { "smithy.api#documentation": "

List the available lenses.

", "smithy.api#http": { "method": "GET", "uri": "/lenses", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults" }, "smithy.api#tags": [ "WA" ] } }, "com.amazonaws.wellarchitected#ListLensesInput": { "type": "structure", "members": { "NextToken": { "target": "com.amazonaws.wellarchitected#NextToken", "traits": { "smithy.api#httpQuery": "NextToken" } }, "MaxResults": { "target": "com.amazonaws.wellarchitected#MaxResults", "traits": { "smithy.api#httpQuery": "MaxResults", "smithy.api#range": { "min": 1, "max": 50 } } }, "LensType": { "target": "com.amazonaws.wellarchitected#LensType", "traits": { "smithy.api#documentation": "

The type of lenses to be returned.

", "smithy.api#httpQuery": "LensType" } }, "LensStatus": { "target": "com.amazonaws.wellarchitected#LensStatusType", "traits": { "smithy.api#documentation": "

The status of lenses to be returned.

", "smithy.api#httpQuery": "LensStatus" } }, "LensName": { "target": "com.amazonaws.wellarchitected#LensName", "traits": { "smithy.api#httpQuery": "LensName" } } }, "traits": { "smithy.api#documentation": "

Input to list lenses.

", "smithy.api#input": {} } }, "com.amazonaws.wellarchitected#ListLensesOutput": { "type": "structure", "members": { "LensSummaries": { "target": "com.amazonaws.wellarchitected#LensSummaries" }, "NextToken": { "target": "com.amazonaws.wellarchitected#NextToken" } }, "traits": { "smithy.api#documentation": "

Output of a list lenses call.

", "smithy.api#output": {} } }, "com.amazonaws.wellarchitected#ListMilestones": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#ListMilestonesInput" }, "output": { "target": "com.amazonaws.wellarchitected#ListMilestonesOutput" }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" }, { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, { "target": "com.amazonaws.wellarchitected#ValidationException" } ], "traits": { "smithy.api#documentation": "

List all milestones for an existing workload.

", "smithy.api#http": { "method": "POST", "uri": "/workloads/{WorkloadId}/milestonesSummaries", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults" }, "smithy.api#tags": [ "WA" ] } }, "com.amazonaws.wellarchitected#ListMilestonesInput": { "type": "structure", "members": { "WorkloadId": { "target": "com.amazonaws.wellarchitected#WorkloadId", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "NextToken": { "target": "com.amazonaws.wellarchitected#NextToken" }, "MaxResults": { "target": "com.amazonaws.wellarchitected#MaxResults", "traits": { "smithy.api#range": { "min": 1, "max": 50 } } } }, "traits": { "smithy.api#documentation": "

Input to list all milestones for a workload.

", "smithy.api#input": {} } }, "com.amazonaws.wellarchitected#ListMilestonesOutput": { "type": "structure", "members": { "WorkloadId": { "target": "com.amazonaws.wellarchitected#WorkloadId" }, "MilestoneSummaries": { "target": "com.amazonaws.wellarchitected#MilestoneSummaries" }, "NextToken": { "target": "com.amazonaws.wellarchitected#NextToken" } }, "traits": { "smithy.api#documentation": "

Output of a list milestones call.

", "smithy.api#output": {} } }, "com.amazonaws.wellarchitected#ListNotifications": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#ListNotificationsInput" }, "output": { "target": "com.amazonaws.wellarchitected#ListNotificationsOutput" }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" }, { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, { "target": "com.amazonaws.wellarchitected#ValidationException" } ], "traits": { "smithy.api#documentation": "

List lens notifications.

", "smithy.api#http": { "method": "POST", "uri": "/notifications", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults" }, "smithy.api#tags": [ "WA" ] } }, "com.amazonaws.wellarchitected#ListNotificationsInput": { "type": "structure", "members": { "WorkloadId": { "target": "com.amazonaws.wellarchitected#WorkloadId" }, "NextToken": { "target": "com.amazonaws.wellarchitected#NextToken" }, "MaxResults": { "target": "com.amazonaws.wellarchitected#MaxResults", "traits": { "smithy.api#documentation": "

The maximum number of results to return for this request.

", "smithy.api#range": { "min": 1, "max": 50 } } }, "ResourceArn": { "target": "com.amazonaws.wellarchitected#ResourceArn", "traits": { "smithy.api#documentation": "

The ARN for the related resource for the notification.

Only one of WorkloadID or ResourceARN should be specified.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.wellarchitected#ListNotificationsOutput": { "type": "structure", "members": { "NotificationSummaries": { "target": "com.amazonaws.wellarchitected#NotificationSummaries", "traits": { "smithy.api#documentation": "

List of lens notification summaries in a workload.

" } }, "NextToken": { "target": "com.amazonaws.wellarchitected#NextToken" } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.wellarchitected#ListProfileNotifications": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#ListProfileNotificationsInput" }, "output": { "target": "com.amazonaws.wellarchitected#ListProfileNotificationsOutput" }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" }, { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, { "target": "com.amazonaws.wellarchitected#ValidationException" } ], "traits": { "smithy.api#documentation": "

List profile notifications.

", "smithy.api#http": { "method": "GET", "uri": "/profileNotifications", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults" }, "smithy.api#tags": [ "WA" ] } }, "com.amazonaws.wellarchitected#ListProfileNotificationsInput": { "type": "structure", "members": { "WorkloadId": { "target": "com.amazonaws.wellarchitected#WorkloadId", "traits": { "smithy.api#httpQuery": "WorkloadId" } }, "NextToken": { "target": "com.amazonaws.wellarchitected#NextToken", "traits": { "smithy.api#httpQuery": "NextToken" } }, "MaxResults": { "target": "com.amazonaws.wellarchitected#MaxResults", "traits": { "smithy.api#httpQuery": "MaxResults", "smithy.api#range": { "min": 1, "max": 50 } } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.wellarchitected#ListProfileNotificationsOutput": { "type": "structure", "members": { "NotificationSummaries": { "target": "com.amazonaws.wellarchitected#ProfileNotificationSummaries", "traits": { "smithy.api#documentation": "

Notification summaries.

" } }, "NextToken": { "target": "com.amazonaws.wellarchitected#NextToken" } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.wellarchitected#ListProfileShares": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#ListProfileSharesInput" }, "output": { "target": "com.amazonaws.wellarchitected#ListProfileSharesOutput" }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" }, { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, { "target": "com.amazonaws.wellarchitected#ValidationException" } ], "traits": { "smithy.api#documentation": "

List profile shares.

", "smithy.api#http": { "method": "GET", "uri": "/profiles/{ProfileArn}/shares", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults" }, "smithy.api#tags": [ "WA" ] } }, "com.amazonaws.wellarchitected#ListProfileSharesInput": { "type": "structure", "members": { "ProfileArn": { "target": "com.amazonaws.wellarchitected#ProfileArn", "traits": { "smithy.api#documentation": "

The profile ARN.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "SharedWithPrefix": { "target": "com.amazonaws.wellarchitected#SharedWithPrefix", "traits": { "smithy.api#documentation": "

The Amazon Web Services account ID, organization ID, or organizational unit (OU) ID with which the profile is shared.

", "smithy.api#httpQuery": "SharedWithPrefix" } }, "NextToken": { "target": "com.amazonaws.wellarchitected#NextToken", "traits": { "smithy.api#httpQuery": "NextToken" } }, "MaxResults": { "target": "com.amazonaws.wellarchitected#MaxResults", "traits": { "smithy.api#documentation": "

The maximum number of results to return for this request.

", "smithy.api#httpQuery": "MaxResults", "smithy.api#range": { "min": 1, "max": 50 } } }, "Status": { "target": "com.amazonaws.wellarchitected#ShareStatus", "traits": { "smithy.api#httpQuery": "Status" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.wellarchitected#ListProfileSharesOutput": { "type": "structure", "members": { "ProfileShareSummaries": { "target": "com.amazonaws.wellarchitected#ProfileShareSummaries", "traits": { "smithy.api#documentation": "

Profile share summaries.

" } }, "NextToken": { "target": "com.amazonaws.wellarchitected#NextToken" } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.wellarchitected#ListProfiles": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#ListProfilesInput" }, "output": { "target": "com.amazonaws.wellarchitected#ListProfilesOutput" }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" }, { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, { "target": "com.amazonaws.wellarchitected#ValidationException" } ], "traits": { "smithy.api#documentation": "

List profiles.

", "smithy.api#http": { "method": "GET", "uri": "/profileSummaries", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults" }, "smithy.api#tags": [ "WA" ] } }, "com.amazonaws.wellarchitected#ListProfilesInput": { "type": "structure", "members": { "ProfileNamePrefix": { "target": "com.amazonaws.wellarchitected#ProfileNamePrefix", "traits": { "smithy.api#documentation": "

An optional string added to the beginning of each profile name returned in the results.

", "smithy.api#httpQuery": "ProfileNamePrefix" } }, "ProfileOwnerType": { "target": "com.amazonaws.wellarchitected#ProfileOwnerType", "traits": { "smithy.api#documentation": "

Profile owner type.

", "smithy.api#httpQuery": "ProfileOwnerType" } }, "NextToken": { "target": "com.amazonaws.wellarchitected#NextToken", "traits": { "smithy.api#httpQuery": "NextToken" } }, "MaxResults": { "target": "com.amazonaws.wellarchitected#MaxResults", "traits": { "smithy.api#httpQuery": "MaxResults", "smithy.api#range": { "min": 1, "max": 50 } } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.wellarchitected#ListProfilesOutput": { "type": "structure", "members": { "ProfileSummaries": { "target": "com.amazonaws.wellarchitected#ProfileSummaries", "traits": { "smithy.api#documentation": "

Profile summaries.

" } }, "NextToken": { "target": "com.amazonaws.wellarchitected#NextToken" } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.wellarchitected#ListReviewTemplateAnswers": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#ListReviewTemplateAnswersInput" }, "output": { "target": "com.amazonaws.wellarchitected#ListReviewTemplateAnswersOutput" }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" }, { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, { "target": "com.amazonaws.wellarchitected#ValidationException" } ], "traits": { "smithy.api#documentation": "

List the answers of a review template.

", "smithy.api#http": { "method": "GET", "uri": "/reviewTemplates/{TemplateArn}/lensReviews/{LensAlias}/answers", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults" }, "smithy.api#tags": [ "WA" ] } }, "com.amazonaws.wellarchitected#ListReviewTemplateAnswersInput": { "type": "structure", "members": { "TemplateArn": { "target": "com.amazonaws.wellarchitected#TemplateArn", "traits": { "smithy.api#documentation": "

The ARN of the review template.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "LensAlias": { "target": "com.amazonaws.wellarchitected#LensAlias", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "PillarId": { "target": "com.amazonaws.wellarchitected#PillarId", "traits": { "smithy.api#httpQuery": "PillarId" } }, "NextToken": { "target": "com.amazonaws.wellarchitected#NextToken", "traits": { "smithy.api#httpQuery": "NextToken" } }, "MaxResults": { "target": "com.amazonaws.wellarchitected#MaxResults", "traits": { "smithy.api#documentation": "

The maximum number of results to return for this request.

", "smithy.api#httpQuery": "MaxResults", "smithy.api#range": { "min": 1, "max": 50 } } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.wellarchitected#ListReviewTemplateAnswersOutput": { "type": "structure", "members": { "TemplateArn": { "target": "com.amazonaws.wellarchitected#TemplateArn", "traits": { "smithy.api#documentation": "

The ARN of the review template.

" } }, "LensAlias": { "target": "com.amazonaws.wellarchitected#LensAlias" }, "AnswerSummaries": { "target": "com.amazonaws.wellarchitected#ReviewTemplateAnswerSummaries", "traits": { "smithy.api#documentation": "

List of answer summaries of a lens review in a review template.

" } }, "NextToken": { "target": "com.amazonaws.wellarchitected#NextToken" } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.wellarchitected#ListReviewTemplates": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#ListReviewTemplatesInput" }, "output": { "target": "com.amazonaws.wellarchitected#ListReviewTemplatesOutput" }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" }, { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, { "target": "com.amazonaws.wellarchitected#ValidationException" } ], "traits": { "smithy.api#documentation": "

List review templates.

", "smithy.api#http": { "method": "GET", "uri": "/reviewTemplates", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults" }, "smithy.api#tags": [ "WA" ] } }, "com.amazonaws.wellarchitected#ListReviewTemplatesInput": { "type": "structure", "members": { "NextToken": { "target": "com.amazonaws.wellarchitected#NextToken", "traits": { "smithy.api#httpQuery": "NextToken" } }, "MaxResults": { "target": "com.amazonaws.wellarchitected#MaxResults", "traits": { "smithy.api#httpQuery": "MaxResults", "smithy.api#range": { "min": 1, "max": 50 } } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.wellarchitected#ListReviewTemplatesOutput": { "type": "structure", "members": { "ReviewTemplates": { "target": "com.amazonaws.wellarchitected#ReviewTemplates", "traits": { "smithy.api#documentation": "

List of review templates.

" } }, "NextToken": { "target": "com.amazonaws.wellarchitected#NextToken" } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.wellarchitected#ListShareInvitations": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#ListShareInvitationsInput" }, "output": { "target": "com.amazonaws.wellarchitected#ListShareInvitationsOutput" }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" }, { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, { "target": "com.amazonaws.wellarchitected#ValidationException" } ], "traits": { "smithy.api#documentation": "

List the share invitations.

WorkloadNamePrefix, LensNamePrefix, ProfileNamePrefix, and TemplateNamePrefix are mutually exclusive. Use the parameter that matches your ShareResourceType.

", "smithy.api#http": { "method": "GET", "uri": "/shareInvitations", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults" }, "smithy.api#tags": [ "WA" ] } }, "com.amazonaws.wellarchitected#ListShareInvitationsInput": { "type": "structure", "members": { "WorkloadNamePrefix": { "target": "com.amazonaws.wellarchitected#WorkloadNamePrefix", "traits": { "smithy.api#httpQuery": "WorkloadNamePrefix" } }, "LensNamePrefix": { "target": "com.amazonaws.wellarchitected#LensNamePrefix", "traits": { "smithy.api#documentation": "

An optional string added to the beginning of each lens name returned in the results.

", "smithy.api#httpQuery": "LensNamePrefix" } }, "ShareResourceType": { "target": "com.amazonaws.wellarchitected#ShareResourceType", "traits": { "smithy.api#documentation": "

The type of share invitations to be returned.

", "smithy.api#httpQuery": "ShareResourceType" } }, "NextToken": { "target": "com.amazonaws.wellarchitected#NextToken", "traits": { "smithy.api#httpQuery": "NextToken" } }, "MaxResults": { "target": "com.amazonaws.wellarchitected#MaxResults", "traits": { "smithy.api#documentation": "

The maximum number of results to return for this request.

", "smithy.api#httpQuery": "MaxResults", "smithy.api#range": { "min": 1, "max": 50 } } }, "ProfileNamePrefix": { "target": "com.amazonaws.wellarchitected#ProfileNamePrefix", "traits": { "smithy.api#documentation": "

An optional string added to the beginning of each profile name returned in the results.

", "smithy.api#httpQuery": "ProfileNamePrefix" } }, "TemplateNamePrefix": { "target": "com.amazonaws.wellarchitected#TemplateNamePrefix", "traits": { "smithy.api#documentation": "

An optional string added to the beginning of each review template name returned in the results.

", "smithy.api#httpQuery": "TemplateNamePrefix" } } }, "traits": { "smithy.api#documentation": "

Input for List Share Invitations

", "smithy.api#input": {} } }, "com.amazonaws.wellarchitected#ListShareInvitationsOutput": { "type": "structure", "members": { "ShareInvitationSummaries": { "target": "com.amazonaws.wellarchitected#ShareInvitationSummaries", "traits": { "smithy.api#documentation": "

List of share invitation summaries in a workload.

" } }, "NextToken": { "target": "com.amazonaws.wellarchitected#NextToken" } }, "traits": { "smithy.api#documentation": "

Input for List Share Invitations

", "smithy.api#output": {} } }, "com.amazonaws.wellarchitected#ListTagsForResource": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#ListTagsForResourceInput" }, "output": { "target": "com.amazonaws.wellarchitected#ListTagsForResourceOutput" }, "errors": [ { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "

List the tags for a resource.

The WorkloadArn parameter can be a workload ARN, a custom lens ARN, a profile ARN, or review template ARN.

", "smithy.api#http": { "method": "GET", "uri": "/tags/{WorkloadArn}", "code": 200 }, "smithy.api#tags": [ "WA" ] } }, "com.amazonaws.wellarchitected#ListTagsForResourceInput": { "type": "structure", "members": { "WorkloadArn": { "target": "com.amazonaws.wellarchitected#WorkloadArn", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.wellarchitected#ListTagsForResourceOutput": { "type": "structure", "members": { "Tags": { "target": "com.amazonaws.wellarchitected#TagMap", "traits": { "smithy.api#documentation": "

The tags for the resource.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.wellarchitected#ListTemplateShares": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#ListTemplateSharesInput" }, "output": { "target": "com.amazonaws.wellarchitected#ListTemplateSharesOutput" }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" }, { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, { "target": "com.amazonaws.wellarchitected#ValidationException" } ], "traits": { "smithy.api#documentation": "

List review template shares.

", "smithy.api#http": { "method": "GET", "uri": "/templates/shares/{TemplateArn}", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults" }, "smithy.api#tags": [ "WA" ] } }, "com.amazonaws.wellarchitected#ListTemplateSharesInput": { "type": "structure", "members": { "TemplateArn": { "target": "com.amazonaws.wellarchitected#TemplateArn", "traits": { "smithy.api#documentation": "

The review template ARN.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "SharedWithPrefix": { "target": "com.amazonaws.wellarchitected#SharedWithPrefix", "traits": { "smithy.api#documentation": "

The Amazon Web Services account ID, organization ID, or organizational unit (OU) ID with which the profile is shared.

", "smithy.api#httpQuery": "SharedWithPrefix" } }, "NextToken": { "target": "com.amazonaws.wellarchitected#NextToken", "traits": { "smithy.api#httpQuery": "NextToken" } }, "MaxResults": { "target": "com.amazonaws.wellarchitected#MaxResults", "traits": { "smithy.api#documentation": "

The maximum number of results to return for this request.

", "smithy.api#httpQuery": "MaxResults", "smithy.api#range": { "min": 1, "max": 50 } } }, "Status": { "target": "com.amazonaws.wellarchitected#ShareStatus", "traits": { "smithy.api#httpQuery": "Status" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.wellarchitected#ListTemplateSharesOutput": { "type": "structure", "members": { "TemplateArn": { "target": "com.amazonaws.wellarchitected#TemplateArn", "traits": { "smithy.api#documentation": "

The review template ARN.

" } }, "TemplateShareSummaries": { "target": "com.amazonaws.wellarchitected#TemplateShareSummaries", "traits": { "smithy.api#documentation": "

A review template share summary return object.

" } }, "NextToken": { "target": "com.amazonaws.wellarchitected#NextToken" } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.wellarchitected#ListWorkloadShares": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#ListWorkloadSharesInput" }, "output": { "target": "com.amazonaws.wellarchitected#ListWorkloadSharesOutput" }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" }, { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, { "target": "com.amazonaws.wellarchitected#ValidationException" } ], "traits": { "smithy.api#documentation": "

List the workload shares associated with the workload.

", "smithy.api#http": { "method": "GET", "uri": "/workloads/{WorkloadId}/shares", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults" }, "smithy.api#tags": [ "WA" ] } }, "com.amazonaws.wellarchitected#ListWorkloadSharesInput": { "type": "structure", "members": { "WorkloadId": { "target": "com.amazonaws.wellarchitected#WorkloadId", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "SharedWithPrefix": { "target": "com.amazonaws.wellarchitected#SharedWithPrefix", "traits": { "smithy.api#documentation": "

The Amazon Web Services account ID, organization ID, or organizational unit (OU) ID with which the workload is shared.

", "smithy.api#httpQuery": "SharedWithPrefix" } }, "NextToken": { "target": "com.amazonaws.wellarchitected#NextToken", "traits": { "smithy.api#httpQuery": "NextToken" } }, "MaxResults": { "target": "com.amazonaws.wellarchitected#MaxResults", "traits": { "smithy.api#documentation": "

The maximum number of results to return for this request.

", "smithy.api#httpQuery": "MaxResults", "smithy.api#range": { "min": 1, "max": 50 } } }, "Status": { "target": "com.amazonaws.wellarchitected#ShareStatus", "traits": { "smithy.api#httpQuery": "Status" } } }, "traits": { "smithy.api#documentation": "

Input for List Workload Share

", "smithy.api#input": {} } }, "com.amazonaws.wellarchitected#ListWorkloadSharesOutput": { "type": "structure", "members": { "WorkloadId": { "target": "com.amazonaws.wellarchitected#WorkloadId" }, "WorkloadShareSummaries": { "target": "com.amazonaws.wellarchitected#WorkloadShareSummaries" }, "NextToken": { "target": "com.amazonaws.wellarchitected#NextToken" } }, "traits": { "smithy.api#documentation": "

Input for List Workload Share

", "smithy.api#output": {} } }, "com.amazonaws.wellarchitected#ListWorkloads": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#ListWorkloadsInput" }, "output": { "target": "com.amazonaws.wellarchitected#ListWorkloadsOutput" }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" }, { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, { "target": "com.amazonaws.wellarchitected#ValidationException" } ], "traits": { "smithy.api#documentation": "

Paginated list of workloads.

", "smithy.api#http": { "method": "POST", "uri": "/workloadsSummaries", "code": 200 }, "smithy.api#paginated": { "inputToken": "NextToken", "outputToken": "NextToken", "pageSize": "MaxResults" }, "smithy.api#tags": [ "WA" ] } }, "com.amazonaws.wellarchitected#ListWorkloadsInput": { "type": "structure", "members": { "WorkloadNamePrefix": { "target": "com.amazonaws.wellarchitected#WorkloadNamePrefix" }, "NextToken": { "target": "com.amazonaws.wellarchitected#NextToken" }, "MaxResults": { "target": "com.amazonaws.wellarchitected#MaxResults", "traits": { "smithy.api#documentation": "

The maximum number of results to return for this request.

", "smithy.api#range": { "min": 1, "max": 50 } } } }, "traits": { "smithy.api#documentation": "

Input to list all workloads.

", "smithy.api#input": {} } }, "com.amazonaws.wellarchitected#ListWorkloadsOutput": { "type": "structure", "members": { "WorkloadSummaries": { "target": "com.amazonaws.wellarchitected#WorkloadSummaries" }, "NextToken": { "target": "com.amazonaws.wellarchitected#NextToken" } }, "traits": { "smithy.api#documentation": "

Output of a list workloads call.

", "smithy.api#output": {} } }, "com.amazonaws.wellarchitected#MaxResults": { "type": "integer", "traits": { "smithy.api#documentation": "

The maximum number of results to return for this request.

" } }, "com.amazonaws.wellarchitected#MaxSelectedProfileChoices": { "type": "integer", "traits": { "smithy.api#range": { "min": 0 } } }, "com.amazonaws.wellarchitected#MetricType": { "type": "enum", "members": { "WORKLOAD": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "WORKLOAD" } } } }, "com.amazonaws.wellarchitected#Milestone": { "type": "structure", "members": { "MilestoneNumber": { "target": "com.amazonaws.wellarchitected#MilestoneNumber" }, "MilestoneName": { "target": "com.amazonaws.wellarchitected#MilestoneName" }, "RecordedAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The date and time when the milestone was recorded.

" } }, "Workload": { "target": "com.amazonaws.wellarchitected#Workload" } }, "traits": { "smithy.api#documentation": "

A milestone return object.

" } }, "com.amazonaws.wellarchitected#MilestoneName": { "type": "string", "traits": { "smithy.api#documentation": "

The name of the milestone in a workload.

Milestone names must be unique within a workload.

", "smithy.api#length": { "min": 3, "max": 100 } } }, "com.amazonaws.wellarchitected#MilestoneNumber": { "type": "integer", "traits": { "smithy.api#documentation": "

The milestone number.

A workload can have a maximum of 100 milestones.

", "smithy.api#range": { "min": 1, "max": 100 } } }, "com.amazonaws.wellarchitected#MilestoneSummaries": { "type": "list", "member": { "target": "com.amazonaws.wellarchitected#MilestoneSummary" }, "traits": { "smithy.api#documentation": "

A list of milestone summaries.

" } }, "com.amazonaws.wellarchitected#MilestoneSummary": { "type": "structure", "members": { "MilestoneNumber": { "target": "com.amazonaws.wellarchitected#MilestoneNumber" }, "MilestoneName": { "target": "com.amazonaws.wellarchitected#MilestoneName" }, "RecordedAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The date and time when the milestone was recorded.

" } }, "WorkloadSummary": { "target": "com.amazonaws.wellarchitected#WorkloadSummary" } }, "traits": { "smithy.api#documentation": "

A milestone summary return object.

" } }, "com.amazonaws.wellarchitected#MinSelectedProfileChoices": { "type": "integer", "traits": { "smithy.api#range": { "min": 0 } } }, "com.amazonaws.wellarchitected#NextToken": { "type": "string", "traits": { "smithy.api#documentation": "

The token to use to retrieve the next set of results.

", "smithy.api#pattern": "^[A-Za-z0-9+\\/=_-]+$" } }, "com.amazonaws.wellarchitected#Notes": { "type": "string", "traits": { "smithy.api#documentation": "

The notes associated with the workload.

For a review template, these are the notes that will be associated with the workload when the template is applied.

", "smithy.api#length": { "max": 2084 } } }, "com.amazonaws.wellarchitected#NotificationSummaries": { "type": "list", "member": { "target": "com.amazonaws.wellarchitected#NotificationSummary" } }, "com.amazonaws.wellarchitected#NotificationSummary": { "type": "structure", "members": { "Type": { "target": "com.amazonaws.wellarchitected#NotificationType", "traits": { "smithy.api#documentation": "

The type of notification.

" } }, "LensUpgradeSummary": { "target": "com.amazonaws.wellarchitected#LensUpgradeSummary", "traits": { "smithy.api#documentation": "

Summary of lens upgrade.

" } } }, "traits": { "smithy.api#documentation": "

A notification summary return object.

" } }, "com.amazonaws.wellarchitected#NotificationType": { "type": "enum", "members": { "LENS_VERSION_UPGRADED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "LENS_VERSION_UPGRADED" } }, "LENS_VERSION_DEPRECATED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "LENS_VERSION_DEPRECATED" } } } }, "com.amazonaws.wellarchitected#OrganizationSharingStatus": { "type": "enum", "members": { "ENABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ENABLED" } }, "DISABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DISABLED" } } } }, "com.amazonaws.wellarchitected#OrganizationalAccountEntry": { "type": "structure", "members": { "accountId": { "target": "com.amazonaws.wellarchitected#AccountId", "traits": { "smithy.api#documentation": "

The Amazon Web Services account ID to include in the monitoring boundary.

", "smithy.api#required": {} } }, "regions": { "target": "com.amazonaws.wellarchitected#Regions", "traits": { "smithy.api#documentation": "

The list of regions to monitor for this account.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

An individual account entry in the organizational monitoring boundary, with its associated regions.

" } }, "com.amazonaws.wellarchitected#OrganizationalAccountEntryList": { "type": "list", "member": { "target": "com.amazonaws.wellarchitected#OrganizationalAccountEntry" }, "traits": { "smithy.api#length": { "min": 0, "max": 2500 }, "smithy.api#uniqueItems": {} } }, "com.amazonaws.wellarchitected#OrganizationalAggregationConfiguration": { "type": "structure", "members": { "organizationalUnits": { "target": "com.amazonaws.wellarchitected#OrganizationalUnitEntryList", "traits": { "smithy.api#documentation": "

A list of organizational unit or root entries that define the organizational scope. Each entry specifies an OU or root ID and the regions to monitor within it.

" } }, "accounts": { "target": "com.amazonaws.wellarchitected#OrganizationalAccountEntryList", "traits": { "smithy.api#documentation": "

A list of individual account entries that define additional accounts to include. Each entry specifies an account ID and the regions to monitor within it.

" } } }, "traits": { "smithy.api#documentation": "

The organizational monitoring boundary configuration. Contains organizational unit entries and individual account entries, each with their own region selections, that define the scope for organizational profile analysis.

" } }, "com.amazonaws.wellarchitected#OrganizationalNodeId": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 68 }, "smithy.api#pattern": "^(r-[a-z0-9]{4,32}|ou-[a-z0-9]{4,32}-[a-z0-9]{8,32})$" } }, "com.amazonaws.wellarchitected#OrganizationalReportAccountIdList": { "type": "list", "member": { "target": "com.amazonaws.wellarchitected#AccountId" }, "traits": { "smithy.api#length": { "max": 10000 }, "smithy.api#uniqueItems": {} } }, "com.amazonaws.wellarchitected#OrganizationalReportFilters": { "type": "structure", "members": { "accountIds": { "target": "com.amazonaws.wellarchitected#OrganizationalReportAccountIdList", "traits": { "smithy.api#documentation": "

AWS account IDs to include in the report. Absent or empty means all accounts in the organization are in scope. Each supplied account is validated against AWS Organizations membership. Accounts that do not belong to the caller's organization are excluded and recorded on the report's coverage summary.

" } }, "organizationalUnitIds": { "target": "com.amazonaws.wellarchitected#OrganizationalUnitIdList", "traits": { "smithy.api#documentation": "

AWS Organizational Unit IDs whose member accounts are included in the report. Absent or empty means no OU-based scoping is applied. Account and OU filters combine as a union.

" } }, "pillars": { "target": "com.amazonaws.wellarchitected#PillarList", "traits": { "smithy.api#documentation": "

Well-Architected pillars to include. Absent or empty means all pillars.

" } }, "recommendationTypes": { "target": "com.amazonaws.wellarchitected#RecommendationTypeList", "traits": { "smithy.api#documentation": "

Recommendation types (RESOURCE, ARCHITECTURE, APPLICATION) to include. Absent or empty means all types.

" } }, "statuses": { "target": "com.amazonaws.wellarchitected#RecommendationStatusList", "traits": { "smithy.api#documentation": "

Recommendation statuses (ACTIVE, SUPPRESSED, COMPLETED) to include. Absent or empty means all statuses.

" } }, "priorities": { "target": "com.amazonaws.wellarchitected#PriorityList", "traits": { "smithy.api#documentation": "

Recommendation priorities (HIGH, MEDIUM, LOW) to include. Absent or empty means all priorities.

" } }, "createdAtRange": { "target": "com.amazonaws.wellarchitected#TimeWindow", "traits": { "smithy.api#documentation": "

Inclusive window on recommendation creation time. Absent means no lower or upper bound on createdAt.

" } }, "updatedAtRange": { "target": "com.amazonaws.wellarchitected#TimeWindow", "traits": { "smithy.api#documentation": "

Inclusive window on recommendation last-updated time. Absent means no lower or upper bound on updatedAt.

" } } }, "traits": { "smithy.api#documentation": "

Filters narrowing the scope of an Organizational Report. Every member is optional. An absent or empty member places no constraint on that dimension. When the entire structure is absent, the report covers every account and every recommendation in the organization.

" } }, "com.amazonaws.wellarchitected#OrganizationalReportFormat": { "type": "enum", "members": { "CSV": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CSV" } }, "JSON": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "JSON" } }, "PARQUET": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PARQUET" } } }, "traits": { "smithy.api#documentation": "

The output format for an Organizational Report artifact retrieved through GetAgentOrganizationalReportData or delivered through SendAgentOrganizationalReportDataToS3.

" } }, "com.amazonaws.wellarchitected#OrganizationalReportState": { "type": "enum", "members": { "DISCOVERING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DISCOVERING" } }, "SNAPSHOTTING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SNAPSHOTTING" } }, "AGGREGATING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AGGREGATING" } }, "COMPRESSING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "COMPRESSING" } }, "COMPLETED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "COMPLETED" } }, "FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAILED" } }, "DELETING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DELETING" } } }, "traits": { "smithy.api#documentation": "

The lifecycle state of an Organizational Report. The state advances through the asynchronous pipeline: DISCOVERING (expanding the caller-supplied scope into the full list of in-scope accounts and profiles), SNAPSHOTTING (materializing per-account profile and recommendation snapshots), AGGREGATING (merging snapshots into the final artifact), COMPRESSING (writing the final CSV, JSON, or Parquet artifacts to Amazon S3), COMPLETED (the report is ready to download), FAILED (terminal failure), and DELETING (the report is being removed).

" } }, "com.amazonaws.wellarchitected#OrganizationalReportSummary": { "type": "structure", "members": { "reportId": { "target": "com.amazonaws.wellarchitected#UUID", "traits": { "smithy.api#documentation": "

Unique identifier of the Organizational Report assigned by the service at creation time.

", "smithy.api#required": {} } }, "ownerAccountId": { "target": "com.amazonaws.wellarchitected#AccountId", "traits": { "smithy.api#documentation": "

AWS account ID of the caller that created the report. Only this account or a delegated administrator of the same organization may retrieve or delete the report.

", "smithy.api#required": {} } }, "organizationId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

Identifier of the AWS Organization the report belongs to. Derived from the caller's authorization context at creation time and not accepted as a client-supplied input.

", "smithy.api#required": {} } }, "label": { "target": "com.amazonaws.wellarchitected#ReportLabel", "traits": { "smithy.api#documentation": "

Optional human-readable label supplied by the caller at creation time.

" } }, "state": { "target": "com.amazonaws.wellarchitected#OrganizationalReportState", "traits": { "smithy.api#documentation": "

Current lifecycle state of the report.

", "smithy.api#required": {} } }, "createdAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

Timestamp at which the report was created.

", "smithy.api#required": {}, "smithy.api#timestampFormat": "date-time" } } }, "traits": { "smithy.api#documentation": "

Summary of an Organizational Report returned in a list response. Includes the core fields of the full report and the optional label, but omits the filters and coverage summary. The filters and coverage summary are available through GetAgentOrganizationalReport. The coverage summary is populated once the report reaches COMPLETED.

" } }, "com.amazonaws.wellarchitected#OrganizationalReportSummaryList": { "type": "list", "member": { "target": "com.amazonaws.wellarchitected#OrganizationalReportSummary" } }, "com.amazonaws.wellarchitected#OrganizationalUnitEntry": { "type": "structure", "members": { "organizationalUnitId": { "target": "com.amazonaws.wellarchitected#OrganizationalNodeId", "traits": { "smithy.api#documentation": "

The AWS Organizations organizational unit ID or root ID. Must match the pattern r-[a-z0-9]{4,32} for roots or ou-[a-z0-9]{4,32}-[a-z0-9]{8,32} for OUs.

", "smithy.api#required": {} } }, "regions": { "target": "com.amazonaws.wellarchitected#Regions", "traits": { "smithy.api#documentation": "

The list of regions to monitor for this organizational unit or root.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

An organizational unit or root entry in the organizational monitoring boundary, with its associated regions.

" } }, "com.amazonaws.wellarchitected#OrganizationalUnitEntryList": { "type": "list", "member": { "target": "com.amazonaws.wellarchitected#OrganizationalUnitEntry" }, "traits": { "smithy.api#length": { "min": 0, "max": 2500 }, "smithy.api#uniqueItems": {} } }, "com.amazonaws.wellarchitected#OrganizationalUnitId": { "type": "string", "traits": { "smithy.api#pattern": "^ou-[0-9a-z]{4,32}-[a-z0-9]{8,32}$" } }, "com.amazonaws.wellarchitected#OrganizationalUnitIdList": { "type": "list", "member": { "target": "com.amazonaws.wellarchitected#OrganizationalUnitId" }, "traits": { "smithy.api#length": { "max": 10000 }, "smithy.api#uniqueItems": {} } }, "com.amazonaws.wellarchitected#PermissionType": { "type": "enum", "members": { "READONLY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "READONLY" } }, "CONTRIBUTOR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CONTRIBUTOR" } } }, "traits": { "smithy.api#documentation": "

Permission granted on a share request.

" } }, "com.amazonaws.wellarchitected#Pillar": { "type": "enum", "members": { "COST_OPTIMIZATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "COST_OPTIMIZATION" } }, "SECURITY": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SECURITY" } }, "RESILIENCE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RESILIENCE" } }, "PERFORMANCE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PERFORMANCE" } }, "OPERATIONAL_EXCELLENCE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "OPERATIONAL_EXCELLENCE" } } }, "traits": { "smithy.api#documentation": "

OPERATIONAL_EXCELLENCE can appear in recommendation results but cannot be specified as a request parameter. The requestable values are COST_OPTIMIZATION, SECURITY, RESILIENCE, and PERFORMANCE.

A pillar of the Amazon Web Services Well-Architected Framework, used to scope recommendation generation.

" } }, "com.amazonaws.wellarchitected#PillarCount": { "type": "structure", "members": { "pillar": { "target": "com.amazonaws.wellarchitected#Pillar", "traits": { "smithy.api#documentation": "

Well-Architected pillar this count is attributed to.

", "smithy.api#required": {} } }, "count": { "target": "smithy.api#Long", "traits": { "smithy.api#documentation": "

Non-negative count of recommendations in the report that are attributed to this pillar.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Pair of a Well-Architected pillar and the number of recommendations attributed to it in a CoverageSummary.

" } }, "com.amazonaws.wellarchitected#PillarCountList": { "type": "list", "member": { "target": "com.amazonaws.wellarchitected#PillarCount" }, "traits": { "smithy.api#length": { "max": 10 }, "smithy.api#uniqueItems": {} } }, "com.amazonaws.wellarchitected#PillarDifference": { "type": "structure", "members": { "PillarId": { "target": "com.amazonaws.wellarchitected#PillarId" }, "PillarName": { "target": "com.amazonaws.wellarchitected#PillarName" }, "DifferenceStatus": { "target": "com.amazonaws.wellarchitected#DifferenceStatus", "traits": { "smithy.api#documentation": "

Indicates the type of change to the pillar.

" } }, "QuestionDifferences": { "target": "com.amazonaws.wellarchitected#QuestionDifferences", "traits": { "smithy.api#documentation": "

List of question differences.

" } } }, "traits": { "smithy.api#documentation": "

A pillar difference return object.

" } }, "com.amazonaws.wellarchitected#PillarDifferences": { "type": "list", "member": { "target": "com.amazonaws.wellarchitected#PillarDifference" } }, "com.amazonaws.wellarchitected#PillarId": { "type": "string", "traits": { "smithy.api#documentation": "

The ID used to identify a pillar, for example, security.

A pillar is identified by its PillarReviewSummary$PillarId.

", "smithy.api#length": { "min": 1, "max": 64 } } }, "com.amazonaws.wellarchitected#PillarItem": { "type": "structure", "members": { "pillar": { "target": "com.amazonaws.wellarchitected#Pillar", "traits": { "smithy.api#documentation": "

The pillar this item configuration applies to.

", "smithy.api#required": {} } }, "ids": { "target": "com.amazonaws.wellarchitected#ItemIds", "traits": { "smithy.api#documentation": "

A list of item IDs to process for this pillar, such as best practice IDs, Amazon Web Services service names, or resource ARNs.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Item configuration for a specific Amazon Web Services Well-Architected Framework pillar.

" } }, "com.amazonaws.wellarchitected#PillarItems": { "type": "list", "member": { "target": "com.amazonaws.wellarchitected#PillarItem" } }, "com.amazonaws.wellarchitected#PillarList": { "type": "list", "member": { "target": "com.amazonaws.wellarchitected#Pillar" }, "traits": { "smithy.api#length": { "max": 10 }, "smithy.api#uniqueItems": {} } }, "com.amazonaws.wellarchitected#PillarMetric": { "type": "structure", "members": { "PillarId": { "target": "com.amazonaws.wellarchitected#PillarId" }, "RiskCounts": { "target": "com.amazonaws.wellarchitected#RiskCounts" }, "Questions": { "target": "com.amazonaws.wellarchitected#QuestionMetrics", "traits": { "smithy.api#documentation": "

The questions that have been identified as risks in the pillar.

" } } }, "traits": { "smithy.api#documentation": "

A metric for a particular pillar in a lens.

" } }, "com.amazonaws.wellarchitected#PillarMetrics": { "type": "list", "member": { "target": "com.amazonaws.wellarchitected#PillarMetric" } }, "com.amazonaws.wellarchitected#PillarName": { "type": "string", "traits": { "smithy.api#documentation": "

The name of the pillar.

", "smithy.api#length": { "min": 1, "max": 128 } } }, "com.amazonaws.wellarchitected#PillarNotes": { "type": "map", "key": { "target": "com.amazonaws.wellarchitected#PillarId" }, "value": { "target": "com.amazonaws.wellarchitected#Notes" }, "traits": { "smithy.api#documentation": "

List of pillar notes of a lens review in a workload.

For a review template, these are the notes that will be associated with the workload when the template is applied.

" } }, "com.amazonaws.wellarchitected#PillarReviewSummaries": { "type": "list", "member": { "target": "com.amazonaws.wellarchitected#PillarReviewSummary" }, "traits": { "smithy.api#documentation": "

List of pillar review summaries of lens review in a workload.

" } }, "com.amazonaws.wellarchitected#PillarReviewSummary": { "type": "structure", "members": { "PillarId": { "target": "com.amazonaws.wellarchitected#PillarId" }, "PillarName": { "target": "com.amazonaws.wellarchitected#PillarName" }, "Notes": { "target": "com.amazonaws.wellarchitected#Notes" }, "RiskCounts": { "target": "com.amazonaws.wellarchitected#RiskCounts" }, "PrioritizedRiskCounts": { "target": "com.amazonaws.wellarchitected#RiskCounts" } }, "traits": { "smithy.api#documentation": "

A pillar review summary of a lens review.

" } }, "com.amazonaws.wellarchitected#Pillars": { "type": "list", "member": { "target": "com.amazonaws.wellarchitected#Pillar" }, "traits": { "smithy.api#length": { "min": 1, "max": 5 }, "smithy.api#uniqueItems": {} } }, "com.amazonaws.wellarchitected#PreferenceEntries": { "type": "list", "member": { "target": "com.amazonaws.wellarchitected#PreferenceEntry" } }, "com.amazonaws.wellarchitected#PreferenceEntry": { "type": "structure", "members": { "key": { "target": "com.amazonaws.wellarchitected#PreferenceKey", "traits": { "smithy.api#documentation": "

Which preference this entry describes.

", "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.wellarchitected#PreferenceStatus", "traits": { "smithy.api#documentation": "

Current state of the preference. ENABLED and DISABLED reflect the result of the most recent successful change. FAILED reflects a stored failure surfaced on a read and is accompanied by a detail message.

", "smithy.api#required": {} } }, "detail": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

A human-readable explanation present only when status is FAILED, describing what went wrong and how to recover.

", "smithy.api#length": { "min": 1, "max": 1024 } } } }, "traits": { "smithy.api#documentation": "

A single Well-Architected Agent preference and its current state.

" } }, "com.amazonaws.wellarchitected#PreferenceKey": { "type": "enum", "members": { "ORG_INTEGRATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ORG_INTEGRATION" } } }, "traits": { "smithy.api#documentation": "

Identifies one of the caller's Well-Architected Agent preferences. A new preference is introduced as a new enum value, which is a backward-compatible change. Existing values are never removed or renamed.

" } }, "com.amazonaws.wellarchitected#PreferenceState": { "type": "enum", "members": { "ENABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ENABLED" } }, "DISABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DISABLED" } } }, "traits": { "smithy.api#documentation": "

This is the writable subset of PreferenceStatus: you can set a preference to ENABLED or DISABLED, but you cannot set FAILED, which is an observed state only.

The settable state of a preference, supplied to PutAgentPreferences.

" } }, "com.amazonaws.wellarchitected#PreferenceStatus": { "type": "enum", "members": { "ENABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ENABLED" } }, "DISABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DISABLED" } }, "FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAILED" } } }, "traits": { "smithy.api#documentation": "

The observed state of a preference. Because enabling and disabling are performed synchronously by PutAgentPreferences, this value is both what the caller requested and what the system achieved. FAILED is never an accepted input; it reflects a stored failure (for example, an onboarding-time auto-creation that failed) surfaced on a read, and is accompanied by a statusMessage.

" } }, "com.amazonaws.wellarchitected#PreferenceUpdate": { "type": "structure", "members": { "key": { "target": "com.amazonaws.wellarchitected#PreferenceKey", "traits": { "smithy.api#documentation": "

Which preference to update.

", "smithy.api#required": {} } }, "state": { "target": "com.amazonaws.wellarchitected#PreferenceState", "traits": { "smithy.api#documentation": "

State to set the preference to. FAILED is an observed state only and cannot be requested.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

A caller's requested change to one preference, supplied to PutAgentPreferences.

" } }, "com.amazonaws.wellarchitected#PreferenceUpdates": { "type": "list", "member": { "target": "com.amazonaws.wellarchitected#PreferenceUpdate" }, "traits": { "smithy.api#length": { "min": 1, "max": 50 } } }, "com.amazonaws.wellarchitected#Priority": { "type": "enum", "members": { "HIGH": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "HIGH" } }, "MEDIUM": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MEDIUM" } }, "LOW": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "LOW" } } }, "traits": { "smithy.api#documentation": "

The priority of a recommendation.

" } }, "com.amazonaws.wellarchitected#PriorityCount": { "type": "structure", "members": { "priority": { "target": "com.amazonaws.wellarchitected#Priority", "traits": { "smithy.api#documentation": "

Priority this count is attributed to.

", "smithy.api#required": {} } }, "count": { "target": "smithy.api#Long", "traits": { "smithy.api#documentation": "

Non-negative count of recommendations in the report that are attributed to this priority.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Pair of a recommendation Priority and the number of recommendations attributed to it in a CoverageSummary.

" } }, "com.amazonaws.wellarchitected#PriorityCountList": { "type": "list", "member": { "target": "com.amazonaws.wellarchitected#PriorityCount" }, "traits": { "smithy.api#length": { "max": 10 }, "smithy.api#uniqueItems": {} } }, "com.amazonaws.wellarchitected#PriorityList": { "type": "list", "member": { "target": "com.amazonaws.wellarchitected#Priority" }, "traits": { "smithy.api#length": { "max": 10 }, "smithy.api#uniqueItems": {} } }, "com.amazonaws.wellarchitected#Profile": { "type": "structure", "members": { "ProfileArn": { "target": "com.amazonaws.wellarchitected#ProfileArn", "traits": { "smithy.api#documentation": "

The profile ARN.

" } }, "ProfileVersion": { "target": "com.amazonaws.wellarchitected#ProfileVersion", "traits": { "smithy.api#documentation": "

The profile version.

" } }, "ProfileName": { "target": "com.amazonaws.wellarchitected#ProfileName", "traits": { "smithy.api#documentation": "

The profile name.

" } }, "ProfileDescription": { "target": "com.amazonaws.wellarchitected#ProfileDescription", "traits": { "smithy.api#documentation": "

The profile description.

" } }, "ProfileQuestions": { "target": "com.amazonaws.wellarchitected#ProfileQuestions", "traits": { "smithy.api#documentation": "

Profile questions.

" } }, "Owner": { "target": "com.amazonaws.wellarchitected#AwsAccountId" }, "CreatedAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The date and time when the profile was created.

" } }, "UpdatedAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The date and time when the profile was last updated.

" } }, "ShareInvitationId": { "target": "com.amazonaws.wellarchitected#ShareInvitationId", "traits": { "smithy.api#documentation": "

The ID assigned to the share invitation.

" } }, "Tags": { "target": "com.amazonaws.wellarchitected#TagMap", "traits": { "smithy.api#documentation": "

The tags assigned to the profile.

" } } }, "traits": { "smithy.api#documentation": "

A profile.

" } }, "com.amazonaws.wellarchitected#ProfileArn": { "type": "string", "traits": { "smithy.api#length": { "max": 2084 }, "smithy.api#pattern": "^arn:aws[-a-z]*:wellarchitected:[a-z]{2}(-gov)?-[a-z]+-\\d:\\d{12}:profile/[a-z0-9]+$" } }, "com.amazonaws.wellarchitected#ProfileArns": { "type": "list", "member": { "target": "com.amazonaws.wellarchitected#ProfileArn" }, "traits": { "smithy.api#length": { "min": 1 } } }, "com.amazonaws.wellarchitected#ProfileChoice": { "type": "structure", "members": { "ChoiceId": { "target": "com.amazonaws.wellarchitected#ChoiceId" }, "ChoiceTitle": { "target": "com.amazonaws.wellarchitected#ChoiceTitle" }, "ChoiceDescription": { "target": "com.amazonaws.wellarchitected#ChoiceDescription" } }, "traits": { "smithy.api#documentation": "

The profile choice.

" } }, "com.amazonaws.wellarchitected#ProfileDescription": { "type": "string", "traits": { "smithy.api#length": { "min": 3, "max": 100 } } }, "com.amazonaws.wellarchitected#ProfileName": { "type": "string", "traits": { "smithy.api#length": { "min": 3, "max": 100 } } }, "com.amazonaws.wellarchitected#ProfileNamePrefix": { "type": "string", "traits": { "smithy.api#length": { "max": 100 } } }, "com.amazonaws.wellarchitected#ProfileNotificationSummaries": { "type": "list", "member": { "target": "com.amazonaws.wellarchitected#ProfileNotificationSummary" } }, "com.amazonaws.wellarchitected#ProfileNotificationSummary": { "type": "structure", "members": { "CurrentProfileVersion": { "target": "com.amazonaws.wellarchitected#ProfileVersion", "traits": { "smithy.api#documentation": "

The current profile version.

" } }, "LatestProfileVersion": { "target": "com.amazonaws.wellarchitected#ProfileVersion", "traits": { "smithy.api#documentation": "

The latest profile version.

" } }, "Type": { "target": "com.amazonaws.wellarchitected#ProfileNotificationType", "traits": { "smithy.api#documentation": "

Type of notification.

" } }, "ProfileArn": { "target": "com.amazonaws.wellarchitected#ProfileArn", "traits": { "smithy.api#documentation": "

The profile ARN.

" } }, "ProfileName": { "target": "com.amazonaws.wellarchitected#ProfileName", "traits": { "smithy.api#documentation": "

The profile name.

" } }, "WorkloadId": { "target": "com.amazonaws.wellarchitected#WorkloadId" }, "WorkloadName": { "target": "com.amazonaws.wellarchitected#WorkloadName" } }, "traits": { "smithy.api#documentation": "

The profile notification summary.

" } }, "com.amazonaws.wellarchitected#ProfileNotificationType": { "type": "enum", "members": { "PROFILE_ANSWERS_UPDATED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PROFILE_ANSWERS_UPDATED" } }, "PROFILE_DELETED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PROFILE_DELETED" } } } }, "com.amazonaws.wellarchitected#ProfileOwnerType": { "type": "enum", "members": { "SELF": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SELF" } }, "SHARED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SHARED" } } } }, "com.amazonaws.wellarchitected#ProfileQuestion": { "type": "structure", "members": { "QuestionId": { "target": "com.amazonaws.wellarchitected#QuestionId" }, "QuestionTitle": { "target": "com.amazonaws.wellarchitected#QuestionTitle" }, "QuestionDescription": { "target": "com.amazonaws.wellarchitected#QuestionDescription" }, "QuestionChoices": { "target": "com.amazonaws.wellarchitected#ProfileQuestionChoices", "traits": { "smithy.api#documentation": "

The question choices.

" } }, "SelectedChoiceIds": { "target": "com.amazonaws.wellarchitected#SelectedChoiceIds", "traits": { "smithy.api#documentation": "

The selected choices.

" } }, "MinSelectedChoices": { "target": "com.amazonaws.wellarchitected#MinSelectedProfileChoices", "traits": { "smithy.api#documentation": "

The minimum number of selected choices.

" } }, "MaxSelectedChoices": { "target": "com.amazonaws.wellarchitected#MaxSelectedProfileChoices", "traits": { "smithy.api#documentation": "

The maximum number of selected choices.

" } } }, "traits": { "smithy.api#documentation": "

A profile question.

" } }, "com.amazonaws.wellarchitected#ProfileQuestionChoices": { "type": "list", "member": { "target": "com.amazonaws.wellarchitected#ProfileChoice" } }, "com.amazonaws.wellarchitected#ProfileQuestionUpdate": { "type": "structure", "members": { "QuestionId": { "target": "com.amazonaws.wellarchitected#QuestionId" }, "SelectedChoiceIds": { "target": "com.amazonaws.wellarchitected#SelectedProfileChoiceIds", "traits": { "smithy.api#documentation": "

The selected choices.

" } } }, "traits": { "smithy.api#documentation": "

An update to a profile question.

" } }, "com.amazonaws.wellarchitected#ProfileQuestionUpdates": { "type": "list", "member": { "target": "com.amazonaws.wellarchitected#ProfileQuestionUpdate" } }, "com.amazonaws.wellarchitected#ProfileQuestions": { "type": "list", "member": { "target": "com.amazonaws.wellarchitected#ProfileQuestion" } }, "com.amazonaws.wellarchitected#ProfileShareSummaries": { "type": "list", "member": { "target": "com.amazonaws.wellarchitected#ProfileShareSummary" } }, "com.amazonaws.wellarchitected#ProfileShareSummary": { "type": "structure", "members": { "ShareId": { "target": "com.amazonaws.wellarchitected#ShareId" }, "SharedWith": { "target": "com.amazonaws.wellarchitected#SharedWith" }, "Status": { "target": "com.amazonaws.wellarchitected#ShareStatus" }, "StatusMessage": { "target": "com.amazonaws.wellarchitected#StatusMessage", "traits": { "smithy.api#documentation": "

Profile share invitation status message.

" } } }, "traits": { "smithy.api#documentation": "

Summary of a profile share.

" } }, "com.amazonaws.wellarchitected#ProfileSummaries": { "type": "list", "member": { "target": "com.amazonaws.wellarchitected#ProfileSummary" } }, "com.amazonaws.wellarchitected#ProfileSummary": { "type": "structure", "members": { "ProfileArn": { "target": "com.amazonaws.wellarchitected#ProfileArn", "traits": { "smithy.api#documentation": "

The profile ARN.

" } }, "ProfileVersion": { "target": "com.amazonaws.wellarchitected#ProfileVersion", "traits": { "smithy.api#documentation": "

The profile version.

" } }, "ProfileName": { "target": "com.amazonaws.wellarchitected#ProfileName", "traits": { "smithy.api#documentation": "

The profile name.

" } }, "ProfileDescription": { "target": "com.amazonaws.wellarchitected#ProfileDescription", "traits": { "smithy.api#documentation": "

The profile description.

" } }, "Owner": { "target": "com.amazonaws.wellarchitected#AwsAccountId" }, "CreatedAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The date and time when the profile was created.

" } }, "UpdatedAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The date and time when the profile was last updated.

" } } }, "traits": { "smithy.api#documentation": "

Summary of a profile.

" } }, "com.amazonaws.wellarchitected#ProfileTemplate": { "type": "structure", "members": { "TemplateName": { "target": "com.amazonaws.wellarchitected#ProfileName", "traits": { "smithy.api#documentation": "

The name of the profile template.

" } }, "TemplateQuestions": { "target": "com.amazonaws.wellarchitected#TemplateQuestions", "traits": { "smithy.api#documentation": "

Profile template questions.

" } }, "CreatedAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The date and time when the profile template was created.

" } }, "UpdatedAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The date and time when the profile template was last updated.

" } } }, "traits": { "smithy.api#documentation": "

The profile template.

" } }, "com.amazonaws.wellarchitected#ProfileTemplateChoice": { "type": "structure", "members": { "ChoiceId": { "target": "com.amazonaws.wellarchitected#ChoiceId" }, "ChoiceTitle": { "target": "com.amazonaws.wellarchitected#ChoiceTitle" }, "ChoiceDescription": { "target": "com.amazonaws.wellarchitected#ChoiceDescription" } }, "traits": { "smithy.api#documentation": "

A profile template choice.

" } }, "com.amazonaws.wellarchitected#ProfileTemplateQuestion": { "type": "structure", "members": { "QuestionId": { "target": "com.amazonaws.wellarchitected#QuestionId" }, "QuestionTitle": { "target": "com.amazonaws.wellarchitected#QuestionTitle" }, "QuestionDescription": { "target": "com.amazonaws.wellarchitected#QuestionDescription" }, "QuestionChoices": { "target": "com.amazonaws.wellarchitected#ProfileTemplateQuestionChoices", "traits": { "smithy.api#documentation": "

The question choices.

" } }, "MinSelectedChoices": { "target": "com.amazonaws.wellarchitected#MinSelectedProfileChoices", "traits": { "smithy.api#documentation": "

The minimum number of choices selected.

" } }, "MaxSelectedChoices": { "target": "com.amazonaws.wellarchitected#MaxSelectedProfileChoices", "traits": { "smithy.api#documentation": "

The maximum number of choices selected.

" } } }, "traits": { "smithy.api#documentation": "

A profile template question.

" } }, "com.amazonaws.wellarchitected#ProfileTemplateQuestionChoices": { "type": "list", "member": { "target": "com.amazonaws.wellarchitected#ProfileTemplateChoice" } }, "com.amazonaws.wellarchitected#ProfileType": { "type": "enum", "members": { "STANDARD": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "

A standard profile that uses an execution role and aggregation configuration to analyze resources across one or more Amazon Web Services accounts.

", "smithy.api#enumValue": "STANDARD" } }, "BASIC": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "

A zero-configuration profile that generates recommendations without requiring an execution role or aggregation setup. Limited to one basic profile per Region.

", "smithy.api#enumValue": "BASIC" } }, "ORGANIZATIONAL": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "

A profile that uses Amazon Web Services Organizations to define its monitoring boundary, enabling analysis across large multi-account environments without per-account role configuration.

", "smithy.api#enumValue": "ORGANIZATIONAL" } } }, "traits": { "smithy.api#documentation": "

The type of a profile.

" } }, "com.amazonaws.wellarchitected#ProfileVersion": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 32 }, "smithy.api#pattern": "^[A-Za-z0-9-]+$" } }, "com.amazonaws.wellarchitected#Progress": { "type": "structure", "members": { "stepsCompleted": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "

The number of generation steps that have been completed.

", "smithy.api#required": {} } }, "totalSteps": { "target": "smithy.api#Integer", "traits": { "smithy.api#documentation": "

The total number of steps in the generation process.

", "smithy.api#required": {} } }, "completionPercentage": { "target": "smithy.api#Double", "traits": { "smithy.api#documentation": "

The completion percentage of the generation process (0-100).

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Progress information for a recommendation generation process.

" } }, "com.amazonaws.wellarchitected#PutAgentPreferences": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#PutAgentPreferencesRequest" }, "output": { "target": "com.amazonaws.wellarchitected#PutAgentPreferencesResponse" }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" }, { "target": "com.amazonaws.wellarchitected#ConflictException" }, { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, { "target": "com.amazonaws.wellarchitected#ValidationException" } ], "traits": { "smithy.api#documentation": "

Creates or replaces the caller's Well-Architected Agent preferences. Each supplied update sets the desired state of one preference. Preferences not named in the request are left unchanged. Enabling or disabling is performed synchronously, so a failure to reach the requested state is returned as a modeled exception rather than a FAILED status. On success the operation returns an empty response. Call GetAgentPreferences to read the resulting state. The account the preferences belong to is inferred from the caller's authorization context.

", "smithy.api#http": { "method": "PUT", "uri": "/api/v1/agent-preferences" }, "smithy.api#idempotent": {}, "smithy.api#tags": [ "AGENT" ], "smithy.rules#staticContextParams": { "SubServiceType": { "value": "AGENT" } }, "smithy.test#smokeTests": [ { "id": "PutAgentPreferences", "params": { "preferences": [ { "key": "ORG_INTEGRATION", "state": "DISABLED" } ] }, "expect": { "failure": {} }, "vendorParamsShape": "aws.test#AwsVendorParams", "vendorParams": { "region": "us-west-2" } } ] } }, "com.amazonaws.wellarchitected#PutAgentPreferencesRequest": { "type": "structure", "members": { "preferences": { "target": "com.amazonaws.wellarchitected#PreferenceUpdates", "traits": { "smithy.api#documentation": "

Preference updates to apply. A given preference key may appear at most once.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.wellarchitected#PutAgentPreferencesResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.wellarchitected#PutAgentProfilePolicy": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#PutAgentProfilePolicyRequest" }, "output": { "target": "com.amazonaws.wellarchitected#PutAgentProfilePolicyResponse" }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" }, { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, { "target": "com.amazonaws.wellarchitected#ValidationException" } ], "traits": { "smithy.api#documentation": "

Attaches or replaces a resource-based policy on an Agent Profile. The policy controls cross-account access to the profile and its child resources such as recommendations, goals, and contexts. Only the profile owner can call this operation. The policy must be valid IAM JSON with Allow-only statements and no negation condition operators.

", "smithy.api#http": { "method": "PUT", "uri": "/api/v1/agent-profiles/{profileArn}/policy" }, "smithy.api#idempotent": {}, "smithy.api#tags": [ "AGENT" ], "smithy.rules#staticContextParams": { "SubServiceType": { "value": "AGENT" } }, "smithy.test#smokeTests": [ { "id": "PutAgentProfilePolicy", "params": { "profileArn": "arn:aws:wellarchitected:us-west-2:123456789012:agent-profile/test-profile", "policy": "{}" }, "expect": { "failure": {} }, "vendorParamsShape": "aws.test#AwsVendorParams", "vendorParams": { "region": "us-west-2" } } ] } }, "com.amazonaws.wellarchitected#PutAgentProfilePolicyRequest": { "type": "structure", "members": { "profileArn": { "target": "com.amazonaws.wellarchitected#AgentProfileArn", "traits": { "smithy.api#documentation": "

The ARN of the Agent Profile to attach the policy to.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "policy": { "target": "com.amazonaws.wellarchitected#ResourcePolicy", "traits": { "smithy.api#documentation": "

The IAM resource-based policy document in JSON format. Maximum size 50KB.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.wellarchitected#PutAgentProfilePolicyResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.wellarchitected#PutAgentRecommendationFeedback": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#PutAgentRecommendationFeedbackRequest" }, "output": { "target": "com.amazonaws.wellarchitected#PutAgentRecommendationFeedbackResponse" }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" }, { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, { "target": "com.amazonaws.wellarchitected#ValidationException" } ], "traits": { "smithy.api#documentation": "

Submits user feedback on a recommendation to help improve future optimization suggestions and track implementation outcomes.

", "smithy.api#http": { "method": "PUT", "uri": "/api/v1/agent-recommendations/{recommendationArn}/feedback" }, "smithy.api#idempotent": {}, "smithy.api#tags": [ "AGENT" ], "smithy.rules#staticContextParams": { "SubServiceType": { "value": "AGENT" } } } }, "com.amazonaws.wellarchitected#PutAgentRecommendationFeedbackRequest": { "type": "structure", "members": { "recommendationArn": { "target": "com.amazonaws.wellarchitected#AgentRecommendationArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the recommendation to provide feedback for.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "type": { "target": "com.amazonaws.wellarchitected#RecommendationFeedbackType", "traits": { "smithy.api#documentation": "

The type of feedback being provided.

", "smithy.api#required": {} } }, "feedbackCategory": { "target": "com.amazonaws.wellarchitected#FeedbackCategory", "traits": { "smithy.api#documentation": "

Optional category classifying the nature of the feedback.

" } }, "comments": { "target": "com.amazonaws.wellarchitected#SensitiveString", "traits": { "smithy.api#documentation": "

Optional comments providing additional context about the feedback.

", "smithy.api#length": { "min": 1, "max": 4096 }, "smithy.api#pattern": "^(?:(?!\\$\\{[a-zA-Z]+:)[\\P{C}\\r\\n])+$" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.wellarchitected#PutAgentRecommendationFeedbackResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.wellarchitected#PutAgentRecommendationPolicy": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#PutAgentRecommendationPolicyRequest" }, "output": { "target": "com.amazonaws.wellarchitected#PutAgentRecommendationPolicyResponse" }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" }, { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, { "target": "com.amazonaws.wellarchitected#ValidationException" } ], "traits": { "smithy.api#documentation": "

Attaches or replaces a resource-based policy on an individual Agent Recommendation. The policy controls cross-account access to the recommendation and its child resources such as items and remediations. The recommendation owner or any principal with profile write access on the parent profile can call this operation. The policy must be valid IAM JSON with Allow-only statements and no negation condition operators.

", "smithy.api#http": { "method": "PUT", "uri": "/api/v1/agent-recommendations/{recommendationArn}/policy" }, "smithy.api#idempotent": {}, "smithy.api#tags": [ "AGENT" ], "smithy.rules#staticContextParams": { "SubServiceType": { "value": "AGENT" } }, "smithy.test#smokeTests": [ { "id": "PutAgentRecommendationPolicy", "params": { "recommendationArn": "arn:aws:wellarchitected:us-west-2:123456789012:agent-recommendation/f6b5df15-3409-483f-b796-45d0e590222c", "policy": "{}" }, "expect": { "failure": {} }, "vendorParamsShape": "aws.test#AwsVendorParams", "vendorParams": { "region": "us-west-2" } } ] } }, "com.amazonaws.wellarchitected#PutAgentRecommendationPolicyRequest": { "type": "structure", "members": { "recommendationArn": { "target": "com.amazonaws.wellarchitected#AgentRecommendationArn", "traits": { "smithy.api#documentation": "

The ARN of the Agent Recommendation to attach the policy to.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "policy": { "target": "com.amazonaws.wellarchitected#ResourcePolicy", "traits": { "smithy.api#documentation": "

The IAM resource-based policy document in JSON format. Maximum size 50KB.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.wellarchitected#PutAgentRecommendationPolicyResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.wellarchitected#Question": { "type": "enum", "members": { "UNANSWERED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UNANSWERED" } }, "ANSWERED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ANSWERED" } } } }, "com.amazonaws.wellarchitected#QuestionCounts": { "type": "map", "key": { "target": "com.amazonaws.wellarchitected#Question" }, "value": { "target": "com.amazonaws.wellarchitected#Count" } }, "com.amazonaws.wellarchitected#QuestionDescription": { "type": "string", "traits": { "smithy.api#documentation": "

The description of the question.

", "smithy.api#length": { "min": 1, "max": 1024 } } }, "com.amazonaws.wellarchitected#QuestionDifference": { "type": "structure", "members": { "QuestionId": { "target": "com.amazonaws.wellarchitected#QuestionId" }, "QuestionTitle": { "target": "com.amazonaws.wellarchitected#QuestionTitle" }, "DifferenceStatus": { "target": "com.amazonaws.wellarchitected#DifferenceStatus", "traits": { "smithy.api#documentation": "

Indicates the type of change to the question.

" } } }, "traits": { "smithy.api#documentation": "

A question difference return object.

" } }, "com.amazonaws.wellarchitected#QuestionDifferences": { "type": "list", "member": { "target": "com.amazonaws.wellarchitected#QuestionDifference" } }, "com.amazonaws.wellarchitected#QuestionId": { "type": "string", "traits": { "smithy.api#documentation": "

The ID of the question.

", "smithy.api#length": { "min": 1, "max": 128 } } }, "com.amazonaws.wellarchitected#QuestionMetric": { "type": "structure", "members": { "QuestionId": { "target": "com.amazonaws.wellarchitected#QuestionId" }, "Risk": { "target": "com.amazonaws.wellarchitected#Risk" }, "BestPractices": { "target": "com.amazonaws.wellarchitected#BestPractices", "traits": { "smithy.api#documentation": "

The best practices, or choices, that have been identified as contributing to risk in a question.

" } } }, "traits": { "smithy.api#documentation": "

A metric for a particular question in the pillar.

" } }, "com.amazonaws.wellarchitected#QuestionMetrics": { "type": "list", "member": { "target": "com.amazonaws.wellarchitected#QuestionMetric" } }, "com.amazonaws.wellarchitected#QuestionPriority": { "type": "enum", "members": { "PRIORITIZED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PRIORITIZED" } }, "NONE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NONE" } } } }, "com.amazonaws.wellarchitected#QuestionTitle": { "type": "string", "traits": { "smithy.api#documentation": "

The title of the question.

", "smithy.api#length": { "min": 1, "max": 512 } } }, "com.amazonaws.wellarchitected#QuestionType": { "type": "enum", "members": { "PRIORITIZED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PRIORITIZED" } }, "NON_PRIORITIZED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NON_PRIORITIZED" } } } }, "com.amazonaws.wellarchitected#QuotaCode": { "type": "string", "traits": { "smithy.api#documentation": "

Service Quotas requirement to identify originating quota.

" } }, "com.amazonaws.wellarchitected#RecommendationArn": { "type": "string", "traits": { "smithy.api#length": { "max": 2048 }, "smithy.api#pattern": "^arn:aws([a-z0-9-]+)?:wellarchitected:[a-z0-9-]{6,64}:\\d{12}:agent-recommendation/[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } }, "com.amazonaws.wellarchitected#RecommendationFeedbackType": { "type": "enum", "members": { "USEFUL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "USEFUL" } }, "NOT_USEFUL": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NOT_USEFUL" } } }, "traits": { "smithy.api#documentation": "

The type of feedback provided for a recommendation.

" } }, "com.amazonaws.wellarchitected#RecommendationGoal": { "type": "structure", "members": { "title": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The title of the goal associated with the recommendation.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Contains information about a goal associated with a recommendation.

" } }, "com.amazonaws.wellarchitected#RecommendationGoals": { "type": "list", "member": { "target": "com.amazonaws.wellarchitected#RecommendationGoal" } }, "com.amazonaws.wellarchitected#RecommendationItemType": { "type": "enum", "members": { "AWS_RESOURCE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AWS_RESOURCE" } }, "RECOMMENDATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RECOMMENDATION" } } }, "traits": { "smithy.api#documentation": "

The type of a recommendation item.

" } }, "com.amazonaws.wellarchitected#RecommendationSource": { "type": "enum", "members": { "TRUSTED_ADVISOR": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "TRUSTED_ADVISOR" } }, "COST_EXPLORER": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "

Recommendation sourced from Amazon Web Services Cost Explorer analysis.

", "smithy.api#enumValue": "COST_EXPLORER" } }, "CLOUDWATCH": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "

Recommendation sourced from Amazon CloudWatch metrics analysis.

", "smithy.api#enumValue": "CLOUDWATCH" } }, "WELL_ARCHITECTED_TOOL": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "

Recommendation sourced from Well-Architected Tool.

", "smithy.api#enumValue": "WELL_ARCHITECTED_TOOL" } }, "WELL_ARCHITECTED_AGENT": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "

Recommendation sourced from Well-Architected Agent.

", "smithy.api#enumValue": "WELL_ARCHITECTED_AGENT" } }, "CUSTOMER_IAC": { "target": "smithy.api#Unit", "traits": { "smithy.api#documentation": "

Recommendation sourced from customer infrastructure-as-code analysis.

", "smithy.api#enumValue": "CUSTOMER_IAC" } } }, "traits": { "smithy.api#documentation": "

The origin system that produced a recommendation.

" } }, "com.amazonaws.wellarchitected#RecommendationSourceList": { "type": "list", "member": { "target": "com.amazonaws.wellarchitected#RecommendationSource" } }, "com.amazonaws.wellarchitected#RecommendationState": { "type": "enum", "members": { "OPEN": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "OPEN" } }, "CLOSED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CLOSED" } } }, "traits": { "smithy.api#documentation": "

The state of a recommendation.

" } }, "com.amazonaws.wellarchitected#RecommendationStatus": { "type": "enum", "members": { "ACTIVE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACTIVE" } }, "SUPPRESSED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SUPPRESSED" } }, "COMPLETED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "COMPLETED" } } }, "traits": { "smithy.api#documentation": "

The status of a recommendation.

" } }, "com.amazonaws.wellarchitected#RecommendationStatusList": { "type": "list", "member": { "target": "com.amazonaws.wellarchitected#RecommendationStatus" }, "traits": { "smithy.api#length": { "max": 10 }, "smithy.api#uniqueItems": {} } }, "com.amazonaws.wellarchitected#RecommendationType": { "type": "enum", "members": { "RESOURCE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RESOURCE" } }, "ARCHITECTURE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ARCHITECTURE" } }, "APPLICATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "APPLICATION" } } }, "traits": { "smithy.api#documentation": "

The type of a recommendation.

" } }, "com.amazonaws.wellarchitected#RecommendationTypeList": { "type": "list", "member": { "target": "com.amazonaws.wellarchitected#RecommendationType" }, "traits": { "smithy.api#length": { "max": 10 }, "smithy.api#uniqueItems": {} } }, "com.amazonaws.wellarchitected#RecommendationTypes": { "type": "list", "member": { "target": "com.amazonaws.wellarchitected#RecommendationType" }, "traits": { "smithy.api#length": { "min": 1, "max": 2 }, "smithy.api#uniqueItems": {} } }, "com.amazonaws.wellarchitected#RecommendedFixStep": { "type": "string", "traits": { "smithy.api#length": { "min": 20, "max": 200 } } }, "com.amazonaws.wellarchitected#RecommendedFixSteps": { "type": "list", "member": { "target": "com.amazonaws.wellarchitected#RecommendedFixStep" }, "traits": { "smithy.api#length": { "min": 1, "max": 5 } } }, "com.amazonaws.wellarchitected#Region": { "type": "string", "traits": { "smithy.api#length": { "max": 64 }, "smithy.api#pattern": "^[a-z]{2}-[a-z]+-\\d{1}$" } }, "com.amazonaws.wellarchitected#Regions": { "type": "list", "member": { "target": "com.amazonaws.wellarchitected#Region" }, "traits": { "smithy.api#length": { "min": 0, "max": 25 }, "smithy.api#uniqueItems": {} } }, "com.amazonaws.wellarchitected#RemediationStep": { "type": "structure", "members": { "title": { "target": "com.amazonaws.wellarchitected#SensitiveString", "traits": { "smithy.api#documentation": "

An optional short label for the step.

", "smithy.api#length": { "min": 3, "max": 80 } } }, "content": { "target": "com.amazonaws.wellarchitected#SensitiveString", "traits": { "smithy.api#documentation": "

The content describing the step, which can include code examples and verification checklists.

", "smithy.api#length": { "min": 80, "max": 8000 }, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

One step within a remediation procedure.

" } }, "com.amazonaws.wellarchitected#RemediationSteps": { "type": "list", "member": { "target": "com.amazonaws.wellarchitected#RemediationStep" }, "traits": { "smithy.api#length": { "min": 1, "max": 10 } } }, "com.amazonaws.wellarchitected#RemediationSummary": { "type": "structure", "members": { "recommendation": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

A short imperative statement of the recommended action.

", "smithy.api#length": { "min": 80, "max": 240 }, "smithy.api#required": {} } }, "steps": { "target": "com.amazonaws.wellarchitected#RecommendedFixSteps", "traits": { "smithy.api#documentation": "

High-level steps to implement the fix.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

A high-level remediation summary returned in the detail response.

" } }, "com.amazonaws.wellarchitected#RemediationType": { "type": "enum", "members": { "AUTO_REMEDIATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "AUTO_REMEDIATION" } }, "CONSOLE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CONSOLE" } }, "CLI": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CLI" } }, "SDK": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "SDK" } }, "IAC": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "IAC" } }, "MCP": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MCP" } } }, "traits": { "smithy.api#documentation": "

The method by which a recommendation is remediated.

" } }, "com.amazonaws.wellarchitected#ReportFormat": { "type": "enum", "members": { "PDF": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PDF" } }, "JSON": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "JSON" } } } }, "com.amazonaws.wellarchitected#ReportLabel": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 500 } } }, "com.amazonaws.wellarchitected#ResourceArn": { "type": "string", "traits": { "smithy.api#length": { "min": 50, "max": 250 }, "smithy.api#pattern": "^arn:aws(-us-gov|-iso(-[a-z])?|-cn)?:wellarchitected:[a-z]{2}(-gov|-iso([a-z])?)?-[a-z]+-\\d:\\d{12}:(review-template)/[a-f0-9]{32}$" } }, "com.amazonaws.wellarchitected#ResourceLink": { "type": "structure", "members": { "url": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The URL of the external reference.

", "smithy.api#length": { "min": 10, "max": 16384 }, "smithy.api#required": {} } }, "title": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

An optional human-readable title for the link.

", "smithy.api#length": { "min": 3, "max": 100 } } } }, "traits": { "smithy.api#documentation": "

An external reference associated with remediation steps.

" } }, "com.amazonaws.wellarchitected#ResourceLinks": { "type": "list", "member": { "target": "com.amazonaws.wellarchitected#ResourceLink" }, "traits": { "smithy.api#length": { "min": 0, "max": 10 } } }, "com.amazonaws.wellarchitected#ResourceNotFoundException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.wellarchitected#ExceptionMessage", "traits": { "smithy.api#clientOptional": {}, "smithy.api#required": {} } }, "ResourceId": { "target": "com.amazonaws.wellarchitected#ExceptionResourceId", "traits": { "smithy.api#clientOptional": {}, "smithy.api#required": {} } }, "ResourceType": { "target": "com.amazonaws.wellarchitected#ExceptionResourceType", "traits": { "smithy.api#clientOptional": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The requested resource was not found.

", "smithy.api#error": "client", "smithy.api#httpError": 404 } }, "com.amazonaws.wellarchitected#ResourcePolicy": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 51200 }, "smithy.api#pattern": "^[\\u0009\\u000A\\u000D\\u0020-\\u00FF]+$" } }, "com.amazonaws.wellarchitected#ReviewTemplate": { "type": "structure", "members": { "Description": { "target": "com.amazonaws.wellarchitected#TemplateDescription", "traits": { "smithy.api#documentation": "

The review template description.

" } }, "Lenses": { "target": "com.amazonaws.wellarchitected#ReviewTemplateLenses", "traits": { "smithy.api#documentation": "

The lenses applied to the review template.

" } }, "Notes": { "target": "com.amazonaws.wellarchitected#Notes" }, "QuestionCounts": { "target": "com.amazonaws.wellarchitected#QuestionCounts", "traits": { "smithy.api#documentation": "

A count of how many total questions are answered and unanswered in the review template.

" } }, "Owner": { "target": "com.amazonaws.wellarchitected#AwsAccountId" }, "UpdatedAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The date and time when the review template was last updated.

" } }, "TemplateArn": { "target": "com.amazonaws.wellarchitected#TemplateArn", "traits": { "smithy.api#documentation": "

The review template ARN.

" } }, "TemplateName": { "target": "com.amazonaws.wellarchitected#TemplateName", "traits": { "smithy.api#documentation": "

The name of the review template.

" } }, "Tags": { "target": "com.amazonaws.wellarchitected#TagMap", "traits": { "smithy.api#documentation": "

The tags assigned to the review template.

" } }, "UpdateStatus": { "target": "com.amazonaws.wellarchitected#ReviewTemplateUpdateStatus", "traits": { "smithy.api#documentation": "

The latest status of a review template.

" } }, "ShareInvitationId": { "target": "com.amazonaws.wellarchitected#ShareInvitationId", "traits": { "smithy.api#documentation": "

The ID assigned to the template share invitation.

" } } }, "traits": { "smithy.api#documentation": "

A review template.

" } }, "com.amazonaws.wellarchitected#ReviewTemplateAnswer": { "type": "structure", "members": { "QuestionId": { "target": "com.amazonaws.wellarchitected#QuestionId" }, "PillarId": { "target": "com.amazonaws.wellarchitected#PillarId" }, "QuestionTitle": { "target": "com.amazonaws.wellarchitected#QuestionTitle" }, "QuestionDescription": { "target": "com.amazonaws.wellarchitected#QuestionDescription" }, "ImprovementPlanUrl": { "target": "com.amazonaws.wellarchitected#ImprovementPlanUrl" }, "HelpfulResourceUrl": { "target": "com.amazonaws.wellarchitected#HelpfulResourceUrl" }, "HelpfulResourceDisplayText": { "target": "com.amazonaws.wellarchitected#DisplayText", "traits": { "smithy.api#documentation": "

The helpful resource text to be displayed for a custom lens.

This field does not apply to Amazon Web Services official lenses.

" } }, "Choices": { "target": "com.amazonaws.wellarchitected#Choices" }, "SelectedChoices": { "target": "com.amazonaws.wellarchitected#SelectedChoices" }, "ChoiceAnswers": { "target": "com.amazonaws.wellarchitected#ChoiceAnswers", "traits": { "smithy.api#documentation": "

A list of selected choices to a question in your review template.

" } }, "IsApplicable": { "target": "com.amazonaws.wellarchitected#IsApplicable" }, "AnswerStatus": { "target": "com.amazonaws.wellarchitected#ReviewTemplateAnswerStatus", "traits": { "smithy.api#documentation": "

The status of whether or not this question has been answered.

" } }, "Notes": { "target": "com.amazonaws.wellarchitected#Notes" }, "Reason": { "target": "com.amazonaws.wellarchitected#AnswerReason", "traits": { "smithy.api#documentation": "

The reason why the question is not applicable to your review template.

" } } }, "traits": { "smithy.api#documentation": "

An answer of the question.

" } }, "com.amazonaws.wellarchitected#ReviewTemplateAnswerStatus": { "type": "enum", "members": { "UNANSWERED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UNANSWERED" } }, "ANSWERED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ANSWERED" } } } }, "com.amazonaws.wellarchitected#ReviewTemplateAnswerSummaries": { "type": "list", "member": { "target": "com.amazonaws.wellarchitected#ReviewTemplateAnswerSummary" } }, "com.amazonaws.wellarchitected#ReviewTemplateAnswerSummary": { "type": "structure", "members": { "QuestionId": { "target": "com.amazonaws.wellarchitected#QuestionId" }, "PillarId": { "target": "com.amazonaws.wellarchitected#PillarId" }, "QuestionTitle": { "target": "com.amazonaws.wellarchitected#QuestionTitle" }, "Choices": { "target": "com.amazonaws.wellarchitected#Choices" }, "SelectedChoices": { "target": "com.amazonaws.wellarchitected#SelectedChoices" }, "ChoiceAnswerSummaries": { "target": "com.amazonaws.wellarchitected#ChoiceAnswerSummaries", "traits": { "smithy.api#documentation": "

A list of selected choices to a question in the review template.

" } }, "IsApplicable": { "target": "com.amazonaws.wellarchitected#IsApplicable" }, "AnswerStatus": { "target": "com.amazonaws.wellarchitected#ReviewTemplateAnswerStatus", "traits": { "smithy.api#documentation": "

The status of whether or not this question has been answered.

" } }, "Reason": { "target": "com.amazonaws.wellarchitected#AnswerReason", "traits": { "smithy.api#documentation": "

The reason why a choice is not-applicable to a question in the review template.

" } }, "QuestionType": { "target": "com.amazonaws.wellarchitected#QuestionType", "traits": { "smithy.api#documentation": "

The type of question.

" } } }, "traits": { "smithy.api#documentation": "

The summary of review template answers.

" } }, "com.amazonaws.wellarchitected#ReviewTemplateArns": { "type": "list", "member": { "target": "com.amazonaws.wellarchitected#TemplateArn" }, "traits": { "smithy.api#length": { "max": 1 } } }, "com.amazonaws.wellarchitected#ReviewTemplateLensAliases": { "type": "list", "member": { "target": "com.amazonaws.wellarchitected#LensAlias" }, "traits": { "smithy.api#length": { "min": 1, "max": 10 } } }, "com.amazonaws.wellarchitected#ReviewTemplateLensReview": { "type": "structure", "members": { "LensAlias": { "target": "com.amazonaws.wellarchitected#LensAlias" }, "LensArn": { "target": "com.amazonaws.wellarchitected#LensArn", "traits": { "smithy.api#documentation": "

The lens ARN.

" } }, "LensVersion": { "target": "com.amazonaws.wellarchitected#LensVersion", "traits": { "smithy.api#documentation": "

The version of the lens.

" } }, "LensName": { "target": "com.amazonaws.wellarchitected#LensName" }, "LensStatus": { "target": "com.amazonaws.wellarchitected#LensStatus", "traits": { "smithy.api#documentation": "

The status of the lens.

" } }, "PillarReviewSummaries": { "target": "com.amazonaws.wellarchitected#ReviewTemplatePillarReviewSummaries", "traits": { "smithy.api#documentation": "

Pillar review summaries of a lens review.

" } }, "UpdatedAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The date and time when the review template lens review was last updated.

" } }, "Notes": { "target": "com.amazonaws.wellarchitected#Notes" }, "QuestionCounts": { "target": "com.amazonaws.wellarchitected#QuestionCounts", "traits": { "smithy.api#documentation": "

A count of how many questions are answered and unanswered in the lens review.

" } }, "NextToken": { "target": "com.amazonaws.wellarchitected#NextToken" } }, "traits": { "smithy.api#documentation": "

The lens review of a review template.

" } }, "com.amazonaws.wellarchitected#ReviewTemplateLenses": { "type": "list", "member": { "target": "com.amazonaws.wellarchitected#LensAlias" } }, "com.amazonaws.wellarchitected#ReviewTemplatePillarReviewSummaries": { "type": "list", "member": { "target": "com.amazonaws.wellarchitected#ReviewTemplatePillarReviewSummary" } }, "com.amazonaws.wellarchitected#ReviewTemplatePillarReviewSummary": { "type": "structure", "members": { "PillarId": { "target": "com.amazonaws.wellarchitected#PillarId" }, "PillarName": { "target": "com.amazonaws.wellarchitected#PillarName" }, "Notes": { "target": "com.amazonaws.wellarchitected#Notes" }, "QuestionCounts": { "target": "com.amazonaws.wellarchitected#QuestionCounts", "traits": { "smithy.api#documentation": "

A count of how many questions are answered and unanswered in the requested pillar of the lens review.

" } } }, "traits": { "smithy.api#documentation": "

Summary of a review template.

" } }, "com.amazonaws.wellarchitected#ReviewTemplateSummary": { "type": "structure", "members": { "Description": { "target": "com.amazonaws.wellarchitected#TemplateDescription", "traits": { "smithy.api#documentation": "

Description of the review template.

" } }, "Lenses": { "target": "com.amazonaws.wellarchitected#ReviewTemplateLenses", "traits": { "smithy.api#documentation": "

Lenses associated with the review template.

" } }, "Owner": { "target": "com.amazonaws.wellarchitected#AwsAccountId" }, "UpdatedAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The date and time when the review template was last updated.

" } }, "TemplateArn": { "target": "com.amazonaws.wellarchitected#TemplateArn", "traits": { "smithy.api#documentation": "

The review template ARN.

" } }, "TemplateName": { "target": "com.amazonaws.wellarchitected#TemplateName", "traits": { "smithy.api#documentation": "

The name of the review template.

" } }, "UpdateStatus": { "target": "com.amazonaws.wellarchitected#ReviewTemplateUpdateStatus", "traits": { "smithy.api#documentation": "

The latest status of a review template.

" } } }, "traits": { "smithy.api#documentation": "

Summary of a review template.

" } }, "com.amazonaws.wellarchitected#ReviewTemplateUpdateStatus": { "type": "enum", "members": { "CURRENT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CURRENT" } }, "LENS_NOT_CURRENT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "LENS_NOT_CURRENT" } } } }, "com.amazonaws.wellarchitected#ReviewTemplates": { "type": "list", "member": { "target": "com.amazonaws.wellarchitected#ReviewTemplateSummary" } }, "com.amazonaws.wellarchitected#Risk": { "type": "enum", "members": { "UNANSWERED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UNANSWERED" } }, "HIGH": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "HIGH" } }, "MEDIUM": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MEDIUM" } }, "NONE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NONE" } }, "NOT_APPLICABLE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NOT_APPLICABLE" } } }, "traits": { "smithy.api#documentation": "

The risk for a given workload, lens review, pillar, or question.

" } }, "com.amazonaws.wellarchitected#RiskCounts": { "type": "map", "key": { "target": "com.amazonaws.wellarchitected#Risk" }, "value": { "target": "com.amazonaws.wellarchitected#Count" }, "traits": { "smithy.api#documentation": "

A map from risk names to the count of how many questions have that rating.

" } }, "com.amazonaws.wellarchitected#RiskRating": { "type": "enum", "members": { "LOW": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "LOW" } }, "MEDIUM": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "MEDIUM" } }, "HIGH": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "HIGH" } } }, "traits": { "smithy.api#documentation": "

The risk rating for automated remediation.

" } }, "com.amazonaws.wellarchitected#Roi": { "type": "structure", "members": { "estimate": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

A short statistic or key metric. Optional when there is no quantifiable figure.

", "smithy.api#length": { "min": 2, "max": 40 } } }, "detail": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

A sentence providing context for the estimate.

", "smithy.api#length": { "min": 30, "max": 300 }, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

A return-on-investment estimate with context.

" } }, "com.amazonaws.wellarchitected#RoleArn": { "type": "string", "traits": { "smithy.api#length": { "max": 2048 }, "smithy.api#pattern": "^arn:([a-z\\-]+):iam::\\d{12}:role/(service-role/)?[a-zA-Z0-9+=,.@\\-_]+$" } }, "com.amazonaws.wellarchitected#S3BucketArn": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 2048 }, "smithy.api#pattern": "^arn:[^:]+:s3:::.+$" } }, "com.amazonaws.wellarchitected#S3ObjectKey": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 1024 } } }, "com.amazonaws.wellarchitected#Scope": { "type": "structure", "members": { "pillars": { "target": "com.amazonaws.wellarchitected#Pillars", "traits": { "smithy.api#documentation": "

The Amazon Web Services Well-Architected Framework pillars to include in the generation scope.

", "smithy.api#required": {} } }, "goalIds": { "target": "com.amazonaws.wellarchitected#GoalIdList", "traits": { "smithy.api#documentation": "

Specific goal IDs to focus on during recommendation generation. Use ListAgentGoals to retrieve goal IDs.

" } }, "items": { "target": "com.amazonaws.wellarchitected#PillarItems", "traits": { "smithy.api#documentation": "

An optional per-pillar filter. When you specify items, only the listed items are processed for each pillar. When you omit items, all items are processed.

" } } }, "traits": { "smithy.api#documentation": "

Defines the scope for recommendation generation, specifying which pillars and goals to focus on.

" } }, "com.amazonaws.wellarchitected#SelectedChoiceIds": { "type": "list", "member": { "target": "com.amazonaws.wellarchitected#ChoiceId" } }, "com.amazonaws.wellarchitected#SelectedChoices": { "type": "list", "member": { "target": "com.amazonaws.wellarchitected#ChoiceId" }, "traits": { "smithy.api#documentation": "

List of selected choice IDs in a question answer.

The values entered replace the previously selected choices.

" } }, "com.amazonaws.wellarchitected#SelectedPillar": { "type": "structure", "members": { "PillarId": { "target": "com.amazonaws.wellarchitected#PillarId" }, "SelectedQuestionIds": { "target": "com.amazonaws.wellarchitected#SelectedQuestionIds", "traits": { "smithy.api#documentation": "

Selected question IDs in the selected pillar.

" } } }, "traits": { "smithy.api#documentation": "

The selected pillar.

" } }, "com.amazonaws.wellarchitected#SelectedPillars": { "type": "list", "member": { "target": "com.amazonaws.wellarchitected#SelectedPillar" } }, "com.amazonaws.wellarchitected#SelectedProfileChoiceIds": { "type": "list", "member": { "target": "com.amazonaws.wellarchitected#ChoiceId" } }, "com.amazonaws.wellarchitected#SelectedQuestionId": { "type": "string" }, "com.amazonaws.wellarchitected#SelectedQuestionIds": { "type": "list", "member": { "target": "com.amazonaws.wellarchitected#SelectedQuestionId" } }, "com.amazonaws.wellarchitected#SendAgentOrganizationalReportDataToS3": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#SendAgentOrganizationalReportDataToS3Request" }, "output": { "target": "com.amazonaws.wellarchitected#SendAgentOrganizationalReportDataToS3Response" }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" }, { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, { "target": "com.amazonaws.wellarchitected#ValidationException" } ], "traits": { "smithy.api#documentation": "

Writes the data artifact for a completed Organizational Report directly into a caller-owned S3 bucket. The artifact is written in the requested format to the supplied bucketArn and objectKey, and the resulting S3 location is returned in deliveredTo. This operation creates an S3 object and should not be retried indiscriminately. To download the artifact through a short-lived presigned URL instead, use GetAgentOrganizationalReportData.

", "smithy.api#http": { "method": "POST", "uri": "/api/v1/agent-organizational-reports/{reportId}/send-to-s3", "code": 200 }, "smithy.api#tags": [ "AGENT" ], "smithy.rules#staticContextParams": { "SubServiceType": { "value": "AGENT" } }, "smithy.test#smokeTests": [ { "id": "SendAgentOrganizationalReportDataToS3", "params": { "reportId": "f6b5df15-3409-483f-b796-45d0e590222c", "format": "JSON", "bucketArn": "arn:aws:s3:::smoke-test-bucket", "objectKey": "smoke-test/report.json" }, "expect": { "failure": {} }, "vendorParamsShape": "aws.test#AwsVendorParams", "vendorParams": { "region": "us-west-2" } } ] } }, "com.amazonaws.wellarchitected#SendAgentOrganizationalReportDataToS3Request": { "type": "structure", "members": { "reportId": { "target": "com.amazonaws.wellarchitected#UUID", "traits": { "smithy.api#documentation": "

Identifier of the report whose data is being delivered.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "format": { "target": "com.amazonaws.wellarchitected#OrganizationalReportFormat", "traits": { "smithy.api#documentation": "

Format of the delivered artifact (CSV, JSON, or PARQUET).

", "smithy.api#required": {} } }, "bucketArn": { "target": "com.amazonaws.wellarchitected#S3BucketArn", "traits": { "smithy.api#documentation": "

ARN of the caller-owned S3 bucket that will receive the artifact.

", "smithy.api#required": {} } }, "objectKey": { "target": "com.amazonaws.wellarchitected#S3ObjectKey", "traits": { "smithy.api#documentation": "

S3 object key under bucketArn where the artifact will be written.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.wellarchitected#SendAgentOrganizationalReportDataToS3Response": { "type": "structure", "members": { "deliveredTo": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

S3 URI (format s3://bucket/key) where the artifact was written.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.wellarchitected#SensitiveDocument": { "type": "document", "traits": { "smithy.api#sensitive": {} } }, "com.amazonaws.wellarchitected#SensitiveString": { "type": "string", "traits": { "smithy.api#sensitive": {} } }, "com.amazonaws.wellarchitected#ServiceCode": { "type": "string", "traits": { "smithy.api#documentation": "

Service Quotas requirement to identify originating service.

" } }, "com.amazonaws.wellarchitected#ServiceQuotaExceededException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.wellarchitected#ExceptionMessage", "traits": { "smithy.api#clientOptional": {}, "smithy.api#required": {} } }, "ResourceId": { "target": "com.amazonaws.wellarchitected#ExceptionResourceId" }, "ResourceType": { "target": "com.amazonaws.wellarchitected#ExceptionResourceType" }, "QuotaCode": { "target": "com.amazonaws.wellarchitected#QuotaCode", "traits": { "smithy.api#clientOptional": {}, "smithy.api#required": {} } }, "ServiceCode": { "target": "com.amazonaws.wellarchitected#ServiceCode", "traits": { "smithy.api#clientOptional": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

The user has reached their resource quota.

", "smithy.api#error": "client", "smithy.api#httpError": 402 } }, "com.amazonaws.wellarchitected#ShareId": { "type": "string", "traits": { "smithy.api#documentation": "

The ID associated with the share.

", "smithy.api#pattern": "^[0-9a-f]{32}$" } }, "com.amazonaws.wellarchitected#ShareInvitation": { "type": "structure", "members": { "ShareInvitationId": { "target": "com.amazonaws.wellarchitected#ShareInvitationId", "traits": { "smithy.api#documentation": "

The ID assigned to the share invitation.

" } }, "ShareResourceType": { "target": "com.amazonaws.wellarchitected#ShareResourceType", "traits": { "smithy.api#documentation": "

The resource type of the share invitation.

" } }, "WorkloadId": { "target": "com.amazonaws.wellarchitected#WorkloadId" }, "LensAlias": { "target": "com.amazonaws.wellarchitected#LensAlias" }, "LensArn": { "target": "com.amazonaws.wellarchitected#LensArn", "traits": { "smithy.api#documentation": "

The ARN for the lens.

" } }, "ProfileArn": { "target": "com.amazonaws.wellarchitected#ProfileArn", "traits": { "smithy.api#documentation": "

The profile ARN.

" } }, "TemplateArn": { "target": "com.amazonaws.wellarchitected#TemplateArn", "traits": { "smithy.api#documentation": "

The review template ARN.

" } } }, "traits": { "smithy.api#documentation": "

The share invitation.

" } }, "com.amazonaws.wellarchitected#ShareInvitationAction": { "type": "enum", "members": { "ACCEPT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACCEPT" } }, "REJECT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "REJECT" } } }, "traits": { "smithy.api#documentation": "

Share invitation action taken by contributor.

" } }, "com.amazonaws.wellarchitected#ShareInvitationId": { "type": "string", "traits": { "smithy.api#pattern": "^[0-9a-f]{32}$" } }, "com.amazonaws.wellarchitected#ShareInvitationSummaries": { "type": "list", "member": { "target": "com.amazonaws.wellarchitected#ShareInvitationSummary" } }, "com.amazonaws.wellarchitected#ShareInvitationSummary": { "type": "structure", "members": { "ShareInvitationId": { "target": "com.amazonaws.wellarchitected#ShareInvitationId", "traits": { "smithy.api#documentation": "

The ID assigned to the share invitation.

" } }, "SharedBy": { "target": "com.amazonaws.wellarchitected#AwsAccountId" }, "SharedWith": { "target": "com.amazonaws.wellarchitected#SharedWith" }, "PermissionType": { "target": "com.amazonaws.wellarchitected#PermissionType" }, "ShareResourceType": { "target": "com.amazonaws.wellarchitected#ShareResourceType", "traits": { "smithy.api#documentation": "

The resource type of the share invitation.

" } }, "WorkloadName": { "target": "com.amazonaws.wellarchitected#WorkloadName" }, "WorkloadId": { "target": "com.amazonaws.wellarchitected#WorkloadId" }, "LensName": { "target": "com.amazonaws.wellarchitected#LensName" }, "LensArn": { "target": "com.amazonaws.wellarchitected#LensArn", "traits": { "smithy.api#documentation": "

The ARN for the lens.

" } }, "ProfileName": { "target": "com.amazonaws.wellarchitected#ProfileName", "traits": { "smithy.api#documentation": "

The profile name.

" } }, "ProfileArn": { "target": "com.amazonaws.wellarchitected#ProfileArn", "traits": { "smithy.api#documentation": "

The profile ARN.

" } }, "TemplateName": { "target": "com.amazonaws.wellarchitected#TemplateName", "traits": { "smithy.api#documentation": "

The name of the review template.

" } }, "TemplateArn": { "target": "com.amazonaws.wellarchitected#TemplateArn", "traits": { "smithy.api#documentation": "

The review template ARN.

" } } }, "traits": { "smithy.api#documentation": "

A share invitation summary return object.

" } }, "com.amazonaws.wellarchitected#ShareResourceType": { "type": "enum", "members": { "WORKLOAD": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "WORKLOAD" } }, "LENS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "LENS" } }, "PROFILE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PROFILE" } }, "TEMPLATE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "TEMPLATE" } } } }, "com.amazonaws.wellarchitected#ShareStatus": { "type": "enum", "members": { "ACCEPTED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ACCEPTED" } }, "REJECTED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "REJECTED" } }, "PENDING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PENDING" } }, "REVOKED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "REVOKED" } }, "EXPIRED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "EXPIRED" } }, "ASSOCIATING": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ASSOCIATING" } }, "ASSOCIATED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ASSOCIATED" } }, "FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FAILED" } } }, "traits": { "smithy.api#documentation": "

The status of the share request.

" } }, "com.amazonaws.wellarchitected#SharedWith": { "type": "string", "traits": { "smithy.api#documentation": "

The Amazon Web Services account ID, organization ID, or organizational unit (OU) ID with which the workload, lens, profile, or review template is shared.

", "smithy.api#length": { "min": 12, "max": 2048 } } }, "com.amazonaws.wellarchitected#SharedWithPrefix": { "type": "string", "traits": { "smithy.api#length": { "max": 100 } } }, "com.amazonaws.wellarchitected#StartAgentRecommendationGeneration": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#StartAgentRecommendationGenerationRequest" }, "output": { "target": "com.amazonaws.wellarchitected#StartAgentRecommendationGenerationResponse" }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" }, { "target": "com.amazonaws.wellarchitected#ConflictException" }, { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ServiceQuotaExceededException" }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, { "target": "com.amazonaws.wellarchitected#ValidationException" } ], "traits": { "smithy.api#documentation": "

Starts a recommendation generation process for the specified agent profile. This asynchronous operation returns immediately. Use GetAgentRecommendationGeneration to check the status of the generation.

Currently, only the ARCHITECTURE recommendation type is supported. RESOURCE and APPLICATION recommendations are generated only by the scheduled generation cycle and cannot be started with this operation.

For the ARCHITECTURE type, the generation analyzes the infrastructure as code (IaC) template that you specify in additionalContext, and returns updated templates with best practice fixes applied. You must specify scope and additionalContext. You can optionally specify name.

Architecture review generations are subject to a daily quota for each profile. For more information, see Quotas and limits in the Amazon Web Services Well-Architected User Guide.

", "smithy.api#http": { "method": "POST", "uri": "/api/v1/agent-profiles/{profileArn}/generations" }, "smithy.api#idempotent": {}, "smithy.api#tags": [ "AGENT" ], "smithy.rules#staticContextParams": { "SubServiceType": { "value": "AGENT" } } } }, "com.amazonaws.wellarchitected#StartAgentRecommendationGenerationRequest": { "type": "structure", "members": { "profileArn": { "target": "com.amazonaws.wellarchitected#AgentProfileArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the optimization profile to use for generating recommendations.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "types": { "target": "com.amazonaws.wellarchitected#RecommendationTypes", "traits": { "smithy.api#documentation": "

The types of recommendations to generate. You can specify up to two types in a single request. Currently, only ARCHITECTURE is supported for this operation.

", "smithy.api#required": {} } }, "name": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

An optional name for this generation that identifies the architecture review in the console and in ListAgentRecommendationGenerations results. Applies to ARCHITECTURE type only. Must be absent for other types.

", "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^[A-Za-z0-9_-]+$" } }, "additionalContext": { "target": "com.amazonaws.wellarchitected#SensitiveDocument", "traits": { "smithy.api#documentation": "

The location of the infrastructure as code (IaC) template to review, and the lenses to review it against. Required for the ARCHITECTURE type. Must be absent for other types. Specify a JSON object with the following members:

" } }, "scope": { "target": "com.amazonaws.wellarchitected#Scope", "traits": { "smithy.api#documentation": "

Defines which pillars, goals, and items the review covers. Required for the ARCHITECTURE type. Must be absent for other types.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.wellarchitected#StartAgentRecommendationGenerationResponse": { "type": "structure", "members": { "id": { "target": "com.amazonaws.wellarchitected#UUID", "traits": { "smithy.api#documentation": "

The unique identifier of the recommendation generation.

", "smithy.api#required": {} } }, "profileArn": { "target": "com.amazonaws.wellarchitected#AgentProfileArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the profile used for this generation.

", "smithy.api#required": {} } }, "name": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The name of the recommendation generation.

" } }, "status": { "target": "com.amazonaws.wellarchitected#GenerationStatus", "traits": { "smithy.api#documentation": "

The current status of the recommendation generation.

", "smithy.api#required": {} } }, "estimatedCompletionTime": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The estimated time for the generation to complete.

", "smithy.api#timestampFormat": "date-time" } }, "createdBy": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The identifier of the user or system that started this generation.

", "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#required": {} } }, "createdAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The timestamp when the generation was started.

", "smithy.api#required": {}, "smithy.api#timestampFormat": "date-time" } }, "lastModifiedBy": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The identifier of the user or system that last modified this generation.

", "smithy.api#length": { "min": 1, "max": 128 } } }, "lastModifiedAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The timestamp when the generation was last modified.

", "smithy.api#timestampFormat": "date-time" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.wellarchitected#StatusMessage": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 512 } } }, "com.amazonaws.wellarchitected#StringList": { "type": "list", "member": { "target": "smithy.api#String" } }, "com.amazonaws.wellarchitected#Subdomain": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 100 } } }, "com.amazonaws.wellarchitected#Tag": { "type": "structure", "members": { "key": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The key of the tag.

", "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^[\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]+$", "smithy.api#required": {} } }, "value": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The value of the tag.

", "smithy.api#length": { "min": 1, "max": 256 }, "smithy.api#pattern": "^[\\p{L}\\p{Z}\\p{N}_.:/=+\\-@]+$", "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

A key-value pair associated with a resource for cost allocation and access control.

" } }, "com.amazonaws.wellarchitected#TagKey": { "type": "string", "traits": { "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^[\\p{L}\\p{N}\\p{Z}_.:/=+@-]+$" } }, "com.amazonaws.wellarchitected#TagKeyList": { "type": "list", "member": { "target": "com.amazonaws.wellarchitected#TagKey" }, "traits": { "smithy.api#length": { "min": 1, "max": 50 } } }, "com.amazonaws.wellarchitected#TagMap": { "type": "map", "key": { "target": "com.amazonaws.wellarchitected#TagKey" }, "value": { "target": "com.amazonaws.wellarchitected#TagValue" }, "traits": { "smithy.api#length": { "min": 1, "max": 50 } } }, "com.amazonaws.wellarchitected#TagResource": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#TagResourceInput" }, "output": { "target": "com.amazonaws.wellarchitected#TagResourceOutput" }, "errors": [ { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "

Adds one or more tags to the specified resource.

The WorkloadArn parameter can be a workload ARN, a custom lens ARN, a profile ARN, or review template ARN.

", "smithy.api#http": { "method": "POST", "uri": "/tags/{WorkloadArn}", "code": 200 }, "smithy.api#tags": [ "WA" ] } }, "com.amazonaws.wellarchitected#TagResourceInput": { "type": "structure", "members": { "WorkloadArn": { "target": "com.amazonaws.wellarchitected#WorkloadArn", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "Tags": { "target": "com.amazonaws.wellarchitected#TagMap", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

The tags for the resource.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.wellarchitected#TagResourceOutput": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.wellarchitected#TagValue": { "type": "string", "traits": { "smithy.api#length": { "max": 256 } } }, "com.amazonaws.wellarchitected#Tags": { "type": "list", "member": { "target": "com.amazonaws.wellarchitected#Tag" } }, "com.amazonaws.wellarchitected#TemplateArn": { "type": "string", "traits": { "smithy.api#length": { "min": 50, "max": 250 }, "smithy.api#pattern": "^arn:aws(-us-gov|-iso(-[a-z])?|-cn)?:wellarchitected:[a-z]{2}(-gov|-iso([a-z])?)?-[a-z]+-\\d:\\d{12}:(review-template)/[a-f0-9]{32}$" } }, "com.amazonaws.wellarchitected#TemplateDescription": { "type": "string", "traits": { "smithy.api#length": { "min": 3, "max": 250 }, "smithy.api#pattern": "^[A-Za-z0-9-_.,:/()@!&?#+'\u2019\\s]+$" } }, "com.amazonaws.wellarchitected#TemplateName": { "type": "string", "traits": { "smithy.api#length": { "min": 3, "max": 100 }, "smithy.api#pattern": "^[A-Za-z0-9-_.,:/()@!&?#+'\u2019\\s]+$" } }, "com.amazonaws.wellarchitected#TemplateNamePrefix": { "type": "string", "traits": { "smithy.api#length": { "max": 100 }, "smithy.api#pattern": "^[A-Za-z0-9-_.,:/()@!&?#+'\u2019\\s]+$" } }, "com.amazonaws.wellarchitected#TemplateQuestions": { "type": "list", "member": { "target": "com.amazonaws.wellarchitected#ProfileTemplateQuestion" } }, "com.amazonaws.wellarchitected#TemplateShareSummaries": { "type": "list", "member": { "target": "com.amazonaws.wellarchitected#TemplateShareSummary" } }, "com.amazonaws.wellarchitected#TemplateShareSummary": { "type": "structure", "members": { "ShareId": { "target": "com.amazonaws.wellarchitected#ShareId" }, "SharedWith": { "target": "com.amazonaws.wellarchitected#SharedWith" }, "Status": { "target": "com.amazonaws.wellarchitected#ShareStatus" }, "StatusMessage": { "target": "com.amazonaws.wellarchitected#StatusMessage", "traits": { "smithy.api#documentation": "

Review template share invitation status message.

" } } }, "traits": { "smithy.api#documentation": "

Summary of a review template share.

" } }, "com.amazonaws.wellarchitected#ThrottlingException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.wellarchitected#ExceptionMessage", "traits": { "smithy.api#clientOptional": {}, "smithy.api#required": {} } }, "QuotaCode": { "target": "com.amazonaws.wellarchitected#QuotaCode" }, "ServiceCode": { "target": "com.amazonaws.wellarchitected#ServiceCode" } }, "traits": { "smithy.api#documentation": "

Request was denied due to request throttling.

", "smithy.api#error": "client", "smithy.api#httpError": 429 } }, "com.amazonaws.wellarchitected#TimeWindow": { "type": "structure", "members": { "from": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

Lower bound of the window (inclusive). Absent means no lower bound.

", "smithy.api#timestampFormat": "date-time" } }, "to": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

Upper bound of the window (inclusive). Absent means no upper bound.

", "smithy.api#timestampFormat": "date-time" } } }, "traits": { "smithy.api#documentation": "

An inclusive time window used by Organizational Report filters. Both bounds are optional, but at least one of from or to must be set when the structure is present.

" } }, "com.amazonaws.wellarchitected#TradeOff": { "type": "structure", "members": { "pillar": { "target": "com.amazonaws.wellarchitected#Pillar", "traits": { "smithy.api#documentation": "

The pillar that could be negatively impacted.

", "smithy.api#required": {} } }, "title": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

A short phrase describing what is lost or degraded.

", "smithy.api#length": { "min": 3, "max": 80 }, "smithy.api#required": {} } }, "description": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

A description of the specific risk and the condition that triggers it.

", "smithy.api#length": { "min": 30, "max": 450 }, "smithy.api#required": {} } }, "risk": { "target": "com.amazonaws.wellarchitected#RiskRating", "traits": { "smithy.api#documentation": "

The risk rating for the trade-off.

", "smithy.api#required": {} } }, "mitigation": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

A specific action to mitigate the trade-off and when to take it.

", "smithy.api#length": { "min": 30, "max": 450 }, "smithy.api#required": {} } }, "riskExplanation": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

An optional explanation providing additional context for the risk rating.

", "smithy.api#length": { "min": 1, "max": 160 } } } }, "traits": { "smithy.api#documentation": "

A negative trade-off from acting on the recommendation.

" } }, "com.amazonaws.wellarchitected#TradeOffs": { "type": "list", "member": { "target": "com.amazonaws.wellarchitected#TradeOff" } }, "com.amazonaws.wellarchitected#TrustedAdvisorIntegrationStatus": { "type": "enum", "members": { "ENABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ENABLED" } }, "DISABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DISABLED" } } } }, "com.amazonaws.wellarchitected#UUID": { "type": "string", "traits": { "smithy.api#pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$" } }, "com.amazonaws.wellarchitected#UntagResource": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#UntagResourceInput" }, "output": { "target": "com.amazonaws.wellarchitected#UntagResourceOutput" }, "errors": [ { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" } ], "traits": { "smithy.api#documentation": "

Deletes specified tags from a resource.

The WorkloadArn parameter can be a workload ARN, a custom lens ARN, a profile ARN, or review template ARN.

To specify multiple tags, use separate tagKeys parameters, for example:

DELETE /tags/WorkloadArn?tagKeys=key1&tagKeys=key2

", "smithy.api#http": { "method": "DELETE", "uri": "/tags/{WorkloadArn}", "code": 200 }, "smithy.api#tags": [ "WA" ] } }, "com.amazonaws.wellarchitected#UntagResourceInput": { "type": "structure", "members": { "WorkloadArn": { "target": "com.amazonaws.wellarchitected#WorkloadArn", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "TagKeys": { "target": "com.amazonaws.wellarchitected#TagKeyList", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

A list of tag keys. Existing tags of the resource whose keys are members of this list are removed from the resource.

", "smithy.api#httpQuery": "tagKeys", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.wellarchitected#UntagResourceOutput": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.wellarchitected#UpdateAgentContext": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#UpdateAgentContextRequest" }, "output": { "target": "com.amazonaws.wellarchitected#UpdateAgentContextResponse" }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" }, { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, { "target": "com.amazonaws.wellarchitected#ValidationException" } ], "traits": { "smithy.api#documentation": "

Updates an existing context associated with a profile.

", "smithy.api#http": { "method": "PUT", "uri": "/api/v1/agent-profiles/{profileArn}/contexts/{id}" }, "smithy.api#idempotent": {}, "smithy.api#tags": [ "AGENT" ], "smithy.rules#staticContextParams": { "SubServiceType": { "value": "AGENT" } }, "smithy.test#smokeTests": [ { "id": "UpdateAgentContext", "params": { "profileArn": "arn:aws:wellarchitected:us-west-2:123456789012:agent-profile/test-profile", "id": "f6b5df15-3409-483f-b796-45d0e590222c" }, "expect": { "failure": {} }, "vendorParamsShape": "aws.test#AwsVendorParams", "vendorParams": { "region": "us-west-2" } } ] } }, "com.amazonaws.wellarchitected#UpdateAgentContextRequest": { "type": "structure", "members": { "clientToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

", "smithy.api#idempotencyToken": {}, "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^[\\x21-\\x7E]+$" } }, "profileArn": { "target": "com.amazonaws.wellarchitected#AgentProfileArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the profile containing the context.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "id": { "target": "com.amazonaws.wellarchitected#UUID", "traits": { "smithy.api#documentation": "

The unique identifier of the context to update.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "title": { "target": "com.amazonaws.wellarchitected#SensitiveString", "traits": { "smithy.api#documentation": "

The updated title of the context.

", "smithy.api#length": { "min": 1, "max": 1000 }, "smithy.api#pattern": "^(?:(?!\\$\\{[a-zA-Z]+:)[\\P{C}])+$" } }, "content": { "target": "com.amazonaws.wellarchitected#ContextContent", "traits": { "smithy.api#documentation": "

The updated typed content of the context. The structure contains application-specific fields such as account IDs, Regions, services, and resource types.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.wellarchitected#UpdateAgentContextResponse": { "type": "structure", "members": { "context": { "target": "com.amazonaws.wellarchitected#ContextSummary", "traits": { "smithy.api#documentation": "

The updated context summary.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.wellarchitected#UpdateAgentGoal": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#UpdateAgentGoalRequest" }, "output": { "target": "com.amazonaws.wellarchitected#UpdateAgentGoalResponse" }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" }, { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, { "target": "com.amazonaws.wellarchitected#ValidationException" } ], "traits": { "smithy.api#documentation": "

Updates the pillars and title of an existing goal associated with a profile.

", "smithy.api#http": { "method": "PUT", "uri": "/api/v1/agent-profiles/{profileArn}/goals/{id}" }, "smithy.api#idempotent": {}, "smithy.api#tags": [ "AGENT" ], "smithy.rules#staticContextParams": { "SubServiceType": { "value": "AGENT" } }, "smithy.test#smokeTests": [ { "id": "UpdateAgentGoal", "params": { "profileArn": "arn:aws:wellarchitected:us-west-2:123456789012:agent-profile/test-profile", "id": "f6b5df15-3409-483f-b796-45d0e590222c" }, "expect": { "failure": {} }, "vendorParamsShape": "aws.test#AwsVendorParams", "vendorParams": { "region": "us-west-2" } } ] } }, "com.amazonaws.wellarchitected#UpdateAgentGoalRequest": { "type": "structure", "members": { "clientToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

", "smithy.api#idempotencyToken": {}, "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^[\\x21-\\x7E]+$" } }, "profileArn": { "target": "com.amazonaws.wellarchitected#AgentProfileArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the profile containing the goal to update.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "id": { "target": "com.amazonaws.wellarchitected#UUID", "traits": { "smithy.api#documentation": "

The unique identifier of the goal to update.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "pillars": { "target": "com.amazonaws.wellarchitected#Pillars", "traits": { "smithy.api#documentation": "

The updated pillars for the goal. Pillars define the optimization focus areas such as cost, performance, resilience, and operational excellence.

" } }, "title": { "target": "com.amazonaws.wellarchitected#SensitiveString", "traits": { "smithy.api#documentation": "

The updated title for the goal. Maximum length of 1000 characters.

", "smithy.api#length": { "min": 1, "max": 1000 }, "smithy.api#pattern": "^(?:(?!\\$\\{[a-zA-Z]+:)[\\P{C}])+$" } }, "description": { "target": "com.amazonaws.wellarchitected#SensitiveString", "traits": { "smithy.api#documentation": "

A description of the goal.

", "smithy.api#length": { "min": 1, "max": 4000 }, "smithy.api#pattern": "^(?:(?!\\$\\{[a-zA-Z]+:)[\\P{C}])+$" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.wellarchitected#UpdateAgentGoalResponse": { "type": "structure", "members": { "goal": { "target": "com.amazonaws.wellarchitected#GoalSummary", "traits": { "smithy.api#documentation": "

The updated goal summary.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.wellarchitected#UpdateAgentOrganizationalProfile": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#UpdateAgentOrganizationalProfileRequest" }, "output": { "target": "com.amazonaws.wellarchitected#UpdateAgentOrganizationalProfileResponse" }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" }, { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, { "target": "com.amazonaws.wellarchitected#ValidationException" } ], "traits": { "smithy.api#documentation": "

Updates an Organizational Profile. Organizational Profiles are specific to Profiles created using AWS Organizations integration. Include only the fields you want to change; any field you omit from the request keeps its current value.

To clear an optional text field, supply an empty string for it; the field is then unset, and a subsequent read omits it rather than returning an empty string. Omitting the field from the request leaves the stored value in place. description and businessOverview can be cleared this way. displayName cannot be cleared because a display name is required, though you can change it. pillars cannot be cleared because a profile must target at least one pillar.

organizationalAggregationConfiguration behaves differently because it is a structure rather than a text field. Supplying it with both its organizationalUnits and accounts lists empty removes every monitored organizational unit and account, but the field itself remains set: a subsequent read returns the structure with two empty lists rather than omitting it. Omitting the field from the request keeps the stored boundary.

", "smithy.api#http": { "method": "PUT", "uri": "/api/v1/agent-organizational-profiles/{profileArn}" }, "smithy.api#idempotent": {}, "smithy.api#tags": [ "AGENT" ], "smithy.rules#staticContextParams": { "SubServiceType": { "value": "AGENT" } }, "smithy.test#smokeTests": [ { "id": "UpdateAgentOrganizationalProfile", "params": { "profileArn": "arn:aws:wellarchitected:us-west-2:123456789012:agent-profile/smoke-test-organizational-profile", "pillars": [ "COST_OPTIMIZATION" ], "organizationalAggregationConfiguration": { "organizationalUnits": [ { "organizationalUnitId": "ou-abcd-11111111", "regions": [ "us-west-2" ] } ] } }, "expect": { "failure": {} }, "vendorParamsShape": "aws.test#AwsVendorParams", "vendorParams": { "region": "us-west-2" } } ] } }, "com.amazonaws.wellarchitected#UpdateAgentOrganizationalProfileRequest": { "type": "structure", "members": { "clientToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

", "smithy.api#idempotencyToken": {}, "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^[\\x21-\\x7E]+$" } }, "profileArn": { "target": "com.amazonaws.wellarchitected#AgentProfileArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the organizational profile to update.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "displayName": { "target": "com.amazonaws.wellarchitected#SensitiveString", "traits": { "smithy.api#documentation": "

The updated display name of the organizational profile. Omit this field to keep the current display name. A display name is required, so it cannot be cleared.

", "smithy.api#length": { "min": 3, "max": 128 }, "smithy.api#pattern": "^[\\P{C}]+$" } }, "description": { "target": "com.amazonaws.wellarchitected#SensitiveString", "traits": { "smithy.api#documentation": "

The updated description of the organizational profile. Omit this field to keep the current description, or supply an empty string to clear it; a cleared description is read back as absent rather than as an empty string.

", "smithy.api#length": { "max": 512 }, "smithy.api#pattern": "^[\\P{C}]*$" } }, "businessOverview": { "target": "com.amazonaws.wellarchitected#SensitiveString", "traits": { "smithy.api#documentation": "

The updated business overview for the organizational profile. Omit this field to keep the current business overview, or supply an empty string to clear it; a cleared business overview is read back as absent rather than as an empty string.

", "smithy.api#length": { "max": 512 }, "smithy.api#pattern": "^[\\P{C}]*$" } }, "pillars": { "target": "com.amazonaws.wellarchitected#Pillars", "traits": { "smithy.api#documentation": "

The updated Amazon Web Services Well-Architected Framework pillars for the organizational profile. Omit this field to keep the current pillars. A profile must target at least one pillar, so an empty list is rejected.

" } }, "deletionProtection": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "

Indicates whether deletion protection is enabled for the organizational profile.

" } }, "organizationalAggregationConfiguration": { "target": "com.amazonaws.wellarchitected#OrganizationalAggregationConfiguration", "traits": { "smithy.api#documentation": "

The organizational monitoring boundary. Contains organizational unit or root entries and individual account entries that define the scope for the profile. Omit this field to keep the current boundary, or supply this structure with both its organizationalUnits and accounts lists empty to remove every monitored organizational unit and account. The field remains set either way \u2014 an emptied boundary is read back as a structure with two empty lists, not as an absent field.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.wellarchitected#UpdateAgentOrganizationalProfileResponse": { "type": "structure", "members": { "name": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The system name of the updated organizational profile.

", "smithy.api#length": { "min": 3, "max": 128 }, "smithy.api#pattern": "^[a-zA-Z0-9_-]+$", "smithy.api#required": {} } }, "displayName": { "target": "com.amazonaws.wellarchitected#SensitiveString", "traits": { "smithy.api#documentation": "

The display name of the updated organizational profile.

", "smithy.api#length": { "min": 3, "max": 128 }, "smithy.api#pattern": "^(?:(?!\\$\\{[a-zA-Z]+:)[\\P{C}])+$" } }, "description": { "target": "com.amazonaws.wellarchitected#SensitiveString", "traits": { "smithy.api#documentation": "

A description of the updated organizational profile.

", "smithy.api#length": { "max": 512 }, "smithy.api#pattern": "^(?:(?!\\$\\{[a-zA-Z]+:)[\\P{C}])*$" } }, "businessOverview": { "target": "com.amazonaws.wellarchitected#SensitiveString", "traits": { "smithy.api#documentation": "

The business overview of the updated organizational profile.

", "smithy.api#length": { "max": 512 }, "smithy.api#pattern": "^(?:(?!\\$\\{[a-zA-Z]+:)[\\P{C}])*$" } }, "pillars": { "target": "com.amazonaws.wellarchitected#Pillars", "traits": { "smithy.api#documentation": "

The Amazon Web Services Well-Architected Framework pillars associated with the updated organizational profile.

", "smithy.api#required": {} } }, "deletionProtection": { "target": "smithy.api#Boolean", "traits": { "smithy.api#default": true, "smithy.api#documentation": "

Indicates whether deletion protection is enabled.

" } }, "organizationId": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The identifier of the Amazon Web Services Organization this profile belongs to.

", "smithy.api#required": {} } }, "organizationalAggregationConfiguration": { "target": "com.amazonaws.wellarchitected#OrganizationalAggregationConfiguration", "traits": { "smithy.api#documentation": "

The organizational monitoring boundary for the updated profile.

" } }, "arn": { "target": "com.amazonaws.wellarchitected#AgentProfileArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the updated organizational profile.

", "smithy.api#required": {} } }, "eligibleForScheduledGeneration": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "

Indicates whether the profile is valid for scheduled recommendation generation.

" } }, "eligibleForArchitectureGeneration": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "

Indicates whether the profile is valid for manual architecture generation.

" } }, "fieldErrors": { "target": "com.amazonaws.wellarchitected#FieldErrors", "traits": { "smithy.api#documentation": "

A map of field paths to error messages for invalid or missing input fields.

" } }, "createdBy": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The identifier of the user or system that created this organizational profile.

", "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#required": {} } }, "createdAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The timestamp when the organizational profile was created.

", "smithy.api#required": {}, "smithy.api#timestampFormat": "date-time" } }, "lastModifiedBy": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The identifier of the user or system that last modified this organizational profile.

", "smithy.api#length": { "min": 1, "max": 128 } } }, "lastModifiedAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The timestamp when the organizational profile was last modified.

", "smithy.api#timestampFormat": "date-time" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.wellarchitected#UpdateAgentProfile": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#UpdateAgentProfileRequest" }, "output": { "target": "com.amazonaws.wellarchitected#UpdateAgentProfileResponse" }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" }, { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" }, { "target": "com.amazonaws.wellarchitected#ServiceQuotaExceededException" }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, { "target": "com.amazonaws.wellarchitected#ValidationException" } ], "traits": { "smithy.api#documentation": "

Updates an existing optimization profile's configuration, including its pillars, execution role, and aggregation settings. Include only the fields you want to change. Any field you omit from the request keeps its current value, so you do not need to retrieve the profile first and resend the fields you are not changing.

To clear an optional text field, supply an empty string for it; the field is then unset, and a subsequent read omits it rather than returning an empty string. Omitting the field from the request leaves the stored value in place. description and businessOverview can be cleared this way. displayName cannot be cleared because a display name is required, though you can change it. pillars cannot be cleared because a profile must target at least one pillar.

aggregationConfiguration behaves differently because it is a list of per-account configurations rather than a text field. Supplying an empty list removes every account entry, but the field itself remains set: a subsequent read returns an empty list rather than omitting the field. Omitting it from the request keeps the stored entries.

", "smithy.api#http": { "method": "PUT", "uri": "/api/v1/agent-profiles/{profileArn}" }, "smithy.api#idempotent": {}, "smithy.api#tags": [ "AGENT" ], "smithy.rules#staticContextParams": { "SubServiceType": { "value": "AGENT" } }, "smithy.test#smokeTests": [ { "id": "UpdateAgentProfile", "params": { "profileArn": "arn:aws:wellarchitected:us-west-2:123456789012:agent-profile/test-profile" }, "expect": { "failure": {} }, "vendorParamsShape": "aws.test#AwsVendorParams", "vendorParams": { "region": "us-west-2" } } ] } }, "com.amazonaws.wellarchitected#UpdateAgentProfileRequest": { "type": "structure", "members": { "clientToken": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

", "smithy.api#idempotencyToken": {}, "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#pattern": "^[\\x21-\\x7E]+$" } }, "profileArn": { "target": "com.amazonaws.wellarchitected#AgentProfileArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the profile to update.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "displayName": { "target": "com.amazonaws.wellarchitected#SensitiveString", "traits": { "smithy.api#documentation": "

The updated display name of the profile. Omit this field to keep the current display name. A display name is required, so it cannot be cleared.

", "smithy.api#length": { "min": 3, "max": 128 }, "smithy.api#pattern": "^(?:(?!\\$\\{[a-zA-Z]+:)[\\P{C}])+$" } }, "description": { "target": "com.amazonaws.wellarchitected#SensitiveString", "traits": { "smithy.api#documentation": "

The updated description of the profile. Omit this field to keep the current description, or supply an empty string to clear it; a cleared description is read back as absent rather than as an empty string.

", "smithy.api#length": { "max": 512 }, "smithy.api#pattern": "^(?:(?!\\$\\{[a-zA-Z]+:)[\\P{C}])*$" } }, "executionRoleArn": { "target": "com.amazonaws.wellarchitected#RoleArn", "traits": { "smithy.api#documentation": "

The updated ARN of the IAM execution role. Omit this field to keep the current execution role.

" } }, "aggregationConfiguration": { "target": "com.amazonaws.wellarchitected#AggregationConfigurations", "traits": { "smithy.api#documentation": "

The updated aggregation configuration, as a list of per-account entries. Omit this field to keep the current entries, or supply an empty list to remove them all. The field remains set either way \u2014 an emptied configuration is read back as an empty list, not as an absent field.

" } }, "businessOverview": { "target": "com.amazonaws.wellarchitected#SensitiveString", "traits": { "smithy.api#documentation": "

The updated business overview for the profile. Omit this field to keep the current business overview, or supply an empty string to clear it; a cleared business overview is read back as absent rather than as an empty string.

", "smithy.api#length": { "max": 512 }, "smithy.api#pattern": "^(?:(?!\\$\\{[a-zA-Z]+:)[\\P{C}])*$" } }, "pillars": { "target": "com.amazonaws.wellarchitected#Pillars", "traits": { "smithy.api#documentation": "

The updated Amazon Web Services Well-Architected Framework pillars for the profile. Omit this field to keep the current pillars. A profile must target at least one pillar, so an empty list is rejected.

" } }, "deletionProtection": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "

Indicates whether deletion protection is enabled for the profile.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.wellarchitected#UpdateAgentProfileResponse": { "type": "structure", "members": { "name": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The system name of the updated profile.

", "smithy.api#length": { "min": 3, "max": 128 }, "smithy.api#pattern": "^[a-zA-Z0-9_-]+$", "smithy.api#required": {} } }, "displayName": { "target": "com.amazonaws.wellarchitected#SensitiveString", "traits": { "smithy.api#documentation": "

The display name of the updated profile.

", "smithy.api#length": { "min": 3, "max": 128 }, "smithy.api#pattern": "^(?:(?!\\$\\{[a-zA-Z]+:)[\\P{C}])+$" } }, "description": { "target": "com.amazonaws.wellarchitected#SensitiveString", "traits": { "smithy.api#documentation": "

A description of the updated profile.

", "smithy.api#length": { "max": 512 }, "smithy.api#pattern": "^(?:(?!\\$\\{[a-zA-Z]+:)[\\P{C}])*$" } }, "businessOverview": { "target": "com.amazonaws.wellarchitected#SensitiveString", "traits": { "smithy.api#documentation": "

The business overview of the updated profile.

", "smithy.api#length": { "max": 512 }, "smithy.api#pattern": "^(?:(?!\\$\\{[a-zA-Z]+:)[\\P{C}])*$" } }, "pillars": { "target": "com.amazonaws.wellarchitected#Pillars", "traits": { "smithy.api#documentation": "

The Amazon Web Services Well-Architected Framework pillars associated with the updated profile.

", "smithy.api#required": {} } }, "deletionProtection": { "target": "smithy.api#Boolean", "traits": { "smithy.api#default": true, "smithy.api#documentation": "

Indicates whether deletion protection is enabled.

" } }, "executionRoleArn": { "target": "com.amazonaws.wellarchitected#RoleArn", "traits": { "smithy.api#documentation": "

The ARN of the IAM execution role.

", "smithy.api#required": {} } }, "aggregationConfiguration": { "target": "com.amazonaws.wellarchitected#AggregationConfigurations", "traits": { "smithy.api#documentation": "

The aggregation configuration.

", "smithy.api#required": {} } }, "arn": { "target": "com.amazonaws.wellarchitected#AgentProfileArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the updated profile.

", "smithy.api#required": {} } }, "eligibleForScheduledGeneration": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "

Indicates whether the profile is valid for scheduled recommendation generation.

" } }, "eligibleForArchitectureGeneration": { "target": "smithy.api#Boolean", "traits": { "smithy.api#documentation": "

Indicates whether the profile is valid for manual architecture generation.

" } }, "fieldErrors": { "target": "com.amazonaws.wellarchitected#FieldErrors", "traits": { "smithy.api#documentation": "

A map of field paths to error messages for invalid or missing input fields.

" } }, "createdBy": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The identifier of the user or system that created this profile.

", "smithy.api#length": { "min": 1, "max": 128 }, "smithy.api#required": {} } }, "createdAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The timestamp when the profile was created.

", "smithy.api#required": {}, "smithy.api#timestampFormat": "date-time" } }, "lastModifiedBy": { "target": "smithy.api#String", "traits": { "smithy.api#documentation": "

The identifier of the user or system that last modified this profile.

", "smithy.api#length": { "min": 1, "max": 128 } } }, "lastModifiedAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The timestamp when the profile was last modified.

", "smithy.api#timestampFormat": "date-time" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.wellarchitected#UpdateAgentRecommendationStatus": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#UpdateAgentRecommendationStatusRequest" }, "output": { "target": "com.amazonaws.wellarchitected#UpdateAgentRecommendationStatusResponse" }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" }, { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, { "target": "com.amazonaws.wellarchitected#ValidationException" } ], "traits": { "smithy.api#documentation": "

Updates the status of a recommendation to track its progress through the implementation lifecycle.

", "smithy.api#http": { "method": "PATCH", "uri": "/api/v1/agent-recommendations/{recommendationArn}/status" }, "smithy.api#idempotent": {}, "smithy.api#tags": [ "AGENT" ], "smithy.rules#staticContextParams": { "SubServiceType": { "value": "AGENT" } } } }, "com.amazonaws.wellarchitected#UpdateAgentRecommendationStatusRequest": { "type": "structure", "members": { "recommendationArn": { "target": "com.amazonaws.wellarchitected#AgentRecommendationArn", "traits": { "smithy.api#documentation": "

The Amazon Resource Name (ARN) of the recommendation to update.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "status": { "target": "com.amazonaws.wellarchitected#RecommendationStatus", "traits": { "smithy.api#documentation": "

The new status to assign to the recommendation.

", "smithy.api#required": {} } }, "updateReason": { "target": "com.amazonaws.wellarchitected#SensitiveString", "traits": { "smithy.api#documentation": "

A free-text reason explaining this status update.

", "smithy.api#length": { "min": 1, "max": 4096 } } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.wellarchitected#UpdateAgentRecommendationStatusResponse": { "type": "structure", "members": {}, "traits": { "smithy.api#output": {} } }, "com.amazonaws.wellarchitected#UpdateAnswer": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#UpdateAnswerInput" }, "output": { "target": "com.amazonaws.wellarchitected#UpdateAnswerOutput" }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" }, { "target": "com.amazonaws.wellarchitected#ConflictException" }, { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, { "target": "com.amazonaws.wellarchitected#ValidationException" } ], "traits": { "smithy.api#documentation": "

Update the answer to a specific question in a workload review.

", "smithy.api#http": { "method": "PATCH", "uri": "/workloads/{WorkloadId}/lensReviews/{LensAlias}/answers/{QuestionId}", "code": 200 }, "smithy.api#tags": [ "WA" ] } }, "com.amazonaws.wellarchitected#UpdateAnswerInput": { "type": "structure", "members": { "WorkloadId": { "target": "com.amazonaws.wellarchitected#WorkloadId", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "LensAlias": { "target": "com.amazonaws.wellarchitected#LensAlias", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "QuestionId": { "target": "com.amazonaws.wellarchitected#QuestionId", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "SelectedChoices": { "target": "com.amazonaws.wellarchitected#SelectedChoices" }, "ChoiceUpdates": { "target": "com.amazonaws.wellarchitected#ChoiceUpdates", "traits": { "smithy.api#documentation": "

A list of choices to update on a question in your workload. The String key corresponds to the choice ID to be updated.

" } }, "Notes": { "target": "com.amazonaws.wellarchitected#Notes" }, "IsApplicable": { "target": "com.amazonaws.wellarchitected#IsApplicable" }, "Reason": { "target": "com.amazonaws.wellarchitected#AnswerReason", "traits": { "smithy.api#documentation": "

The reason why a question is not applicable to your workload.

" } } }, "traits": { "smithy.api#documentation": "

Input to update answer.

", "smithy.api#input": {} } }, "com.amazonaws.wellarchitected#UpdateAnswerOutput": { "type": "structure", "members": { "WorkloadId": { "target": "com.amazonaws.wellarchitected#WorkloadId" }, "LensAlias": { "target": "com.amazonaws.wellarchitected#LensAlias" }, "LensArn": { "target": "com.amazonaws.wellarchitected#LensArn", "traits": { "smithy.api#documentation": "

The ARN for the lens.

" } }, "Answer": { "target": "com.amazonaws.wellarchitected#Answer" } }, "traits": { "smithy.api#documentation": "

Output of a update answer call.

", "smithy.api#output": {} } }, "com.amazonaws.wellarchitected#UpdateGlobalSettings": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#UpdateGlobalSettingsInput" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" }, { "target": "com.amazonaws.wellarchitected#ConflictException" }, { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, { "target": "com.amazonaws.wellarchitected#ValidationException" } ], "traits": { "smithy.api#documentation": "

Update whether the Amazon Web Services account is opted into organization sharing and discovery integration features.

", "smithy.api#http": { "method": "PATCH", "uri": "/global-settings", "code": 200 }, "smithy.api#tags": [ "WA" ] } }, "com.amazonaws.wellarchitected#UpdateGlobalSettingsInput": { "type": "structure", "members": { "OrganizationSharingStatus": { "target": "com.amazonaws.wellarchitected#OrganizationSharingStatus", "traits": { "smithy.api#documentation": "

The status of organization sharing settings.

" } }, "DiscoveryIntegrationStatus": { "target": "com.amazonaws.wellarchitected#DiscoveryIntegrationStatus", "traits": { "smithy.api#documentation": "

The status of discovery support settings.

" } }, "JiraConfiguration": { "target": "com.amazonaws.wellarchitected#AccountJiraConfigurationInput", "traits": { "smithy.api#documentation": "

The status of Jira integration settings.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.wellarchitected#UpdateIntegration": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#UpdateIntegrationInput" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" }, { "target": "com.amazonaws.wellarchitected#ConflictException" }, { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, { "target": "com.amazonaws.wellarchitected#ValidationException" } ], "traits": { "smithy.api#documentation": "

Update integration features.

", "smithy.api#http": { "method": "POST", "uri": "/workloads/{WorkloadId}/updateIntegration", "code": 200 }, "smithy.api#tags": [ "WA" ] } }, "com.amazonaws.wellarchitected#UpdateIntegrationInput": { "type": "structure", "members": { "WorkloadId": { "target": "com.amazonaws.wellarchitected#WorkloadId", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "ClientRequestToken": { "target": "com.amazonaws.wellarchitected#ClientRequestToken", "traits": { "smithy.api#clientOptional": {}, "smithy.api#idempotencyToken": {}, "smithy.api#required": {} } }, "IntegratingService": { "target": "com.amazonaws.wellarchitected#IntegratingService", "traits": { "smithy.api#clientOptional": {}, "smithy.api#documentation": "

Which integrated service to update.

", "smithy.api#required": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.wellarchitected#UpdateLensReview": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#UpdateLensReviewInput" }, "output": { "target": "com.amazonaws.wellarchitected#UpdateLensReviewOutput" }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" }, { "target": "com.amazonaws.wellarchitected#ConflictException" }, { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, { "target": "com.amazonaws.wellarchitected#ValidationException" } ], "traits": { "smithy.api#documentation": "

Update lens review for a particular workload.

", "smithy.api#http": { "method": "PATCH", "uri": "/workloads/{WorkloadId}/lensReviews/{LensAlias}", "code": 200 }, "smithy.api#tags": [ "WA" ] } }, "com.amazonaws.wellarchitected#UpdateLensReviewInput": { "type": "structure", "members": { "WorkloadId": { "target": "com.amazonaws.wellarchitected#WorkloadId", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "LensAlias": { "target": "com.amazonaws.wellarchitected#LensAlias", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "LensNotes": { "target": "com.amazonaws.wellarchitected#Notes" }, "PillarNotes": { "target": "com.amazonaws.wellarchitected#PillarNotes" }, "JiraConfiguration": { "target": "com.amazonaws.wellarchitected#JiraSelectedQuestionConfiguration", "traits": { "smithy.api#documentation": "

Configuration of the Jira integration.

" } } }, "traits": { "smithy.api#documentation": "

Input for update lens review.

", "smithy.api#input": {} } }, "com.amazonaws.wellarchitected#UpdateLensReviewOutput": { "type": "structure", "members": { "WorkloadId": { "target": "com.amazonaws.wellarchitected#WorkloadId" }, "LensReview": { "target": "com.amazonaws.wellarchitected#LensReview" } }, "traits": { "smithy.api#documentation": "

Output of a update lens review call.

", "smithy.api#output": {} } }, "com.amazonaws.wellarchitected#UpdateProfile": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#UpdateProfileInput" }, "output": { "target": "com.amazonaws.wellarchitected#UpdateProfileOutput" }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" }, { "target": "com.amazonaws.wellarchitected#ConflictException" }, { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, { "target": "com.amazonaws.wellarchitected#ValidationException" } ], "traits": { "smithy.api#documentation": "

Update a profile.

", "smithy.api#http": { "method": "PATCH", "uri": "/profiles/{ProfileArn}", "code": 200 }, "smithy.api#tags": [ "WA" ] } }, "com.amazonaws.wellarchitected#UpdateProfileInput": { "type": "structure", "members": { "ProfileArn": { "target": "com.amazonaws.wellarchitected#ProfileArn", "traits": { "smithy.api#documentation": "

The profile ARN.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "ProfileDescription": { "target": "com.amazonaws.wellarchitected#ProfileDescription", "traits": { "smithy.api#documentation": "

The profile description.

" } }, "ProfileQuestions": { "target": "com.amazonaws.wellarchitected#ProfileQuestionUpdates", "traits": { "smithy.api#documentation": "

Profile questions.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.wellarchitected#UpdateProfileOutput": { "type": "structure", "members": { "Profile": { "target": "com.amazonaws.wellarchitected#Profile", "traits": { "smithy.api#documentation": "

The profile.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.wellarchitected#UpdateReviewTemplate": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#UpdateReviewTemplateInput" }, "output": { "target": "com.amazonaws.wellarchitected#UpdateReviewTemplateOutput" }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" }, { "target": "com.amazonaws.wellarchitected#ConflictException" }, { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, { "target": "com.amazonaws.wellarchitected#ValidationException" } ], "traits": { "smithy.api#documentation": "

Update a review template.

", "smithy.api#http": { "method": "PATCH", "uri": "/reviewTemplates/{TemplateArn}", "code": 200 }, "smithy.api#tags": [ "WA" ] } }, "com.amazonaws.wellarchitected#UpdateReviewTemplateAnswer": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#UpdateReviewTemplateAnswerInput" }, "output": { "target": "com.amazonaws.wellarchitected#UpdateReviewTemplateAnswerOutput" }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" }, { "target": "com.amazonaws.wellarchitected#ConflictException" }, { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, { "target": "com.amazonaws.wellarchitected#ValidationException" } ], "traits": { "smithy.api#documentation": "

Update a review template answer.

", "smithy.api#http": { "method": "PATCH", "uri": "/reviewTemplates/{TemplateArn}/lensReviews/{LensAlias}/answers/{QuestionId}", "code": 200 }, "smithy.api#tags": [ "WA" ] } }, "com.amazonaws.wellarchitected#UpdateReviewTemplateAnswerInput": { "type": "structure", "members": { "TemplateArn": { "target": "com.amazonaws.wellarchitected#TemplateArn", "traits": { "smithy.api#documentation": "

The review template ARN.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "LensAlias": { "target": "com.amazonaws.wellarchitected#LensAlias", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "QuestionId": { "target": "com.amazonaws.wellarchitected#QuestionId", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "SelectedChoices": { "target": "com.amazonaws.wellarchitected#SelectedChoices" }, "ChoiceUpdates": { "target": "com.amazonaws.wellarchitected#ChoiceUpdates", "traits": { "smithy.api#documentation": "

A list of choices to be updated.

" } }, "Notes": { "target": "com.amazonaws.wellarchitected#Notes" }, "IsApplicable": { "target": "com.amazonaws.wellarchitected#IsApplicable" }, "Reason": { "target": "com.amazonaws.wellarchitected#AnswerReason", "traits": { "smithy.api#documentation": "

The update reason.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.wellarchitected#UpdateReviewTemplateAnswerOutput": { "type": "structure", "members": { "TemplateArn": { "target": "com.amazonaws.wellarchitected#TemplateArn", "traits": { "smithy.api#documentation": "

The review template ARN.

" } }, "LensAlias": { "target": "com.amazonaws.wellarchitected#LensAlias" }, "Answer": { "target": "com.amazonaws.wellarchitected#ReviewTemplateAnswer", "traits": { "smithy.api#documentation": "

An answer of the question.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.wellarchitected#UpdateReviewTemplateInput": { "type": "structure", "members": { "TemplateArn": { "target": "com.amazonaws.wellarchitected#TemplateArn", "traits": { "smithy.api#documentation": "

The review template ARN.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "TemplateName": { "target": "com.amazonaws.wellarchitected#TemplateName", "traits": { "smithy.api#documentation": "

The review template name.

" } }, "Description": { "target": "com.amazonaws.wellarchitected#TemplateDescription", "traits": { "smithy.api#documentation": "

The review template description.

" } }, "Notes": { "target": "com.amazonaws.wellarchitected#Notes" }, "LensesToAssociate": { "target": "com.amazonaws.wellarchitected#ReviewTemplateLensAliases", "traits": { "smithy.api#documentation": "

A list of lens aliases or ARNs to apply to the review template.

" } }, "LensesToDisassociate": { "target": "com.amazonaws.wellarchitected#ReviewTemplateLensAliases", "traits": { "smithy.api#documentation": "

A list of lens aliases or ARNs to unapply to the review template. The wellarchitected lens cannot be unapplied.

" } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.wellarchitected#UpdateReviewTemplateLensReview": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#UpdateReviewTemplateLensReviewInput" }, "output": { "target": "com.amazonaws.wellarchitected#UpdateReviewTemplateLensReviewOutput" }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" }, { "target": "com.amazonaws.wellarchitected#ConflictException" }, { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, { "target": "com.amazonaws.wellarchitected#ValidationException" } ], "traits": { "smithy.api#documentation": "

Update a lens review associated with a review template.

", "smithy.api#http": { "method": "PATCH", "uri": "/reviewTemplates/{TemplateArn}/lensReviews/{LensAlias}", "code": 200 }, "smithy.api#tags": [ "WA" ] } }, "com.amazonaws.wellarchitected#UpdateReviewTemplateLensReviewInput": { "type": "structure", "members": { "TemplateArn": { "target": "com.amazonaws.wellarchitected#TemplateArn", "traits": { "smithy.api#documentation": "

The review template ARN.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "LensAlias": { "target": "com.amazonaws.wellarchitected#LensAlias", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "LensNotes": { "target": "com.amazonaws.wellarchitected#Notes" }, "PillarNotes": { "target": "com.amazonaws.wellarchitected#PillarNotes" } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.wellarchitected#UpdateReviewTemplateLensReviewOutput": { "type": "structure", "members": { "TemplateArn": { "target": "com.amazonaws.wellarchitected#TemplateArn", "traits": { "smithy.api#documentation": "

The review template ARN.

" } }, "LensReview": { "target": "com.amazonaws.wellarchitected#ReviewTemplateLensReview", "traits": { "smithy.api#documentation": "

A lens review of a question.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.wellarchitected#UpdateReviewTemplateOutput": { "type": "structure", "members": { "ReviewTemplate": { "target": "com.amazonaws.wellarchitected#ReviewTemplate", "traits": { "smithy.api#documentation": "

A review template.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.wellarchitected#UpdateShareInvitation": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#UpdateShareInvitationInput" }, "output": { "target": "com.amazonaws.wellarchitected#UpdateShareInvitationOutput" }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" }, { "target": "com.amazonaws.wellarchitected#ConflictException" }, { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, { "target": "com.amazonaws.wellarchitected#ValidationException" } ], "traits": { "smithy.api#documentation": "

Update a workload or custom lens share invitation.

This API operation can be called independently of any resource. Previous documentation implied that a workload ARN must be specified.

", "smithy.api#http": { "method": "PATCH", "uri": "/shareInvitations/{ShareInvitationId}", "code": 200 }, "smithy.api#tags": [ "WA" ] } }, "com.amazonaws.wellarchitected#UpdateShareInvitationInput": { "type": "structure", "members": { "ShareInvitationId": { "target": "com.amazonaws.wellarchitected#ShareInvitationId", "traits": { "smithy.api#documentation": "

The ID assigned to the share invitation.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "ShareInvitationAction": { "target": "com.amazonaws.wellarchitected#ShareInvitationAction", "traits": { "smithy.api#clientOptional": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Input for Update Share Invitation

", "smithy.api#input": {} } }, "com.amazonaws.wellarchitected#UpdateShareInvitationOutput": { "type": "structure", "members": { "ShareInvitation": { "target": "com.amazonaws.wellarchitected#ShareInvitation", "traits": { "smithy.api#documentation": "

The updated workload or custom lens share invitation.

" } } }, "traits": { "smithy.api#output": {} } }, "com.amazonaws.wellarchitected#UpdateWorkload": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#UpdateWorkloadInput" }, "output": { "target": "com.amazonaws.wellarchitected#UpdateWorkloadOutput" }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" }, { "target": "com.amazonaws.wellarchitected#ConflictException" }, { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, { "target": "com.amazonaws.wellarchitected#ValidationException" } ], "traits": { "smithy.api#documentation": "

Update an existing workload.

", "smithy.api#http": { "method": "PATCH", "uri": "/workloads/{WorkloadId}", "code": 200 }, "smithy.api#tags": [ "WA" ] } }, "com.amazonaws.wellarchitected#UpdateWorkloadInput": { "type": "structure", "members": { "WorkloadId": { "target": "com.amazonaws.wellarchitected#WorkloadId", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "WorkloadName": { "target": "com.amazonaws.wellarchitected#WorkloadName" }, "Description": { "target": "com.amazonaws.wellarchitected#WorkloadDescription" }, "Environment": { "target": "com.amazonaws.wellarchitected#WorkloadEnvironment" }, "AccountIds": { "target": "com.amazonaws.wellarchitected#WorkloadAccountIds" }, "AwsRegions": { "target": "com.amazonaws.wellarchitected#WorkloadAwsRegions" }, "NonAwsRegions": { "target": "com.amazonaws.wellarchitected#WorkloadNonAwsRegions" }, "PillarPriorities": { "target": "com.amazonaws.wellarchitected#WorkloadPillarPriorities" }, "ArchitecturalDesign": { "target": "com.amazonaws.wellarchitected#WorkloadArchitecturalDesign" }, "ReviewOwner": { "target": "com.amazonaws.wellarchitected#WorkloadReviewOwner" }, "IsReviewOwnerUpdateAcknowledged": { "target": "com.amazonaws.wellarchitected#IsReviewOwnerUpdateAcknowledged", "traits": { "smithy.api#documentation": "

Flag indicating whether the workload owner has acknowledged that the Review owner field is required.

If a Review owner is not added to the workload within 60 days of acknowledgement, access to the workload is restricted until an owner is added.

" } }, "IndustryType": { "target": "com.amazonaws.wellarchitected#WorkloadIndustryType" }, "Industry": { "target": "com.amazonaws.wellarchitected#WorkloadIndustry" }, "Notes": { "target": "com.amazonaws.wellarchitected#Notes" }, "ImprovementStatus": { "target": "com.amazonaws.wellarchitected#WorkloadImprovementStatus" }, "DiscoveryConfig": { "target": "com.amazonaws.wellarchitected#WorkloadDiscoveryConfig", "traits": { "smithy.api#documentation": "

Well-Architected discovery configuration settings to associate to the workload.

" } }, "Applications": { "target": "com.amazonaws.wellarchitected#WorkloadApplications", "traits": { "smithy.api#documentation": "

List of AppRegistry application ARNs to associate to the workload.

" } }, "JiraConfiguration": { "target": "com.amazonaws.wellarchitected#WorkloadJiraConfigurationInput", "traits": { "smithy.api#documentation": "

Configuration of the Jira integration.

" } } }, "traits": { "smithy.api#documentation": "

Input to update a workload.

", "smithy.api#input": {} } }, "com.amazonaws.wellarchitected#UpdateWorkloadOutput": { "type": "structure", "members": { "Workload": { "target": "com.amazonaws.wellarchitected#Workload" } }, "traits": { "smithy.api#documentation": "

Output of an update workload call.

", "smithy.api#output": {} } }, "com.amazonaws.wellarchitected#UpdateWorkloadShare": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#UpdateWorkloadShareInput" }, "output": { "target": "com.amazonaws.wellarchitected#UpdateWorkloadShareOutput" }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" }, { "target": "com.amazonaws.wellarchitected#ConflictException" }, { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, { "target": "com.amazonaws.wellarchitected#ValidationException" } ], "traits": { "smithy.api#documentation": "

Update a workload share.

", "smithy.api#http": { "method": "PATCH", "uri": "/workloads/{WorkloadId}/shares/{ShareId}", "code": 200 }, "smithy.api#tags": [ "WA" ] } }, "com.amazonaws.wellarchitected#UpdateWorkloadShareInput": { "type": "structure", "members": { "ShareId": { "target": "com.amazonaws.wellarchitected#ShareId", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "WorkloadId": { "target": "com.amazonaws.wellarchitected#WorkloadId", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "PermissionType": { "target": "com.amazonaws.wellarchitected#PermissionType", "traits": { "smithy.api#clientOptional": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Input for Update Workload Share

", "smithy.api#input": {} } }, "com.amazonaws.wellarchitected#UpdateWorkloadShareOutput": { "type": "structure", "members": { "WorkloadId": { "target": "com.amazonaws.wellarchitected#WorkloadId" }, "WorkloadShare": { "target": "com.amazonaws.wellarchitected#WorkloadShare" } }, "traits": { "smithy.api#documentation": "

Input for Update Workload Share

", "smithy.api#output": {} } }, "com.amazonaws.wellarchitected#UpgradeLensReview": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#UpgradeLensReviewInput" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" }, { "target": "com.amazonaws.wellarchitected#ConflictException" }, { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" }, { "target": "com.amazonaws.wellarchitected#ServiceQuotaExceededException" }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, { "target": "com.amazonaws.wellarchitected#ValidationException" } ], "traits": { "smithy.api#documentation": "

Upgrade lens review for a particular workload.

", "smithy.api#http": { "method": "PUT", "uri": "/workloads/{WorkloadId}/lensReviews/{LensAlias}/upgrade", "code": 200 }, "smithy.api#tags": [ "WA" ] } }, "com.amazonaws.wellarchitected#UpgradeLensReviewInput": { "type": "structure", "members": { "WorkloadId": { "target": "com.amazonaws.wellarchitected#WorkloadId", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "LensAlias": { "target": "com.amazonaws.wellarchitected#LensAlias", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "MilestoneName": { "target": "com.amazonaws.wellarchitected#MilestoneName", "traits": { "smithy.api#clientOptional": {}, "smithy.api#required": {} } }, "ClientRequestToken": { "target": "com.amazonaws.wellarchitected#ClientRequestToken" } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.wellarchitected#UpgradeProfileVersion": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#UpgradeProfileVersionInput" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" }, { "target": "com.amazonaws.wellarchitected#ConflictException" }, { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" }, { "target": "com.amazonaws.wellarchitected#ServiceQuotaExceededException" }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, { "target": "com.amazonaws.wellarchitected#ValidationException" } ], "traits": { "smithy.api#documentation": "

Upgrade a profile.

", "smithy.api#http": { "method": "PUT", "uri": "/workloads/{WorkloadId}/profiles/{ProfileArn}/upgrade", "code": 200 }, "smithy.api#tags": [ "WA" ] } }, "com.amazonaws.wellarchitected#UpgradeProfileVersionInput": { "type": "structure", "members": { "WorkloadId": { "target": "com.amazonaws.wellarchitected#WorkloadId", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "ProfileArn": { "target": "com.amazonaws.wellarchitected#ProfileArn", "traits": { "smithy.api#documentation": "

The profile ARN.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "MilestoneName": { "target": "com.amazonaws.wellarchitected#MilestoneName" }, "ClientRequestToken": { "target": "com.amazonaws.wellarchitected#ClientRequestToken", "traits": { "smithy.api#idempotencyToken": {} } } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.wellarchitected#UpgradeReviewTemplateLensReview": { "type": "operation", "input": { "target": "com.amazonaws.wellarchitected#UpgradeReviewTemplateLensReviewInput" }, "output": { "target": "smithy.api#Unit" }, "errors": [ { "target": "com.amazonaws.wellarchitected#AccessDeniedException" }, { "target": "com.amazonaws.wellarchitected#ConflictException" }, { "target": "com.amazonaws.wellarchitected#InternalServerException" }, { "target": "com.amazonaws.wellarchitected#ResourceNotFoundException" }, { "target": "com.amazonaws.wellarchitected#ThrottlingException" }, { "target": "com.amazonaws.wellarchitected#ValidationException" } ], "traits": { "smithy.api#documentation": "

Upgrade the lens review of a review template.

", "smithy.api#http": { "method": "PUT", "uri": "/reviewTemplates/{TemplateArn}/lensReviews/{LensAlias}/upgrade", "code": 200 }, "smithy.api#tags": [ "WA" ] } }, "com.amazonaws.wellarchitected#UpgradeReviewTemplateLensReviewInput": { "type": "structure", "members": { "TemplateArn": { "target": "com.amazonaws.wellarchitected#TemplateArn", "traits": { "smithy.api#documentation": "

The ARN of the review template.

", "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "LensAlias": { "target": "com.amazonaws.wellarchitected#LensAlias", "traits": { "smithy.api#httpLabel": {}, "smithy.api#required": {} } }, "ClientRequestToken": { "target": "com.amazonaws.wellarchitected#ClientRequestToken" } }, "traits": { "smithy.api#input": {} } }, "com.amazonaws.wellarchitected#Urls": { "type": "list", "member": { "target": "com.amazonaws.wellarchitected#ChoiceContent" } }, "com.amazonaws.wellarchitected#ValidationException": { "type": "structure", "members": { "Message": { "target": "com.amazonaws.wellarchitected#ExceptionMessage", "traits": { "smithy.api#clientOptional": {}, "smithy.api#required": {} } }, "Reason": { "target": "com.amazonaws.wellarchitected#ValidationExceptionReason" }, "Fields": { "target": "com.amazonaws.wellarchitected#ValidationExceptionFieldList" } }, "traits": { "smithy.api#documentation": "

The user input is not valid.

", "smithy.api#error": "client", "smithy.api#httpError": 400 } }, "com.amazonaws.wellarchitected#ValidationExceptionField": { "type": "structure", "members": { "Name": { "target": "com.amazonaws.wellarchitected#ValidationExceptionFieldName", "traits": { "smithy.api#clientOptional": {}, "smithy.api#required": {} } }, "Message": { "target": "com.amazonaws.wellarchitected#ExceptionMessage", "traits": { "smithy.api#clientOptional": {}, "smithy.api#required": {} } } }, "traits": { "smithy.api#documentation": "

Stores information about a field passed inside a request that resulted in an exception.

" } }, "com.amazonaws.wellarchitected#ValidationExceptionFieldList": { "type": "list", "member": { "target": "com.amazonaws.wellarchitected#ValidationExceptionField" }, "traits": { "smithy.api#documentation": "

The fields that caused the error, if applicable.

" } }, "com.amazonaws.wellarchitected#ValidationExceptionFieldName": { "type": "string", "traits": { "smithy.api#documentation": "

The field name for which validation failed.

" } }, "com.amazonaws.wellarchitected#ValidationExceptionReason": { "type": "enum", "members": { "UNKNOWN_OPERATION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "UNKNOWN_OPERATION" } }, "CANNOT_PARSE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "CANNOT_PARSE" } }, "FIELD_VALIDATION_FAILED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "FIELD_VALIDATION_FAILED" } }, "OTHER": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "OTHER" } } }, "traits": { "smithy.api#documentation": "

The reason why the request failed validation.

" } }, "com.amazonaws.wellarchitected#VersionDifferences": { "type": "structure", "members": { "PillarDifferences": { "target": "com.amazonaws.wellarchitected#PillarDifferences", "traits": { "smithy.api#documentation": "

The differences between the base and latest versions of the lens.

" } } }, "traits": { "smithy.api#documentation": "

The differences between the base and latest versions of the lens.

" } }, "com.amazonaws.wellarchitected#WellArchitectedApiServiceLambda": { "type": "service", "version": "2020-03-31", "operations": [ { "target": "com.amazonaws.wellarchitected#AssociateLenses" }, { "target": "com.amazonaws.wellarchitected#AssociateProfiles" }, { "target": "com.amazonaws.wellarchitected#CreateAgentBasicProfile" }, { "target": "com.amazonaws.wellarchitected#CreateAgentContext" }, { "target": "com.amazonaws.wellarchitected#CreateAgentGoal" }, { "target": "com.amazonaws.wellarchitected#CreateAgentOrganizationalProfile" }, { "target": "com.amazonaws.wellarchitected#CreateAgentOrganizationalReport" }, { "target": "com.amazonaws.wellarchitected#CreateAgentProfile" }, { "target": "com.amazonaws.wellarchitected#CreateLensShare" }, { "target": "com.amazonaws.wellarchitected#CreateLensVersion" }, { "target": "com.amazonaws.wellarchitected#CreateMilestone" }, { "target": "com.amazonaws.wellarchitected#CreateProfile" }, { "target": "com.amazonaws.wellarchitected#CreateProfileShare" }, { "target": "com.amazonaws.wellarchitected#CreateReviewTemplate" }, { "target": "com.amazonaws.wellarchitected#CreateTemplateShare" }, { "target": "com.amazonaws.wellarchitected#CreateWorkload" }, { "target": "com.amazonaws.wellarchitected#CreateWorkloadShare" }, { "target": "com.amazonaws.wellarchitected#DeleteAgentContext" }, { "target": "com.amazonaws.wellarchitected#DeleteAgentGoal" }, { "target": "com.amazonaws.wellarchitected#DeleteAgentOrganizationalReport" }, { "target": "com.amazonaws.wellarchitected#DeleteAgentProfile" }, { "target": "com.amazonaws.wellarchitected#DeleteAgentProfilePolicy" }, { "target": "com.amazonaws.wellarchitected#DeleteAgentRecommendationPolicy" }, { "target": "com.amazonaws.wellarchitected#DeleteLens" }, { "target": "com.amazonaws.wellarchitected#DeleteLensShare" }, { "target": "com.amazonaws.wellarchitected#DeleteProfile" }, { "target": "com.amazonaws.wellarchitected#DeleteProfileShare" }, { "target": "com.amazonaws.wellarchitected#DeleteReviewTemplate" }, { "target": "com.amazonaws.wellarchitected#DeleteTemplateShare" }, { "target": "com.amazonaws.wellarchitected#DeleteWorkload" }, { "target": "com.amazonaws.wellarchitected#DeleteWorkloadShare" }, { "target": "com.amazonaws.wellarchitected#DisassociateLenses" }, { "target": "com.amazonaws.wellarchitected#DisassociateProfiles" }, { "target": "com.amazonaws.wellarchitected#ExportLens" }, { "target": "com.amazonaws.wellarchitected#GetAgentContext" }, { "target": "com.amazonaws.wellarchitected#GetAgentGoal" }, { "target": "com.amazonaws.wellarchitected#GetAgentOrganizationalReport" }, { "target": "com.amazonaws.wellarchitected#GetAgentOrganizationalReportData" }, { "target": "com.amazonaws.wellarchitected#GetAgentPreferences" }, { "target": "com.amazonaws.wellarchitected#GetAgentProfile" }, { "target": "com.amazonaws.wellarchitected#GetAgentProfilePolicy" }, { "target": "com.amazonaws.wellarchitected#GetAgentRecommendation" }, { "target": "com.amazonaws.wellarchitected#GetAgentRecommendationGeneration" }, { "target": "com.amazonaws.wellarchitected#GetAgentRecommendationPolicy" }, { "target": "com.amazonaws.wellarchitected#GetAnswer" }, { "target": "com.amazonaws.wellarchitected#GetConsolidatedReport" }, { "target": "com.amazonaws.wellarchitected#GetGlobalSettings" }, { "target": "com.amazonaws.wellarchitected#GetLens" }, { "target": "com.amazonaws.wellarchitected#GetLensReview" }, { "target": "com.amazonaws.wellarchitected#GetLensReviewReport" }, { "target": "com.amazonaws.wellarchitected#GetLensVersionDifference" }, { "target": "com.amazonaws.wellarchitected#GetMilestone" }, { "target": "com.amazonaws.wellarchitected#GetProfile" }, { "target": "com.amazonaws.wellarchitected#GetProfileTemplate" }, { "target": "com.amazonaws.wellarchitected#GetReviewTemplate" }, { "target": "com.amazonaws.wellarchitected#GetReviewTemplateAnswer" }, { "target": "com.amazonaws.wellarchitected#GetReviewTemplateLensReview" }, { "target": "com.amazonaws.wellarchitected#GetWorkload" }, { "target": "com.amazonaws.wellarchitected#ImportLens" }, { "target": "com.amazonaws.wellarchitected#ListAgentContexts" }, { "target": "com.amazonaws.wellarchitected#ListAgentGoals" }, { "target": "com.amazonaws.wellarchitected#ListAgentOrganizationalReports" }, { "target": "com.amazonaws.wellarchitected#ListAgentProfiles" }, { "target": "com.amazonaws.wellarchitected#ListAgentRecommendationGenerations" }, { "target": "com.amazonaws.wellarchitected#ListAgentRecommendationItems" }, { "target": "com.amazonaws.wellarchitected#ListAgentRecommendations" }, { "target": "com.amazonaws.wellarchitected#ListAnswers" }, { "target": "com.amazonaws.wellarchitected#ListCheckDetails" }, { "target": "com.amazonaws.wellarchitected#ListCheckSummaries" }, { "target": "com.amazonaws.wellarchitected#ListLenses" }, { "target": "com.amazonaws.wellarchitected#ListLensReviewImprovements" }, { "target": "com.amazonaws.wellarchitected#ListLensReviews" }, { "target": "com.amazonaws.wellarchitected#ListLensShares" }, { "target": "com.amazonaws.wellarchitected#ListMilestones" }, { "target": "com.amazonaws.wellarchitected#ListNotifications" }, { "target": "com.amazonaws.wellarchitected#ListProfileNotifications" }, { "target": "com.amazonaws.wellarchitected#ListProfiles" }, { "target": "com.amazonaws.wellarchitected#ListProfileShares" }, { "target": "com.amazonaws.wellarchitected#ListReviewTemplateAnswers" }, { "target": "com.amazonaws.wellarchitected#ListReviewTemplates" }, { "target": "com.amazonaws.wellarchitected#ListShareInvitations" }, { "target": "com.amazonaws.wellarchitected#ListTagsForResource" }, { "target": "com.amazonaws.wellarchitected#ListTemplateShares" }, { "target": "com.amazonaws.wellarchitected#ListWorkloads" }, { "target": "com.amazonaws.wellarchitected#ListWorkloadShares" }, { "target": "com.amazonaws.wellarchitected#PutAgentPreferences" }, { "target": "com.amazonaws.wellarchitected#PutAgentProfilePolicy" }, { "target": "com.amazonaws.wellarchitected#PutAgentRecommendationFeedback" }, { "target": "com.amazonaws.wellarchitected#PutAgentRecommendationPolicy" }, { "target": "com.amazonaws.wellarchitected#SendAgentOrganizationalReportDataToS3" }, { "target": "com.amazonaws.wellarchitected#StartAgentRecommendationGeneration" }, { "target": "com.amazonaws.wellarchitected#TagResource" }, { "target": "com.amazonaws.wellarchitected#UntagResource" }, { "target": "com.amazonaws.wellarchitected#UpdateAgentContext" }, { "target": "com.amazonaws.wellarchitected#UpdateAgentGoal" }, { "target": "com.amazonaws.wellarchitected#UpdateAgentOrganizationalProfile" }, { "target": "com.amazonaws.wellarchitected#UpdateAgentProfile" }, { "target": "com.amazonaws.wellarchitected#UpdateAgentRecommendationStatus" }, { "target": "com.amazonaws.wellarchitected#UpdateAnswer" }, { "target": "com.amazonaws.wellarchitected#UpdateGlobalSettings" }, { "target": "com.amazonaws.wellarchitected#UpdateIntegration" }, { "target": "com.amazonaws.wellarchitected#UpdateLensReview" }, { "target": "com.amazonaws.wellarchitected#UpdateProfile" }, { "target": "com.amazonaws.wellarchitected#UpdateReviewTemplate" }, { "target": "com.amazonaws.wellarchitected#UpdateReviewTemplateAnswer" }, { "target": "com.amazonaws.wellarchitected#UpdateReviewTemplateLensReview" }, { "target": "com.amazonaws.wellarchitected#UpdateShareInvitation" }, { "target": "com.amazonaws.wellarchitected#UpdateWorkload" }, { "target": "com.amazonaws.wellarchitected#UpdateWorkloadShare" }, { "target": "com.amazonaws.wellarchitected#UpgradeLensReview" }, { "target": "com.amazonaws.wellarchitected#UpgradeProfileVersion" }, { "target": "com.amazonaws.wellarchitected#UpgradeReviewTemplateLensReview" } ], "traits": { "aws.api#service": { "sdkId": "WellArchitected", "arnNamespace": "wellarchitected", "cloudFormationName": "WellArchitected", "cloudTrailEventSource": "wellarchitected.amazonaws.com", "endpointPrefix": "wellarchitected" }, "aws.auth#sigv4": { "name": "wellarchitected" }, "aws.endpoints#rulesBasedEndpoints": {}, "aws.endpoints#standardRegionalEndpoints": {}, "aws.protocols#restJson1": {}, "smithy.api#documentation": "Amazon Web Services Well-Architected

This is the Amazon Web Services Well-Architected API Reference. Amazon Web Services Well-Architected helps you evaluate your architectures against Amazon Web Services best practices across operational excellence, security, reliability, performance efficiency, cost optimization, and sustainability.

To view API actions organized by service, see API actions.

Amazon Web Services Well-Architected Agent (preview)

Describes the API operations for managing optimization profiles, goals, application context, and recommendations in the Amazon Web Services Well-Architected Agent. Through this API, you can create and configure agent profiles that define the scope of your Amazon Web Services environment to analyze, set optimization goals across cost, security, performance, and resilience pillars, start recommendation generation, retrieve prioritized recommendations with ready-to-deploy remediation scripts, and provide feedback to improve future recommendations.

For more information, see What is Amazon Web Services Well-Architected Agent?

Well-Architected Tool

Describes the API operations for creating and managing workloads, conducting lens reviews, tracking milestones, managing custom lenses, sharing workloads across accounts, and managing profiles with the Well-Architected Tool.

For more information, see What is Well-Architected Tool?

", "smithy.api#title": "AWS Well-Architected Tool", "smithy.rules#endpointBdd": { "version": "1.1", "parameters": { "UseDualStack": { "builtIn": "AWS::UseDualStack", "required": true, "default": false, "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", "type": "boolean" }, "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" }, "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" }, "SubServiceType": { "required": false, "documentation": "Identifies the sub-service used for endpoint routing. This value is set automatically per operation and is not client-configurable. It is unset for Well-Architected Tool operations. It is AGENT for Well-Architected Agent operations, which resolve to the wellarchitected-agent endpoint.", "type": "string" } }, "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] }, { "fn": "isSet", "argv": [ { "ref": "Region" } ] }, { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" }, { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] }, { "fn": "isSet", "argv": [ { "ref": "SubServiceType" } ] }, { "fn": "stringEquals", "argv": [ { "ref": "SubServiceType" }, "AGENT" ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] }, { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] }, true ] } ], "results": [ { "conditions": [], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [], "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://wellarchitected-agent-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "wellarchitected", "signingRegion": "{Region}" } ] }, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://wellarchitected-agent-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "wellarchitected", "signingRegion": "{Region}" } ] }, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://wellarchitected-agent.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "wellarchitected", "signingRegion": "{Region}" } ] }, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" }, { "conditions": [], "endpoint": { "url": "https://wellarchitected-agent.{Region}.{PartitionResult#dnsSuffix}", "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "wellarchitected", "signingRegion": "{Region}" } ] }, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://wellarchitected-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://wellarchitected-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://wellarchitected.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "endpoint": { "url": "https://wellarchitected.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ], "root": 2, "nodeCount": 21, "nodes": "/////wAAAAH/////AAAAAAAAABQAAAADAAAAAQAAAAQF9eEPAAAAAgAAAAUF9eEPAAAAAwAAAAwAAAAGAAAABQAAAAcAAAAIAAAABgAAAAoAAAAIAAAABwAAAAkF9eEOAAAACAX14Q0F9eEJAAAABwAAAAsF9eEKAAAACAX14QgF9eEJAAAABAAAAA4AAAANAAAABwX14QUF9eEHAAAABQAAAA8AAAAQAAAABgAAABIAAAAQAAAABwAAABEF9eEMAAAACAX14QsF9eEFAAAABwAAABMF9eEGAAAACAX14QQF9eEFAAAAAwX14QEAAAAVAAAABwX14QIF9eED" }, "smithy.rules#endpointRuleSet": { "version": "1.0", "parameters": { "UseDualStack": { "builtIn": "AWS::UseDualStack", "required": true, "default": false, "documentation": "When true, use the dual-stack endpoint. If the configured endpoint does not support dual-stack, dispatching the request MAY return an error.", "type": "boolean" }, "UseFIPS": { "builtIn": "AWS::UseFIPS", "required": true, "default": false, "documentation": "When true, send this request to the FIPS-compliant regional endpoint. If the configured endpoint does not have a FIPS compliant endpoint, dispatching the request will return an error.", "type": "boolean" }, "Endpoint": { "builtIn": "SDK::Endpoint", "required": false, "documentation": "Override the endpoint used to send this request", "type": "string" }, "Region": { "builtIn": "AWS::Region", "required": false, "documentation": "The AWS region used to dispatch the request.", "type": "string" }, "SubServiceType": { "required": false, "documentation": "Identifies the sub-service used for endpoint routing. This value is set automatically per operation and is not client-configurable. It is unset for Well-Architected Tool operations. It is AGENT for Well-Architected Agent operations, which resolve to the wellarchitected-agent endpoint.", "type": "string" } }, "rules": [ { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Endpoint" } ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] } ], "error": "Invalid Configuration: FIPS and custom endpoint are not supported", "type": "error" }, { "conditions": [], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "error": "Invalid Configuration: Dualstack and custom endpoint are not supported", "type": "error" }, { "conditions": [], "endpoint": { "url": { "ref": "Endpoint" }, "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" }, { "documentation": "Route AGENT operations to wellarchitected-agent endpoint", "conditions": [ { "fn": "isSet", "argv": [ { "ref": "SubServiceType" } ] }, { "fn": "stringEquals", "argv": [ { "ref": "SubServiceType" }, "AGENT" ] }, { "fn": "isSet", "argv": [ { "ref": "Region" } ] }, { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] }, { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] }, true ] } ], "endpoint": { "url": "https://wellarchitected-agent-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "wellarchitected", "signingRegion": "{Region}" } ] }, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, false ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "endpoint": { "url": "https://wellarchitected-agent-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "wellarchitected", "signingRegion": "{Region}" } ] }, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, false ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] }, true ] } ], "endpoint": { "url": "https://wellarchitected-agent.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "wellarchitected", "signingRegion": "{Region}" } ] }, "headers": {} }, "type": "endpoint" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" } ], "type": "tree" }, { "conditions": [], "endpoint": { "url": "https://wellarchitected-agent.{Region}.{PartitionResult#dnsSuffix}", "properties": { "authSchemes": [ { "name": "sigv4", "signingName": "wellarchitected", "signingRegion": "{Region}" } ] }, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "rules": [ { "conditions": [ { "fn": "isSet", "argv": [ { "ref": "Region" } ] } ], "rules": [ { "conditions": [ { "fn": "aws.partition", "argv": [ { "ref": "Region" } ], "assign": "PartitionResult" } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] } ] }, { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] } ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://wellarchitected-fips.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "FIPS and DualStack are enabled, but this partition does not support one or both", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, true ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, false ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsFIPS" ] }, true ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://wellarchitected-fips.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "FIPS is enabled but this partition does not support FIPS", "type": "error" } ], "type": "tree" }, { "conditions": [ { "fn": "booleanEquals", "argv": [ { "ref": "UseFIPS" }, false ] }, { "fn": "booleanEquals", "argv": [ { "ref": "UseDualStack" }, true ] } ], "rules": [ { "conditions": [ { "fn": "booleanEquals", "argv": [ true, { "fn": "getAttr", "argv": [ { "ref": "PartitionResult" }, "supportsDualStack" ] } ] } ], "rules": [ { "conditions": [], "endpoint": { "url": "https://wellarchitected.{Region}.{PartitionResult#dualStackDnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" }, { "conditions": [], "error": "DualStack is enabled but this partition does not support DualStack", "type": "error" } ], "type": "tree" }, { "conditions": [], "endpoint": { "url": "https://wellarchitected.{Region}.{PartitionResult#dnsSuffix}", "properties": {}, "headers": {} }, "type": "endpoint" } ], "type": "tree" } ], "type": "tree" }, { "conditions": [], "error": "Invalid Configuration: Missing Region", "type": "error" } ], "type": "tree" } ] }, "smithy.rules#endpointTests": { "testCases": [ { "documentation": "For custom endpoint with region not set and fips disabled", "expect": { "endpoint": { "url": "https://example.com" } }, "params": { "Endpoint": "https://example.com", "UseFIPS": false } }, { "documentation": "For custom endpoint with fips enabled", "expect": { "error": "Invalid Configuration: FIPS and custom endpoint are not supported" }, "params": { "Endpoint": "https://example.com", "UseFIPS": true } }, { "documentation": "For custom endpoint with fips disabled and dualstack enabled", "expect": { "error": "Invalid Configuration: Dualstack and custom endpoint are not supported" }, "params": { "Endpoint": "https://example.com", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region us-east-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://wellarchitected-fips.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region us-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://wellarchitected-fips.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://wellarchitected.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region us-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://wellarchitected.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region cn-northwest-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://wellarchitected-fips.cn-northwest-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-northwest-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region cn-northwest-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://wellarchitected-fips.cn-northwest-1.amazonaws.com.cn" } }, "params": { "Region": "cn-northwest-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://wellarchitected.cn-northwest-1.api.amazonwebservices.com.cn" } }, "params": { "Region": "cn-northwest-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region cn-northwest-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://wellarchitected.cn-northwest-1.amazonaws.com.cn" } }, "params": { "Region": "cn-northwest-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eusc-de-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://wellarchitected-fips.eusc-de-east-1.amazonaws.eu" } }, "params": { "Region": "eusc-de-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region eusc-de-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://wellarchitected.eusc-de-east-1.amazonaws.eu" } }, "params": { "Region": "eusc-de-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-iso-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://wellarchitected-fips.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-iso-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://wellarchitected.us-iso-east-1.c2s.ic.gov" } }, "params": { "Region": "us-iso-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-isob-east-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://wellarchitected-fips.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-isob-east-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://wellarchitected.us-isob-east-1.sc2s.sgov.gov" } }, "params": { "Region": "us-isob-east-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region eu-isoe-west-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://wellarchitected-fips.eu-isoe-west-1.cloud.adc-e.uk" } }, "params": { "Region": "eu-isoe-west-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region eu-isoe-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://wellarchitected.eu-isoe-west-1.cloud.adc-e.uk" } }, "params": { "Region": "eu-isoe-west-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-isof-south-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://wellarchitected-fips.us-isof-south-1.csp.hci.ic.gov" } }, "params": { "Region": "us-isof-south-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-isof-south-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://wellarchitected.us-isof-south-1.csp.hci.ic.gov" } }, "params": { "Region": "us-isof-south-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack enabled", "expect": { "endpoint": { "url": "https://wellarchitected-fips.us-gov-west-1.api.aws" } }, "params": { "Region": "us-gov-west-1", "UseFIPS": true, "UseDualStack": true } }, { "documentation": "For region us-gov-west-1 with FIPS enabled and DualStack disabled", "expect": { "endpoint": { "url": "https://wellarchitected-fips.us-gov-west-1.amazonaws.com" } }, "params": { "Region": "us-gov-west-1", "UseFIPS": true, "UseDualStack": false } }, { "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack enabled", "expect": { "endpoint": { "url": "https://wellarchitected.us-gov-west-1.api.aws" } }, "params": { "Region": "us-gov-west-1", "UseFIPS": false, "UseDualStack": true } }, { "documentation": "For region us-gov-west-1 with FIPS disabled and DualStack disabled", "expect": { "endpoint": { "url": "https://wellarchitected.us-gov-west-1.amazonaws.com" } }, "params": { "Region": "us-gov-west-1", "UseFIPS": false, "UseDualStack": false } }, { "documentation": "Missing region", "expect": { "error": "Invalid Configuration: Missing Region" } }, { "documentation": "AGENT case: standard region, no FIPS, no DualStack -> amazonaws.com", "expect": { "endpoint": { "properties": { "authSchemes": [ { "signingRegion": "us-east-1", "name": "sigv4", "signingName": "wellarchitected" } ] }, "url": "https://wellarchitected-agent.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "SubServiceType": "AGENT" } }, { "documentation": "AGENT case: FIPS enabled -> amazonaws.com with -fips", "expect": { "endpoint": { "properties": { "authSchemes": [ { "signingRegion": "us-east-1", "name": "sigv4", "signingName": "wellarchitected" } ] }, "url": "https://wellarchitected-agent-fips.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": false, "SubServiceType": "AGENT" } }, { "documentation": "AGENT case: DualStack enabled -> api.aws", "expect": { "endpoint": { "properties": { "authSchemes": [ { "signingRegion": "us-west-2", "name": "sigv4", "signingName": "wellarchitected" } ] }, "url": "https://wellarchitected-agent.us-west-2.api.aws" } }, "params": { "Region": "us-west-2", "UseFIPS": false, "UseDualStack": true, "SubServiceType": "AGENT" } }, { "documentation": "AGENT case: FIPS + DualStack -> api.aws with -fips", "expect": { "endpoint": { "properties": { "authSchemes": [ { "signingRegion": "us-east-1", "name": "sigv4", "signingName": "wellarchitected" } ] }, "url": "https://wellarchitected-agent-fips.us-east-1.api.aws" } }, "params": { "Region": "us-east-1", "UseFIPS": true, "UseDualStack": true, "SubServiceType": "AGENT" } }, { "documentation": "AGENT case: us-west-2 standard -> amazonaws.com", "expect": { "endpoint": { "properties": { "authSchemes": [ { "signingRegion": "us-west-2", "name": "sigv4", "signingName": "wellarchitected" } ] }, "url": "https://wellarchitected-agent.us-west-2.amazonaws.com" } }, "params": { "Region": "us-west-2", "UseFIPS": false, "UseDualStack": false, "SubServiceType": "AGENT" } }, { "documentation": "AGENT case: custom endpoint override still works", "expect": { "endpoint": { "url": "https://custom.endpoint.example.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "SubServiceType": "AGENT", "Endpoint": "https://custom.endpoint.example.com" } }, { "documentation": "Non-AGENT SubServiceType falls through to the base WA endpoint", "expect": { "endpoint": { "url": "https://wellarchitected.us-east-1.amazonaws.com" } }, "params": { "Region": "us-east-1", "UseFIPS": false, "UseDualStack": false, "SubServiceType": "SOMETHING-ELSE" } } ], "version": "1.0" } } }, "com.amazonaws.wellarchitected#Workload": { "type": "structure", "members": { "WorkloadId": { "target": "com.amazonaws.wellarchitected#WorkloadId" }, "WorkloadArn": { "target": "com.amazonaws.wellarchitected#WorkloadArn" }, "WorkloadName": { "target": "com.amazonaws.wellarchitected#WorkloadName" }, "Description": { "target": "com.amazonaws.wellarchitected#WorkloadDescription" }, "Environment": { "target": "com.amazonaws.wellarchitected#WorkloadEnvironment" }, "UpdatedAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The date and time when the workload was last updated.

" } }, "AccountIds": { "target": "com.amazonaws.wellarchitected#WorkloadAccountIds" }, "AwsRegions": { "target": "com.amazonaws.wellarchitected#WorkloadAwsRegions" }, "NonAwsRegions": { "target": "com.amazonaws.wellarchitected#WorkloadNonAwsRegions" }, "ArchitecturalDesign": { "target": "com.amazonaws.wellarchitected#WorkloadArchitecturalDesign" }, "ReviewOwner": { "target": "com.amazonaws.wellarchitected#WorkloadReviewOwner" }, "ReviewRestrictionDate": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The review restriction date for the workload.

" } }, "IsReviewOwnerUpdateAcknowledged": { "target": "com.amazonaws.wellarchitected#IsReviewOwnerUpdateAcknowledged", "traits": { "smithy.api#documentation": "

Flag indicating whether the workload owner has acknowledged that the Review owner field is required.

If a Review owner is not added to the workload within 60 days of acknowledgement, access to the workload is restricted until an owner is added.

" } }, "IndustryType": { "target": "com.amazonaws.wellarchitected#WorkloadIndustryType" }, "Industry": { "target": "com.amazonaws.wellarchitected#WorkloadIndustry" }, "Notes": { "target": "com.amazonaws.wellarchitected#Notes" }, "ImprovementStatus": { "target": "com.amazonaws.wellarchitected#WorkloadImprovementStatus" }, "RiskCounts": { "target": "com.amazonaws.wellarchitected#RiskCounts" }, "PillarPriorities": { "target": "com.amazonaws.wellarchitected#WorkloadPillarPriorities" }, "Lenses": { "target": "com.amazonaws.wellarchitected#WorkloadLenses" }, "Owner": { "target": "com.amazonaws.wellarchitected#AwsAccountId" }, "ShareInvitationId": { "target": "com.amazonaws.wellarchitected#ShareInvitationId", "traits": { "smithy.api#documentation": "

The ID assigned to the share invitation.

" } }, "Tags": { "target": "com.amazonaws.wellarchitected#TagMap", "traits": { "smithy.api#documentation": "

The tags associated with the workload.

" } }, "DiscoveryConfig": { "target": "com.amazonaws.wellarchitected#WorkloadDiscoveryConfig", "traits": { "smithy.api#documentation": "

Discovery configuration associated to the workload.

" } }, "Applications": { "target": "com.amazonaws.wellarchitected#WorkloadApplications", "traits": { "smithy.api#documentation": "

List of AppRegistry application ARNs associated to the workload.

" } }, "Profiles": { "target": "com.amazonaws.wellarchitected#WorkloadProfiles", "traits": { "smithy.api#documentation": "

Profile associated with a workload.

" } }, "PrioritizedRiskCounts": { "target": "com.amazonaws.wellarchitected#RiskCounts" }, "JiraConfiguration": { "target": "com.amazonaws.wellarchitected#WorkloadJiraConfigurationOutput", "traits": { "smithy.api#documentation": "

Jira configuration for a specific workload.

" } } }, "traits": { "smithy.api#documentation": "

A workload return object.

" } }, "com.amazonaws.wellarchitected#WorkloadAccountIds": { "type": "list", "member": { "target": "com.amazonaws.wellarchitected#AwsAccountId" }, "traits": { "smithy.api#documentation": "

The list of Amazon Web Services account IDs associated with the workload.

", "smithy.api#length": { "max": 100 } } }, "com.amazonaws.wellarchitected#WorkloadApplications": { "type": "list", "member": { "target": "com.amazonaws.wellarchitected#ApplicationArn" }, "traits": { "smithy.api#length": { "max": 1 } } }, "com.amazonaws.wellarchitected#WorkloadArchitecturalDesign": { "type": "string", "traits": { "smithy.api#documentation": "

The URL of the architectural design for the workload.

", "smithy.api#length": { "max": 2048 }, "smithy.api#pattern": "^(|(https?|ftp):\\/\\/[^\\s/$.?#].[^\\s]*)$" } }, "com.amazonaws.wellarchitected#WorkloadArn": { "type": "string", "traits": { "smithy.api#documentation": "

The ARN for the workload.

" } }, "com.amazonaws.wellarchitected#WorkloadAwsRegions": { "type": "list", "member": { "target": "com.amazonaws.wellarchitected#AwsRegion" }, "traits": { "smithy.api#documentation": "

The list of Amazon Web Services Regions associated with the workload, for example, us-east-2, or ca-central-1.

", "smithy.api#length": { "max": 50 } } }, "com.amazonaws.wellarchitected#WorkloadDescription": { "type": "string", "traits": { "smithy.api#documentation": "

The description for the workload.

", "smithy.api#length": { "min": 3, "max": 250 } } }, "com.amazonaws.wellarchitected#WorkloadDiscoveryConfig": { "type": "structure", "members": { "TrustedAdvisorIntegrationStatus": { "target": "com.amazonaws.wellarchitected#TrustedAdvisorIntegrationStatus", "traits": { "smithy.api#documentation": "

Discovery integration status in respect to Trusted Advisor for the workload.

" } }, "WorkloadResourceDefinition": { "target": "com.amazonaws.wellarchitected#WorkloadResourceDefinition", "traits": { "smithy.api#documentation": "

The mode to use for identifying resources associated with the workload.

You can specify WORKLOAD_METADATA, APP_REGISTRY, or both.

" } } }, "traits": { "smithy.api#documentation": "

Discovery configuration associated to the workload.

" } }, "com.amazonaws.wellarchitected#WorkloadEnvironment": { "type": "enum", "members": { "PRODUCTION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PRODUCTION" } }, "PREPRODUCTION": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "PREPRODUCTION" } } }, "traits": { "smithy.api#documentation": "

The environment for the workload.

" } }, "com.amazonaws.wellarchitected#WorkloadId": { "type": "string", "traits": { "smithy.api#documentation": "

The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.

", "smithy.api#length": { "min": 32, "max": 32 }, "smithy.api#pattern": "^[0-9a-f]{32}$" } }, "com.amazonaws.wellarchitected#WorkloadImprovementStatus": { "type": "enum", "members": { "NOT_APPLICABLE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NOT_APPLICABLE" } }, "NOT_STARTED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "NOT_STARTED" } }, "IN_PROGRESS": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "IN_PROGRESS" } }, "COMPLETE": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "COMPLETE" } }, "RISK_ACKNOWLEDGED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "RISK_ACKNOWLEDGED" } } }, "traits": { "smithy.api#documentation": "

The improvement status for a workload.

" } }, "com.amazonaws.wellarchitected#WorkloadIndustry": { "type": "string", "traits": { "smithy.api#documentation": "

The industry for the workload.

", "smithy.api#length": { "max": 100 } } }, "com.amazonaws.wellarchitected#WorkloadIndustryType": { "type": "string", "traits": { "smithy.api#documentation": "

The industry type for the workload.

If specified, must be one of the following:

", "smithy.api#length": { "max": 100 } } }, "com.amazonaws.wellarchitected#WorkloadIssueManagementStatus": { "type": "enum", "members": { "ENABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "ENABLED" } }, "DISABLED": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "DISABLED" } }, "INHERIT": { "target": "smithy.api#Unit", "traits": { "smithy.api#enumValue": "INHERIT" } } } }, "com.amazonaws.wellarchitected#WorkloadJiraConfigurationInput": { "type": "structure", "members": { "IssueManagementStatus": { "target": "com.amazonaws.wellarchitected#WorkloadIssueManagementStatus", "traits": { "smithy.api#documentation": "

Workload-level: Jira issue management status.

" } }, "IssueManagementType": { "target": "com.amazonaws.wellarchitected#IssueManagementType", "traits": { "smithy.api#documentation": "

Workload-level: Jira issue management type.

" } }, "JiraProjectKey": { "target": "com.amazonaws.wellarchitected#JiraProjectKey", "traits": { "smithy.api#documentation": "

Workload-level: Jira project key to sync workloads to.

" } } }, "traits": { "smithy.api#documentation": "

Workload-level: Input for the Jira configuration.

" } }, "com.amazonaws.wellarchitected#WorkloadJiraConfigurationOutput": { "type": "structure", "members": { "IssueManagementStatus": { "target": "com.amazonaws.wellarchitected#WorkloadIssueManagementStatus", "traits": { "smithy.api#documentation": "

Workload-level: Jira issue management status.

" } }, "IssueManagementType": { "target": "com.amazonaws.wellarchitected#IssueManagementType", "traits": { "smithy.api#documentation": "

Workload-level: Jira issue management type.

" } }, "JiraProjectKey": { "target": "com.amazonaws.wellarchitected#JiraProjectKey", "traits": { "smithy.api#documentation": "

Workload-level: Jira project key to sync workloads to.

" } }, "StatusMessage": { "target": "com.amazonaws.wellarchitected#StatusMessage", "traits": { "smithy.api#documentation": "

Workload-level: Status message on configuration of the Jira integration.

" } } }, "traits": { "smithy.api#documentation": "

Workload-level: Output configuration of the Jira integration.

" } }, "com.amazonaws.wellarchitected#WorkloadLenses": { "type": "list", "member": { "target": "com.amazonaws.wellarchitected#LensAlias" }, "traits": { "smithy.api#documentation": "

The list of lenses associated with the workload. Each lens is identified by its LensSummary$LensAlias.

If a review template that specifies lenses is applied to the workload, those lenses are applied to the workload in addition to these lenses.

" } }, "com.amazonaws.wellarchitected#WorkloadName": { "type": "string", "traits": { "smithy.api#documentation": "

The name of the workload.

The name must be unique within an account within an Amazon Web Services Region. Spaces and capitalization are ignored when checking for uniqueness.

", "smithy.api#length": { "min": 3, "max": 100 } } }, "com.amazonaws.wellarchitected#WorkloadNamePrefix": { "type": "string", "traits": { "smithy.api#documentation": "

An optional string added to the beginning of each workload name returned in the results.

", "smithy.api#length": { "max": 100 } } }, "com.amazonaws.wellarchitected#WorkloadNonAwsRegion": { "type": "string", "traits": { "smithy.api#length": { "min": 3, "max": 25 } } }, "com.amazonaws.wellarchitected#WorkloadNonAwsRegions": { "type": "list", "member": { "target": "com.amazonaws.wellarchitected#WorkloadNonAwsRegion" }, "traits": { "smithy.api#documentation": "

The list of non-Amazon Web Services Regions associated with the workload.

", "smithy.api#length": { "max": 5 } } }, "com.amazonaws.wellarchitected#WorkloadPillarPriorities": { "type": "list", "member": { "target": "com.amazonaws.wellarchitected#PillarId" }, "traits": { "smithy.api#documentation": "

The priorities of the pillars, which are used to order items in the improvement plan. Each pillar is represented by its PillarReviewSummary$PillarId.

" } }, "com.amazonaws.wellarchitected#WorkloadProfile": { "type": "structure", "members": { "ProfileArn": { "target": "com.amazonaws.wellarchitected#ProfileArn", "traits": { "smithy.api#documentation": "

The profile ARN.

" } }, "ProfileVersion": { "target": "com.amazonaws.wellarchitected#ProfileVersion", "traits": { "smithy.api#documentation": "

The profile version.

" } } }, "traits": { "smithy.api#documentation": "

The profile associated with a workload.

" } }, "com.amazonaws.wellarchitected#WorkloadProfileArns": { "type": "list", "member": { "target": "com.amazonaws.wellarchitected#ProfileArn" }, "traits": { "smithy.api#length": { "max": 1 } } }, "com.amazonaws.wellarchitected#WorkloadProfiles": { "type": "list", "member": { "target": "com.amazonaws.wellarchitected#WorkloadProfile" }, "traits": { "smithy.api#length": { "max": 1 } } }, "com.amazonaws.wellarchitected#WorkloadResourceDefinition": { "type": "list", "member": { "target": "com.amazonaws.wellarchitected#DefinitionType" } }, "com.amazonaws.wellarchitected#WorkloadReviewOwner": { "type": "string", "traits": { "smithy.api#documentation": "

The review owner of the workload. The name, email address, or identifier for the primary group or individual that owns the workload review process.

", "smithy.api#length": { "min": 3, "max": 255 } } }, "com.amazonaws.wellarchitected#WorkloadShare": { "type": "structure", "members": { "ShareId": { "target": "com.amazonaws.wellarchitected#ShareId" }, "SharedBy": { "target": "com.amazonaws.wellarchitected#AwsAccountId" }, "SharedWith": { "target": "com.amazonaws.wellarchitected#SharedWith" }, "PermissionType": { "target": "com.amazonaws.wellarchitected#PermissionType" }, "Status": { "target": "com.amazonaws.wellarchitected#ShareStatus" }, "WorkloadName": { "target": "com.amazonaws.wellarchitected#WorkloadName" }, "WorkloadId": { "target": "com.amazonaws.wellarchitected#WorkloadId" } }, "traits": { "smithy.api#documentation": "

A workload share return object.

" } }, "com.amazonaws.wellarchitected#WorkloadShareSummaries": { "type": "list", "member": { "target": "com.amazonaws.wellarchitected#WorkloadShareSummary" }, "traits": { "smithy.api#documentation": "

A list of workload share summaries.

" } }, "com.amazonaws.wellarchitected#WorkloadShareSummary": { "type": "structure", "members": { "ShareId": { "target": "com.amazonaws.wellarchitected#ShareId" }, "SharedWith": { "target": "com.amazonaws.wellarchitected#SharedWith" }, "PermissionType": { "target": "com.amazonaws.wellarchitected#PermissionType" }, "Status": { "target": "com.amazonaws.wellarchitected#ShareStatus" }, "StatusMessage": { "target": "com.amazonaws.wellarchitected#StatusMessage", "traits": { "smithy.api#documentation": "

Optional message to compliment the Status field.

" } } }, "traits": { "smithy.api#documentation": "

A workload share summary return object.

" } }, "com.amazonaws.wellarchitected#WorkloadSummaries": { "type": "list", "member": { "target": "com.amazonaws.wellarchitected#WorkloadSummary" }, "traits": { "smithy.api#documentation": "

A list of workload summaries.

" } }, "com.amazonaws.wellarchitected#WorkloadSummary": { "type": "structure", "members": { "WorkloadId": { "target": "com.amazonaws.wellarchitected#WorkloadId" }, "WorkloadArn": { "target": "com.amazonaws.wellarchitected#WorkloadArn" }, "WorkloadName": { "target": "com.amazonaws.wellarchitected#WorkloadName" }, "Owner": { "target": "com.amazonaws.wellarchitected#AwsAccountId" }, "UpdatedAt": { "target": "smithy.api#Timestamp", "traits": { "smithy.api#documentation": "

The date and time when the workload was last updated.

" } }, "Lenses": { "target": "com.amazonaws.wellarchitected#WorkloadLenses" }, "RiskCounts": { "target": "com.amazonaws.wellarchitected#RiskCounts" }, "ImprovementStatus": { "target": "com.amazonaws.wellarchitected#WorkloadImprovementStatus" }, "Profiles": { "target": "com.amazonaws.wellarchitected#WorkloadProfiles", "traits": { "smithy.api#documentation": "

Profile associated with a workload.

" } }, "PrioritizedRiskCounts": { "target": "com.amazonaws.wellarchitected#RiskCounts" } }, "traits": { "smithy.api#documentation": "

A workload summary return object.

" } } } }