types

package
v0.0.0-...-68f2935 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 24, 2024 License: Apache-2.0 Imports: 4 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AccessDeniedException 

type AccessDeniedException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

User does not have sufficient access to perform this action.

func (*AccessDeniedException) Error 

func (e *AccessDeniedException) Error() string

func (*AccessDeniedException) ErrorCode 

func (e *AccessDeniedException) ErrorCode() string

func (*AccessDeniedException) ErrorFault 

func (e *AccessDeniedException) ErrorFault() smithy.ErrorFault

func (*AccessDeniedException) ErrorMessage 

func (e *AccessDeniedException) ErrorMessage() string

type AccountJiraConfigurationInput 

type AccountJiraConfigurationInput struct {

	// Account-level: Configuration status of the Jira integration.
	IntegrationStatus IntegrationStatusInput

	// Account-level: Jira issue management status.
	IssueManagementStatus AccountJiraIssueManagementStatus

	// Account-level: Jira issue management type.
	IssueManagementType IssueManagementType

	// Account-level: Jira project key to sync workloads to.
	JiraProjectKey *string
	// contains filtered or unexported fields
}

Account-level: Input for the Jira configuration.

type AccountJiraConfigurationOutput 

type AccountJiraConfigurationOutput struct {

	// Account-level: Configuration status of the Jira integration.
	IntegrationStatus IntegrationStatus

	// Account-level: Jira issue management status.
	IssueManagementStatus AccountJiraIssueManagementStatus

	// Account-level: Jira issue management type.
	IssueManagementType IssueManagementType

	// Account-level: Jira project key to sync workloads to.
	JiraProjectKey *string

	// Account-level: Status message on configuration of the Jira integration.
	StatusMessage *string

	// Account-level: Jira subdomain URL.
	Subdomain *string
	// contains filtered or unexported fields
}

Account-level: Output configuration of the Jira integration.

type AccountJiraIssueManagementStatus 

type AccountJiraIssueManagementStatus string
const (
	AccountJiraIssueManagementStatusEnabled  AccountJiraIssueManagementStatus = "ENABLED"
	AccountJiraIssueManagementStatusDisabled AccountJiraIssueManagementStatus = "DISABLED"
)

Enum values for AccountJiraIssueManagementStatus

func (AccountJiraIssueManagementStatus) Values 

func (AccountJiraIssueManagementStatus) Values() []AccountJiraIssueManagementStatus

Values returns all known values for AccountJiraIssueManagementStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type AdditionalResourceType 

type AdditionalResourceType string
const (
	AdditionalResourceTypeHelpfulResource AdditionalResourceType = "HELPFUL_RESOURCE"
	AdditionalResourceTypeImprovementPlan AdditionalResourceType = "IMPROVEMENT_PLAN"
)

Enum values for AdditionalResourceType

func (AdditionalResourceType) Values 

func (AdditionalResourceType) Values() []AdditionalResourceType

Values returns all known values for AdditionalResourceType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type AdditionalResources 

type AdditionalResources struct {

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

	// Type of additional resource for a custom lens.
	Type AdditionalResourceType
	// contains filtered or unexported fields
}

The choice level additional resources for a custom lens.

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

type Answer 

type Answer struct {

	// A list of selected choices to a question in your workload.
	ChoiceAnswers []ChoiceAnswer

	// List of choices available for a question.
	Choices []Choice

	// The helpful resource text to be displayed for a custom lens.
	//
	// This field does not apply to Amazon Web Services official lenses.
	HelpfulResourceDisplayText *string

	// 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.
	HelpfulResourceUrl *string

	// 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.
	//
	// This value does not apply to custom lenses.
	ImprovementPlanUrl *string

	// Defines whether this question is applicable to a lens review.
	IsApplicable *bool

	// Configuration of the Jira integration.
	JiraConfiguration *JiraConfiguration

	// 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.
	Notes *string

	// The ID used to identify a pillar, for example, security .
	//
	// A pillar is identified by its PillarReviewSummary$PillarId.
	PillarId *string

	// The description of the question.
	QuestionDescription *string

	// The ID of the question.
	QuestionId *string

	// The title of the question.
	QuestionTitle *string

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

	// The risk for a given workload, lens review, pillar, or question.
	Risk Risk

	// List of selected choice IDs in a question answer.
	//
	// The values entered replace the previously selected choices.
	SelectedChoices []string
	// contains filtered or unexported fields
}

An answer of the question.

type AnswerReason 

type AnswerReason string
const (
	AnswerReasonOutOfScope              AnswerReason = "OUT_OF_SCOPE"
	AnswerReasonBusinessPriorities      AnswerReason = "BUSINESS_PRIORITIES"
	AnswerReasonArchitectureConstraints AnswerReason = "ARCHITECTURE_CONSTRAINTS"
	AnswerReasonOther                   AnswerReason = "OTHER"
	AnswerReasonNone                    AnswerReason = "NONE"
)

Enum values for AnswerReason

func (AnswerReason) Values 

func (AnswerReason) Values() []AnswerReason

Values returns all known values for AnswerReason. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type AnswerSummary 

type AnswerSummary struct {

	// A list of selected choices to a question in your workload.
	ChoiceAnswerSummaries []ChoiceAnswerSummary

	// List of choices available for a question.
	Choices []Choice

	// Defines whether this question is applicable to a lens review.
	IsApplicable *bool

	// Configuration of the Jira integration.
	JiraConfiguration *JiraConfiguration

	// The ID used to identify a pillar, for example, security .
	//
	// A pillar is identified by its PillarReviewSummary$PillarId.
	PillarId *string

	// The ID of the question.
	QuestionId *string

	// The title of the question.
	QuestionTitle *string

	// The type of the question.
	QuestionType QuestionType

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

	// The risk for a given workload, lens review, pillar, or question.
	Risk Risk

	// List of selected choice IDs in a question answer.
	//
	// The values entered replace the previously selected choices.
	SelectedChoices []string
	// contains filtered or unexported fields
}

An answer summary of a lens review in a workload.

type BestPractice 

type BestPractice struct {

	// The ID of a choice.
	ChoiceId *string

	// The title of a choice.
	ChoiceTitle *string
	// contains filtered or unexported fields
}

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

type CheckDetail 

type CheckDetail struct {

	// An Amazon Web Services account ID.
	AccountId *string

	// The ID of a choice.
	ChoiceId *string

	// Trusted Advisor check description.
	Description *string

	// Count of flagged resources associated to the check.
	FlaggedResources *int32

	// Trusted Advisor check ID.
	Id *string

	// Well-Architected Lens ARN associated to the check.
	LensArn *string

	// Trusted Advisor check name.
	Name *string

	// The ID used to identify a pillar, for example, security .
	//
	// A pillar is identified by its PillarReviewSummary$PillarId.
	PillarId *string

	// Provider of the check related to the best practice.
	Provider CheckProvider

	// The ID of the question.
	QuestionId *string

	// Reason associated to the check.
	Reason CheckFailureReason

	// Status associated to the check.
	Status CheckStatus

	// The date and time recorded.
	UpdatedAt *time.Time
	// contains filtered or unexported fields
}

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

type CheckFailureReason 

type CheckFailureReason string
const (
	CheckFailureReasonAssumeRoleError        CheckFailureReason = "ASSUME_ROLE_ERROR"
	CheckFailureReasonAccessDenied           CheckFailureReason = "ACCESS_DENIED"
	CheckFailureReasonUnknownError           CheckFailureReason = "UNKNOWN_ERROR"
	CheckFailureReasonPremiumSupportRequired CheckFailureReason = "PREMIUM_SUPPORT_REQUIRED"
)

