Documentation
¶
Index ¶
- type AccessDeniedException
- type Answer
- type AnswerSummary
- type Choice
- type ConflictException
- type DifferenceStatus
- type ImprovementSummary
- type InternalServerException
- type LensReview
- type LensReviewReport
- type LensReviewSummary
- type LensStatus
- type LensSummary
- type LensUpgradeSummary
- type Milestone
- type MilestoneSummary
- type NotificationSummary
- type NotificationType
- type PermissionType
- type PillarDifference
- type PillarReviewSummary
- type QuestionDifference
- type ResourceNotFoundException
- type Risk
- type ServiceQuotaExceededException
- type ShareInvitation
- type ShareInvitationAction
- type ShareInvitationSummary
- type ShareStatus
- type ThrottlingException
- type ValidationException
- type ValidationExceptionField
- type ValidationExceptionReason
- type VersionDifferences
- type Workload
- type WorkloadEnvironment
- type WorkloadImprovementStatus
- type WorkloadShare
- type WorkloadShareSummary
- type WorkloadSummary
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AccessDeniedException ¶
type AccessDeniedException struct {
Message *string
}
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 Answer ¶
type Answer struct { // List of choices available for a question. Choices []Choice // The helpful resource URL for a question. HelpfulResourceUrl *string // The improvement plan URL for a question. ImprovementPlanUrl *string // Defines whether this question is applicable to a lens review. IsApplicable bool // The notes associated with the workload. 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 risk for a given workload, lens review, pillar, or question. Risk Risk // List of selected choice IDs in a question answer. SelectedChoices []string }
An answer of the question.
type AnswerSummary ¶
type AnswerSummary struct { // 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 risk for a given workload, lens review, pillar, or question. Risk Risk // List of selected choice IDs in a question answer. SelectedChoices []string }
An answer summary of a lens review in a workload.
type Choice ¶
type Choice struct { // The ID of a choice. ChoiceId *string // The description of a choice. Description *string // The title of a choice. Title *string }
A choice available to answer question.
type ConflictException ¶
The resource already exists.
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 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 ImprovementSummary ¶
type ImprovementSummary struct { // The improvement plan URL for a question. ImprovementPlanUrl *string // 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 }
An improvement summary of a lens review in a workload.
type InternalServerException ¶
type InternalServerException struct {
Message *string
}
There is a problem with the AWS 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 LensReview ¶
type LensReview struct { // The alias of the lens, for example, serverless. Each lens is identified by its // LensSummary$LensAlias. LensAlias *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. 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 questions have that rating. RiskCounts map[string]int32 // The date and time recorded. UpdatedAt *time.Time }
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. Base64String *string // The alias of the lens, for example, serverless. Each lens is identified by its // LensSummary$LensAlias. LensAlias *string }
A report of a lens review.
type LensReviewSummary ¶
type LensReviewSummary struct { // The alias of the lens, for example, serverless. Each lens is identified by its // LensSummary$LensAlias. LensAlias *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 questions have that rating. RiskCounts map[string]int32 // The date and time recorded. UpdatedAt *time.Time }
A lens review summary of a workload.
type LensStatus ¶
type LensStatus string
const ( LensStatusCurrent LensStatus = "CURRENT" LensStatusNotCurrent LensStatus = "NOT_CURRENT" LensStatusDeprecated LensStatus = "DEPRECATED" )
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 LensSummary ¶
type LensSummary struct { // The description of the lens. Description *string // The alias of the lens, for example, serverless. Each lens is identified by its // LensSummary$LensAlias. LensAlias *string // The full name of the lens. LensName *string // The version of the lens. LensVersion *string }
A lens summary of a lens.
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 example, serverless. Each lens is identified by its // LensSummary$LensAlias. LensAlias *string // The ID assigned to the workload. This ID is unique within an AWS Region. WorkloadId *string // The name of the workload. The name must be unique within an account within a // Region. Spaces and capitalization are ignored when checking for uniqueness. WorkloadName *string }
Lens upgrade summary return object.
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 }
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 }
A milestone summary return object.
type NotificationSummary ¶
type NotificationSummary struct { // Summary of lens upgrade. LensUpgradeSummary *LensUpgradeSummary // The type of notification. Type NotificationType }
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 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 // List of question differences. QuestionDifferences []QuestionDifference }
A pillar difference return object.
type PillarReviewSummary ¶
type PillarReviewSummary struct { // The notes associated with the workload. 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 questions have that rating. RiskCounts map[string]int32 }
A pillar review summary of a lens review.
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 }
A question difference return object.
type ResourceNotFoundException ¶
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 Risk ¶
type Risk string
type ServiceQuotaExceededException ¶
type ServiceQuotaExceededException struct { Message *string ResourceId *string ResourceType *string QuotaCode *string ServiceCode *string }
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 ¶
The share invitation.
type ShareInvitationAction ¶
type ShareInvitationAction string
const ()
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 { PermissionType ShareInvitationId *string SharedBy *string SharedWith *string WorkloadId *string // Region. Spaces and capitalization are ignored when checking for uniqueness. WorkloadName *string }PermissionType
A share invitation summary return object.
type ShareStatus ¶
type ShareStatus string
const ()
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 ThrottlingException ¶
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 ValidationException ¶
type ValidationException struct { Message *string Reason ValidationExceptionReason Fields []ValidationExceptionField }
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 }
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 }
The differences between the base and latest versions of the lens.
type Workload ¶
type Workload struct { // The list of AWS account IDs associated with the workload. AccountIds []string // The URL of the architectural design for the workload. ArchitecturalDesign *string // The list of AWS Regions associated with the workload, for example, us-east-2, or // ca-central-1. AwsRegions []string // The description for the workload. Description *string // 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 // The list of lenses associated with the workload. Each lens is identified by its // LensSummary$LensAlias. Lenses []string // The list of non-AWS Regions associated with the workload. NonAwsRegions []string // The notes associated with the workload. Notes *string // An AWS 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 // 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 questions have that rating. RiskCounts map[string]int32 ShareInvitationId *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 AWS Region. WorkloadId *string // The name of the workload. The name must be unique within an account within a // Region. Spaces and capitalization are ignored when checking for uniqueness. WorkloadName *string }
A workload return object.
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 WorkloadShare ¶
type WorkloadShare struct { PermissionType ShareId *string SharedBy *string SharedWith *string Status ShareStatus WorkloadId *string // Region. Spaces and capitalization are ignored when checking for uniqueness. WorkloadName *string }PermissionType
A workload share return object.
type WorkloadShareSummary ¶
type WorkloadShareSummary struct { PermissionType ShareId *string SharedWith *string Status ShareStatus }PermissionType
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. Lenses []string // An AWS account ID. Owner *string // A map from risk names to the count of how 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 AWS Region. WorkloadId *string // The name of the workload. The name must be unique within an account within a // Region. Spaces and capitalization are ignored when checking for uniqueness. WorkloadName *string }
A workload summary return object.