Enum values for CheckFailureReason

func (CheckFailureReason) Values 

func (CheckFailureReason) Values() []CheckFailureReason

Values returns all known values for CheckFailureReason. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type CheckProvider 

type CheckProvider string
const (
	CheckProviderTrustedAdvisor CheckProvider = "TRUSTED_ADVISOR"
)

Enum values for CheckProvider

func (CheckProvider) Values 

func (CheckProvider) Values() []CheckProvider

Values returns all known values for CheckProvider. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type CheckStatus 

type CheckStatus string
const (
	CheckStatusOkay         CheckStatus = "OKAY"
	CheckStatusWarning      CheckStatus = "WARNING"
	CheckStatusError        CheckStatus = "ERROR"
	CheckStatusNotAvailable CheckStatus = "NOT_AVAILABLE"
	CheckStatusFetchFailed  CheckStatus = "FETCH_FAILED"
)

Enum values for CheckStatus

func (CheckStatus) Values 

func (CheckStatus) Values() []CheckStatus

Values returns all known values for CheckStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type CheckSummary 

type CheckSummary struct {

	// Account summary associated to the check.
	AccountSummary map[string]int32

	// The ID of a choice.
	ChoiceId *string

	// Trusted Advisor check description.
	Description *string

	// Trusted Advisor check ID.
	Id *string

	// Well-Architected Lens ARN associated to the check.
	LensArn *string

	// Trusted Advisor check name.
	Name *string

	// The ID used to identify a pillar, for example, security .
	//
	// A pillar is identified by its PillarReviewSummary$PillarId.
	PillarId *string

	// Provider of the check related to the best practice.
	Provider CheckProvider

	// The ID of the question.
	QuestionId *string

	// Status associated to the check.
	Status CheckStatus

	// The date and time recorded.
	UpdatedAt *time.Time
	// contains filtered or unexported fields
}

Trusted Advisor check summary.

type Choice 

type Choice struct {

	// 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.
	AdditionalResources []AdditionalResources

	// The ID of a choice.
	ChoiceId *string

	// The description of a choice.
	Description *string

	// 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.
	HelpfulResource *ChoiceContent

	// 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.
	ImprovementPlan *ChoiceContent

	// The title of a choice.
	Title *string
	// contains filtered or unexported fields
}

A choice available to answer question.

type ChoiceAnswer 

type ChoiceAnswer struct {

	// The ID of a choice.
	ChoiceId *string

	// The notes associated with a choice.
	Notes *string

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

	// The status of a choice.
	Status ChoiceStatus
	// contains filtered or unexported fields
}

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

type ChoiceAnswerSummary 

type ChoiceAnswerSummary struct {

	// The ID of a choice.
	ChoiceId *string

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

	// The status of a choice.
	Status ChoiceStatus
	// contains filtered or unexported fields
}

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

type ChoiceContent 

type ChoiceContent struct {

	// The display text for the choice content.
	DisplayText *string

	// The URL for the choice content.
	Url *string
	// contains filtered or unexported fields
}

The choice content.

type ChoiceImprovementPlan 

type ChoiceImprovementPlan struct {

	// The ID of a choice.
	ChoiceId *string

	// The display text for the improvement plan.
	DisplayText *string

	// 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.
	//
	// This value does not apply to custom lenses.
	ImprovementPlanUrl *string
	// contains filtered or unexported fields
}

The choice level improvement plan.

type ChoiceReason 

type ChoiceReason string
const (
	ChoiceReasonOutOfScope              ChoiceReason = "OUT_OF_SCOPE"
	ChoiceReasonBusinessPriorities      ChoiceReason = "BUSINESS_PRIORITIES"
	ChoiceReasonArchitectureConstraints ChoiceReason = "ARCHITECTURE_CONSTRAINTS"
	ChoiceReasonOther                   ChoiceReason = "OTHER"
	ChoiceReasonNone                    ChoiceReason = "NONE"
)

Enum values for ChoiceReason

func (ChoiceReason) Values 

func (ChoiceReason) Values() []ChoiceReason

Values returns all known values for ChoiceReason. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ChoiceStatus 

type ChoiceStatus string
const (
	ChoiceStatusSelected      ChoiceStatus = "SELECTED"
	ChoiceStatusNotApplicable ChoiceStatus = "NOT_APPLICABLE"
	ChoiceStatusUnselected    ChoiceStatus = "UNSELECTED"
)

Enum values for ChoiceStatus

func (ChoiceStatus) Values 

func (ChoiceStatus) Values() []ChoiceStatus

Values returns all known values for ChoiceStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ChoiceUpdate 

type ChoiceUpdate struct {

	// The status of a choice.
	//
	// This member is required.
	Status ChoiceStatus

	// The notes associated with a choice.
	Notes *string

	// The reason why a choice is non-applicable to a question in your workload.
	Reason ChoiceReason
	// contains filtered or unexported fields
}

A list of choices to be updated.

type ConflictException 

type ConflictException struct {
	Message *string

	ErrorCodeOverride *string

	ResourceId   *string
	ResourceType *string
	// contains filtered or unexported fields
}

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

func (*ConflictException) Error 

func (e *ConflictException) Error() string

func (*ConflictException) ErrorCode 

func (e *ConflictException) ErrorCode() string

func (*ConflictException) ErrorFault 

func (e *ConflictException) ErrorFault() smithy.ErrorFault

func (*ConflictException) ErrorMessage 

func (e *ConflictException) ErrorMessage() string

type ConsolidatedReportMetric 

type ConsolidatedReportMetric struct {

	// The metrics for the lenses in the workload.
	Lenses []LensMetric

	// The total number of lenses applied to the workload.
	LensesAppliedCount *int32

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

	// A map from risk names to the count of how many questions have that rating.
	RiskCounts map[string]int32

	// The date and time recorded.
	UpdatedAt *time.Time

	// The ARN for the workload.
	WorkloadArn *string

	// The ID assigned to the workload. This ID is unique within an Amazon Web
	// Services Region.
	WorkloadId *string

	// 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.
	WorkloadName *string
	// contains filtered or unexported fields
}

A metric that contributes to the consolidated report.

type DefinitionType 

type DefinitionType string
const (
	DefinitionTypeWorkloadMetadata DefinitionType = "WORKLOAD_METADATA"
	DefinitionTypeAppRegistry      DefinitionType = "APP_REGISTRY"
)

Enum values for DefinitionType

func (DefinitionType) Values 

func (DefinitionType) Values() []DefinitionType

Values returns all known values for DefinitionType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type DifferenceStatus 

type DifferenceStatus string
const (
	DifferenceStatusUpdated DifferenceStatus = "UPDATED"
	DifferenceStatusNew     DifferenceStatus = "NEW"
	DifferenceStatusDeleted DifferenceStatus = "DELETED"
)

Enum values for DifferenceStatus

func (DifferenceStatus) Values 

func (DifferenceStatus) Values() []DifferenceStatus

Values returns all known values for DifferenceStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type DiscoveryIntegrationStatus 

type DiscoveryIntegrationStatus string
const (
	DiscoveryIntegrationStatusEnabled  DiscoveryIntegrationStatus = "ENABLED"
	DiscoveryIntegrationStatusDisabled DiscoveryIntegrationStatus = "DISABLED"
)

Enum values for DiscoveryIntegrationStatus

func (DiscoveryIntegrationStatus) Values 

func (DiscoveryIntegrationStatus) Values() []DiscoveryIntegrationStatus

Values returns all known values for DiscoveryIntegrationStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ImportLensStatus 

type ImportLensStatus string
const (
	ImportLensStatusInProgress ImportLensStatus = "IN_PROGRESS"
	ImportLensStatusComplete   ImportLensStatus = "COMPLETE"
	ImportLensStatusError      ImportLensStatus = "ERROR"
)

Enum values for ImportLensStatus

func (ImportLensStatus) Values 

func (ImportLensStatus) Values() []ImportLensStatus

Values returns all known values for ImportLensStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ImprovementSummary 

type ImprovementSummary struct {

	// 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.
	//
	// This value does not apply to custom lenses.
	ImprovementPlanUrl *string

	// The improvement plan details.
	ImprovementPlans []ChoiceImprovementPlan

	// Configuration of the Jira integration.
	JiraConfiguration *JiraConfiguration

	// The ID used to identify a pillar, for example, security .
	//
	// A pillar is identified by its PillarReviewSummary$PillarId.
	PillarId *string

	// The ID of the question.
	QuestionId *string

	// The title of the question.
	QuestionTitle *string

	// The risk for a given workload, lens review, pillar, or question.
	Risk Risk
	// contains filtered or unexported fields
}

An improvement summary of a lens review in a workload.

type IntegratingService 

type IntegratingService string
const (
	IntegratingServiceJira IntegratingService = "JIRA"
)

Enum values for IntegratingService

func (IntegratingService) Values 

func (IntegratingService) Values() []IntegratingService

Values returns all known values for IntegratingService. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type IntegrationStatus 

type IntegrationStatus string
const (
	IntegrationStatusConfigured    IntegrationStatus = "CONFIGURED"
	IntegrationStatusNotConfigured IntegrationStatus = "NOT_CONFIGURED"
)

Enum values for IntegrationStatus

func (IntegrationStatus) Values 

func (IntegrationStatus) Values() []IntegrationStatus

Values returns all known values for IntegrationStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type IntegrationStatusInput 

type IntegrationStatusInput string
const (
	IntegrationStatusInputNotConfigured IntegrationStatusInput = "NOT_CONFIGURED"
)

Enum values for IntegrationStatusInput

func (IntegrationStatusInput) Values 

func (IntegrationStatusInput) Values() []IntegrationStatusInput

Values returns all known values for IntegrationStatusInput. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type InternalServerException 

type InternalServerException struct {
	Message *string

	ErrorCodeOverride *string
	// contains filtered or unexported fields
}

There is a problem with the Well-Architected Tool API service.

func (*InternalServerException) Error 

func (e *InternalServerException) Error() string

func (*InternalServerException) ErrorCode 

func (e *InternalServerException) ErrorCode() string

func (*InternalServerException) ErrorFault 

func (e *InternalServerException) ErrorFault() smithy.ErrorFault

func (*InternalServerException) ErrorMessage 

func (e *InternalServerException) ErrorMessage() string

type IssueManagementType 

type IssueManagementType string
const (
	IssueManagementTypeAuto   IssueManagementType = "AUTO"
	IssueManagementTypeManual IssueManagementType = "MANUAL"
)

Enum values for IssueManagementType

func (IssueManagementType) Values 

func (IssueManagementType) Values() []IssueManagementType

Values returns all known values for IssueManagementType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type JiraConfiguration 

type JiraConfiguration struct {

	// The URL of the associated Jira issue.
	JiraIssueUrl *string

	// The date and time recorded.
	LastSyncedTime *time.Time
	// contains filtered or unexported fields
}

Configuration of the Jira integration.

type JiraSelectedQuestionConfiguration 

type JiraSelectedQuestionConfiguration struct {

	// Selected pillars in the workload.
	SelectedPillars []SelectedPillar
	// contains filtered or unexported fields
}

Selected questions in the workload.

type Lens 

type Lens struct {

	// The description of the lens.
	Description *string

	// The ARN of a lens.
	LensArn *string

	// The version of a lens.
	LensVersion *string

	// The full name of the lens.
	Name *string

	// The Amazon Web Services account ID that owns the lens.
	Owner *string

	// The ID assigned to the share invitation.
	ShareInvitationId *string

	// The tags assigned to the lens.
	Tags map[string]string
	// contains filtered or unexported fields
}

A lens return object.

type LensMetric 

type LensMetric struct {

	// The lens ARN.
	LensArn *string

	// The metrics for the pillars in a lens.
	Pillars []PillarMetric

	// A map from risk names to the count of how many questions have that rating.
	RiskCounts map[string]int32
	// contains filtered or unexported fields
}

A metric for a particular lens in a workload.

type LensReview 

type LensReview struct {

	// Jira configuration status of the Lens review.
	JiraConfiguration *JiraSelectedQuestionConfiguration

	// 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.
	LensAlias *string

	// The ARN for the lens.
	LensArn *string

	// The full name of the lens.
	LensName *string

	// The status of the lens.
	LensStatus LensStatus

	// The version of the lens.
	LensVersion *string

	// The token to use to retrieve the next set of results.
	NextToken *string

	// 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.
	Notes *string

	// List of pillar review summaries of lens review in a workload.
	PillarReviewSummaries []PillarReviewSummary

	// A map from risk names to the count of how many questions have that rating.
	PrioritizedRiskCounts map[string]int32

	// The profiles associated with the workload.
	Profiles []WorkloadProfile

	// A map from risk names to the count of how many questions have that rating.
	RiskCounts map[string]int32

	// The date and time recorded.
	UpdatedAt *time.Time
	// contains filtered or unexported fields
}

A lens review of a question.

type LensReviewReport 

type LensReviewReport struct {

	// 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.
	Base64String *string

	// 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.
	LensAlias *string

	// The ARN for the lens.
	LensArn *string
	// contains filtered or unexported fields
}

A report of a lens review.

type LensReviewSummary 

type LensReviewSummary struct {

	// 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.
	LensAlias *string

	// The ARN for the lens.
	LensArn *string

	// The full name of the lens.
	LensName *string

	// The status of the lens.
	LensStatus LensStatus

	// The version of the lens.
	LensVersion *string

	// A map from risk names to the count of how many questions have that rating.
	PrioritizedRiskCounts map[string]int32

	// The profiles associated with the workload.
	Profiles []WorkloadProfile

	// A map from risk names to the count of how many questions have that rating.
	RiskCounts map[string]int32

	// The date and time recorded.
	UpdatedAt *time.Time
	// contains filtered or unexported fields
}

A lens review summary of a workload.

type LensShareSummary 

type LensShareSummary struct {

	// The ID associated with the share.
	ShareId *string

	// The Amazon Web Services account ID, organization ID, or organizational unit
	// (OU) ID with which the workload, lens, profile, or review template is shared.
	SharedWith *string

	// The status of the share request.
	Status ShareStatus

	// Optional message to compliment the Status field.
	StatusMessage *string
	// contains filtered or unexported fields
}

A lens share summary return object.

type LensStatus 

type LensStatus string
const (
	LensStatusCurrent    LensStatus = "CURRENT"
	LensStatusNotCurrent LensStatus = "NOT_CURRENT"
	LensStatusDeprecated LensStatus = "DEPRECATED"
	LensStatusDeleted    LensStatus = "DELETED"
	LensStatusUnshared   LensStatus = "UNSHARED"
)

Enum values for LensStatus

func (LensStatus) Values 

func (LensStatus) Values() []LensStatus

Values returns all known values for LensStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type LensStatusType 

type LensStatusType string
const (
	LensStatusTypeAll       LensStatusType = "ALL"
	LensStatusTypeDraft     LensStatusType = "DRAFT"
	LensStatusTypePublished LensStatusType = "PUBLISHED"
)

Enum values for LensStatusType

func (LensStatusType) Values 

func (LensStatusType) Values() []LensStatusType

Values returns all known values for LensStatusType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type LensSummary 

type LensSummary struct {

	// The date and time recorded.
	CreatedAt *time.Time

	// The description of the lens.
	Description *string

	// 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.
	LensAlias *string

	// The ARN of the lens.
	LensArn *string

	// The full name of the lens.
	LensName *string

	// The status of the lens.
	LensStatus LensStatus

	// The type of the lens.
	LensType LensType

	// The version of the lens.
	LensVersion *string

	// An Amazon Web Services account ID.
	Owner *string

	// The date and time recorded.
	UpdatedAt *time.Time
	// contains filtered or unexported fields
}

A lens summary of a lens.

type LensType 

type LensType string
const (
	LensTypeAwsOfficial  LensType = "AWS_OFFICIAL"
	LensTypeCustomShared LensType = "CUSTOM_SHARED"
	LensTypeCustomSelf   LensType = "CUSTOM_SELF"
)

Enum values for LensType

func (LensType) Values 

func (LensType) Values() []LensType

Values returns all known values for LensType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type LensUpgradeSummary 

type LensUpgradeSummary struct {

	// The current version of the lens.
	CurrentLensVersion *string

	// The latest version of the lens.
	LatestLensVersion *string

	// 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.
	LensAlias *string

	// The ARN for the lens.
	LensArn *string

	// ResourceArn of the lens being upgraded
	ResourceArn *string

	// 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.
	ResourceName *string

	// The ID assigned to the workload. This ID is unique within an Amazon Web
	// Services Region.
	WorkloadId *string

	// 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.
	WorkloadName *string
	// contains filtered or unexported fields
}

Lens upgrade summary return object.

type MetricType 

type MetricType string
const (
	MetricTypeWorkload MetricType = "WORKLOAD"
)

Enum values for MetricType

func (MetricType) Values 

func (MetricType) Values() []MetricType

Values returns all known values for MetricType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type Milestone 

type Milestone struct {

	// The name of the milestone in a workload.
	//
	// Milestone names must be unique within a workload.
	MilestoneName *string

	// The milestone number.
	//
	// A workload can have a maximum of 100 milestones.
	MilestoneNumber *int32

	// The date and time recorded.
	RecordedAt *time.Time

	// A workload return object.
	Workload *Workload
	// contains filtered or unexported fields
}

A milestone return object.

type MilestoneSummary 

type MilestoneSummary struct {

	// The name of the milestone in a workload.
	//
	// Milestone names must be unique within a workload.
	MilestoneName *string

	// The milestone number.
	//
	// A workload can have a maximum of 100 milestones.
	MilestoneNumber *int32

	// The date and time recorded.
	RecordedAt *time.Time

	// A workload summary return object.
	WorkloadSummary *WorkloadSummary
	// contains filtered or unexported fields
}

A milestone summary return object.

type NotificationSummary 

type NotificationSummary struct {

	// Summary of lens upgrade.
	LensUpgradeSummary *LensUpgradeSummary

	// The type of notification.
	Type NotificationType
	// contains filtered or unexported fields
}

A notification summary return object.

type NotificationType 

type NotificationType string
const (
	NotificationTypeLensVersionUpgraded   NotificationType = "LENS_VERSION_UPGRADED"
	NotificationTypeLensVersionDeprecated NotificationType = "LENS_VERSION_DEPRECATED"
)

Enum values for NotificationType

func (NotificationType) Values 

func (NotificationType) Values() []NotificationType

Values returns all known values for NotificationType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type OrganizationSharingStatus 

type OrganizationSharingStatus string
const (
	OrganizationSharingStatusEnabled  OrganizationSharingStatus = "ENABLED"
	OrganizationSharingStatusDisabled OrganizationSharingStatus = "DISABLED"
)

Enum values for OrganizationSharingStatus

func (OrganizationSharingStatus) Values 

func (OrganizationSharingStatus) Values() []OrganizationSharingStatus

Values returns all known values for OrganizationSharingStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type PermissionType 

type PermissionType string
const (
	PermissionTypeReadonly    PermissionType = "READONLY"
	PermissionTypeContributor PermissionType = "CONTRIBUTOR"
)

Enum values for PermissionType

func (PermissionType) Values 

func (PermissionType) Values() []PermissionType

Values returns all known values for PermissionType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type PillarDifference 

type PillarDifference struct {

	// Indicates the type of change to the pillar.
	DifferenceStatus DifferenceStatus

	// The ID used to identify a pillar, for example, security .
	//
	// A pillar is identified by its PillarReviewSummary$PillarId.
	PillarId *string

	// The name of the pillar.
	PillarName *string

	// List of question differences.
	QuestionDifferences []QuestionDifference
	// contains filtered or unexported fields
}

A pillar difference return object.

type PillarMetric 

type PillarMetric struct {

	// The ID used to identify a pillar, for example, security .
	//
	// A pillar is identified by its PillarReviewSummary$PillarId.
	PillarId *string

	// The questions that have been identified as risks in the pillar.
	Questions []QuestionMetric

	// A map from risk names to the count of how many questions have that rating.
	RiskCounts map[string]int32
	// contains filtered or unexported fields
}

A metric for a particular pillar in a lens.

type PillarReviewSummary 

type PillarReviewSummary struct {

	// 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.
	Notes *string

	// The ID used to identify a pillar, for example, security .
	//
	// A pillar is identified by its PillarReviewSummary$PillarId.
	PillarId *string

	// The name of the pillar.
	PillarName *string

	// A map from risk names to the count of how many questions have that rating.
	PrioritizedRiskCounts map[string]int32

	// A map from risk names to the count of how many questions have that rating.
	RiskCounts map[string]int32
	// contains filtered or unexported fields
}

A pillar review summary of a lens review.

type Profile 

type Profile struct {

	// The date and time recorded.
	CreatedAt *time.Time

	// An Amazon Web Services account ID.
	Owner *string

	// The profile ARN.
	ProfileArn *string

	// The profile description.
	ProfileDescription *string

	// The profile name.
	ProfileName *string

	// Profile questions.
	ProfileQuestions []ProfileQuestion

	// The profile version.
	ProfileVersion *string

	// The ID assigned to the share invitation.
	ShareInvitationId *string

	// The tags assigned to the profile.
	Tags map[string]string

	// The date and time recorded.
	UpdatedAt *time.Time
	// contains filtered or unexported fields
}

A profile.

type ProfileChoice 

type ProfileChoice struct {

	// The description of a choice.
	ChoiceDescription *string

	// The ID of a choice.
	ChoiceId *string

	// The title of a choice.
	ChoiceTitle *string
	// contains filtered or unexported fields
}

The profile choice.

type ProfileNotificationSummary 

type ProfileNotificationSummary struct {

	// The current profile version.
	CurrentProfileVersion *string

	// The latest profile version.
	LatestProfileVersion *string

	// The profile ARN.
	ProfileArn *string

	// The profile name.
	ProfileName *string

	// Type of notification.
	Type ProfileNotificationType

	// The ID assigned to the workload. This ID is unique within an Amazon Web
	// Services Region.
	WorkloadId *string

	// 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.
	WorkloadName *string
	// contains filtered or unexported fields
}

The profile notification summary.

type ProfileNotificationType 

type ProfileNotificationType string
const (
	ProfileNotificationTypeProfileAnswersUpdated ProfileNotificationType = "PROFILE_ANSWERS_UPDATED"
	ProfileNotificationTypeProfileDeleted        ProfileNotificationType = "PROFILE_DELETED"
)

Enum values for ProfileNotificationType

func (ProfileNotificationType) Values 

func (ProfileNotificationType) Values() []ProfileNotificationType

Values returns all known values for ProfileNotificationType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ProfileOwnerType 

type ProfileOwnerType string
const (
	ProfileOwnerTypeSelf   ProfileOwnerType = "SELF"
	ProfileOwnerTypeShared ProfileOwnerType = "SHARED"
)

Enum values for ProfileOwnerType

func (ProfileOwnerType) Values 

func (ProfileOwnerType) Values() []ProfileOwnerType

Values returns all known values for ProfileOwnerType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ProfileQuestion 

type ProfileQuestion struct {

	// The maximum number of selected choices.
	MaxSelectedChoices *int32

	// The minimum number of selected choices.
	MinSelectedChoices *int32

	// The question choices.
	QuestionChoices []ProfileChoice

	// The description of the question.
	QuestionDescription *string

	// The ID of the question.
	QuestionId *string

	// The title of the question.
	QuestionTitle *string

	// The selected choices.
	SelectedChoiceIds []string
	// contains filtered or unexported fields
}

A profile question.

type ProfileQuestionUpdate 

type ProfileQuestionUpdate struct {

	// The ID of the question.
	QuestionId *string

	// The selected choices.
	SelectedChoiceIds []string
	// contains filtered or unexported fields
}

An update to a profile question.

type ProfileShareSummary 

type ProfileShareSummary struct {

	// The ID associated with the share.
	ShareId *string

	// The Amazon Web Services account ID, organization ID, or organizational unit
	// (OU) ID with which the workload, lens, profile, or review template is shared.
	SharedWith *string

	// The status of the share request.
	Status ShareStatus

	// Profile share invitation status message.
	StatusMessage *string
	// contains filtered or unexported fields
}

Summary of a profile share.

type ProfileSummary 

type ProfileSummary struct {

	// The date and time recorded.
	CreatedAt *time.Time

	// An Amazon Web Services account ID.
	Owner *string

	// The profile ARN.
	ProfileArn *string

	// The profile description.
	ProfileDescription *string

	// The profile name.
	ProfileName *string

	// The profile version.
	ProfileVersion *string

	// The date and time recorded.
	UpdatedAt *time.Time
	// contains filtered or unexported fields
}

Summary of a profile.

type ProfileTemplate 

type ProfileTemplate struct {

	// The date and time recorded.
	CreatedAt *time.Time

	// The name of the profile template.
	TemplateName *string

	// Profile template questions.
	TemplateQuestions []ProfileTemplateQuestion

	// The date and time recorded.
	UpdatedAt *time.Time
	// contains filtered or unexported fields
}

The profile template.

type ProfileTemplateChoice 

type ProfileTemplateChoice struct {

	// The description of a choice.
	ChoiceDescription *string

	// The ID of a choice.
	ChoiceId *string

	// The title of a choice.
	ChoiceTitle *string
	// contains filtered or unexported fields
}

A profile template choice.

type ProfileTemplateQuestion 

type ProfileTemplateQuestion struct {

	// The maximum number of choices selected.
	MaxSelectedChoices *int32

	// The minimum number of choices selected.
	MinSelectedChoices *int32

	// The question choices.
	QuestionChoices []ProfileTemplateChoice

	// The description of the question.
	QuestionDescription *string

	// The ID of the question.
	QuestionId *string

	// The title of the question.
	QuestionTitle *string
	// contains filtered or unexported fields
}

A profile template question.

type Question 

type Question string
const (
	QuestionUnanswered Question = "UNANSWERED"
	QuestionAnswered   Question = "ANSWERED"
)

Enum values for Question

func (Question) Values 

func (Question) Values() []Question

Values returns all known values for Question. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type QuestionDifference 

type QuestionDifference struct {

	// Indicates the type of change to the question.
	DifferenceStatus DifferenceStatus

	// The ID of the question.
	QuestionId *string

	// The title of the question.
	QuestionTitle *string
	// contains filtered or unexported fields
}

A question difference return object.

type QuestionMetric 

type QuestionMetric struct {

	// The best practices, or choices, that have been identified as contributing to
	// risk in a question.
	BestPractices []BestPractice

	// The ID of the question.
	QuestionId *string

	// The risk for a given workload, lens review, pillar, or question.
	Risk Risk
	// contains filtered or unexported fields
}

A metric for a particular question in the pillar.

type QuestionPriority 

type QuestionPriority string
const (
	QuestionPriorityPrioritized QuestionPriority = "PRIORITIZED"
	QuestionPriorityNone        QuestionPriority = "NONE"
)

Enum values for QuestionPriority

func (QuestionPriority) Values 

func (QuestionPriority) Values() []QuestionPriority

Values returns all known values for QuestionPriority. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type QuestionType 

type QuestionType string
const (
	QuestionTypePrioritized    QuestionType = "PRIORITIZED"
	QuestionTypeNonPrioritized QuestionType = "NON_PRIORITIZED"
)

Enum values for QuestionType

func (QuestionType) Values 

func (QuestionType) Values() []QuestionType

Values returns all known values for QuestionType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ReportFormat 

type ReportFormat string
const (
	ReportFormatPdf  ReportFormat = "PDF"
	ReportFormatJson ReportFormat = "JSON"
)

Enum values for ReportFormat

func (ReportFormat) Values 

func (ReportFormat) Values() []ReportFormat

Values returns all known values for ReportFormat. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ResourceNotFoundException 

type ResourceNotFoundException struct {
	Message *string

	ErrorCodeOverride *string

	ResourceId   *string
	ResourceType *string
	// contains filtered or unexported fields
}

The requested resource was not found.

func (*ResourceNotFoundException) Error 

func (e *ResourceNotFoundException) Error() string

func (*ResourceNotFoundException) ErrorCode 

func (e *ResourceNotFoundException) ErrorCode() string

func (*ResourceNotFoundException) ErrorFault 

func (e *ResourceNotFoundException) ErrorFault() smithy.ErrorFault

func (*ResourceNotFoundException) ErrorMessage 

func (e *ResourceNotFoundException) ErrorMessage() string

type ReviewTemplate 

type ReviewTemplate struct {

	// The review template description.
	Description *string

	// The lenses applied to the review template.
	Lenses []string

	// 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.
	Notes *string

	// An Amazon Web Services account ID.
	Owner *string

	// A count of how many total questions are answered and unanswered in the review
	// template.
	QuestionCounts map[string]int32

	// The ID assigned to the template share invitation.
	ShareInvitationId *string

	// The tags assigned to the review template.
	Tags map[string]string

	// The review template ARN.
	TemplateArn *string

	// The name of the review template.
	TemplateName *string

	// The latest status of a review template.
	UpdateStatus ReviewTemplateUpdateStatus

	// The date and time recorded.
	UpdatedAt *time.Time
	// contains filtered or unexported fields
}

A review template.

type ReviewTemplateAnswer 

type ReviewTemplateAnswer struct {

	// The status of whether or not this question has been answered.
	AnswerStatus ReviewTemplateAnswerStatus

	// A list of selected choices to a question in your review template.
	ChoiceAnswers []ChoiceAnswer

	// List of choices available for a question.
	Choices []Choice

	// The helpful resource text to be displayed for a custom lens.
	//
	// This field does not apply to Amazon Web Services official lenses.
	HelpfulResourceDisplayText *string

	// 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.
	HelpfulResourceUrl *string

	// 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.
	//
	// This value does not apply to custom lenses.
	ImprovementPlanUrl *string

	// Defines whether this question is applicable to a lens review.
	IsApplicable *bool

	// 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.
	Notes *string

	// The ID used to identify a pillar, for example, security .
	//
	// A pillar is identified by its PillarReviewSummary$PillarId.
	PillarId *string

	// The description of the question.
	QuestionDescription *string

	// The ID of the question.
	QuestionId *string

	// The title of the question.
	QuestionTitle *string

	// The reason why the question is not applicable to your review template.
	Reason AnswerReason

	// List of selected choice IDs in a question answer.
	//
	// The values entered replace the previously selected choices.
	SelectedChoices []string
	// contains filtered or unexported fields
}

An answer of the question.

type ReviewTemplateAnswerStatus 

type ReviewTemplateAnswerStatus string
const (
	ReviewTemplateAnswerStatusUnanswered ReviewTemplateAnswerStatus = "UNANSWERED"
	ReviewTemplateAnswerStatusAnswered   ReviewTemplateAnswerStatus = "ANSWERED"
)

Enum values for ReviewTemplateAnswerStatus

func (ReviewTemplateAnswerStatus) Values 

func (ReviewTemplateAnswerStatus) Values() []ReviewTemplateAnswerStatus

Values returns all known values for ReviewTemplateAnswerStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ReviewTemplateAnswerSummary 

type ReviewTemplateAnswerSummary struct {

	// The status of whether or not this question has been answered.
	AnswerStatus ReviewTemplateAnswerStatus

	// A list of selected choices to a question in the review template.
	ChoiceAnswerSummaries []ChoiceAnswerSummary

	// List of choices available for a question.
	Choices []Choice

	// Defines whether this question is applicable to a lens review.
	IsApplicable *bool

	// The ID used to identify a pillar, for example, security .
	//
	// A pillar is identified by its PillarReviewSummary$PillarId.
	PillarId *string

	// The ID of the question.
	QuestionId *string

	// The title of the question.
	QuestionTitle *string

	// The type of question.
	QuestionType QuestionType

	// The reason why a choice is not-applicable to a question in the review template.
	Reason AnswerReason

	// List of selected choice IDs in a question answer.
	//
	// The values entered replace the previously selected choices.
	SelectedChoices []string
	// contains filtered or unexported fields
}

The summary of review template answers.

type ReviewTemplateLensReview 

type ReviewTemplateLensReview struct {

	// 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.
	LensAlias *string

	// The lens ARN.
	LensArn *string

	// The full name of the lens.
	LensName *string

	// The status of the lens.
	LensStatus LensStatus

	// The version of the lens.
	LensVersion *string

	// The token to use to retrieve the next set of results.
	NextToken *string

	// 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.
	Notes *string

	// Pillar review summaries of a lens review.
	PillarReviewSummaries []ReviewTemplatePillarReviewSummary

	// A count of how many questions are answered and unanswered in the lens review.
	QuestionCounts map[string]int32

	// The date and time recorded.
	UpdatedAt *time.Time
	// contains filtered or unexported fields
}

The lens review of a review template.

type ReviewTemplatePillarReviewSummary 

type ReviewTemplatePillarReviewSummary struct {

	// 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.
	Notes *string

	// The ID used to identify a pillar, for example, security .
	//
	// A pillar is identified by its PillarReviewSummary$PillarId.
	PillarId *string

	// The name of the pillar.
	PillarName *string

	// A count of how many questions are answered and unanswered in the requested
	// pillar of the lens review.
	QuestionCounts map[string]int32
	// contains filtered or unexported fields
}

Summary of a review template.

type ReviewTemplateSummary 

type ReviewTemplateSummary struct {

	// Description of the review template.
	Description *string

	// Lenses associated with the review template.
	Lenses []string

	// An Amazon Web Services account ID.
	Owner *string

	// The review template ARN.
	TemplateArn *string

	// The name of the review template.
	TemplateName *string

	// The latest status of a review template.
	UpdateStatus ReviewTemplateUpdateStatus

	// The date and time recorded.
	UpdatedAt *time.Time
	// contains filtered or unexported fields
}

Summary of a review template.

type ReviewTemplateUpdateStatus 

type ReviewTemplateUpdateStatus string
const (
	ReviewTemplateUpdateStatusCurrent        ReviewTemplateUpdateStatus = "CURRENT"
	ReviewTemplateUpdateStatusLensNotCurrent ReviewTemplateUpdateStatus = "LENS_NOT_CURRENT"
)

Enum values for ReviewTemplateUpdateStatus

func (ReviewTemplateUpdateStatus) Values 

func (ReviewTemplateUpdateStatus) Values() []ReviewTemplateUpdateStatus

Values returns all known values for ReviewTemplateUpdateStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type Risk 

type Risk string
const (
	RiskUnanswered    Risk = "UNANSWERED"
	RiskHigh          Risk = "HIGH"
	RiskMedium        Risk = "MEDIUM"
	RiskNone          Risk = "NONE"
	RiskNotApplicable Risk = "NOT_APPLICABLE"
)

Enum values for Risk

func (Risk) Values 

func (Risk) Values() []Risk

Values returns all known values for Risk. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type SelectedPillar 

type SelectedPillar struct {

	// The ID used to identify a pillar, for example, security .
	//
	// A pillar is identified by its PillarReviewSummary$PillarId.
	PillarId *string

	// Selected question IDs in the selected pillar.
	SelectedQuestionIds []string
	// contains filtered or unexported fields
}

The selected pillar.

type ServiceQuotaExceededException 

type ServiceQuotaExceededException struct {
	Message *string

	ErrorCodeOverride *string

	ResourceId   *string
	ResourceType *string
	QuotaCode    *string
	ServiceCode  *string
	// contains filtered or unexported fields
}

The user has reached their resource quota.

func (*ServiceQuotaExceededException) Error 

func (e *ServiceQuotaExceededException) Error() string

func (*ServiceQuotaExceededException) ErrorCode 

func (e *ServiceQuotaExceededException) ErrorCode() string

func (*ServiceQuotaExceededException) ErrorFault 

func (e *ServiceQuotaExceededException) ErrorFault() smithy.ErrorFault

func (*ServiceQuotaExceededException) ErrorMessage 

func (e *ServiceQuotaExceededException) ErrorMessage() string

type ShareInvitation 

type ShareInvitation struct {

	// 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.
	LensAlias *string

	// The ARN for the lens.
	LensArn *string

	// The profile ARN.
	ProfileArn *string

	// The ID assigned to the share invitation.
	ShareInvitationId *string

	// The resource type of the share invitation.
	ShareResourceType ShareResourceType

	// The review template ARN.
	TemplateArn *string

	// The ID assigned to the workload. This ID is unique within an Amazon Web
	// Services Region.
	WorkloadId *string
	// contains filtered or unexported fields
}

The share invitation.

type ShareInvitationAction 

type ShareInvitationAction string
const (
	ShareInvitationActionAccept ShareInvitationAction = "ACCEPT"
	ShareInvitationActionReject ShareInvitationAction = "REJECT"
)

Enum values for ShareInvitationAction

func (ShareInvitationAction) Values 

func (ShareInvitationAction) Values() []ShareInvitationAction

Values returns all known values for ShareInvitationAction. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ShareInvitationSummary 

type ShareInvitationSummary struct {

	// The ARN for the lens.
	LensArn *string

	// The full name of the lens.
	LensName *string

	// Permission granted on a share request.
	PermissionType PermissionType

	// The profile ARN.
	ProfileArn *string

	// The profile name.
	ProfileName *string

	// The ID assigned to the share invitation.
	ShareInvitationId *string

	// The resource type of the share invitation.
	ShareResourceType ShareResourceType

	// An Amazon Web Services account ID.
	SharedBy *string

	// The Amazon Web Services account ID, organization ID, or organizational unit
	// (OU) ID with which the workload, lens, profile, or review template is shared.
	SharedWith *string

	// The review template ARN.
	TemplateArn *string

	// The name of the review template.
	TemplateName *string

	// The ID assigned to the workload. This ID is unique within an Amazon Web
	// Services Region.
	WorkloadId *string

	// 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.
	WorkloadName *string
	// contains filtered or unexported fields
}

A share invitation summary return object.

type ShareResourceType 

type ShareResourceType string
const (
	ShareResourceTypeWorkload ShareResourceType = "WORKLOAD"
	ShareResourceTypeLens     ShareResourceType = "LENS"
	ShareResourceTypeProfile  ShareResourceType = "PROFILE"
	ShareResourceTypeTemplate ShareResourceType = "TEMPLATE"
)

Enum values for ShareResourceType

func (ShareResourceType) Values 

func (ShareResourceType) Values() []ShareResourceType

Values returns all known values for ShareResourceType. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ShareStatus 

type ShareStatus string
const (
	ShareStatusAccepted    ShareStatus = "ACCEPTED"
	ShareStatusRejected    ShareStatus = "REJECTED"
	ShareStatusPending     ShareStatus = "PENDING"
	ShareStatusRevoked     ShareStatus = "REVOKED"
	ShareStatusExpired     ShareStatus = "EXPIRED"
	ShareStatusAssociating ShareStatus = "ASSOCIATING"
	ShareStatusAssociated  ShareStatus = "ASSOCIATED"
	ShareStatusFailed      ShareStatus = "FAILED"
)

Enum values for ShareStatus

func (ShareStatus) Values 

func (ShareStatus) Values() []ShareStatus

Values returns all known values for ShareStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type TemplateShareSummary 

type TemplateShareSummary struct {

	// The ID associated with the share.
	ShareId *string

	// The Amazon Web Services account ID, organization ID, or organizational unit
	// (OU) ID with which the workload, lens, profile, or review template is shared.
	SharedWith *string

	// The status of the share request.
	Status ShareStatus

	// Review template share invitation status message.
	StatusMessage *string
	// contains filtered or unexported fields
}

Summary of a review template share.

type ThrottlingException 

type ThrottlingException struct {
	Message *string

	ErrorCodeOverride *string

	QuotaCode   *string
	ServiceCode *string
	// contains filtered or unexported fields
}

Request was denied due to request throttling.

func (*ThrottlingException) Error 

func (e *ThrottlingException) Error() string

func (*ThrottlingException) ErrorCode 

func (e *ThrottlingException) ErrorCode() string

func (*ThrottlingException) ErrorFault 

func (e *ThrottlingException) ErrorFault() smithy.ErrorFault

func (*ThrottlingException) ErrorMessage 

func (e *ThrottlingException) ErrorMessage() string

type TrustedAdvisorIntegrationStatus 

type TrustedAdvisorIntegrationStatus string
const (
	TrustedAdvisorIntegrationStatusEnabled  TrustedAdvisorIntegrationStatus = "ENABLED"
	TrustedAdvisorIntegrationStatusDisabled TrustedAdvisorIntegrationStatus = "DISABLED"
)

Enum values for TrustedAdvisorIntegrationStatus

func (TrustedAdvisorIntegrationStatus) Values 

func (TrustedAdvisorIntegrationStatus) Values() []TrustedAdvisorIntegrationStatus

Values returns all known values for TrustedAdvisorIntegrationStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type ValidationException 

type ValidationException struct {
	Message *string

	ErrorCodeOverride *string

	Reason ValidationExceptionReason
	Fields []ValidationExceptionField
	// contains filtered or unexported fields
}

The user input is not valid.

func (*ValidationException) Error 

func (e *ValidationException) Error() string

func (*ValidationException) ErrorCode 

func (e *ValidationException) ErrorCode() string

func (*ValidationException) ErrorFault 

func (e *ValidationException) ErrorFault() smithy.ErrorFault

func (*ValidationException) ErrorMessage 

func (e *ValidationException) ErrorMessage() string

type ValidationExceptionField 

type ValidationExceptionField struct {

	// Description of the error.
	//
	// This member is required.
	Message *string

	// The field name for which validation failed.
	//
	// This member is required.
	Name *string
	// contains filtered or unexported fields
}

Stores information about a field passed inside a request that resulted in an exception.

type ValidationExceptionReason 

type ValidationExceptionReason string
const (
	ValidationExceptionReasonUnknownOperation      ValidationExceptionReason = "UNKNOWN_OPERATION"
	ValidationExceptionReasonCannotParse           ValidationExceptionReason = "CANNOT_PARSE"
	ValidationExceptionReasonFieldValidationFailed ValidationExceptionReason = "FIELD_VALIDATION_FAILED"
	ValidationExceptionReasonOther                 ValidationExceptionReason = "OTHER"
)

Enum values for ValidationExceptionReason

func (ValidationExceptionReason) Values 

func (ValidationExceptionReason) Values() []ValidationExceptionReason

Values returns all known values for ValidationExceptionReason. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type VersionDifferences 

type VersionDifferences struct {

	// The differences between the base and latest versions of the lens.
	PillarDifferences []PillarDifference
	// contains filtered or unexported fields
}

The differences between the base and latest versions of the lens.

type Workload 

type Workload struct {

	// The list of Amazon Web Services account IDs associated with the workload.
	AccountIds []string

	// List of AppRegistry application ARNs associated to the workload.
	Applications []string

	// The URL of the architectural design for the workload.
	ArchitecturalDesign *string

	// The list of Amazon Web Services Regions associated with the workload, for
	// example, us-east-2 , or ca-central-1 .
	AwsRegions []string

	// The description for the workload.
	Description *string

	// Discovery configuration associated to the workload.
	DiscoveryConfig *WorkloadDiscoveryConfig

	// The environment for the workload.
	Environment WorkloadEnvironment

	// The improvement status for a workload.
	ImprovementStatus WorkloadImprovementStatus

	// The industry for the workload.
	Industry *string

	// The industry type for the workload.
	//
	// If specified, must be one of the following:
	//
	//   - Agriculture
	//
	//   - Automobile
	//
	//   - Defense
	//
	//   - Design and Engineering
	//
	//   - Digital Advertising
	//
	//   - Education
	//
	//   - Environmental Protection
	//
	//   - Financial Services
	//
	//   - Gaming
	//
	//   - General Public Services
	//
	//   - Healthcare
	//
	//   - Hospitality
	//
	//   - InfoTech
	//
	//   - Justice and Public Safety
	//
	//   - Life Sciences
	//
	//   - Manufacturing
	//
	//   - Media & Entertainment
	//
	//   - Mining & Resources
	//
	//   - Oil & Gas
	//
	//   - Power & Utilities
	//
	//   - Professional Services
	//
	//   - Real Estate & Construction
	//
	//   - Retail & Wholesale
	//
	//   - Social Protection
	//
	//   - Telecommunications
	//
	//   - Travel, Transportation & Logistics
	//
	//   - Other
	IndustryType *string

	// 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.
	IsReviewOwnerUpdateAcknowledged *bool

	// Jira configuration for a specific workload.
	JiraConfiguration *WorkloadJiraConfigurationOutput

	// 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.
	Lenses []string

	//  The list of non-Amazon Web Services Regions associated with the workload.
	NonAwsRegions []string

	// 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.
	Notes *string

	// An Amazon Web Services account ID.
	Owner *string

	// The priorities of the pillars, which are used to order items in the improvement
	// plan. Each pillar is represented by its PillarReviewSummary$PillarId.
	PillarPriorities []string

	// A map from risk names to the count of how many questions have that rating.
	PrioritizedRiskCounts map[string]int32

	// Profile associated with a workload.
	Profiles []WorkloadProfile

	// The review owner of the workload. The name, email address, or identifier for
	// the primary group or individual that owns the workload review process.
	ReviewOwner *string

	// The date and time recorded.
	ReviewRestrictionDate *time.Time

	// A map from risk names to the count of how many questions have that rating.
	RiskCounts map[string]int32

	// The ID assigned to the share invitation.
	ShareInvitationId *string

	// The tags associated with the workload.
	Tags map[string]string

	// The date and time recorded.
	UpdatedAt *time.Time

	// The ARN for the workload.
	WorkloadArn *string

	// The ID assigned to the workload. This ID is unique within an Amazon Web
	// Services Region.
	WorkloadId *string

	// 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.
	WorkloadName *string
	// contains filtered or unexported fields
}

A workload return object.

type WorkloadDiscoveryConfig 

type WorkloadDiscoveryConfig struct {

	// Discovery integration status in respect to Trusted Advisor for the workload.
	TrustedAdvisorIntegrationStatus TrustedAdvisorIntegrationStatus

	// The mode to use for identifying resources associated with the workload.
	//
	// You can specify WORKLOAD_METADATA , APP_REGISTRY , or both.
	WorkloadResourceDefinition []DefinitionType
	// contains filtered or unexported fields
}

Discovery configuration associated to the workload.

type WorkloadEnvironment 

type WorkloadEnvironment string
const (
	WorkloadEnvironmentProduction    WorkloadEnvironment = "PRODUCTION"
	WorkloadEnvironmentPreproduction WorkloadEnvironment = "PREPRODUCTION"
)

Enum values for WorkloadEnvironment

func (WorkloadEnvironment) Values 

func (WorkloadEnvironment) Values() []WorkloadEnvironment

Values returns all known values for WorkloadEnvironment. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type WorkloadImprovementStatus 

type WorkloadImprovementStatus string
const (
	WorkloadImprovementStatusNotApplicable    WorkloadImprovementStatus = "NOT_APPLICABLE"
	WorkloadImprovementStatusNotStarted       WorkloadImprovementStatus = "NOT_STARTED"
	WorkloadImprovementStatusInProgress       WorkloadImprovementStatus = "IN_PROGRESS"
	WorkloadImprovementStatusComplete         WorkloadImprovementStatus = "COMPLETE"
	WorkloadImprovementStatusRiskAcknowledged WorkloadImprovementStatus = "RISK_ACKNOWLEDGED"
)

Enum values for WorkloadImprovementStatus

func (WorkloadImprovementStatus) Values 

func (WorkloadImprovementStatus) Values() []WorkloadImprovementStatus

Values returns all known values for WorkloadImprovementStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type WorkloadIssueManagementStatus 

type WorkloadIssueManagementStatus string
const (
	WorkloadIssueManagementStatusEnabled  WorkloadIssueManagementStatus = "ENABLED"
	WorkloadIssueManagementStatusDisabled WorkloadIssueManagementStatus = "DISABLED"
	WorkloadIssueManagementStatusInherit  WorkloadIssueManagementStatus = "INHERIT"
)

Enum values for WorkloadIssueManagementStatus

func (WorkloadIssueManagementStatus) Values 

func (WorkloadIssueManagementStatus) Values() []WorkloadIssueManagementStatus

Values returns all known values for WorkloadIssueManagementStatus. Note that this can be expanded in the future, and so it is only as up to date as the client.

The ordering of this slice is not guaranteed to be stable across updates.

type WorkloadJiraConfigurationInput 

type WorkloadJiraConfigurationInput struct {

	// Workload-level: Jira issue management status.
	IssueManagementStatus WorkloadIssueManagementStatus

	// Workload-level: Jira issue management type.
	IssueManagementType IssueManagementType

	// Workload-level: Jira project key to sync workloads to.
	JiraProjectKey *string
	// contains filtered or unexported fields
}

Workload-level: Input for the Jira configuration.

type WorkloadJiraConfigurationOutput 

type WorkloadJiraConfigurationOutput struct {

	// Workload-level: Jira issue management status.
	IssueManagementStatus WorkloadIssueManagementStatus

	// Workload-level: Jira issue management type.
	IssueManagementType IssueManagementType

	// Workload-level: Jira project key to sync workloads to.
	JiraProjectKey *string

	// Workload-level: Status message on configuration of the Jira integration.
	StatusMessage *string
	// contains filtered or unexported fields
}

Workload-level: Output configuration of the Jira integration.

type WorkloadProfile 

type WorkloadProfile struct {

	// The profile ARN.
	ProfileArn *string

	// The profile version.
	ProfileVersion *string
	// contains filtered or unexported fields
}

The profile associated with a workload.

type WorkloadShare 

type WorkloadShare struct {

	// Permission granted on a share request.
	PermissionType PermissionType

	// The ID associated with the share.
	ShareId *string

	// An Amazon Web Services account ID.
	SharedBy *string

	// The Amazon Web Services account ID, organization ID, or organizational unit
	// (OU) ID with which the workload, lens, profile, or review template is shared.
	SharedWith *string

	// The status of the share request.
	Status ShareStatus

	// The ID assigned to the workload. This ID is unique within an Amazon Web
	// Services Region.
	WorkloadId *string

	// 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.
	WorkloadName *string
	// contains filtered or unexported fields
}

A workload share return object.

type WorkloadShareSummary 

type WorkloadShareSummary struct {

	// Permission granted on a share request.
	PermissionType PermissionType

	// The ID associated with the share.
	ShareId *string

	// The Amazon Web Services account ID, organization ID, or organizational unit
	// (OU) ID with which the workload, lens, profile, or review template is shared.
	SharedWith *string

	// The status of the share request.
	Status ShareStatus

	// Optional message to compliment the Status field.
	StatusMessage *string
	// contains filtered or unexported fields
}

A workload share summary return object.

type WorkloadSummary 

type WorkloadSummary struct {

	// The improvement status for a workload.
	ImprovementStatus WorkloadImprovementStatus

	// 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.
	Lenses []string

	// An Amazon Web Services account ID.
	Owner *string

	// A map from risk names to the count of how many questions have that rating.
	PrioritizedRiskCounts map[string]int32

	// Profile associated with a workload.
	Profiles []WorkloadProfile

	// A map from risk names to the count of how many questions have that rating.
	RiskCounts map[string]int32

	// The date and time recorded.
	UpdatedAt *time.Time

	// The ARN for the workload.
	WorkloadArn *string

	// The ID assigned to the workload. This ID is unique within an Amazon Web
	// Services Region.
	WorkloadId *string

	// 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.
	WorkloadName *string
	// contains filtered or unexported fields
}

A workload summary return object.

Source Files

  • enums.go
  • errors.go
  • types.go

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.