wellarchitected

package
v1.44.279 Latest Latest
Warning

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

Go to latest
Published: Jun 8, 2023 License: Apache-2.0 Imports: 10 Imported by: 13

Documentation

Overview

Package wellarchitected provides the client and types for making API requests to AWS Well-Architected Tool.

This is the Well-Architected Tool API Reference. The WA Tool API provides programmatic access to the Well-Architected Tool (http://aws.amazon.com/well-architected-tool) in the Amazon Web Services Management Console (https://console.aws.amazon.com/wellarchitected). For information about the Well-Architected Tool, see the Well-Architected Tool User Guide (https://docs.aws.amazon.com/wellarchitected/latest/userguide/intro.html).

See https://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31 for more information on this service.

See wellarchitected package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/wellarchitected/

Using the Client

To contact AWS Well-Architected Tool with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the AWS Well-Architected Tool client WellArchitected for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/wellarchitected/#New

Index

Constants

View Source
const (
	// AdditionalResourceTypeHelpfulResource is a AdditionalResourceType enum value
	AdditionalResourceTypeHelpfulResource = "HELPFUL_RESOURCE"

	// AdditionalResourceTypeImprovementPlan is a AdditionalResourceType enum value
	AdditionalResourceTypeImprovementPlan = "IMPROVEMENT_PLAN"
)
View Source
const (
	// AnswerReasonOutOfScope is a AnswerReason enum value
	AnswerReasonOutOfScope = "OUT_OF_SCOPE"

	// AnswerReasonBusinessPriorities is a AnswerReason enum value
	AnswerReasonBusinessPriorities = "BUSINESS_PRIORITIES"

	// AnswerReasonArchitectureConstraints is a AnswerReason enum value
	AnswerReasonArchitectureConstraints = "ARCHITECTURE_CONSTRAINTS"

	// AnswerReasonOther is a AnswerReason enum value
	AnswerReasonOther = "OTHER"

	// AnswerReasonNone is a AnswerReason enum value
	AnswerReasonNone = "NONE"
)
View Source
const (
	// CheckFailureReasonAssumeRoleError is a CheckFailureReason enum value
	CheckFailureReasonAssumeRoleError = "ASSUME_ROLE_ERROR"

	// CheckFailureReasonAccessDenied is a CheckFailureReason enum value
	CheckFailureReasonAccessDenied = "ACCESS_DENIED"

	// CheckFailureReasonUnknownError is a CheckFailureReason enum value
	CheckFailureReasonUnknownError = "UNKNOWN_ERROR"

	// CheckFailureReasonPremiumSupportRequired is a CheckFailureReason enum value
	CheckFailureReasonPremiumSupportRequired = "PREMIUM_SUPPORT_REQUIRED"
)
View Source
const (
	// CheckStatusOkay is a CheckStatus enum value
	CheckStatusOkay = "OKAY"

	// CheckStatusWarning is a CheckStatus enum value
	CheckStatusWarning = "WARNING"

	// CheckStatusError is a CheckStatus enum value
	CheckStatusError = "ERROR"

	// CheckStatusNotAvailable is a CheckStatus enum value
	CheckStatusNotAvailable = "NOT_AVAILABLE"

	// CheckStatusFetchFailed is a CheckStatus enum value
	CheckStatusFetchFailed = "FETCH_FAILED"
)
View Source
const (
	// ChoiceReasonOutOfScope is a ChoiceReason enum value
	ChoiceReasonOutOfScope = "OUT_OF_SCOPE"

	// ChoiceReasonBusinessPriorities is a ChoiceReason enum value
	ChoiceReasonBusinessPriorities = "BUSINESS_PRIORITIES"

	// ChoiceReasonArchitectureConstraints is a ChoiceReason enum value
	ChoiceReasonArchitectureConstraints = "ARCHITECTURE_CONSTRAINTS"

	// ChoiceReasonOther is a ChoiceReason enum value
	ChoiceReasonOther = "OTHER"

	// ChoiceReasonNone is a ChoiceReason enum value
	ChoiceReasonNone = "NONE"
)
View Source
const (
	// ChoiceStatusSelected is a ChoiceStatus enum value
	ChoiceStatusSelected = "SELECTED"

	// ChoiceStatusNotApplicable is a ChoiceStatus enum value
	ChoiceStatusNotApplicable = "NOT_APPLICABLE"

	// ChoiceStatusUnselected is a ChoiceStatus enum value
	ChoiceStatusUnselected = "UNSELECTED"
)
View Source
const (
	// DefinitionTypeWorkloadMetadata is a DefinitionType enum value
	DefinitionTypeWorkloadMetadata = "WORKLOAD_METADATA"

	// DefinitionTypeAppRegistry is a DefinitionType enum value
	DefinitionTypeAppRegistry = "APP_REGISTRY"
)
View Source
const (
	// DifferenceStatusUpdated is a DifferenceStatus enum value
	DifferenceStatusUpdated = "UPDATED"

	// DifferenceStatusNew is a DifferenceStatus enum value
	DifferenceStatusNew = "NEW"

	// DifferenceStatusDeleted is a DifferenceStatus enum value
	DifferenceStatusDeleted = "DELETED"
)
View Source
const (
	// DiscoveryIntegrationStatusEnabled is a DiscoveryIntegrationStatus enum value
	DiscoveryIntegrationStatusEnabled = "ENABLED"

	// DiscoveryIntegrationStatusDisabled is a DiscoveryIntegrationStatus enum value
	DiscoveryIntegrationStatusDisabled = "DISABLED"
)
View Source
const (
	// ImportLensStatusInProgress is a ImportLensStatus enum value
	ImportLensStatusInProgress = "IN_PROGRESS"

	// ImportLensStatusComplete is a ImportLensStatus enum value
	ImportLensStatusComplete = "COMPLETE"

	// ImportLensStatusError is a ImportLensStatus enum value
	ImportLensStatusError = "ERROR"
)
View Source
const (
	// LensStatusCurrent is a LensStatus enum value
	LensStatusCurrent = "CURRENT"

	// LensStatusNotCurrent is a LensStatus enum value
	LensStatusNotCurrent = "NOT_CURRENT"

	// LensStatusDeprecated is a LensStatus enum value
	LensStatusDeprecated = "DEPRECATED"

	// LensStatusDeleted is a LensStatus enum value
	LensStatusDeleted = "DELETED"

	// LensStatusUnshared is a LensStatus enum value
	LensStatusUnshared = "UNSHARED"
)
View Source
const (
	// LensStatusTypeAll is a LensStatusType enum value
	LensStatusTypeAll = "ALL"

	// LensStatusTypeDraft is a LensStatusType enum value
	LensStatusTypeDraft = "DRAFT"

	// LensStatusTypePublished is a LensStatusType enum value
	LensStatusTypePublished = "PUBLISHED"
)
View Source
const (
	// LensTypeAwsOfficial is a LensType enum value
	LensTypeAwsOfficial = "AWS_OFFICIAL"

	// LensTypeCustomShared is a LensType enum value
	LensTypeCustomShared = "CUSTOM_SHARED"

	// LensTypeCustomSelf is a LensType enum value
	LensTypeCustomSelf = "CUSTOM_SELF"
)
View Source
const (
	// NotificationTypeLensVersionUpgraded is a NotificationType enum value
	NotificationTypeLensVersionUpgraded = "LENS_VERSION_UPGRADED"

	// NotificationTypeLensVersionDeprecated is a NotificationType enum value
	NotificationTypeLensVersionDeprecated = "LENS_VERSION_DEPRECATED"
)
View Source
const (
	// OrganizationSharingStatusEnabled is a OrganizationSharingStatus enum value
	OrganizationSharingStatusEnabled = "ENABLED"

	// OrganizationSharingStatusDisabled is a OrganizationSharingStatus enum value
	OrganizationSharingStatusDisabled = "DISABLED"
)
View Source
const (
	// PermissionTypeReadonly is a PermissionType enum value
	PermissionTypeReadonly = "READONLY"

	// PermissionTypeContributor is a PermissionType enum value
	PermissionTypeContributor = "CONTRIBUTOR"
)

Permission granted on a workload share.

View Source
const (
	// ReportFormatPdf is a ReportFormat enum value
	ReportFormatPdf = "PDF"

	// ReportFormatJson is a ReportFormat enum value
	ReportFormatJson = "JSON"
)
View Source
const (
	// RiskUnanswered is a Risk enum value
	RiskUnanswered = "UNANSWERED"

	// RiskHigh is a Risk enum value
	RiskHigh = "HIGH"

	// RiskMedium is a Risk enum value
	RiskMedium = "MEDIUM"

	// RiskNone is a Risk enum value
	RiskNone = "NONE"

	// RiskNotApplicable is a Risk enum value
	RiskNotApplicable = "NOT_APPLICABLE"
)

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

View Source
const (
	// ShareInvitationActionAccept is a ShareInvitationAction enum value
	ShareInvitationActionAccept = "ACCEPT"

	// ShareInvitationActionReject is a ShareInvitationAction enum value
	ShareInvitationActionReject = "REJECT"
)

Share invitation action taken by contributor.

View Source
const (
	// ShareResourceTypeWorkload is a ShareResourceType enum value
	ShareResourceTypeWorkload = "WORKLOAD"

	// ShareResourceTypeLens is a ShareResourceType enum value
	ShareResourceTypeLens = "LENS"
)
View Source
const (
	// ShareStatusAccepted is a ShareStatus enum value
	ShareStatusAccepted = "ACCEPTED"

	// ShareStatusRejected is a ShareStatus enum value
	ShareStatusRejected = "REJECTED"

	// ShareStatusPending is a ShareStatus enum value
	ShareStatusPending = "PENDING"

	// ShareStatusRevoked is a ShareStatus enum value
	ShareStatusRevoked = "REVOKED"

	// ShareStatusExpired is a ShareStatus enum value
	ShareStatusExpired = "EXPIRED"

	// ShareStatusAssociating is a ShareStatus enum value
	ShareStatusAssociating = "ASSOCIATING"

	// ShareStatusAssociated is a ShareStatus enum value
	ShareStatusAssociated = "ASSOCIATED"

	// ShareStatusFailed is a ShareStatus enum value
	ShareStatusFailed = "FAILED"
)

The status of a workload share.

View Source
const (
	// TrustedAdvisorIntegrationStatusEnabled is a TrustedAdvisorIntegrationStatus enum value
	TrustedAdvisorIntegrationStatusEnabled = "ENABLED"

	// TrustedAdvisorIntegrationStatusDisabled is a TrustedAdvisorIntegrationStatus enum value
	TrustedAdvisorIntegrationStatusDisabled = "DISABLED"
)
View Source
const (
	// ValidationExceptionReasonUnknownOperation is a ValidationExceptionReason enum value
	ValidationExceptionReasonUnknownOperation = "UNKNOWN_OPERATION"

	// ValidationExceptionReasonCannotParse is a ValidationExceptionReason enum value
	ValidationExceptionReasonCannotParse = "CANNOT_PARSE"

	// ValidationExceptionReasonFieldValidationFailed is a ValidationExceptionReason enum value
	ValidationExceptionReasonFieldValidationFailed = "FIELD_VALIDATION_FAILED"

	// ValidationExceptionReasonOther is a ValidationExceptionReason enum value
	ValidationExceptionReasonOther = "OTHER"
)

The reason why the request failed validation.

View Source
const (
	// WorkloadEnvironmentProduction is a WorkloadEnvironment enum value
	WorkloadEnvironmentProduction = "PRODUCTION"

	// WorkloadEnvironmentPreproduction is a WorkloadEnvironment enum value
	WorkloadEnvironmentPreproduction = "PREPRODUCTION"
)

The environment for the workload.

View Source
const (
	// WorkloadImprovementStatusNotApplicable is a WorkloadImprovementStatus enum value
	WorkloadImprovementStatusNotApplicable = "NOT_APPLICABLE"

	// WorkloadImprovementStatusNotStarted is a WorkloadImprovementStatus enum value
	WorkloadImprovementStatusNotStarted = "NOT_STARTED"

	// WorkloadImprovementStatusInProgress is a WorkloadImprovementStatus enum value
	WorkloadImprovementStatusInProgress = "IN_PROGRESS"

	// WorkloadImprovementStatusComplete is a WorkloadImprovementStatus enum value
	WorkloadImprovementStatusComplete = "COMPLETE"

	// WorkloadImprovementStatusRiskAcknowledged is a WorkloadImprovementStatus enum value
	WorkloadImprovementStatusRiskAcknowledged = "RISK_ACKNOWLEDGED"
)

The improvement status for a workload.

View Source
const (

	// ErrCodeAccessDeniedException for service response error code
	// "AccessDeniedException".
	//
	// User does not have sufficient access to perform this action.
	ErrCodeAccessDeniedException = "AccessDeniedException"

	// ErrCodeConflictException for service response error code
	// "ConflictException".
	//
	// The resource has already been processed, was deleted, or is too large.
	ErrCodeConflictException = "ConflictException"

	// ErrCodeInternalServerException for service response error code
	// "InternalServerException".
	//
	// There is a problem with the Well-Architected Tool API service.
	ErrCodeInternalServerException = "InternalServerException"

	// ErrCodeResourceNotFoundException for service response error code
	// "ResourceNotFoundException".
	//
	// The requested resource was not found.
	ErrCodeResourceNotFoundException = "ResourceNotFoundException"

	// ErrCodeServiceQuotaExceededException for service response error code
	// "ServiceQuotaExceededException".
	//
	// The user has reached their resource quota.
	ErrCodeServiceQuotaExceededException = "ServiceQuotaExceededException"

	// ErrCodeThrottlingException for service response error code
	// "ThrottlingException".
	//
	// Request was denied due to request throttling.
	ErrCodeThrottlingException = "ThrottlingException"

	// ErrCodeValidationException for service response error code
	// "ValidationException".
	//
	// The user input is not valid.
	ErrCodeValidationException = "ValidationException"
)
View Source
const (
	ServiceName = "WellArchitected" // Name of service.
	EndpointsID = "wellarchitected" // ID to lookup a service endpoint with.
	ServiceID   = "WellArchitected" // ServiceID is a unique identifier of a specific service.
)

Service information constants

View Source
const (
	// CheckProviderTrustedAdvisor is a CheckProvider enum value
	CheckProviderTrustedAdvisor = "TRUSTED_ADVISOR"
)
View Source
const (
	// MetricTypeWorkload is a MetricType enum value
	MetricTypeWorkload = "WORKLOAD"
)

Variables

This section is empty.

Functions

func AdditionalResourceType_Values added in v1.44.39

func AdditionalResourceType_Values() []string

AdditionalResourceType_Values returns all elements of the AdditionalResourceType enum

func AnswerReason_Values added in v1.40.0

func AnswerReason_Values() []string

AnswerReason_Values returns all elements of the AnswerReason enum

func CheckFailureReason_Values added in v1.44.132

func CheckFailureReason_Values() []string

CheckFailureReason_Values returns all elements of the CheckFailureReason enum

func CheckProvider_Values added in v1.44.132

func CheckProvider_Values() []string

CheckProvider_Values returns all elements of the CheckProvider enum

func CheckStatus_Values added in v1.44.132

func CheckStatus_Values() []string

CheckStatus_Values returns all elements of the CheckStatus enum

func ChoiceReason_Values added in v1.40.0

func ChoiceReason_Values() []string

ChoiceReason_Values returns all elements of the ChoiceReason enum

func ChoiceStatus_Values added in v1.40.0

func ChoiceStatus_Values() []string

ChoiceStatus_Values returns all elements of the ChoiceStatus enum

func DefinitionType_Values added in v1.44.256

func DefinitionType_Values() []string

DefinitionType_Values returns all elements of the DefinitionType enum

func DifferenceStatus_Values

func DifferenceStatus_Values() []string

DifferenceStatus_Values returns all elements of the DifferenceStatus enum

func DiscoveryIntegrationStatus_Values added in v1.44.256

func DiscoveryIntegrationStatus_Values() []string

DiscoveryIntegrationStatus_Values returns all elements of the DiscoveryIntegrationStatus enum

func ImportLensStatus_Values added in v1.42.15

func ImportLensStatus_Values() []string

ImportLensStatus_Values returns all elements of the ImportLensStatus enum

func LensStatusType_Values added in v1.42.15

func LensStatusType_Values() []string

LensStatusType_Values returns all elements of the LensStatusType enum

func LensStatus_Values

func LensStatus_Values() []string

LensStatus_Values returns all elements of the LensStatus enum

func LensType_Values added in v1.42.15

func LensType_Values() []string

LensType_Values returns all elements of the LensType enum

func MetricType_Values added in v1.44.233

func MetricType_Values() []string

MetricType_Values returns all elements of the MetricType enum

func NotificationType_Values

func NotificationType_Values() []string

NotificationType_Values returns all elements of the NotificationType enum

func OrganizationSharingStatus_Values added in v1.44.46

func OrganizationSharingStatus_Values() []string

OrganizationSharingStatus_Values returns all elements of the OrganizationSharingStatus enum

func PermissionType_Values

func PermissionType_Values() []string

PermissionType_Values returns all elements of the PermissionType enum

func ReportFormat_Values added in v1.44.233

func ReportFormat_Values() []string

ReportFormat_Values returns all elements of the ReportFormat enum

func Risk_Values

func Risk_Values() []string

Risk_Values returns all elements of the Risk enum

func ShareInvitationAction_Values

func ShareInvitationAction_Values() []string

ShareInvitationAction_Values returns all elements of the ShareInvitationAction enum

func ShareResourceType_Values added in v1.42.15

func ShareResourceType_Values() []string

ShareResourceType_Values returns all elements of the ShareResourceType enum

func ShareStatus_Values

func ShareStatus_Values() []string

ShareStatus_Values returns all elements of the ShareStatus enum

func TrustedAdvisorIntegrationStatus_Values added in v1.44.132

func TrustedAdvisorIntegrationStatus_Values() []string

TrustedAdvisorIntegrationStatus_Values returns all elements of the TrustedAdvisorIntegrationStatus enum

func ValidationExceptionReason_Values

func ValidationExceptionReason_Values() []string

ValidationExceptionReason_Values returns all elements of the ValidationExceptionReason enum

func WorkloadEnvironment_Values

func WorkloadEnvironment_Values() []string

WorkloadEnvironment_Values returns all elements of the WorkloadEnvironment enum

func WorkloadImprovementStatus_Values

func WorkloadImprovementStatus_Values() []string

WorkloadImprovementStatus_Values returns all elements of the WorkloadImprovementStatus enum

Types

type AccessDeniedException

type AccessDeniedException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// Description of the error.
	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

User does not have sufficient access to perform this action.

func (*AccessDeniedException) Code

func (s *AccessDeniedException) Code() string

Code returns the exception type name.

func (*AccessDeniedException) Error

func (s *AccessDeniedException) Error() string

func (AccessDeniedException) GoString

func (s AccessDeniedException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AccessDeniedException) Message

func (s *AccessDeniedException) Message() string

Message returns the exception's message.

func (*AccessDeniedException) OrigErr

func (s *AccessDeniedException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*AccessDeniedException) RequestID

func (s *AccessDeniedException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*AccessDeniedException) StatusCode

func (s *AccessDeniedException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (AccessDeniedException) String

func (s AccessDeniedException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AdditionalResources added in v1.44.39

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:"list"`

	// Type of additional resource for a custom lens.
	Type *string `type:"string" enum:"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.

func (AdditionalResources) GoString added in v1.44.39

func (s AdditionalResources) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AdditionalResources) SetContent added in v1.44.39

SetContent sets the Content field's value.

func (*AdditionalResources) SetType added in v1.44.39

SetType sets the Type field's value.

func (AdditionalResources) String added in v1.44.39

func (s AdditionalResources) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Answer

type Answer struct {

	// A list of selected choices to a question in your workload.
	ChoiceAnswers []*ChoiceAnswer `type:"list"`

	// List of choices available for a question.
	Choices []*Choice `type:"list"`

	// The helpful resource text to be displayed for a custom lens.
	//
	// This field does not apply to Amazon Web Services official lenses.
	HelpfulResourceDisplayText *string `min:"1" type:"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 `min:"1" type:"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 `min:"1" type:"string"`

	// Defines whether this question is applicable to a lens review.
	IsApplicable *bool `type:"boolean"`

	// The notes associated with the workload.
	Notes *string `type:"string"`

	// The ID used to identify a pillar, for example, security.
	//
	// A pillar is identified by its PillarReviewSummary$PillarId.
	PillarId *string `min:"1" type:"string"`

	// The description of the question.
	QuestionDescription *string `min:"1" type:"string"`

	// The ID of the question.
	QuestionId *string `min:"1" type:"string"`

	// The title of the question.
	QuestionTitle *string `min:"1" type:"string"`

	// The reason why the question is not applicable to your workload.
	Reason *string `type:"string" enum:"AnswerReason"`

	// The risk for a given workload, lens review, pillar, or question.
	Risk *string `type:"string" enum:"Risk"`

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

An answer of the question.

func (Answer) GoString

func (s Answer) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Answer) SetChoiceAnswers added in v1.40.0

func (s *Answer) SetChoiceAnswers(v []*ChoiceAnswer) *Answer

SetChoiceAnswers sets the ChoiceAnswers field's value.

func (*Answer) SetChoices

func (s *Answer) SetChoices(v []*Choice) *Answer

SetChoices sets the Choices field's value.

func (*Answer) SetHelpfulResourceDisplayText added in v1.42.15

func (s *Answer) SetHelpfulResourceDisplayText(v string) *Answer

SetHelpfulResourceDisplayText sets the HelpfulResourceDisplayText field's value.

func (*Answer) SetHelpfulResourceUrl

func (s *Answer) SetHelpfulResourceUrl(v string) *Answer

SetHelpfulResourceUrl sets the HelpfulResourceUrl field's value.

func (*Answer) SetImprovementPlanUrl

func (s *Answer) SetImprovementPlanUrl(v string) *Answer

SetImprovementPlanUrl sets the ImprovementPlanUrl field's value.

func (*Answer) SetIsApplicable

func (s *Answer) SetIsApplicable(v bool) *Answer

SetIsApplicable sets the IsApplicable field's value.

func (*Answer) SetNotes

func (s *Answer) SetNotes(v string) *Answer

SetNotes sets the Notes field's value.

func (*Answer) SetPillarId

func (s *Answer) SetPillarId(v string) *Answer

SetPillarId sets the PillarId field's value.

func (*Answer) SetQuestionDescription

func (s *Answer) SetQuestionDescription(v string) *Answer

SetQuestionDescription sets the QuestionDescription field's value.

func (*Answer) SetQuestionId

func (s *Answer) SetQuestionId(v string) *Answer

SetQuestionId sets the QuestionId field's value.

func (*Answer) SetQuestionTitle

func (s *Answer) SetQuestionTitle(v string) *Answer

SetQuestionTitle sets the QuestionTitle field's value.

func (*Answer) SetReason added in v1.40.0

func (s *Answer) SetReason(v string) *Answer

SetReason sets the Reason field's value.

func (*Answer) SetRisk

func (s *Answer) SetRisk(v string) *Answer

SetRisk sets the Risk field's value.

func (*Answer) SetSelectedChoices

func (s *Answer) SetSelectedChoices(v []*string) *Answer

SetSelectedChoices sets the SelectedChoices field's value.

func (Answer) String

func (s Answer) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AnswerSummary

type AnswerSummary struct {

	// A list of selected choices to a question in your workload.
	ChoiceAnswerSummaries []*ChoiceAnswerSummary `type:"list"`

	// List of choices available for a question.
	Choices []*Choice `type:"list"`

	// Defines whether this question is applicable to a lens review.
	IsApplicable *bool `type:"boolean"`

	// The ID used to identify a pillar, for example, security.
	//
	// A pillar is identified by its PillarReviewSummary$PillarId.
	PillarId *string `min:"1" type:"string"`

	// The ID of the question.
	QuestionId *string `min:"1" type:"string"`

	// The title of the question.
	QuestionTitle *string `min:"1" type:"string"`

	// The reason why a choice is non-applicable to a question in your workload.
	Reason *string `type:"string" enum:"AnswerReason"`

	// The risk for a given workload, lens review, pillar, or question.
	Risk *string `type:"string" enum:"Risk"`

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

An answer summary of a lens review in a workload.

func (AnswerSummary) GoString

func (s AnswerSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AnswerSummary) SetChoiceAnswerSummaries added in v1.40.0

func (s *AnswerSummary) SetChoiceAnswerSummaries(v []*ChoiceAnswerSummary) *AnswerSummary

SetChoiceAnswerSummaries sets the ChoiceAnswerSummaries field's value.

func (*AnswerSummary) SetChoices

func (s *AnswerSummary) SetChoices(v []*Choice) *AnswerSummary

SetChoices sets the Choices field's value.

func (*AnswerSummary) SetIsApplicable

func (s *AnswerSummary) SetIsApplicable(v bool) *AnswerSummary

SetIsApplicable sets the IsApplicable field's value.

func (*AnswerSummary) SetPillarId

func (s *AnswerSummary) SetPillarId(v string) *AnswerSummary

SetPillarId sets the PillarId field's value.

func (*AnswerSummary) SetQuestionId

func (s *AnswerSummary) SetQuestionId(v string) *AnswerSummary

SetQuestionId sets the QuestionId field's value.

func (*AnswerSummary) SetQuestionTitle

func (s *AnswerSummary) SetQuestionTitle(v string) *AnswerSummary

SetQuestionTitle sets the QuestionTitle field's value.

func (*AnswerSummary) SetReason added in v1.40.0

func (s *AnswerSummary) SetReason(v string) *AnswerSummary

SetReason sets the Reason field's value.

func (*AnswerSummary) SetRisk

func (s *AnswerSummary) SetRisk(v string) *AnswerSummary

SetRisk sets the Risk field's value.

func (*AnswerSummary) SetSelectedChoices

func (s *AnswerSummary) SetSelectedChoices(v []*string) *AnswerSummary

SetSelectedChoices sets the SelectedChoices field's value.

func (AnswerSummary) String

func (s AnswerSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AssociateLensesInput

type AssociateLensesInput struct {

	// List of lens aliases to associate or disassociate with a workload. Up to
	// 10 lenses can be specified.
	//
	// Identify a lens using its LensSummary$LensAlias.
	//
	// LensAliases is a required field
	LensAliases []*string `min:"1" type:"list" required:"true"`

	// The ID assigned to the workload. This ID is unique within an Amazon Web Services
	// Region.
	//
	// WorkloadId is a required field
	WorkloadId *string `location:"uri" locationName:"WorkloadId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Input to associate lens reviews.

func (AssociateLensesInput) GoString

func (s AssociateLensesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AssociateLensesInput) SetLensAliases

func (s *AssociateLensesInput) SetLensAliases(v []*string) *AssociateLensesInput

SetLensAliases sets the LensAliases field's value.

func (*AssociateLensesInput) SetWorkloadId

func (s *AssociateLensesInput) SetWorkloadId(v string) *AssociateLensesInput

SetWorkloadId sets the WorkloadId field's value.

func (AssociateLensesInput) String

func (s AssociateLensesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AssociateLensesInput) Validate

func (s *AssociateLensesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type AssociateLensesOutput

type AssociateLensesOutput struct {
	// contains filtered or unexported fields
}

func (AssociateLensesOutput) GoString

func (s AssociateLensesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (AssociateLensesOutput) String

func (s AssociateLensesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type BestPractice added in v1.44.233

type BestPractice struct {

	// The ID of a choice.
	ChoiceId *string `min:"1" type:"string"`

	// The title of a choice.
	ChoiceTitle *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

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

func (BestPractice) GoString added in v1.44.233

func (s BestPractice) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*BestPractice) SetChoiceId added in v1.44.233

func (s *BestPractice) SetChoiceId(v string) *BestPractice

SetChoiceId sets the ChoiceId field's value.

func (*BestPractice) SetChoiceTitle added in v1.44.233

func (s *BestPractice) SetChoiceTitle(v string) *BestPractice

SetChoiceTitle sets the ChoiceTitle field's value.

func (BestPractice) String added in v1.44.233

func (s BestPractice) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CheckDetail added in v1.44.132

type CheckDetail struct {

	// An Amazon Web Services account ID.
	AccountId *string `type:"string"`

	// The ID of a choice.
	ChoiceId *string `min:"1" type:"string"`

	// Trusted Advisor check description.
	Description *string `type:"string"`

	// Count of flagged resources associated to the check.
	FlaggedResources *int64 `min:"1" type:"integer"`

	// Trusted Advisor check ID.
	Id *string `type:"string"`

	// Well-Architected Lens ARN associated to the check.
	LensArn *string `type:"string"`

	// Trusted Advisor check name.
	Name *string `type:"string"`

	// The ID used to identify a pillar, for example, security.
	//
	// A pillar is identified by its PillarReviewSummary$PillarId.
	PillarId *string `min:"1" type:"string"`

	// Provider of the check related to the best practice.
	Provider *string `type:"string" enum:"CheckProvider"`

	// The ID of the question.
	QuestionId *string `min:"1" type:"string"`

	// Reason associated to the check.
	Reason *string `type:"string" enum:"CheckFailureReason"`

	// Status associated to the check.
	Status *string `type:"string" enum:"CheckStatus"`

	// The date and time recorded.
	UpdatedAt *time.Time `type:"timestamp"`
	// contains filtered or unexported fields
}

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

func (CheckDetail) GoString added in v1.44.132

func (s CheckDetail) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CheckDetail) SetAccountId added in v1.44.132

func (s *CheckDetail) SetAccountId(v string) *CheckDetail

SetAccountId sets the AccountId field's value.

func (*CheckDetail) SetChoiceId added in v1.44.132

func (s *CheckDetail) SetChoiceId(v string) *CheckDetail

SetChoiceId sets the ChoiceId field's value.

func (*CheckDetail) SetDescription added in v1.44.132

func (s *CheckDetail) SetDescription(v string) *CheckDetail

SetDescription sets the Description field's value.

func (*CheckDetail) SetFlaggedResources added in v1.44.132

func (s *CheckDetail) SetFlaggedResources(v int64) *CheckDetail

SetFlaggedResources sets the FlaggedResources field's value.

func (*CheckDetail) SetId added in v1.44.132

func (s *CheckDetail) SetId(v string) *CheckDetail

SetId sets the Id field's value.

func (*CheckDetail) SetLensArn added in v1.44.132

func (s *CheckDetail) SetLensArn(v string) *CheckDetail

SetLensArn sets the LensArn field's value.

func (*CheckDetail) SetName added in v1.44.132

func (s *CheckDetail) SetName(v string) *CheckDetail

SetName sets the Name field's value.

func (*CheckDetail) SetPillarId added in v1.44.132

func (s *CheckDetail) SetPillarId(v string) *CheckDetail

SetPillarId sets the PillarId field's value.

func (*CheckDetail) SetProvider added in v1.44.132

func (s *CheckDetail) SetProvider(v string) *CheckDetail

SetProvider sets the Provider field's value.

func (*CheckDetail) SetQuestionId added in v1.44.132

func (s *CheckDetail) SetQuestionId(v string) *CheckDetail

SetQuestionId sets the QuestionId field's value.

func (*CheckDetail) SetReason added in v1.44.132

func (s *CheckDetail) SetReason(v string) *CheckDetail

SetReason sets the Reason field's value.

func (*CheckDetail) SetStatus added in v1.44.132

func (s *CheckDetail) SetStatus(v string) *CheckDetail

SetStatus sets the Status field's value.

func (*CheckDetail) SetUpdatedAt added in v1.44.132

func (s *CheckDetail) SetUpdatedAt(v time.Time) *CheckDetail

SetUpdatedAt sets the UpdatedAt field's value.

func (CheckDetail) String added in v1.44.132

func (s CheckDetail) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CheckSummary added in v1.44.132

type CheckSummary struct {

	// Account summary associated to the check.
	AccountSummary map[string]*int64 `type:"map"`

	// The ID of a choice.
	ChoiceId *string `min:"1" type:"string"`

	// Trusted Advisor check description.
	Description *string `type:"string"`

	// Trusted Advisor check ID.
	Id *string `type:"string"`

	// Well-Architected Lens ARN associated to the check.
	LensArn *string `type:"string"`

	// Trusted Advisor check name.
	Name *string `type:"string"`

	// The ID used to identify a pillar, for example, security.
	//
	// A pillar is identified by its PillarReviewSummary$PillarId.
	PillarId *string `min:"1" type:"string"`

	// Provider of the check related to the best practice.
	Provider *string `type:"string" enum:"CheckProvider"`

	// The ID of the question.
	QuestionId *string `min:"1" type:"string"`

	// Status associated to the check.
	Status *string `type:"string" enum:"CheckStatus"`

	// The date and time recorded.
	UpdatedAt *time.Time `type:"timestamp"`
	// contains filtered or unexported fields
}

Trusted Advisor check summary.

func (CheckSummary) GoString added in v1.44.132

func (s CheckSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CheckSummary) SetAccountSummary added in v1.44.132

func (s *CheckSummary) SetAccountSummary(v map[string]*int64) *CheckSummary

SetAccountSummary sets the AccountSummary field's value.

func (*CheckSummary) SetChoiceId added in v1.44.132

func (s *CheckSummary) SetChoiceId(v string) *CheckSummary

SetChoiceId sets the ChoiceId field's value.

func (*CheckSummary) SetDescription added in v1.44.132

func (s *CheckSummary) SetDescription(v string) *CheckSummary

SetDescription sets the Description field's value.

func (*CheckSummary) SetId added in v1.44.132

func (s *CheckSummary) SetId(v string) *CheckSummary

SetId sets the Id field's value.

func (*CheckSummary) SetLensArn added in v1.44.132

func (s *CheckSummary) SetLensArn(v string) *CheckSummary

SetLensArn sets the LensArn field's value.

func (*CheckSummary) SetName added in v1.44.132

func (s *CheckSummary) SetName(v string) *CheckSummary

SetName sets the Name field's value.

func (*CheckSummary) SetPillarId added in v1.44.132

func (s *CheckSummary) SetPillarId(v string) *CheckSummary

SetPillarId sets the PillarId field's value.

func (*CheckSummary) SetProvider added in v1.44.132

func (s *CheckSummary) SetProvider(v string) *CheckSummary

SetProvider sets the Provider field's value.

func (*CheckSummary) SetQuestionId added in v1.44.132

func (s *CheckSummary) SetQuestionId(v string) *CheckSummary

SetQuestionId sets the QuestionId field's value.

func (*CheckSummary) SetStatus added in v1.44.132

func (s *CheckSummary) SetStatus(v string) *CheckSummary

SetStatus sets the Status field's value.

func (*CheckSummary) SetUpdatedAt added in v1.44.132

func (s *CheckSummary) SetUpdatedAt(v time.Time) *CheckSummary

SetUpdatedAt sets the UpdatedAt field's value.

func (CheckSummary) String added in v1.44.132

func (s CheckSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 `type:"list"`

	// The ID of a choice.
	ChoiceId *string `min:"1" type:"string"`

	// The description of a choice.
	Description *string `min:"1" type:"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 `type:"structure"`

	// 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 `type:"structure"`

	// The title of a choice.
	Title *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

A choice available to answer question.

func (Choice) GoString

func (s Choice) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Choice) SetAdditionalResources added in v1.44.39

func (s *Choice) SetAdditionalResources(v []*AdditionalResources) *Choice

SetAdditionalResources sets the AdditionalResources field's value.

func (*Choice) SetChoiceId

func (s *Choice) SetChoiceId(v string) *Choice

SetChoiceId sets the ChoiceId field's value.

func (*Choice) SetDescription

func (s *Choice) SetDescription(v string) *Choice

SetDescription sets the Description field's value.

func (*Choice) SetHelpfulResource added in v1.42.15

func (s *Choice) SetHelpfulResource(v *ChoiceContent) *Choice

SetHelpfulResource sets the HelpfulResource field's value.

func (*Choice) SetImprovementPlan added in v1.42.15

func (s *Choice) SetImprovementPlan(v *ChoiceContent) *Choice

SetImprovementPlan sets the ImprovementPlan field's value.

func (*Choice) SetTitle

func (s *Choice) SetTitle(v string) *Choice

SetTitle sets the Title field's value.

func (Choice) String

func (s Choice) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ChoiceAnswer added in v1.40.0

type ChoiceAnswer struct {

	// The ID of a choice.
	ChoiceId *string `min:"1" type:"string"`

	// The notes associated with a choice.
	Notes *string `type:"string"`

	// The reason why a choice is non-applicable to a question in your workload.
	Reason *string `type:"string" enum:"ChoiceReason"`

	// The status of a choice.
	Status *string `type:"string" enum:"ChoiceStatus"`
	// contains filtered or unexported fields
}

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

func (ChoiceAnswer) GoString added in v1.40.0

func (s ChoiceAnswer) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ChoiceAnswer) SetChoiceId added in v1.40.0

func (s *ChoiceAnswer) SetChoiceId(v string) *ChoiceAnswer

SetChoiceId sets the ChoiceId field's value.

func (*ChoiceAnswer) SetNotes added in v1.40.0

func (s *ChoiceAnswer) SetNotes(v string) *ChoiceAnswer

SetNotes sets the Notes field's value.

func (*ChoiceAnswer) SetReason added in v1.40.0

func (s *ChoiceAnswer) SetReason(v string) *ChoiceAnswer

SetReason sets the Reason field's value.

func (*ChoiceAnswer) SetStatus added in v1.40.0

func (s *ChoiceAnswer) SetStatus(v string) *ChoiceAnswer

SetStatus sets the Status field's value.

func (ChoiceAnswer) String added in v1.40.0

func (s ChoiceAnswer) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ChoiceAnswerSummary added in v1.40.0

type ChoiceAnswerSummary struct {

	// The ID of a choice.
	ChoiceId *string `min:"1" type:"string"`

	// The reason why a choice is non-applicable to a question in your workload.
	Reason *string `type:"string" enum:"ChoiceReason"`

	// The status of a choice.
	Status *string `type:"string" enum:"ChoiceStatus"`
	// contains filtered or unexported fields
}

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

func (ChoiceAnswerSummary) GoString added in v1.40.0

func (s ChoiceAnswerSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ChoiceAnswerSummary) SetChoiceId added in v1.40.0

func (s *ChoiceAnswerSummary) SetChoiceId(v string) *ChoiceAnswerSummary

SetChoiceId sets the ChoiceId field's value.

func (*ChoiceAnswerSummary) SetReason added in v1.40.0

SetReason sets the Reason field's value.

func (*ChoiceAnswerSummary) SetStatus added in v1.40.0

SetStatus sets the Status field's value.

func (ChoiceAnswerSummary) String added in v1.40.0

func (s ChoiceAnswerSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ChoiceContent added in v1.42.15

type ChoiceContent struct {

	// The display text for the choice content.
	DisplayText *string `min:"1" type:"string"`

	// The URL for the choice content.
	Url *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

The choice content.

func (ChoiceContent) GoString added in v1.42.15

func (s ChoiceContent) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ChoiceContent) SetDisplayText added in v1.42.15

func (s *ChoiceContent) SetDisplayText(v string) *ChoiceContent

SetDisplayText sets the DisplayText field's value.

func (*ChoiceContent) SetUrl added in v1.42.15

func (s *ChoiceContent) SetUrl(v string) *ChoiceContent

SetUrl sets the Url field's value.

func (ChoiceContent) String added in v1.42.15

func (s ChoiceContent) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ChoiceImprovementPlan added in v1.42.15

type ChoiceImprovementPlan struct {

	// The ID of a choice.
	ChoiceId *string `min:"1" type:"string"`

	// The display text for the improvement plan.
	DisplayText *string `min:"1" type:"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 `min:"1" type:"string"`
	// contains filtered or unexported fields
}

The choice level improvement plan.

func (ChoiceImprovementPlan) GoString added in v1.42.15

func (s ChoiceImprovementPlan) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ChoiceImprovementPlan) SetChoiceId added in v1.42.15

SetChoiceId sets the ChoiceId field's value.

func (*ChoiceImprovementPlan) SetDisplayText added in v1.42.15

func (s *ChoiceImprovementPlan) SetDisplayText(v string) *ChoiceImprovementPlan

SetDisplayText sets the DisplayText field's value.

func (*ChoiceImprovementPlan) SetImprovementPlanUrl added in v1.42.15

func (s *ChoiceImprovementPlan) SetImprovementPlanUrl(v string) *ChoiceImprovementPlan

SetImprovementPlanUrl sets the ImprovementPlanUrl field's value.

func (ChoiceImprovementPlan) String added in v1.42.15

func (s ChoiceImprovementPlan) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ChoiceUpdate added in v1.40.0

type ChoiceUpdate struct {

	// The notes associated with a choice.
	Notes *string `type:"string"`

	// The reason why a choice is non-applicable to a question in your workload.
	Reason *string `type:"string" enum:"ChoiceReason"`

	// The status of a choice.
	//
	// Status is a required field
	Status *string `type:"string" required:"true" enum:"ChoiceStatus"`
	// contains filtered or unexported fields
}

A list of choices to be updated.

func (ChoiceUpdate) GoString added in v1.40.0

func (s ChoiceUpdate) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ChoiceUpdate) SetNotes added in v1.40.0

func (s *ChoiceUpdate) SetNotes(v string) *ChoiceUpdate

SetNotes sets the Notes field's value.

func (*ChoiceUpdate) SetReason added in v1.40.0

func (s *ChoiceUpdate) SetReason(v string) *ChoiceUpdate

SetReason sets the Reason field's value.

func (*ChoiceUpdate) SetStatus added in v1.40.0

func (s *ChoiceUpdate) SetStatus(v string) *ChoiceUpdate

SetStatus sets the Status field's value.

func (ChoiceUpdate) String added in v1.40.0

func (s ChoiceUpdate) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ChoiceUpdate) Validate added in v1.40.0

func (s *ChoiceUpdate) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ConflictException

type ConflictException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// Description of the error.
	Message_ *string `locationName:"Message" type:"string"`

	// Identifier of the resource affected.
	//
	// ResourceId is a required field
	ResourceId *string `type:"string" required:"true"`

	// Type of the resource affected.
	//
	// ResourceType is a required field
	ResourceType *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

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

func (*ConflictException) Code

func (s *ConflictException) Code() string

Code returns the exception type name.

func (*ConflictException) Error

func (s *ConflictException) Error() string

func (ConflictException) GoString

func (s ConflictException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ConflictException) Message

func (s *ConflictException) Message() string

Message returns the exception's message.

func (*ConflictException) OrigErr

func (s *ConflictException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ConflictException) RequestID

func (s *ConflictException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ConflictException) StatusCode

func (s *ConflictException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ConflictException) String

func (s ConflictException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ConsolidatedReportMetric added in v1.44.233

type ConsolidatedReportMetric struct {

	// The metrics for the lenses in the workload.
	Lenses []*LensMetric `type:"list"`

	// The total number of lenses applied to the workload.
	LensesAppliedCount *int64 `type:"integer"`

	// The metric type of a metric in the consolidated report. Currently only WORKLOAD
	// metric types are supported.
	MetricType *string `type:"string" enum:"MetricType"`

	// A map from risk names to the count of how many questions have that rating.
	RiskCounts map[string]*int64 `type:"map"`

	// The date and time recorded.
	UpdatedAt *time.Time `type:"timestamp"`

	// The ARN for the workload.
	WorkloadArn *string `type:"string"`

	// The ID assigned to the workload. This ID is unique within an Amazon Web Services
	// Region.
	WorkloadId *string `type:"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 `min:"3" type:"string"`
	// contains filtered or unexported fields
}

A metric that contributes to the consolidated report.

func (ConsolidatedReportMetric) GoString added in v1.44.233

func (s ConsolidatedReportMetric) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ConsolidatedReportMetric) SetLenses added in v1.44.233

SetLenses sets the Lenses field's value.

func (*ConsolidatedReportMetric) SetLensesAppliedCount added in v1.44.233

func (s *ConsolidatedReportMetric) SetLensesAppliedCount(v int64) *ConsolidatedReportMetric

SetLensesAppliedCount sets the LensesAppliedCount field's value.

func (*ConsolidatedReportMetric) SetMetricType added in v1.44.233

SetMetricType sets the MetricType field's value.

func (*ConsolidatedReportMetric) SetRiskCounts added in v1.44.233

SetRiskCounts sets the RiskCounts field's value.

func (*ConsolidatedReportMetric) SetUpdatedAt added in v1.44.233

SetUpdatedAt sets the UpdatedAt field's value.

func (*ConsolidatedReportMetric) SetWorkloadArn added in v1.44.233

SetWorkloadArn sets the WorkloadArn field's value.

func (*ConsolidatedReportMetric) SetWorkloadId added in v1.44.233

SetWorkloadId sets the WorkloadId field's value.

func (*ConsolidatedReportMetric) SetWorkloadName added in v1.44.233

SetWorkloadName sets the WorkloadName field's value.

func (ConsolidatedReportMetric) String added in v1.44.233

func (s ConsolidatedReportMetric) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateLensShareInput added in v1.42.15

type CreateLensShareInput struct {

	// A unique case-sensitive string used to ensure that this request is idempotent
	// (executes only once).
	//
	// You should not reuse the same token for other requests. If you retry a request
	// with the same client request token and the same parameters after the original
	// request has completed successfully, the result of the original request is
	// returned.
	//
	// This token is listed as required, however, if you do not specify it, the
	// Amazon Web Services SDKs automatically generate one for you. If you are not
	// using the Amazon Web Services SDK or the CLI, you must provide this token
	// or the request will fail.
	ClientRequestToken *string `type:"string" idempotencyToken:"true"`

	// 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 is a required field
	LensAlias *string `location:"uri" locationName:"LensAlias" min:"1" type:"string" required:"true"`

	// The Amazon Web Services account ID, IAM role, organization ID, or organizational
	// unit (OU) ID with which the workload is shared.
	//
	// SharedWith is a required field
	SharedWith *string `min:"12" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateLensShareInput) GoString added in v1.42.15

func (s CreateLensShareInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateLensShareInput) SetClientRequestToken added in v1.42.15

func (s *CreateLensShareInput) SetClientRequestToken(v string) *CreateLensShareInput

SetClientRequestToken sets the ClientRequestToken field's value.

func (*CreateLensShareInput) SetLensAlias added in v1.42.15

func (s *CreateLensShareInput) SetLensAlias(v string) *CreateLensShareInput

SetLensAlias sets the LensAlias field's value.

func (*CreateLensShareInput) SetSharedWith added in v1.42.15

func (s *CreateLensShareInput) SetSharedWith(v string) *CreateLensShareInput

SetSharedWith sets the SharedWith field's value.

func (CreateLensShareInput) String added in v1.42.15

func (s CreateLensShareInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateLensShareInput) Validate added in v1.42.15

func (s *CreateLensShareInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateLensShareOutput added in v1.42.15

type CreateLensShareOutput struct {

	// The ID associated with the workload share.
	ShareId *string `type:"string"`
	// contains filtered or unexported fields
}

func (CreateLensShareOutput) GoString added in v1.42.15

func (s CreateLensShareOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateLensShareOutput) SetShareId added in v1.42.15

SetShareId sets the ShareId field's value.

func (CreateLensShareOutput) String added in v1.42.15

func (s CreateLensShareOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateLensVersionInput added in v1.42.15

type CreateLensVersionInput struct {

	// A unique case-sensitive string used to ensure that this request is idempotent
	// (executes only once).
	//
	// You should not reuse the same token for other requests. If you retry a request
	// with the same client request token and the same parameters after the original
	// request has completed successfully, the result of the original request is
	// returned.
	//
	// This token is listed as required, however, if you do not specify it, the
	// Amazon Web Services SDKs automatically generate one for you. If you are not
	// using the Amazon Web Services SDK or the CLI, you must provide this token
	// or the request will fail.
	ClientRequestToken *string `type:"string" idempotencyToken:"true"`

	// Set to true if this new major lens version.
	IsMajorVersion *bool `type:"boolean"`

	// 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 is a required field
	LensAlias *string `location:"uri" locationName:"LensAlias" min:"1" type:"string" required:"true"`

	// The version of the lens being created.
	//
	// LensVersion is a required field
	LensVersion *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateLensVersionInput) GoString added in v1.42.15

func (s CreateLensVersionInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateLensVersionInput) SetClientRequestToken added in v1.42.15

func (s *CreateLensVersionInput) SetClientRequestToken(v string) *CreateLensVersionInput

SetClientRequestToken sets the ClientRequestToken field's value.

func (*CreateLensVersionInput) SetIsMajorVersion added in v1.42.15

func (s *CreateLensVersionInput) SetIsMajorVersion(v bool) *CreateLensVersionInput

SetIsMajorVersion sets the IsMajorVersion field's value.

func (*CreateLensVersionInput) SetLensAlias added in v1.42.15

SetLensAlias sets the LensAlias field's value.

func (*CreateLensVersionInput) SetLensVersion added in v1.42.15

SetLensVersion sets the LensVersion field's value.

func (CreateLensVersionInput) String added in v1.42.15

func (s CreateLensVersionInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateLensVersionInput) Validate added in v1.42.15

func (s *CreateLensVersionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateLensVersionOutput added in v1.42.15

type CreateLensVersionOutput struct {

	// The ARN for the lens.
	LensArn *string `type:"string"`

	// The version of the lens.
	LensVersion *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (CreateLensVersionOutput) GoString added in v1.42.15

func (s CreateLensVersionOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateLensVersionOutput) SetLensArn added in v1.42.15

SetLensArn sets the LensArn field's value.

func (*CreateLensVersionOutput) SetLensVersion added in v1.42.15

SetLensVersion sets the LensVersion field's value.

func (CreateLensVersionOutput) String added in v1.42.15

func (s CreateLensVersionOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateMilestoneInput

type CreateMilestoneInput struct {

	// A unique case-sensitive string used to ensure that this request is idempotent
	// (executes only once).
	//
	// You should not reuse the same token for other requests. If you retry a request
	// with the same client request token and the same parameters after the original
	// request has completed successfully, the result of the original request is
	// returned.
	//
	// This token is listed as required, however, if you do not specify it, the
	// Amazon Web Services SDKs automatically generate one for you. If you are not
	// using the Amazon Web Services SDK or the CLI, you must provide this token
	// or the request will fail.
	ClientRequestToken *string `type:"string" idempotencyToken:"true"`

	// The name of the milestone in a workload.
	//
	// Milestone names must be unique within a workload.
	//
	// MilestoneName is a required field
	MilestoneName *string `min:"3" type:"string" required:"true"`

	// The ID assigned to the workload. This ID is unique within an Amazon Web Services
	// Region.
	//
	// WorkloadId is a required field
	WorkloadId *string `location:"uri" locationName:"WorkloadId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Input for milestone creation.

func (CreateMilestoneInput) GoString

func (s CreateMilestoneInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateMilestoneInput) SetClientRequestToken

func (s *CreateMilestoneInput) SetClientRequestToken(v string) *CreateMilestoneInput

SetClientRequestToken sets the ClientRequestToken field's value.

func (*CreateMilestoneInput) SetMilestoneName

func (s *CreateMilestoneInput) SetMilestoneName(v string) *CreateMilestoneInput

SetMilestoneName sets the MilestoneName field's value.

func (*CreateMilestoneInput) SetWorkloadId

func (s *CreateMilestoneInput) SetWorkloadId(v string) *CreateMilestoneInput

SetWorkloadId sets the WorkloadId field's value.

func (CreateMilestoneInput) String

func (s CreateMilestoneInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateMilestoneInput) Validate

func (s *CreateMilestoneInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateMilestoneOutput

type CreateMilestoneOutput struct {

	// The milestone number.
	//
	// A workload can have a maximum of 100 milestones.
	MilestoneNumber *int64 `min:"1" type:"integer"`

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

Output of a create milestone call.

func (CreateMilestoneOutput) GoString

func (s CreateMilestoneOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateMilestoneOutput) SetMilestoneNumber

func (s *CreateMilestoneOutput) SetMilestoneNumber(v int64) *CreateMilestoneOutput

SetMilestoneNumber sets the MilestoneNumber field's value.

func (*CreateMilestoneOutput) SetWorkloadId

func (s *CreateMilestoneOutput) SetWorkloadId(v string) *CreateMilestoneOutput

SetWorkloadId sets the WorkloadId field's value.

func (CreateMilestoneOutput) String

func (s CreateMilestoneOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateWorkloadInput

type CreateWorkloadInput struct {

	// The list of Amazon Web Services account IDs associated with the workload.
	AccountIds []*string `type:"list"`

	// List of AppRegistry application ARNs associated to the workload.
	Applications []*string `type:"list"`

	// The URL of the architectural design for the workload.
	ArchitecturalDesign *string `type:"string"`

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

	// A unique case-sensitive string used to ensure that this request is idempotent
	// (executes only once).
	//
	// You should not reuse the same token for other requests. If you retry a request
	// with the same client request token and the same parameters after the original
	// request has completed successfully, the result of the original request is
	// returned.
	//
	// This token is listed as required, however, if you do not specify it, the
	// Amazon Web Services SDKs automatically generate one for you. If you are not
	// using the Amazon Web Services SDK or the CLI, you must provide this token
	// or the request will fail.
	ClientRequestToken *string `type:"string" idempotencyToken:"true"`

	// The description for the workload.
	//
	// Description is a required field
	Description *string `min:"3" type:"string" required:"true"`

	// Well-Architected discovery configuration settings associated to the workload.
	DiscoveryConfig *WorkloadDiscoveryConfig `type:"structure"`

	// The environment for the workload.
	//
	// Environment is a required field
	Environment *string `type:"string" required:"true" enum:"WorkloadEnvironment"`

	// The industry for the workload.
	Industry *string `type:"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 `type:"string"`

	// The list of lenses associated with the workload. Each lens is identified
	// by its LensSummary$LensAlias.
	//
	// Lenses is a required field
	Lenses []*string `type:"list" required:"true"`

	// The list of non-Amazon Web Services Regions associated with the workload.
	NonAwsRegions []*string `type:"list"`

	// The notes associated with the workload.
	Notes *string `type:"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 `type:"list"`

	// 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 `min:"3" type:"string"`

	// The tags to be associated with the workload.
	Tags map[string]*string `min:"1" type:"map"`

	// 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 is a required field
	WorkloadName *string `min:"3" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Input for workload creation.

func (CreateWorkloadInput) GoString

func (s CreateWorkloadInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateWorkloadInput) SetAccountIds

func (s *CreateWorkloadInput) SetAccountIds(v []*string) *CreateWorkloadInput

SetAccountIds sets the AccountIds field's value.

func (*CreateWorkloadInput) SetApplications added in v1.44.132

func (s *CreateWorkloadInput) SetApplications(v []*string) *CreateWorkloadInput

SetApplications sets the Applications field's value.

func (*CreateWorkloadInput) SetArchitecturalDesign

func (s *CreateWorkloadInput) SetArchitecturalDesign(v string) *CreateWorkloadInput

SetArchitecturalDesign sets the ArchitecturalDesign field's value.

func (*CreateWorkloadInput) SetAwsRegions

func (s *CreateWorkloadInput) SetAwsRegions(v []*string) *CreateWorkloadInput

SetAwsRegions sets the AwsRegions field's value.

func (*CreateWorkloadInput) SetClientRequestToken

func (s *CreateWorkloadInput) SetClientRequestToken(v string) *CreateWorkloadInput

SetClientRequestToken sets the ClientRequestToken field's value.

func (*CreateWorkloadInput) SetDescription

func (s *CreateWorkloadInput) SetDescription(v string) *CreateWorkloadInput

SetDescription sets the Description field's value.

func (*CreateWorkloadInput) SetDiscoveryConfig added in v1.44.132

SetDiscoveryConfig sets the DiscoveryConfig field's value.

func (*CreateWorkloadInput) SetEnvironment

func (s *CreateWorkloadInput) SetEnvironment(v string) *CreateWorkloadInput

SetEnvironment sets the Environment field's value.

func (*CreateWorkloadInput) SetIndustry

func (s *CreateWorkloadInput) SetIndustry(v string) *CreateWorkloadInput

SetIndustry sets the Industry field's value.

func (*CreateWorkloadInput) SetIndustryType

func (s *CreateWorkloadInput) SetIndustryType(v string) *CreateWorkloadInput

SetIndustryType sets the IndustryType field's value.

func (*CreateWorkloadInput) SetLenses

func (s *CreateWorkloadInput) SetLenses(v []*string) *CreateWorkloadInput

SetLenses sets the Lenses field's value.

func (*CreateWorkloadInput) SetNonAwsRegions

func (s *CreateWorkloadInput) SetNonAwsRegions(v []*string) *CreateWorkloadInput

SetNonAwsRegions sets the NonAwsRegions field's value.

func (*CreateWorkloadInput) SetNotes

SetNotes sets the Notes field's value.

func (*CreateWorkloadInput) SetPillarPriorities

func (s *CreateWorkloadInput) SetPillarPriorities(v []*string) *CreateWorkloadInput

SetPillarPriorities sets the PillarPriorities field's value.

func (*CreateWorkloadInput) SetReviewOwner

func (s *CreateWorkloadInput) SetReviewOwner(v string) *CreateWorkloadInput

SetReviewOwner sets the ReviewOwner field's value.

func (*CreateWorkloadInput) SetTags added in v1.37.23

SetTags sets the Tags field's value.

func (*CreateWorkloadInput) SetWorkloadName

func (s *CreateWorkloadInput) SetWorkloadName(v string) *CreateWorkloadInput

SetWorkloadName sets the WorkloadName field's value.

func (CreateWorkloadInput) String

func (s CreateWorkloadInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateWorkloadInput) Validate

func (s *CreateWorkloadInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateWorkloadOutput

type CreateWorkloadOutput struct {

	// The ARN for the workload.
	WorkloadArn *string `type:"string"`

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

Output of a create workload call.

func (CreateWorkloadOutput) GoString

func (s CreateWorkloadOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateWorkloadOutput) SetWorkloadArn

func (s *CreateWorkloadOutput) SetWorkloadArn(v string) *CreateWorkloadOutput

SetWorkloadArn sets the WorkloadArn field's value.

func (*CreateWorkloadOutput) SetWorkloadId

func (s *CreateWorkloadOutput) SetWorkloadId(v string) *CreateWorkloadOutput

SetWorkloadId sets the WorkloadId field's value.

func (CreateWorkloadOutput) String

func (s CreateWorkloadOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateWorkloadShareInput

type CreateWorkloadShareInput struct {

	// A unique case-sensitive string used to ensure that this request is idempotent
	// (executes only once).
	//
	// You should not reuse the same token for other requests. If you retry a request
	// with the same client request token and the same parameters after the original
	// request has completed successfully, the result of the original request is
	// returned.
	//
	// This token is listed as required, however, if you do not specify it, the
	// Amazon Web Services SDKs automatically generate one for you. If you are not
	// using the Amazon Web Services SDK or the CLI, you must provide this token
	// or the request will fail.
	ClientRequestToken *string `type:"string" idempotencyToken:"true"`

	// Permission granted on a workload share.
	//
	// PermissionType is a required field
	PermissionType *string `type:"string" required:"true" enum:"PermissionType"`

	// The Amazon Web Services account ID, IAM role, organization ID, or organizational
	// unit (OU) ID with which the workload is shared.
	//
	// SharedWith is a required field
	SharedWith *string `min:"12" type:"string" required:"true"`

	// The ID assigned to the workload. This ID is unique within an Amazon Web Services
	// Region.
	//
	// WorkloadId is a required field
	WorkloadId *string `location:"uri" locationName:"WorkloadId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Input for Create Workload Share

func (CreateWorkloadShareInput) GoString

func (s CreateWorkloadShareInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateWorkloadShareInput) SetClientRequestToken

func (s *CreateWorkloadShareInput) SetClientRequestToken(v string) *CreateWorkloadShareInput

SetClientRequestToken sets the ClientRequestToken field's value.

func (*CreateWorkloadShareInput) SetPermissionType

func (s *CreateWorkloadShareInput) SetPermissionType(v string) *CreateWorkloadShareInput

SetPermissionType sets the PermissionType field's value.

func (*CreateWorkloadShareInput) SetSharedWith

SetSharedWith sets the SharedWith field's value.

func (*CreateWorkloadShareInput) SetWorkloadId

SetWorkloadId sets the WorkloadId field's value.

func (CreateWorkloadShareInput) String

func (s CreateWorkloadShareInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateWorkloadShareInput) Validate

func (s *CreateWorkloadShareInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateWorkloadShareOutput

type CreateWorkloadShareOutput struct {

	// The ID associated with the workload share.
	ShareId *string `type:"string"`

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

Input for Create Workload Share

func (CreateWorkloadShareOutput) GoString

func (s CreateWorkloadShareOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateWorkloadShareOutput) SetShareId

SetShareId sets the ShareId field's value.

func (*CreateWorkloadShareOutput) SetWorkloadId

SetWorkloadId sets the WorkloadId field's value.

func (CreateWorkloadShareOutput) String

func (s CreateWorkloadShareOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteLensInput added in v1.42.15

type DeleteLensInput struct {

	// A unique case-sensitive string used to ensure that this request is idempotent
	// (executes only once).
	//
	// You should not reuse the same token for other requests. If you retry a request
	// with the same client request token and the same parameters after the original
	// request has completed successfully, the result of the original request is
	// returned.
	//
	// This token is listed as required, however, if you do not specify it, the
	// Amazon Web Services SDKs automatically generate one for you. If you are not
	// using the Amazon Web Services SDK or the CLI, you must provide this token
	// or the request will fail.
	ClientRequestToken *string `location:"querystring" locationName:"ClientRequestToken" type:"string" idempotencyToken:"true"`

	// 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 is a required field
	LensAlias *string `location:"uri" locationName:"LensAlias" min:"1" type:"string" required:"true"`

	// The status of the lens to be deleted.
	//
	// LensStatus is a required field
	LensStatus *string `location:"querystring" locationName:"LensStatus" type:"string" required:"true" enum:"LensStatusType"`
	// contains filtered or unexported fields
}

func (DeleteLensInput) GoString added in v1.42.15

func (s DeleteLensInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteLensInput) SetClientRequestToken added in v1.42.15

func (s *DeleteLensInput) SetClientRequestToken(v string) *DeleteLensInput

SetClientRequestToken sets the ClientRequestToken field's value.

func (*DeleteLensInput) SetLensAlias added in v1.42.15

func (s *DeleteLensInput) SetLensAlias(v string) *DeleteLensInput

SetLensAlias sets the LensAlias field's value.

func (*DeleteLensInput) SetLensStatus added in v1.42.15

func (s *DeleteLensInput) SetLensStatus(v string) *DeleteLensInput

SetLensStatus sets the LensStatus field's value.

func (DeleteLensInput) String added in v1.42.15

func (s DeleteLensInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteLensInput) Validate added in v1.42.15

func (s *DeleteLensInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteLensOutput added in v1.42.15

type DeleteLensOutput struct {
	// contains filtered or unexported fields
}

func (DeleteLensOutput) GoString added in v1.42.15

func (s DeleteLensOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteLensOutput) String added in v1.42.15

func (s DeleteLensOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteLensShareInput added in v1.42.15

type DeleteLensShareInput struct {

	// A unique case-sensitive string used to ensure that this request is idempotent
	// (executes only once).
	//
	// You should not reuse the same token for other requests. If you retry a request
	// with the same client request token and the same parameters after the original
	// request has completed successfully, the result of the original request is
	// returned.
	//
	// This token is listed as required, however, if you do not specify it, the
	// Amazon Web Services SDKs automatically generate one for you. If you are not
	// using the Amazon Web Services SDK or the CLI, you must provide this token
	// or the request will fail.
	ClientRequestToken *string `location:"querystring" locationName:"ClientRequestToken" type:"string" idempotencyToken:"true"`

	// 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 is a required field
	LensAlias *string `location:"uri" locationName:"LensAlias" min:"1" type:"string" required:"true"`

	// The ID associated with the workload share.
	//
	// ShareId is a required field
	ShareId *string `location:"uri" locationName:"ShareId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteLensShareInput) GoString added in v1.42.15

func (s DeleteLensShareInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteLensShareInput) SetClientRequestToken added in v1.42.15

func (s *DeleteLensShareInput) SetClientRequestToken(v string) *DeleteLensShareInput

SetClientRequestToken sets the ClientRequestToken field's value.

func (*DeleteLensShareInput) SetLensAlias added in v1.42.15

func (s *DeleteLensShareInput) SetLensAlias(v string) *DeleteLensShareInput

SetLensAlias sets the LensAlias field's value.

func (*DeleteLensShareInput) SetShareId added in v1.42.15

SetShareId sets the ShareId field's value.

func (DeleteLensShareInput) String added in v1.42.15

func (s DeleteLensShareInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteLensShareInput) Validate added in v1.42.15

func (s *DeleteLensShareInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteLensShareOutput added in v1.42.15

type DeleteLensShareOutput struct {
	// contains filtered or unexported fields
}

func (DeleteLensShareOutput) GoString added in v1.42.15

func (s DeleteLensShareOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteLensShareOutput) String added in v1.42.15

func (s DeleteLensShareOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteWorkloadInput

type DeleteWorkloadInput struct {

	// A unique case-sensitive string used to ensure that this request is idempotent
	// (executes only once).
	//
	// You should not reuse the same token for other requests. If you retry a request
	// with the same client request token and the same parameters after the original
	// request has completed successfully, the result of the original request is
	// returned.
	//
	// This token is listed as required, however, if you do not specify it, the
	// Amazon Web Services SDKs automatically generate one for you. If you are not
	// using the Amazon Web Services SDK or the CLI, you must provide this token
	// or the request will fail.
	ClientRequestToken *string `location:"querystring" locationName:"ClientRequestToken" type:"string" idempotencyToken:"true"`

	// The ID assigned to the workload. This ID is unique within an Amazon Web Services
	// Region.
	//
	// WorkloadId is a required field
	WorkloadId *string `location:"uri" locationName:"WorkloadId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Input for workload deletion.

func (DeleteWorkloadInput) GoString

func (s DeleteWorkloadInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteWorkloadInput) SetClientRequestToken

func (s *DeleteWorkloadInput) SetClientRequestToken(v string) *DeleteWorkloadInput

SetClientRequestToken sets the ClientRequestToken field's value.

func (*DeleteWorkloadInput) SetWorkloadId

func (s *DeleteWorkloadInput) SetWorkloadId(v string) *DeleteWorkloadInput

SetWorkloadId sets the WorkloadId field's value.

func (DeleteWorkloadInput) String

func (s DeleteWorkloadInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteWorkloadInput) Validate

func (s *DeleteWorkloadInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteWorkloadOutput

type DeleteWorkloadOutput struct {
	// contains filtered or unexported fields
}

func (DeleteWorkloadOutput) GoString

func (s DeleteWorkloadOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteWorkloadOutput) String

func (s DeleteWorkloadOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteWorkloadShareInput

type DeleteWorkloadShareInput struct {

	// A unique case-sensitive string used to ensure that this request is idempotent
	// (executes only once).
	//
	// You should not reuse the same token for other requests. If you retry a request
	// with the same client request token and the same parameters after the original
	// request has completed successfully, the result of the original request is
	// returned.
	//
	// This token is listed as required, however, if you do not specify it, the
	// Amazon Web Services SDKs automatically generate one for you. If you are not
	// using the Amazon Web Services SDK or the CLI, you must provide this token
	// or the request will fail.
	ClientRequestToken *string `location:"querystring" locationName:"ClientRequestToken" type:"string" idempotencyToken:"true"`

	// The ID associated with the workload share.
	//
	// ShareId is a required field
	ShareId *string `location:"uri" locationName:"ShareId" type:"string" required:"true"`

	// The ID assigned to the workload. This ID is unique within an Amazon Web Services
	// Region.
	//
	// WorkloadId is a required field
	WorkloadId *string `location:"uri" locationName:"WorkloadId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Input for Delete Workload Share

func (DeleteWorkloadShareInput) GoString

func (s DeleteWorkloadShareInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteWorkloadShareInput) SetClientRequestToken

func (s *DeleteWorkloadShareInput) SetClientRequestToken(v string) *DeleteWorkloadShareInput

SetClientRequestToken sets the ClientRequestToken field's value.

func (*DeleteWorkloadShareInput) SetShareId

SetShareId sets the ShareId field's value.

func (*DeleteWorkloadShareInput) SetWorkloadId

SetWorkloadId sets the WorkloadId field's value.

func (DeleteWorkloadShareInput) String

func (s DeleteWorkloadShareInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteWorkloadShareInput) Validate

func (s *DeleteWorkloadShareInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteWorkloadShareOutput

type DeleteWorkloadShareOutput struct {
	// contains filtered or unexported fields
}

func (DeleteWorkloadShareOutput) GoString

func (s DeleteWorkloadShareOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteWorkloadShareOutput) String

func (s DeleteWorkloadShareOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DisassociateLensesInput

type DisassociateLensesInput struct {

	// List of lens aliases to associate or disassociate with a workload. Up to
	// 10 lenses can be specified.
	//
	// Identify a lens using its LensSummary$LensAlias.
	//
	// LensAliases is a required field
	LensAliases []*string `min:"1" type:"list" required:"true"`

	// The ID assigned to the workload. This ID is unique within an Amazon Web Services
	// Region.
	//
	// WorkloadId is a required field
	WorkloadId *string `location:"uri" locationName:"WorkloadId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Input to disassociate lens reviews.

func (DisassociateLensesInput) GoString

func (s DisassociateLensesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DisassociateLensesInput) SetLensAliases

func (s *DisassociateLensesInput) SetLensAliases(v []*string) *DisassociateLensesInput

SetLensAliases sets the LensAliases field's value.

func (*DisassociateLensesInput) SetWorkloadId

SetWorkloadId sets the WorkloadId field's value.

func (DisassociateLensesInput) String

func (s DisassociateLensesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DisassociateLensesInput) Validate

func (s *DisassociateLensesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DisassociateLensesOutput

type DisassociateLensesOutput struct {
	// contains filtered or unexported fields
}

func (DisassociateLensesOutput) GoString

func (s DisassociateLensesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DisassociateLensesOutput) String

func (s DisassociateLensesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ExportLensInput added in v1.42.15

type ExportLensInput 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 is a required field
	LensAlias *string `location:"uri" locationName:"LensAlias" min:"1" type:"string" required:"true"`

	// The lens version to be exported.
	LensVersion *string `location:"querystring" locationName:"LensVersion" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ExportLensInput) GoString added in v1.42.15

func (s ExportLensInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ExportLensInput) SetLensAlias added in v1.42.15

func (s *ExportLensInput) SetLensAlias(v string) *ExportLensInput

SetLensAlias sets the LensAlias field's value.

func (*ExportLensInput) SetLensVersion added in v1.42.15

func (s *ExportLensInput) SetLensVersion(v string) *ExportLensInput

SetLensVersion sets the LensVersion field's value.

func (ExportLensInput) String added in v1.42.15

func (s ExportLensInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ExportLensInput) Validate added in v1.42.15

func (s *ExportLensInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ExportLensOutput added in v1.42.15

type ExportLensOutput struct {

	// The JSON representation of a lens.
	LensJSON *string `min:"2" type:"string"`
	// contains filtered or unexported fields
}

func (ExportLensOutput) GoString added in v1.42.15

func (s ExportLensOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ExportLensOutput) SetLensJSON added in v1.42.15

func (s *ExportLensOutput) SetLensJSON(v string) *ExportLensOutput

SetLensJSON sets the LensJSON field's value.

func (ExportLensOutput) String added in v1.42.15

func (s ExportLensOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetAnswerInput

type GetAnswerInput 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 is a required field
	LensAlias *string `location:"uri" locationName:"LensAlias" min:"1" type:"string" required:"true"`

	// The milestone number.
	//
	// A workload can have a maximum of 100 milestones.
	MilestoneNumber *int64 `location:"querystring" locationName:"MilestoneNumber" min:"1" type:"integer"`

	// The ID of the question.
	//
	// QuestionId is a required field
	QuestionId *string `location:"uri" locationName:"QuestionId" min:"1" type:"string" required:"true"`

	// The ID assigned to the workload. This ID is unique within an Amazon Web Services
	// Region.
	//
	// WorkloadId is a required field
	WorkloadId *string `location:"uri" locationName:"WorkloadId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Input to get answer.

func (GetAnswerInput) GoString

func (s GetAnswerInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetAnswerInput) SetLensAlias

func (s *GetAnswerInput) SetLensAlias(v string) *GetAnswerInput

SetLensAlias sets the LensAlias field's value.

func (*GetAnswerInput) SetMilestoneNumber

func (s *GetAnswerInput) SetMilestoneNumber(v int64) *GetAnswerInput

SetMilestoneNumber sets the MilestoneNumber field's value.

func (*GetAnswerInput) SetQuestionId

func (s *GetAnswerInput) SetQuestionId(v string) *GetAnswerInput

SetQuestionId sets the QuestionId field's value.

func (*GetAnswerInput) SetWorkloadId

func (s *GetAnswerInput) SetWorkloadId(v string) *GetAnswerInput

SetWorkloadId sets the WorkloadId field's value.

func (GetAnswerInput) String

func (s GetAnswerInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetAnswerInput) Validate

func (s *GetAnswerInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetAnswerOutput

type GetAnswerOutput struct {

	// An answer of the question.
	Answer *Answer `type:"structure"`

	// 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 `min:"1" type:"string"`

	// The ARN for the lens.
	LensArn *string `type:"string"`

	// The milestone number.
	//
	// A workload can have a maximum of 100 milestones.
	MilestoneNumber *int64 `min:"1" type:"integer"`

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

Output of a get answer call.

func (GetAnswerOutput) GoString

func (s GetAnswerOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetAnswerOutput) SetAnswer

func (s *GetAnswerOutput) SetAnswer(v *Answer) *GetAnswerOutput

SetAnswer sets the Answer field's value.

func (*GetAnswerOutput) SetLensAlias

func (s *GetAnswerOutput) SetLensAlias(v string) *GetAnswerOutput

SetLensAlias sets the LensAlias field's value.

func (*GetAnswerOutput) SetLensArn added in v1.42.15

func (s *GetAnswerOutput) SetLensArn(v string) *GetAnswerOutput

SetLensArn sets the LensArn field's value.

func (*GetAnswerOutput) SetMilestoneNumber

func (s *GetAnswerOutput) SetMilestoneNumber(v int64) *GetAnswerOutput

SetMilestoneNumber sets the MilestoneNumber field's value.

func (*GetAnswerOutput) SetWorkloadId

func (s *GetAnswerOutput) SetWorkloadId(v string) *GetAnswerOutput

SetWorkloadId sets the WorkloadId field's value.

func (GetAnswerOutput) String

func (s GetAnswerOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetConsolidatedReportInput added in v1.44.233

type GetConsolidatedReportInput struct {

	// The format of the consolidated report.
	//
	// For PDF, Base64String is returned. For JSON, Metrics is returned.
	//
	// Format is a required field
	Format *string `location:"querystring" locationName:"Format" type:"string" required:"true" enum:"ReportFormat"`

	// Set to true to have shared resources included in the report.
	IncludeSharedResources *bool `location:"querystring" locationName:"IncludeSharedResources" type:"boolean"`

	// The maximum number of results to return for this request.
	MaxResults *int64 `location:"querystring" locationName:"MaxResults" min:"1" type:"integer"`

	// The token to use to retrieve the next set of results.
	NextToken *string `location:"querystring" locationName:"NextToken" type:"string"`
	// contains filtered or unexported fields
}

func (GetConsolidatedReportInput) GoString added in v1.44.233

func (s GetConsolidatedReportInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetConsolidatedReportInput) SetFormat added in v1.44.233

SetFormat sets the Format field's value.

func (*GetConsolidatedReportInput) SetIncludeSharedResources added in v1.44.233

func (s *GetConsolidatedReportInput) SetIncludeSharedResources(v bool) *GetConsolidatedReportInput

SetIncludeSharedResources sets the IncludeSharedResources field's value.

func (*GetConsolidatedReportInput) SetMaxResults added in v1.44.233

SetMaxResults sets the MaxResults field's value.

func (*GetConsolidatedReportInput) SetNextToken added in v1.44.233

SetNextToken sets the NextToken field's value.

func (GetConsolidatedReportInput) String added in v1.44.233

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetConsolidatedReportInput) Validate added in v1.44.233

func (s *GetConsolidatedReportInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetConsolidatedReportOutput added in v1.44.233

type GetConsolidatedReportOutput 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 `type:"string"`

	// The metrics that make up the consolidated report.
	//
	// Only returned when JSON format is requested.
	Metrics []*ConsolidatedReportMetric `type:"list"`

	// The token to use to retrieve the next set of results.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (GetConsolidatedReportOutput) GoString added in v1.44.233

func (s GetConsolidatedReportOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetConsolidatedReportOutput) SetBase64String added in v1.44.233

SetBase64String sets the Base64String field's value.

func (*GetConsolidatedReportOutput) SetMetrics added in v1.44.233

SetMetrics sets the Metrics field's value.

func (*GetConsolidatedReportOutput) SetNextToken added in v1.44.233

SetNextToken sets the NextToken field's value.

func (GetConsolidatedReportOutput) String added in v1.44.233

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetLensInput added in v1.42.15

type GetLensInput 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 is a required field
	LensAlias *string `location:"uri" locationName:"LensAlias" min:"1" type:"string" required:"true"`

	// The lens version to be retrieved.
	LensVersion *string `location:"querystring" locationName:"LensVersion" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (GetLensInput) GoString added in v1.42.15

func (s GetLensInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetLensInput) SetLensAlias added in v1.42.15

func (s *GetLensInput) SetLensAlias(v string) *GetLensInput

SetLensAlias sets the LensAlias field's value.

func (*GetLensInput) SetLensVersion added in v1.42.15

func (s *GetLensInput) SetLensVersion(v string) *GetLensInput

SetLensVersion sets the LensVersion field's value.

func (GetLensInput) String added in v1.42.15

func (s GetLensInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetLensInput) Validate added in v1.42.15

func (s *GetLensInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetLensOutput added in v1.42.15

type GetLensOutput struct {

	// A lens return object.
	Lens *Lens `type:"structure"`
	// contains filtered or unexported fields
}

func (GetLensOutput) GoString added in v1.42.15

func (s GetLensOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetLensOutput) SetLens added in v1.42.15

func (s *GetLensOutput) SetLens(v *Lens) *GetLensOutput

SetLens sets the Lens field's value.

func (GetLensOutput) String added in v1.42.15

func (s GetLensOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetLensReviewInput

type GetLensReviewInput 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 is a required field
	LensAlias *string `location:"uri" locationName:"LensAlias" min:"1" type:"string" required:"true"`

	// The milestone number.
	//
	// A workload can have a maximum of 100 milestones.
	MilestoneNumber *int64 `location:"querystring" locationName:"MilestoneNumber" min:"1" type:"integer"`

	// The ID assigned to the workload. This ID is unique within an Amazon Web Services
	// Region.
	//
	// WorkloadId is a required field
	WorkloadId *string `location:"uri" locationName:"WorkloadId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Input to get lens review.

func (GetLensReviewInput) GoString

func (s GetLensReviewInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetLensReviewInput) SetLensAlias

func (s *GetLensReviewInput) SetLensAlias(v string) *GetLensReviewInput

SetLensAlias sets the LensAlias field's value.

func (*GetLensReviewInput) SetMilestoneNumber

func (s *GetLensReviewInput) SetMilestoneNumber(v int64) *GetLensReviewInput

SetMilestoneNumber sets the MilestoneNumber field's value.

func (*GetLensReviewInput) SetWorkloadId

func (s *GetLensReviewInput) SetWorkloadId(v string) *GetLensReviewInput

SetWorkloadId sets the WorkloadId field's value.

func (GetLensReviewInput) String

func (s GetLensReviewInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetLensReviewInput) Validate

func (s *GetLensReviewInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetLensReviewOutput

type GetLensReviewOutput struct {

	// A lens review of a question.
	LensReview *LensReview `type:"structure"`

	// The milestone number.
	//
	// A workload can have a maximum of 100 milestones.
	MilestoneNumber *int64 `min:"1" type:"integer"`

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

Output of a get lens review call.

func (GetLensReviewOutput) GoString

func (s GetLensReviewOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetLensReviewOutput) SetLensReview

func (s *GetLensReviewOutput) SetLensReview(v *LensReview) *GetLensReviewOutput

SetLensReview sets the LensReview field's value.

func (*GetLensReviewOutput) SetMilestoneNumber

func (s *GetLensReviewOutput) SetMilestoneNumber(v int64) *GetLensReviewOutput

SetMilestoneNumber sets the MilestoneNumber field's value.

func (*GetLensReviewOutput) SetWorkloadId

func (s *GetLensReviewOutput) SetWorkloadId(v string) *GetLensReviewOutput

SetWorkloadId sets the WorkloadId field's value.

func (GetLensReviewOutput) String

func (s GetLensReviewOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetLensReviewReportInput

type GetLensReviewReportInput 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 is a required field
	LensAlias *string `location:"uri" locationName:"LensAlias" min:"1" type:"string" required:"true"`

	// The milestone number.
	//
	// A workload can have a maximum of 100 milestones.
	MilestoneNumber *int64 `location:"querystring" locationName:"MilestoneNumber" min:"1" type:"integer"`

	// The ID assigned to the workload. This ID is unique within an Amazon Web Services
	// Region.
	//
	// WorkloadId is a required field
	WorkloadId *string `location:"uri" locationName:"WorkloadId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Input to get lens review report.

func (GetLensReviewReportInput) GoString

func (s GetLensReviewReportInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetLensReviewReportInput) SetLensAlias

SetLensAlias sets the LensAlias field's value.

func (*GetLensReviewReportInput) SetMilestoneNumber

func (s *GetLensReviewReportInput) SetMilestoneNumber(v int64) *GetLensReviewReportInput

SetMilestoneNumber sets the MilestoneNumber field's value.

func (*GetLensReviewReportInput) SetWorkloadId

SetWorkloadId sets the WorkloadId field's value.

func (GetLensReviewReportInput) String

func (s GetLensReviewReportInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetLensReviewReportInput) Validate

func (s *GetLensReviewReportInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetLensReviewReportOutput

type GetLensReviewReportOutput struct {

	// A report of a lens review.
	LensReviewReport *LensReviewReport `type:"structure"`

	// The milestone number.
	//
	// A workload can have a maximum of 100 milestones.
	MilestoneNumber *int64 `min:"1" type:"integer"`

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

Output of a get lens review report call.

func (GetLensReviewReportOutput) GoString

func (s GetLensReviewReportOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetLensReviewReportOutput) SetLensReviewReport

SetLensReviewReport sets the LensReviewReport field's value.

func (*GetLensReviewReportOutput) SetMilestoneNumber

func (s *GetLensReviewReportOutput) SetMilestoneNumber(v int64) *GetLensReviewReportOutput

SetMilestoneNumber sets the MilestoneNumber field's value.

func (*GetLensReviewReportOutput) SetWorkloadId

SetWorkloadId sets the WorkloadId field's value.

func (GetLensReviewReportOutput) String

func (s GetLensReviewReportOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetLensVersionDifferenceInput

type GetLensVersionDifferenceInput struct {

	// The base version of the lens.
	BaseLensVersion *string `location:"querystring" locationName:"BaseLensVersion" min:"1" type:"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 is a required field
	LensAlias *string `location:"uri" locationName:"LensAlias" min:"1" type:"string" required:"true"`

	// The lens version to target a difference for.
	TargetLensVersion *string `location:"querystring" locationName:"TargetLensVersion" min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (GetLensVersionDifferenceInput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetLensVersionDifferenceInput) SetBaseLensVersion

SetBaseLensVersion sets the BaseLensVersion field's value.

func (*GetLensVersionDifferenceInput) SetLensAlias

SetLensAlias sets the LensAlias field's value.

func (*GetLensVersionDifferenceInput) SetTargetLensVersion added in v1.42.15

SetTargetLensVersion sets the TargetLensVersion field's value.

func (GetLensVersionDifferenceInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetLensVersionDifferenceInput) Validate

func (s *GetLensVersionDifferenceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetLensVersionDifferenceOutput

type GetLensVersionDifferenceOutput struct {

	// The base version of the lens.
	BaseLensVersion *string `min:"1" type:"string"`

	// The latest version of the lens.
	LatestLensVersion *string `min:"1" type:"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 `min:"1" type:"string"`

	// The ARN for the lens.
	LensArn *string `type:"string"`

	// The target lens version for the lens.
	TargetLensVersion *string `min:"1" type:"string"`

	// The differences between the base and latest versions of the lens.
	VersionDifferences *VersionDifferences `type:"structure"`
	// contains filtered or unexported fields
}

func (GetLensVersionDifferenceOutput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetLensVersionDifferenceOutput) SetBaseLensVersion

SetBaseLensVersion sets the BaseLensVersion field's value.

func (*GetLensVersionDifferenceOutput) SetLatestLensVersion

SetLatestLensVersion sets the LatestLensVersion field's value.

func (*GetLensVersionDifferenceOutput) SetLensAlias

SetLensAlias sets the LensAlias field's value.

func (*GetLensVersionDifferenceOutput) SetLensArn added in v1.42.15

SetLensArn sets the LensArn field's value.

func (*GetLensVersionDifferenceOutput) SetTargetLensVersion added in v1.42.15

SetTargetLensVersion sets the TargetLensVersion field's value.

func (*GetLensVersionDifferenceOutput) SetVersionDifferences

SetVersionDifferences sets the VersionDifferences field's value.

func (GetLensVersionDifferenceOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetMilestoneInput

type GetMilestoneInput struct {

	// The milestone number.
	//
	// A workload can have a maximum of 100 milestones.
	//
	// MilestoneNumber is a required field
	MilestoneNumber *int64 `location:"uri" locationName:"MilestoneNumber" min:"1" type:"integer" required:"true"`

	// The ID assigned to the workload. This ID is unique within an Amazon Web Services
	// Region.
	//
	// WorkloadId is a required field
	WorkloadId *string `location:"uri" locationName:"WorkloadId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Input to get a milestone.

func (GetMilestoneInput) GoString

func (s GetMilestoneInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetMilestoneInput) SetMilestoneNumber

func (s *GetMilestoneInput) SetMilestoneNumber(v int64) *GetMilestoneInput

SetMilestoneNumber sets the MilestoneNumber field's value.

func (*GetMilestoneInput) SetWorkloadId

func (s *GetMilestoneInput) SetWorkloadId(v string) *GetMilestoneInput

SetWorkloadId sets the WorkloadId field's value.

func (GetMilestoneInput) String

func (s GetMilestoneInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetMilestoneInput) Validate

func (s *GetMilestoneInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetMilestoneOutput

type GetMilestoneOutput struct {

	// A milestone return object.
	Milestone *Milestone `type:"structure"`

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

Output of a get milestone call.

func (GetMilestoneOutput) GoString

func (s GetMilestoneOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetMilestoneOutput) SetMilestone

func (s *GetMilestoneOutput) SetMilestone(v *Milestone) *GetMilestoneOutput

SetMilestone sets the Milestone field's value.

func (*GetMilestoneOutput) SetWorkloadId

func (s *GetMilestoneOutput) SetWorkloadId(v string) *GetMilestoneOutput

SetWorkloadId sets the WorkloadId field's value.

func (GetMilestoneOutput) String

func (s GetMilestoneOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type GetWorkloadInput

type GetWorkloadInput struct {

	// The ID assigned to the workload. This ID is unique within an Amazon Web Services
	// Region.
	//
	// WorkloadId is a required field
	WorkloadId *string `location:"uri" locationName:"WorkloadId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Input to get a workload.

func (GetWorkloadInput) GoString

func (s GetWorkloadInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetWorkloadInput) SetWorkloadId

func (s *GetWorkloadInput) SetWorkloadId(v string) *GetWorkloadInput

SetWorkloadId sets the WorkloadId field's value.

func (GetWorkloadInput) String

func (s GetWorkloadInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetWorkloadInput) Validate

func (s *GetWorkloadInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type GetWorkloadOutput

type GetWorkloadOutput struct {

	// A workload return object.
	Workload *Workload `type:"structure"`
	// contains filtered or unexported fields
}

Output of a get workload call.

func (GetWorkloadOutput) GoString

func (s GetWorkloadOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*GetWorkloadOutput) SetWorkload

func (s *GetWorkloadOutput) SetWorkload(v *Workload) *GetWorkloadOutput

SetWorkload sets the Workload field's value.

func (GetWorkloadOutput) String

func (s GetWorkloadOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ImportLensInput added in v1.42.15

type ImportLensInput struct {

	// A unique case-sensitive string used to ensure that this request is idempotent
	// (executes only once).
	//
	// You should not reuse the same token for other requests. If you retry a request
	// with the same client request token and the same parameters after the original
	// request has completed successfully, the result of the original request is
	// returned.
	//
	// This token is listed as required, however, if you do not specify it, the
	// Amazon Web Services SDKs automatically generate one for you. If you are not
	// using the Amazon Web Services SDK or the CLI, you must provide this token
	// or the request will fail.
	ClientRequestToken *string `type:"string" idempotencyToken:"true"`

	// The JSON representation of a lens.
	//
	// JSONString is a required field
	JSONString *string `min:"2" type:"string" required:"true"`

	// 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 `min:"1" type:"string"`

	// Tags to associate to a lens.
	Tags map[string]*string `min:"1" type:"map"`
	// contains filtered or unexported fields
}

func (ImportLensInput) GoString added in v1.42.15

func (s ImportLensInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ImportLensInput) SetClientRequestToken added in v1.42.15

func (s *ImportLensInput) SetClientRequestToken(v string) *ImportLensInput

SetClientRequestToken sets the ClientRequestToken field's value.

func (*ImportLensInput) SetJSONString added in v1.42.15

func (s *ImportLensInput) SetJSONString(v string) *ImportLensInput

SetJSONString sets the JSONString field's value.

func (*ImportLensInput) SetLensAlias added in v1.42.15

func (s *ImportLensInput) SetLensAlias(v string) *ImportLensInput

SetLensAlias sets the LensAlias field's value.

func (*ImportLensInput) SetTags added in v1.42.15

func (s *ImportLensInput) SetTags(v map[string]*string) *ImportLensInput

SetTags sets the Tags field's value.

func (ImportLensInput) String added in v1.42.15

func (s ImportLensInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ImportLensInput) Validate added in v1.42.15

func (s *ImportLensInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ImportLensOutput added in v1.42.15

type ImportLensOutput struct {

	// The ARN for the lens that was created or updated.
	LensArn *string `type:"string"`

	// The status of the imported lens.
	Status *string `type:"string" enum:"ImportLensStatus"`
	// contains filtered or unexported fields
}

func (ImportLensOutput) GoString added in v1.42.15

func (s ImportLensOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ImportLensOutput) SetLensArn added in v1.42.15

func (s *ImportLensOutput) SetLensArn(v string) *ImportLensOutput

SetLensArn sets the LensArn field's value.

func (*ImportLensOutput) SetStatus added in v1.42.15

func (s *ImportLensOutput) SetStatus(v string) *ImportLensOutput

SetStatus sets the Status field's value.

func (ImportLensOutput) String added in v1.42.15

func (s ImportLensOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 `min:"1" type:"string"`

	// The improvement plan details.
	ImprovementPlans []*ChoiceImprovementPlan `type:"list"`

	// The ID used to identify a pillar, for example, security.
	//
	// A pillar is identified by its PillarReviewSummary$PillarId.
	PillarId *string `min:"1" type:"string"`

	// The ID of the question.
	QuestionId *string `min:"1" type:"string"`

	// The title of the question.
	QuestionTitle *string `min:"1" type:"string"`

	// The risk for a given workload, lens review, pillar, or question.
	Risk *string `type:"string" enum:"Risk"`
	// contains filtered or unexported fields
}

An improvement summary of a lens review in a workload.

func (ImprovementSummary) GoString

func (s ImprovementSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ImprovementSummary) SetImprovementPlanUrl

func (s *ImprovementSummary) SetImprovementPlanUrl(v string) *ImprovementSummary

SetImprovementPlanUrl sets the ImprovementPlanUrl field's value.

func (*ImprovementSummary) SetImprovementPlans added in v1.42.15

func (s *ImprovementSummary) SetImprovementPlans(v []*ChoiceImprovementPlan) *ImprovementSummary

SetImprovementPlans sets the ImprovementPlans field's value.

func (*ImprovementSummary) SetPillarId

func (s *ImprovementSummary) SetPillarId(v string) *ImprovementSummary

SetPillarId sets the PillarId field's value.

func (*ImprovementSummary) SetQuestionId

func (s *ImprovementSummary) SetQuestionId(v string) *ImprovementSummary

SetQuestionId sets the QuestionId field's value.

func (*ImprovementSummary) SetQuestionTitle

func (s *ImprovementSummary) SetQuestionTitle(v string) *ImprovementSummary

SetQuestionTitle sets the QuestionTitle field's value.

func (*ImprovementSummary) SetRisk

SetRisk sets the Risk field's value.

func (ImprovementSummary) String

func (s ImprovementSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InternalServerException

type InternalServerException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// Description of the error.
	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

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

func (*InternalServerException) Code

func (s *InternalServerException) Code() string

Code returns the exception type name.

func (*InternalServerException) Error

func (s *InternalServerException) Error() string

func (InternalServerException) GoString

func (s InternalServerException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InternalServerException) Message

func (s *InternalServerException) Message() string

Message returns the exception's message.

func (*InternalServerException) OrigErr

func (s *InternalServerException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InternalServerException) RequestID

func (s *InternalServerException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InternalServerException) StatusCode

func (s *InternalServerException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InternalServerException) String

func (s InternalServerException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Lens added in v1.42.15

type Lens struct {

	// The description of the lens.
	Description *string `min:"1" type:"string"`

	// The ARN of a lens.
	LensArn *string `type:"string"`

	// The version of a lens.
	LensVersion *string `min:"1" type:"string"`

	// The full name of the lens.
	Name *string `min:"1" type:"string"`

	// The Amazon Web Services account ID that owns the lens.
	Owner *string `type:"string"`

	// The ID assigned to the share invitation.
	ShareInvitationId *string `type:"string"`

	// The tags assigned to the lens.
	Tags map[string]*string `min:"1" type:"map"`
	// contains filtered or unexported fields
}

A lens return object.

func (Lens) GoString added in v1.42.15

func (s Lens) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Lens) SetDescription added in v1.42.15

func (s *Lens) SetDescription(v string) *Lens

SetDescription sets the Description field's value.

func (*Lens) SetLensArn added in v1.42.15

func (s *Lens) SetLensArn(v string) *Lens

SetLensArn sets the LensArn field's value.

func (*Lens) SetLensVersion added in v1.42.15

func (s *Lens) SetLensVersion(v string) *Lens

SetLensVersion sets the LensVersion field's value.

func (*Lens) SetName added in v1.42.15

func (s *Lens) SetName(v string) *Lens

SetName sets the Name field's value.

func (*Lens) SetOwner added in v1.42.15

func (s *Lens) SetOwner(v string) *Lens

SetOwner sets the Owner field's value.

func (*Lens) SetShareInvitationId added in v1.42.15

func (s *Lens) SetShareInvitationId(v string) *Lens

SetShareInvitationId sets the ShareInvitationId field's value.

func (*Lens) SetTags added in v1.44.39

func (s *Lens) SetTags(v map[string]*string) *Lens

SetTags sets the Tags field's value.

func (Lens) String added in v1.42.15

func (s Lens) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type LensMetric added in v1.44.233

type LensMetric struct {

	// The lens ARN.
	LensArn *string `type:"string"`

	// The metrics for the pillars in a lens.
	Pillars []*PillarMetric `type:"list"`

	// A map from risk names to the count of how many questions have that rating.
	RiskCounts map[string]*int64 `type:"map"`
	// contains filtered or unexported fields
}

A metric for a particular lens in a workload.

func (LensMetric) GoString added in v1.44.233

func (s LensMetric) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LensMetric) SetLensArn added in v1.44.233

func (s *LensMetric) SetLensArn(v string) *LensMetric

SetLensArn sets the LensArn field's value.

func (*LensMetric) SetPillars added in v1.44.233

func (s *LensMetric) SetPillars(v []*PillarMetric) *LensMetric

SetPillars sets the Pillars field's value.

func (*LensMetric) SetRiskCounts added in v1.44.233

func (s *LensMetric) SetRiskCounts(v map[string]*int64) *LensMetric

SetRiskCounts sets the RiskCounts field's value.

func (LensMetric) String added in v1.44.233

func (s LensMetric) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type LensReview

type LensReview 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 `min:"1" type:"string"`

	// The ARN for the lens.
	LensArn *string `type:"string"`

	// The full name of the lens.
	LensName *string `min:"1" type:"string"`

	// The status of the lens.
	LensStatus *string `type:"string" enum:"LensStatus"`

	// The version of the lens.
	LensVersion *string `min:"1" type:"string"`

	// The token to use to retrieve the next set of results.
	NextToken *string `type:"string"`

	// The notes associated with the workload.
	Notes *string `type:"string"`

	// List of pillar review summaries of lens review in a workload.
	PillarReviewSummaries []*PillarReviewSummary `type:"list"`

	// A map from risk names to the count of how many questions have that rating.
	RiskCounts map[string]*int64 `type:"map"`

	// The date and time recorded.
	UpdatedAt *time.Time `type:"timestamp"`
	// contains filtered or unexported fields
}

A lens review of a question.

func (LensReview) GoString

func (s LensReview) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LensReview) SetLensAlias

func (s *LensReview) SetLensAlias(v string) *LensReview

SetLensAlias sets the LensAlias field's value.

func (*LensReview) SetLensArn added in v1.42.15

func (s *LensReview) SetLensArn(v string) *LensReview

SetLensArn sets the LensArn field's value.

func (*LensReview) SetLensName

func (s *LensReview) SetLensName(v string) *LensReview

SetLensName sets the LensName field's value.

func (*LensReview) SetLensStatus

func (s *LensReview) SetLensStatus(v string) *LensReview

SetLensStatus sets the LensStatus field's value.

func (*LensReview) SetLensVersion

func (s *LensReview) SetLensVersion(v string) *LensReview

SetLensVersion sets the LensVersion field's value.

func (*LensReview) SetNextToken

func (s *LensReview) SetNextToken(v string) *LensReview

SetNextToken sets the NextToken field's value.

func (*LensReview) SetNotes

func (s *LensReview) SetNotes(v string) *LensReview

SetNotes sets the Notes field's value.

func (*LensReview) SetPillarReviewSummaries

func (s *LensReview) SetPillarReviewSummaries(v []*PillarReviewSummary) *LensReview

SetPillarReviewSummaries sets the PillarReviewSummaries field's value.

func (*LensReview) SetRiskCounts

func (s *LensReview) SetRiskCounts(v map[string]*int64) *LensReview

SetRiskCounts sets the RiskCounts field's value.

func (*LensReview) SetUpdatedAt

func (s *LensReview) SetUpdatedAt(v time.Time) *LensReview

SetUpdatedAt sets the UpdatedAt field's value.

func (LensReview) String

func (s LensReview) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 `type:"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 `min:"1" type:"string"`

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

A report of a lens review.

func (LensReviewReport) GoString

func (s LensReviewReport) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LensReviewReport) SetBase64String

func (s *LensReviewReport) SetBase64String(v string) *LensReviewReport

SetBase64String sets the Base64String field's value.

func (*LensReviewReport) SetLensAlias

func (s *LensReviewReport) SetLensAlias(v string) *LensReviewReport

SetLensAlias sets the LensAlias field's value.

func (*LensReviewReport) SetLensArn added in v1.42.15

func (s *LensReviewReport) SetLensArn(v string) *LensReviewReport

SetLensArn sets the LensArn field's value.

func (LensReviewReport) String

func (s LensReviewReport) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 `min:"1" type:"string"`

	// The ARN for the lens.
	LensArn *string `type:"string"`

	// The full name of the lens.
	LensName *string `min:"1" type:"string"`

	// The status of the lens.
	LensStatus *string `type:"string" enum:"LensStatus"`

	// The version of the lens.
	LensVersion *string `min:"1" type:"string"`

	// A map from risk names to the count of how many questions have that rating.
	RiskCounts map[string]*int64 `type:"map"`

	// The date and time recorded.
	UpdatedAt *time.Time `type:"timestamp"`
	// contains filtered or unexported fields
}

A lens review summary of a workload.

func (LensReviewSummary) GoString

func (s LensReviewSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LensReviewSummary) SetLensAlias

func (s *LensReviewSummary) SetLensAlias(v string) *LensReviewSummary

SetLensAlias sets the LensAlias field's value.

func (*LensReviewSummary) SetLensArn added in v1.42.15

func (s *LensReviewSummary) SetLensArn(v string) *LensReviewSummary

SetLensArn sets the LensArn field's value.

func (*LensReviewSummary) SetLensName

func (s *LensReviewSummary) SetLensName(v string) *LensReviewSummary

SetLensName sets the LensName field's value.

func (*LensReviewSummary) SetLensStatus

func (s *LensReviewSummary) SetLensStatus(v string) *LensReviewSummary

SetLensStatus sets the LensStatus field's value.

func (*LensReviewSummary) SetLensVersion

func (s *LensReviewSummary) SetLensVersion(v string) *LensReviewSummary

SetLensVersion sets the LensVersion field's value.

func (*LensReviewSummary) SetRiskCounts

func (s *LensReviewSummary) SetRiskCounts(v map[string]*int64) *LensReviewSummary

SetRiskCounts sets the RiskCounts field's value.

func (*LensReviewSummary) SetUpdatedAt

func (s *LensReviewSummary) SetUpdatedAt(v time.Time) *LensReviewSummary

SetUpdatedAt sets the UpdatedAt field's value.

func (LensReviewSummary) String

func (s LensReviewSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type LensShareSummary added in v1.42.15

type LensShareSummary struct {

	// The ID associated with the workload share.
	ShareId *string `type:"string"`

	// The Amazon Web Services account ID, IAM role, organization ID, or organizational
	// unit (OU) ID with which the workload is shared.
	SharedWith *string `min:"12" type:"string"`

	// The status of a workload share.
	Status *string `type:"string" enum:"ShareStatus"`

	// Optional message to compliment the Status field.
	StatusMessage *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

A lens share summary return object.

func (LensShareSummary) GoString added in v1.42.15

func (s LensShareSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LensShareSummary) SetShareId added in v1.42.15

func (s *LensShareSummary) SetShareId(v string) *LensShareSummary

SetShareId sets the ShareId field's value.

func (*LensShareSummary) SetSharedWith added in v1.42.15

func (s *LensShareSummary) SetSharedWith(v string) *LensShareSummary

SetSharedWith sets the SharedWith field's value.

func (*LensShareSummary) SetStatus added in v1.42.15

func (s *LensShareSummary) SetStatus(v string) *LensShareSummary

SetStatus sets the Status field's value.

func (*LensShareSummary) SetStatusMessage added in v1.44.46

func (s *LensShareSummary) SetStatusMessage(v string) *LensShareSummary

SetStatusMessage sets the StatusMessage field's value.

func (LensShareSummary) String added in v1.42.15

func (s LensShareSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type LensSummary

type LensSummary struct {

	// The date and time recorded.
	CreatedAt *time.Time `type:"timestamp"`

	// The description of the lens.
	Description *string `min:"1" type:"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 `min:"1" type:"string"`

	// The ARN of the lens.
	LensArn *string `type:"string"`

	// The full name of the lens.
	LensName *string `min:"1" type:"string"`

	// The status of the lens.
	LensStatus *string `type:"string" enum:"LensStatus"`

	// The type of the lens.
	LensType *string `type:"string" enum:"LensType"`

	// The version of the lens.
	LensVersion *string `min:"1" type:"string"`

	// An Amazon Web Services account ID.
	Owner *string `type:"string"`

	// The date and time recorded.
	UpdatedAt *time.Time `type:"timestamp"`
	// contains filtered or unexported fields
}

A lens summary of a lens.

func (LensSummary) GoString

func (s LensSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LensSummary) SetCreatedAt added in v1.42.15

func (s *LensSummary) SetCreatedAt(v time.Time) *LensSummary

SetCreatedAt sets the CreatedAt field's value.

func (*LensSummary) SetDescription

func (s *LensSummary) SetDescription(v string) *LensSummary

SetDescription sets the Description field's value.

func (*LensSummary) SetLensAlias

func (s *LensSummary) SetLensAlias(v string) *LensSummary

SetLensAlias sets the LensAlias field's value.

func (*LensSummary) SetLensArn added in v1.42.15

func (s *LensSummary) SetLensArn(v string) *LensSummary

SetLensArn sets the LensArn field's value.

func (*LensSummary) SetLensName

func (s *LensSummary) SetLensName(v string) *LensSummary

SetLensName sets the LensName field's value.

func (*LensSummary) SetLensStatus added in v1.42.15

func (s *LensSummary) SetLensStatus(v string) *LensSummary

SetLensStatus sets the LensStatus field's value.

func (*LensSummary) SetLensType added in v1.42.15

func (s *LensSummary) SetLensType(v string) *LensSummary

SetLensType sets the LensType field's value.

func (*LensSummary) SetLensVersion

func (s *LensSummary) SetLensVersion(v string) *LensSummary

SetLensVersion sets the LensVersion field's value.

func (*LensSummary) SetOwner added in v1.42.15

func (s *LensSummary) SetOwner(v string) *LensSummary

SetOwner sets the Owner field's value.

func (*LensSummary) SetUpdatedAt added in v1.42.15

func (s *LensSummary) SetUpdatedAt(v time.Time) *LensSummary

SetUpdatedAt sets the UpdatedAt field's value.

func (LensSummary) String

func (s LensSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type LensUpgradeSummary

type LensUpgradeSummary struct {

	// The current version of the lens.
	CurrentLensVersion *string `min:"1" type:"string"`

	// The latest version of the lens.
	LatestLensVersion *string `min:"1" type:"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 `min:"1" type:"string"`

	// The ARN for the lens.
	LensArn *string `type:"string"`

	// The ID assigned to the workload. This ID is unique within an Amazon Web Services
	// Region.
	WorkloadId *string `type:"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 `min:"3" type:"string"`
	// contains filtered or unexported fields
}

Lens upgrade summary return object.

func (LensUpgradeSummary) GoString

func (s LensUpgradeSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LensUpgradeSummary) SetCurrentLensVersion

func (s *LensUpgradeSummary) SetCurrentLensVersion(v string) *LensUpgradeSummary

SetCurrentLensVersion sets the CurrentLensVersion field's value.

func (*LensUpgradeSummary) SetLatestLensVersion

func (s *LensUpgradeSummary) SetLatestLensVersion(v string) *LensUpgradeSummary

SetLatestLensVersion sets the LatestLensVersion field's value.

func (*LensUpgradeSummary) SetLensAlias

func (s *LensUpgradeSummary) SetLensAlias(v string) *LensUpgradeSummary

SetLensAlias sets the LensAlias field's value.

func (*LensUpgradeSummary) SetLensArn added in v1.42.15

func (s *LensUpgradeSummary) SetLensArn(v string) *LensUpgradeSummary

SetLensArn sets the LensArn field's value.

func (*LensUpgradeSummary) SetWorkloadId

func (s *LensUpgradeSummary) SetWorkloadId(v string) *LensUpgradeSummary

SetWorkloadId sets the WorkloadId field's value.

func (*LensUpgradeSummary) SetWorkloadName

func (s *LensUpgradeSummary) SetWorkloadName(v string) *LensUpgradeSummary

SetWorkloadName sets the WorkloadName field's value.

func (LensUpgradeSummary) String

func (s LensUpgradeSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListAnswersInput

type ListAnswersInput 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 is a required field
	LensAlias *string `location:"uri" locationName:"LensAlias" min:"1" type:"string" required:"true"`

	// The maximum number of results to return for this request.
	MaxResults *int64 `location:"querystring" locationName:"MaxResults" min:"1" type:"integer"`

	// The milestone number.
	//
	// A workload can have a maximum of 100 milestones.
	MilestoneNumber *int64 `location:"querystring" locationName:"MilestoneNumber" min:"1" type:"integer"`

	// The token to use to retrieve the next set of results.
	NextToken *string `location:"querystring" locationName:"NextToken" type:"string"`

	// The ID used to identify a pillar, for example, security.
	//
	// A pillar is identified by its PillarReviewSummary$PillarId.
	PillarId *string `location:"querystring" locationName:"PillarId" min:"1" type:"string"`

	// The ID assigned to the workload. This ID is unique within an Amazon Web Services
	// Region.
	//
	// WorkloadId is a required field
	WorkloadId *string `location:"uri" locationName:"WorkloadId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Input to list answers.

func (ListAnswersInput) GoString

func (s ListAnswersInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAnswersInput) SetLensAlias

func (s *ListAnswersInput) SetLensAlias(v string) *ListAnswersInput

SetLensAlias sets the LensAlias field's value.

func (*ListAnswersInput) SetMaxResults

func (s *ListAnswersInput) SetMaxResults(v int64) *ListAnswersInput

SetMaxResults sets the MaxResults field's value.

func (*ListAnswersInput) SetMilestoneNumber

func (s *ListAnswersInput) SetMilestoneNumber(v int64) *ListAnswersInput

SetMilestoneNumber sets the MilestoneNumber field's value.

func (*ListAnswersInput) SetNextToken

func (s *ListAnswersInput) SetNextToken(v string) *ListAnswersInput

SetNextToken sets the NextToken field's value.

func (*ListAnswersInput) SetPillarId

func (s *ListAnswersInput) SetPillarId(v string) *ListAnswersInput

SetPillarId sets the PillarId field's value.

func (*ListAnswersInput) SetWorkloadId

func (s *ListAnswersInput) SetWorkloadId(v string) *ListAnswersInput

SetWorkloadId sets the WorkloadId field's value.

func (ListAnswersInput) String

func (s ListAnswersInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAnswersInput) Validate

func (s *ListAnswersInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListAnswersOutput

type ListAnswersOutput struct {

	// List of answer summaries of lens review in a workload.
	AnswerSummaries []*AnswerSummary `type:"list"`

	// 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 `min:"1" type:"string"`

	// The ARN for the lens.
	LensArn *string `type:"string"`

	// The milestone number.
	//
	// A workload can have a maximum of 100 milestones.
	MilestoneNumber *int64 `min:"1" type:"integer"`

	// The token to use to retrieve the next set of results.
	NextToken *string `type:"string"`

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

Output of a list answers call.

func (ListAnswersOutput) GoString

func (s ListAnswersOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListAnswersOutput) SetAnswerSummaries

func (s *ListAnswersOutput) SetAnswerSummaries(v []*AnswerSummary) *ListAnswersOutput

SetAnswerSummaries sets the AnswerSummaries field's value.

func (*ListAnswersOutput) SetLensAlias

func (s *ListAnswersOutput) SetLensAlias(v string) *ListAnswersOutput

SetLensAlias sets the LensAlias field's value.

func (*ListAnswersOutput) SetLensArn added in v1.42.15

func (s *ListAnswersOutput) SetLensArn(v string) *ListAnswersOutput

SetLensArn sets the LensArn field's value.

func (*ListAnswersOutput) SetMilestoneNumber

func (s *ListAnswersOutput) SetMilestoneNumber(v int64) *ListAnswersOutput

SetMilestoneNumber sets the MilestoneNumber field's value.

func (*ListAnswersOutput) SetNextToken

func (s *ListAnswersOutput) SetNextToken(v string) *ListAnswersOutput

SetNextToken sets the NextToken field's value.

func (*ListAnswersOutput) SetWorkloadId

func (s *ListAnswersOutput) SetWorkloadId(v string) *ListAnswersOutput

SetWorkloadId sets the WorkloadId field's value.

func (ListAnswersOutput) String

func (s ListAnswersOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListCheckDetailsInput added in v1.44.132

type ListCheckDetailsInput struct {

	// The ID of a choice.
	//
	// ChoiceId is a required field
	ChoiceId *string `min:"1" type:"string" required:"true"`

	// Well-Architected Lens ARN.
	//
	// LensArn is a required field
	LensArn *string `type:"string" required:"true"`

	// The maximum number of results to return for this request.
	MaxResults *int64 `min:"1" type:"integer"`

	// The token to use to retrieve the next set of results.
	NextToken *string `type:"string"`

	// The ID used to identify a pillar, for example, security.
	//
	// A pillar is identified by its PillarReviewSummary$PillarId.
	//
	// PillarId is a required field
	PillarId *string `min:"1" type:"string" required:"true"`

	// The ID of the question.
	//
	// QuestionId is a required field
	QuestionId *string `min:"1" type:"string" required:"true"`

	// The ID assigned to the workload. This ID is unique within an Amazon Web Services
	// Region.
	//
	// WorkloadId is a required field
	WorkloadId *string `location:"uri" locationName:"WorkloadId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListCheckDetailsInput) GoString added in v1.44.132

func (s ListCheckDetailsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListCheckDetailsInput) SetChoiceId added in v1.44.132

SetChoiceId sets the ChoiceId field's value.

func (*ListCheckDetailsInput) SetLensArn added in v1.44.132

SetLensArn sets the LensArn field's value.

func (*ListCheckDetailsInput) SetMaxResults added in v1.44.132

func (s *ListCheckDetailsInput) SetMaxResults(v int64) *ListCheckDetailsInput

SetMaxResults sets the MaxResults field's value.

func (*ListCheckDetailsInput) SetNextToken added in v1.44.132

SetNextToken sets the NextToken field's value.

func (*ListCheckDetailsInput) SetPillarId added in v1.44.132

SetPillarId sets the PillarId field's value.

func (*ListCheckDetailsInput) SetQuestionId added in v1.44.132

func (s *ListCheckDetailsInput) SetQuestionId(v string) *ListCheckDetailsInput

SetQuestionId sets the QuestionId field's value.

func (*ListCheckDetailsInput) SetWorkloadId added in v1.44.132

func (s *ListCheckDetailsInput) SetWorkloadId(v string) *ListCheckDetailsInput

SetWorkloadId sets the WorkloadId field's value.

func (ListCheckDetailsInput) String added in v1.44.132

func (s ListCheckDetailsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListCheckDetailsInput) Validate added in v1.44.132

func (s *ListCheckDetailsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListCheckDetailsOutput added in v1.44.132

type ListCheckDetailsOutput struct {

	// The details about the Trusted Advisor checks related to the Well-Architected
	// best practice.
	CheckDetails []*CheckDetail `type:"list"`

	// The token to use to retrieve the next set of results.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListCheckDetailsOutput) GoString added in v1.44.132

func (s ListCheckDetailsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListCheckDetailsOutput) SetCheckDetails added in v1.44.132

func (s *ListCheckDetailsOutput) SetCheckDetails(v []*CheckDetail) *ListCheckDetailsOutput

SetCheckDetails sets the CheckDetails field's value.

func (*ListCheckDetailsOutput) SetNextToken added in v1.44.132

SetNextToken sets the NextToken field's value.

func (ListCheckDetailsOutput) String added in v1.44.132

func (s ListCheckDetailsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListCheckSummariesInput added in v1.44.132

type ListCheckSummariesInput struct {

	// The ID of a choice.
	//
	// ChoiceId is a required field
	ChoiceId *string `min:"1" type:"string" required:"true"`

	// Well-Architected Lens ARN.
	//
	// LensArn is a required field
	LensArn *string `type:"string" required:"true"`

	// The maximum number of results to return for this request.
	MaxResults *int64 `min:"1" type:"integer"`

	// The token to use to retrieve the next set of results.
	NextToken *string `type:"string"`

	// The ID used to identify a pillar, for example, security.
	//
	// A pillar is identified by its PillarReviewSummary$PillarId.
	//
	// PillarId is a required field
	PillarId *string `min:"1" type:"string" required:"true"`

	// The ID of the question.
	//
	// QuestionId is a required field
	QuestionId *string `min:"1" type:"string" required:"true"`

	// The ID assigned to the workload. This ID is unique within an Amazon Web Services
	// Region.
	//
	// WorkloadId is a required field
	WorkloadId *string `location:"uri" locationName:"WorkloadId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListCheckSummariesInput) GoString added in v1.44.132

func (s ListCheckSummariesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListCheckSummariesInput) SetChoiceId added in v1.44.132

SetChoiceId sets the ChoiceId field's value.

func (*ListCheckSummariesInput) SetLensArn added in v1.44.132

SetLensArn sets the LensArn field's value.

func (*ListCheckSummariesInput) SetMaxResults added in v1.44.132

SetMaxResults sets the MaxResults field's value.

func (*ListCheckSummariesInput) SetNextToken added in v1.44.132

SetNextToken sets the NextToken field's value.

func (*ListCheckSummariesInput) SetPillarId added in v1.44.132

SetPillarId sets the PillarId field's value.

func (*ListCheckSummariesInput) SetQuestionId added in v1.44.132

SetQuestionId sets the QuestionId field's value.

func (*ListCheckSummariesInput) SetWorkloadId added in v1.44.132

SetWorkloadId sets the WorkloadId field's value.

func (ListCheckSummariesInput) String added in v1.44.132

func (s ListCheckSummariesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListCheckSummariesInput) Validate added in v1.44.132

func (s *ListCheckSummariesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListCheckSummariesOutput added in v1.44.132

type ListCheckSummariesOutput struct {

	// List of Trusted Advisor summaries related to the Well-Architected best practice.
	CheckSummaries []*CheckSummary `type:"list"`

	// The token to use to retrieve the next set of results.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListCheckSummariesOutput) GoString added in v1.44.132

func (s ListCheckSummariesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListCheckSummariesOutput) SetCheckSummaries added in v1.44.132

SetCheckSummaries sets the CheckSummaries field's value.

func (*ListCheckSummariesOutput) SetNextToken added in v1.44.132

SetNextToken sets the NextToken field's value.

func (ListCheckSummariesOutput) String added in v1.44.132

func (s ListCheckSummariesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListLensReviewImprovementsInput

type ListLensReviewImprovementsInput 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 is a required field
	LensAlias *string `location:"uri" locationName:"LensAlias" min:"1" type:"string" required:"true"`

	// The maximum number of results to return for this request.
	MaxResults *int64 `location:"querystring" locationName:"MaxResults" min:"1" type:"integer"`

	// The milestone number.
	//
	// A workload can have a maximum of 100 milestones.
	MilestoneNumber *int64 `location:"querystring" locationName:"MilestoneNumber" min:"1" type:"integer"`

	// The token to use to retrieve the next set of results.
	NextToken *string `location:"querystring" locationName:"NextToken" type:"string"`

	// The ID used to identify a pillar, for example, security.
	//
	// A pillar is identified by its PillarReviewSummary$PillarId.
	PillarId *string `location:"querystring" locationName:"PillarId" min:"1" type:"string"`

	// The ID assigned to the workload. This ID is unique within an Amazon Web Services
	// Region.
	//
	// WorkloadId is a required field
	WorkloadId *string `location:"uri" locationName:"WorkloadId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Input to list lens review improvements.

func (ListLensReviewImprovementsInput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListLensReviewImprovementsInput) SetLensAlias

SetLensAlias sets the LensAlias field's value.

func (*ListLensReviewImprovementsInput) SetMaxResults

SetMaxResults sets the MaxResults field's value.

func (*ListLensReviewImprovementsInput) SetMilestoneNumber

SetMilestoneNumber sets the MilestoneNumber field's value.

func (*ListLensReviewImprovementsInput) SetNextToken

SetNextToken sets the NextToken field's value.

func (*ListLensReviewImprovementsInput) SetPillarId

SetPillarId sets the PillarId field's value.

func (*ListLensReviewImprovementsInput) SetWorkloadId

SetWorkloadId sets the WorkloadId field's value.

func (ListLensReviewImprovementsInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListLensReviewImprovementsInput) Validate

func (s *ListLensReviewImprovementsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListLensReviewImprovementsOutput

type ListLensReviewImprovementsOutput struct {

	// List of improvement summaries of lens review in a workload.
	ImprovementSummaries []*ImprovementSummary `type:"list"`

	// 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 `min:"1" type:"string"`

	// The ARN for the lens.
	LensArn *string `type:"string"`

	// The milestone number.
	//
	// A workload can have a maximum of 100 milestones.
	MilestoneNumber *int64 `min:"1" type:"integer"`

	// The token to use to retrieve the next set of results.
	NextToken *string `type:"string"`

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

Output of a list lens review improvements call.

func (ListLensReviewImprovementsOutput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListLensReviewImprovementsOutput) SetImprovementSummaries

SetImprovementSummaries sets the ImprovementSummaries field's value.

func (*ListLensReviewImprovementsOutput) SetLensAlias

SetLensAlias sets the LensAlias field's value.

func (*ListLensReviewImprovementsOutput) SetLensArn added in v1.42.15

SetLensArn sets the LensArn field's value.

func (*ListLensReviewImprovementsOutput) SetMilestoneNumber

SetMilestoneNumber sets the MilestoneNumber field's value.

func (*ListLensReviewImprovementsOutput) SetNextToken

SetNextToken sets the NextToken field's value.

func (*ListLensReviewImprovementsOutput) SetWorkloadId

SetWorkloadId sets the WorkloadId field's value.

func (ListLensReviewImprovementsOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListLensReviewsInput

type ListLensReviewsInput struct {

	// The maximum number of results to return for this request.
	MaxResults *int64 `location:"querystring" locationName:"MaxResults" min:"1" type:"integer"`

	// The milestone number.
	//
	// A workload can have a maximum of 100 milestones.
	MilestoneNumber *int64 `location:"querystring" locationName:"MilestoneNumber" min:"1" type:"integer"`

	// The token to use to retrieve the next set of results.
	NextToken *string `location:"querystring" locationName:"NextToken" type:"string"`

	// The ID assigned to the workload. This ID is unique within an Amazon Web Services
	// Region.
	//
	// WorkloadId is a required field
	WorkloadId *string `location:"uri" locationName:"WorkloadId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Input to list lens reviews.

func (ListLensReviewsInput) GoString

func (s ListLensReviewsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListLensReviewsInput) SetMaxResults

func (s *ListLensReviewsInput) SetMaxResults(v int64) *ListLensReviewsInput

SetMaxResults sets the MaxResults field's value.

func (*ListLensReviewsInput) SetMilestoneNumber

func (s *ListLensReviewsInput) SetMilestoneNumber(v int64) *ListLensReviewsInput

SetMilestoneNumber sets the MilestoneNumber field's value.

func (*ListLensReviewsInput) SetNextToken

func (s *ListLensReviewsInput) SetNextToken(v string) *ListLensReviewsInput

SetNextToken sets the NextToken field's value.

func (*ListLensReviewsInput) SetWorkloadId

func (s *ListLensReviewsInput) SetWorkloadId(v string) *ListLensReviewsInput

SetWorkloadId sets the WorkloadId field's value.

func (ListLensReviewsInput) String

func (s ListLensReviewsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListLensReviewsInput) Validate

func (s *ListLensReviewsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListLensReviewsOutput

type ListLensReviewsOutput struct {

	// List of lens summaries of lens reviews of a workload.
	LensReviewSummaries []*LensReviewSummary `type:"list"`

	// The milestone number.
	//
	// A workload can have a maximum of 100 milestones.
	MilestoneNumber *int64 `min:"1" type:"integer"`

	// The token to use to retrieve the next set of results.
	NextToken *string `type:"string"`

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

Output of a list lens reviews call.

func (ListLensReviewsOutput) GoString

func (s ListLensReviewsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListLensReviewsOutput) SetLensReviewSummaries

func (s *ListLensReviewsOutput) SetLensReviewSummaries(v []*LensReviewSummary) *ListLensReviewsOutput

SetLensReviewSummaries sets the LensReviewSummaries field's value.

func (*ListLensReviewsOutput) SetMilestoneNumber

func (s *ListLensReviewsOutput) SetMilestoneNumber(v int64) *ListLensReviewsOutput

SetMilestoneNumber sets the MilestoneNumber field's value.

func (*ListLensReviewsOutput) SetNextToken

SetNextToken sets the NextToken field's value.

func (*ListLensReviewsOutput) SetWorkloadId

func (s *ListLensReviewsOutput) SetWorkloadId(v string) *ListLensReviewsOutput

SetWorkloadId sets the WorkloadId field's value.

func (ListLensReviewsOutput) String

func (s ListLensReviewsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListLensSharesInput added in v1.42.15

type ListLensSharesInput 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 is a required field
	LensAlias *string `location:"uri" locationName:"LensAlias" min:"1" type:"string" required:"true"`

	// The maximum number of results to return for this request.
	MaxResults *int64 `location:"querystring" locationName:"MaxResults" min:"1" type:"integer"`

	// The token to use to retrieve the next set of results.
	NextToken *string `location:"querystring" locationName:"NextToken" type:"string"`

	// The Amazon Web Services account ID, IAM role, organization ID, or organizational
	// unit (OU) ID with which the lens is shared.
	SharedWithPrefix *string `location:"querystring" locationName:"SharedWithPrefix" type:"string"`

	// The status of a workload share.
	Status *string `location:"querystring" locationName:"Status" type:"string" enum:"ShareStatus"`
	// contains filtered or unexported fields
}

func (ListLensSharesInput) GoString added in v1.42.15

func (s ListLensSharesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListLensSharesInput) SetLensAlias added in v1.42.15

func (s *ListLensSharesInput) SetLensAlias(v string) *ListLensSharesInput

SetLensAlias sets the LensAlias field's value.

func (*ListLensSharesInput) SetMaxResults added in v1.42.15

func (s *ListLensSharesInput) SetMaxResults(v int64) *ListLensSharesInput

SetMaxResults sets the MaxResults field's value.

func (*ListLensSharesInput) SetNextToken added in v1.42.15

func (s *ListLensSharesInput) SetNextToken(v string) *ListLensSharesInput

SetNextToken sets the NextToken field's value.

func (*ListLensSharesInput) SetSharedWithPrefix added in v1.42.15

func (s *ListLensSharesInput) SetSharedWithPrefix(v string) *ListLensSharesInput

SetSharedWithPrefix sets the SharedWithPrefix field's value.

func (*ListLensSharesInput) SetStatus added in v1.44.46

SetStatus sets the Status field's value.

func (ListLensSharesInput) String added in v1.42.15

func (s ListLensSharesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListLensSharesInput) Validate added in v1.42.15

func (s *ListLensSharesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListLensSharesOutput added in v1.42.15

type ListLensSharesOutput struct {

	// A list of lens share summaries.
	LensShareSummaries []*LensShareSummary `type:"list"`

	// The token to use to retrieve the next set of results.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

func (ListLensSharesOutput) GoString added in v1.42.15

func (s ListLensSharesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListLensSharesOutput) SetLensShareSummaries added in v1.42.15

func (s *ListLensSharesOutput) SetLensShareSummaries(v []*LensShareSummary) *ListLensSharesOutput

SetLensShareSummaries sets the LensShareSummaries field's value.

func (*ListLensSharesOutput) SetNextToken added in v1.42.15

func (s *ListLensSharesOutput) SetNextToken(v string) *ListLensSharesOutput

SetNextToken sets the NextToken field's value.

func (ListLensSharesOutput) String added in v1.42.15

func (s ListLensSharesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListLensesInput

type ListLensesInput struct {

	// The full name of the lens.
	LensName *string `location:"querystring" locationName:"LensName" min:"1" type:"string"`

	// The status of lenses to be returned.
	LensStatus *string `location:"querystring" locationName:"LensStatus" type:"string" enum:"LensStatusType"`

	// The type of lenses to be returned.
	LensType *string `location:"querystring" locationName:"LensType" type:"string" enum:"LensType"`

	// The maximum number of results to return for this request.
	MaxResults *int64 `location:"querystring" locationName:"MaxResults" min:"1" type:"integer"`

	// The token to use to retrieve the next set of results.
	NextToken *string `location:"querystring" locationName:"NextToken" type:"string"`
	// contains filtered or unexported fields
}

Input to list lenses.

func (ListLensesInput) GoString

func (s ListLensesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListLensesInput) SetLensName added in v1.42.15

func (s *ListLensesInput) SetLensName(v string) *ListLensesInput

SetLensName sets the LensName field's value.

func (*ListLensesInput) SetLensStatus added in v1.42.15

func (s *ListLensesInput) SetLensStatus(v string) *ListLensesInput

SetLensStatus sets the LensStatus field's value.

func (*ListLensesInput) SetLensType added in v1.42.15

func (s *ListLensesInput) SetLensType(v string) *ListLensesInput

SetLensType sets the LensType field's value.

func (*ListLensesInput) SetMaxResults

func (s *ListLensesInput) SetMaxResults(v int64) *ListLensesInput

SetMaxResults sets the MaxResults field's value.

func (*ListLensesInput) SetNextToken

func (s *ListLensesInput) SetNextToken(v string) *ListLensesInput

SetNextToken sets the NextToken field's value.

func (ListLensesInput) String

func (s ListLensesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListLensesInput) Validate

func (s *ListLensesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListLensesOutput

type ListLensesOutput struct {

	// List of lens summaries of available lenses.
	LensSummaries []*LensSummary `type:"list"`

	// The token to use to retrieve the next set of results.
	NextToken *string `type:"string"`
	// contains filtered or unexported fields
}

Output of a list lenses call.

func (ListLensesOutput) GoString

func (s ListLensesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListLensesOutput) SetLensSummaries

func (s *ListLensesOutput) SetLensSummaries(v []*LensSummary) *ListLensesOutput

SetLensSummaries sets the LensSummaries field's value.

func (*ListLensesOutput) SetNextToken

func (s *ListLensesOutput) SetNextToken(v string) *ListLensesOutput

SetNextToken sets the NextToken field's value.

func (ListLensesOutput) String

func (s ListLensesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListMilestonesInput

type ListMilestonesInput struct {

	// The maximum number of results to return for this request.
	MaxResults *int64 `min:"1" type:"integer"`

	// The token to use to retrieve the next set of results.
	NextToken *string `type:"string"`

	// The ID assigned to the workload. This ID is unique within an Amazon Web Services
	// Region.
	//
	// WorkloadId is a required field
	WorkloadId *string `location:"uri" locationName:"WorkloadId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Input to list all milestones for a workload.

func (ListMilestonesInput) GoString

func (s ListMilestonesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListMilestonesInput) SetMaxResults

func (s *ListMilestonesInput) SetMaxResults(v int64) *ListMilestonesInput

SetMaxResults sets the MaxResults field's value.

func (*ListMilestonesInput) SetNextToken

func (s *ListMilestonesInput) SetNextToken(v string) *ListMilestonesInput

SetNextToken sets the NextToken field's value.

func (*ListMilestonesInput) SetWorkloadId

func (s *ListMilestonesInput) SetWorkloadId(v string) *ListMilestonesInput

SetWorkloadId sets the WorkloadId field's value.

func (ListMilestonesInput) String

func (s ListMilestonesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListMilestonesInput) Validate

func (s *ListMilestonesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListMilestonesOutput

type ListMilestonesOutput struct {

	// A list of milestone summaries.
	MilestoneSummaries []*MilestoneSummary `type:"list"`

	// The token to use to retrieve the next set of results.
	NextToken *string `type:"string"`

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

Output of a list milestones call.

func (ListMilestonesOutput) GoString

func (s ListMilestonesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListMilestonesOutput) SetMilestoneSummaries

func (s *ListMilestonesOutput) SetMilestoneSummaries(v []*MilestoneSummary) *ListMilestonesOutput

SetMilestoneSummaries sets the MilestoneSummaries field's value.

func (*ListMilestonesOutput) SetNextToken

func (s *ListMilestonesOutput) SetNextToken(v string) *ListMilestonesOutput

SetNextToken sets the NextToken field's value.

func (*ListMilestonesOutput) SetWorkloadId

func (s *ListMilestonesOutput) SetWorkloadId(v string) *ListMilestonesOutput

SetWorkloadId sets the WorkloadId field's value.

func (ListMilestonesOutput) String

func (s ListMilestonesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListNotificationsInput

type ListNotificationsInput struct {

	// The maximum number of results to return for this request.
	MaxResults *int64 `min:"1" type:"integer"`

	// The token to use to retrieve the next set of results.
	NextToken *string `type:"string"`

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

func (ListNotificationsInput) GoString

func (s ListNotificationsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListNotificationsInput) SetMaxResults

SetMaxResults sets the MaxResults field's value.

func (*ListNotificationsInput) SetNextToken

SetNextToken sets the NextToken field's value.

func (*ListNotificationsInput) SetWorkloadId

SetWorkloadId sets the WorkloadId field's value.

func (ListNotificationsInput) String

func (s ListNotificationsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListNotificationsInput) Validate

func (s *ListNotificationsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListNotificationsOutput

type ListNotificationsOutput struct {

	// The token to use to retrieve the next set of results.
	NextToken *string `type:"string"`

	// List of lens notification summaries in a workload.
	NotificationSummaries []*NotificationSummary `type:"list"`
	// contains filtered or unexported fields
}

func (ListNotificationsOutput) GoString

func (s ListNotificationsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListNotificationsOutput) SetNextToken

SetNextToken sets the NextToken field's value.

func (*ListNotificationsOutput) SetNotificationSummaries

func (s *ListNotificationsOutput) SetNotificationSummaries(v []*NotificationSummary) *ListNotificationsOutput

SetNotificationSummaries sets the NotificationSummaries field's value.

func (ListNotificationsOutput) String

func (s ListNotificationsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListShareInvitationsInput

type ListShareInvitationsInput struct {

	// An optional string added to the beginning of each lens name returned in the
	// results.
	LensNamePrefix *string `location:"querystring" locationName:"LensNamePrefix" type:"string"`

	// The maximum number of results to return for this request.
	MaxResults *int64 `location:"querystring" locationName:"MaxResults" min:"1" type:"integer"`

	// The token to use to retrieve the next set of results.
	NextToken *string `location:"querystring" locationName:"NextToken" type:"string"`

	// The type of share invitations to be returned.
	ShareResourceType *string `location:"querystring" locationName:"ShareResourceType" type:"string" enum:"ShareResourceType"`

	// An optional string added to the beginning of each workload name returned
	// in the results.
	WorkloadNamePrefix *string `location:"querystring" locationName:"WorkloadNamePrefix" type:"string"`
	// contains filtered or unexported fields
}

Input for List Share Invitations

func (ListShareInvitationsInput) GoString

func (s ListShareInvitationsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListShareInvitationsInput) SetLensNamePrefix added in v1.42.15

SetLensNamePrefix sets the LensNamePrefix field's value.

func (*ListShareInvitationsInput) SetMaxResults

SetMaxResults sets the MaxResults field's value.

func (*ListShareInvitationsInput) SetNextToken

SetNextToken sets the NextToken field's value.

func (*ListShareInvitationsInput) SetShareResourceType added in v1.42.15

func (s *ListShareInvitationsInput) SetShareResourceType(v string) *ListShareInvitationsInput

SetShareResourceType sets the ShareResourceType field's value.

func (*ListShareInvitationsInput) SetWorkloadNamePrefix

func (s *ListShareInvitationsInput) SetWorkloadNamePrefix(v string) *ListShareInvitationsInput

SetWorkloadNamePrefix sets the WorkloadNamePrefix field's value.

func (ListShareInvitationsInput) String

func (s ListShareInvitationsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListShareInvitationsInput) Validate

func (s *ListShareInvitationsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListShareInvitationsOutput

type ListShareInvitationsOutput struct {

	// The token to use to retrieve the next set of results.
	NextToken *string `type:"string"`

	// List of share invitation summaries in a workload.
	ShareInvitationSummaries []*ShareInvitationSummary `type:"list"`
	// contains filtered or unexported fields
}

Input for List Share Invitations

func (ListShareInvitationsOutput) GoString

func (s ListShareInvitationsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListShareInvitationsOutput) SetNextToken

SetNextToken sets the NextToken field's value.

func (*ListShareInvitationsOutput) SetShareInvitationSummaries

SetShareInvitationSummaries sets the ShareInvitationSummaries field's value.

func (ListShareInvitationsOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListTagsForResourceInput added in v1.37.23

type ListTagsForResourceInput struct {

	// The ARN for the workload.
	//
	// WorkloadArn is a required field
	WorkloadArn *string `location:"uri" locationName:"WorkloadArn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceInput) GoString added in v1.37.23

func (s ListTagsForResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceInput) SetWorkloadArn added in v1.37.23

SetWorkloadArn sets the WorkloadArn field's value.

func (ListTagsForResourceInput) String added in v1.37.23

func (s ListTagsForResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceInput) Validate added in v1.37.23

func (s *ListTagsForResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListTagsForResourceOutput added in v1.37.23

type ListTagsForResourceOutput struct {

	// The tags for the resource.
	Tags map[string]*string `min:"1" type:"map"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceOutput) GoString added in v1.37.23

func (s ListTagsForResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceOutput) SetTags added in v1.37.23

SetTags sets the Tags field's value.

func (ListTagsForResourceOutput) String added in v1.37.23

func (s ListTagsForResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListWorkloadSharesInput

type ListWorkloadSharesInput struct {

	// The maximum number of results to return for this request.
	MaxResults *int64 `location:"querystring" locationName:"MaxResults" min:"1" type:"integer"`

	// The token to use to retrieve the next set of results.
	NextToken *string `location:"querystring" locationName:"NextToken" type:"string"`

	// The Amazon Web Services account ID, IAM role, organization ID, or organizational
	// unit (OU) ID with which the workload is shared.
	SharedWithPrefix *string `location:"querystring" locationName:"SharedWithPrefix" type:"string"`

	// The status of a workload share.
	Status *string `location:"querystring" locationName:"Status" type:"string" enum:"ShareStatus"`

	// The ID assigned to the workload. This ID is unique within an Amazon Web Services
	// Region.
	//
	// WorkloadId is a required field
	WorkloadId *string `location:"uri" locationName:"WorkloadId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Input for List Workload Share

func (ListWorkloadSharesInput) GoString

func (s ListWorkloadSharesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListWorkloadSharesInput) SetMaxResults

SetMaxResults sets the MaxResults field's value.

func (*ListWorkloadSharesInput) SetNextToken

SetNextToken sets the NextToken field's value.

func (*ListWorkloadSharesInput) SetSharedWithPrefix

func (s *ListWorkloadSharesInput) SetSharedWithPrefix(v string) *ListWorkloadSharesInput

SetSharedWithPrefix sets the SharedWithPrefix field's value.

func (*ListWorkloadSharesInput) SetStatus added in v1.44.46

SetStatus sets the Status field's value.

func (*ListWorkloadSharesInput) SetWorkloadId

SetWorkloadId sets the WorkloadId field's value.

func (ListWorkloadSharesInput) String

func (s ListWorkloadSharesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListWorkloadSharesInput) Validate

func (s *ListWorkloadSharesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListWorkloadSharesOutput

type ListWorkloadSharesOutput struct {

	// The token to use to retrieve the next set of results.
	NextToken *string `type:"string"`

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

	// A list of workload share summaries.
	WorkloadShareSummaries []*WorkloadShareSummary `type:"list"`
	// contains filtered or unexported fields
}

Input for List Workload Share

func (ListWorkloadSharesOutput) GoString

func (s ListWorkloadSharesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListWorkloadSharesOutput) SetNextToken

SetNextToken sets the NextToken field's value.

func (*ListWorkloadSharesOutput) SetWorkloadId

SetWorkloadId sets the WorkloadId field's value.

func (*ListWorkloadSharesOutput) SetWorkloadShareSummaries

func (s *ListWorkloadSharesOutput) SetWorkloadShareSummaries(v []*WorkloadShareSummary) *ListWorkloadSharesOutput

SetWorkloadShareSummaries sets the WorkloadShareSummaries field's value.

func (ListWorkloadSharesOutput) String

func (s ListWorkloadSharesOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListWorkloadsInput

type ListWorkloadsInput struct {

	// The maximum number of results to return for this request.
	MaxResults *int64 `min:"1" type:"integer"`

	// The token to use to retrieve the next set of results.
	NextToken *string `type:"string"`

	// An optional string added to the beginning of each workload name returned
	// in the results.
	WorkloadNamePrefix *string `type:"string"`
	// contains filtered or unexported fields
}

Input to list all workloads.

func (ListWorkloadsInput) GoString

func (s ListWorkloadsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListWorkloadsInput) SetMaxResults

func (s *ListWorkloadsInput) SetMaxResults(v int64) *ListWorkloadsInput

SetMaxResults sets the MaxResults field's value.

func (*ListWorkloadsInput) SetNextToken

func (s *ListWorkloadsInput) SetNextToken(v string) *ListWorkloadsInput

SetNextToken sets the NextToken field's value.

func (*ListWorkloadsInput) SetWorkloadNamePrefix

func (s *ListWorkloadsInput) SetWorkloadNamePrefix(v string) *ListWorkloadsInput

SetWorkloadNamePrefix sets the WorkloadNamePrefix field's value.

func (ListWorkloadsInput) String

func (s ListWorkloadsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListWorkloadsInput) Validate

func (s *ListWorkloadsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListWorkloadsOutput

type ListWorkloadsOutput struct {

	// The token to use to retrieve the next set of results.
	NextToken *string `type:"string"`

	// A list of workload summaries.
	WorkloadSummaries []*WorkloadSummary `type:"list"`
	// contains filtered or unexported fields
}

Output of a list workloads call.

func (ListWorkloadsOutput) GoString

func (s ListWorkloadsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListWorkloadsOutput) SetNextToken

func (s *ListWorkloadsOutput) SetNextToken(v string) *ListWorkloadsOutput

SetNextToken sets the NextToken field's value.

func (*ListWorkloadsOutput) SetWorkloadSummaries

func (s *ListWorkloadsOutput) SetWorkloadSummaries(v []*WorkloadSummary) *ListWorkloadsOutput

SetWorkloadSummaries sets the WorkloadSummaries field's value.

func (ListWorkloadsOutput) String

func (s ListWorkloadsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Milestone

type Milestone struct {

	// The name of the milestone in a workload.
	//
	// Milestone names must be unique within a workload.
	MilestoneName *string `min:"3" type:"string"`

	// The milestone number.
	//
	// A workload can have a maximum of 100 milestones.
	MilestoneNumber *int64 `min:"1" type:"integer"`

	// The date and time recorded.
	RecordedAt *time.Time `type:"timestamp"`

	// A workload return object.
	Workload *Workload `type:"structure"`
	// contains filtered or unexported fields
}

A milestone return object.

func (Milestone) GoString

func (s Milestone) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Milestone) SetMilestoneName

func (s *Milestone) SetMilestoneName(v string) *Milestone

SetMilestoneName sets the MilestoneName field's value.

func (*Milestone) SetMilestoneNumber

func (s *Milestone) SetMilestoneNumber(v int64) *Milestone

SetMilestoneNumber sets the MilestoneNumber field's value.

func (*Milestone) SetRecordedAt

func (s *Milestone) SetRecordedAt(v time.Time) *Milestone

SetRecordedAt sets the RecordedAt field's value.

func (*Milestone) SetWorkload

func (s *Milestone) SetWorkload(v *Workload) *Milestone

SetWorkload sets the Workload field's value.

func (Milestone) String

func (s Milestone) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type MilestoneSummary

type MilestoneSummary struct {

	// The name of the milestone in a workload.
	//
	// Milestone names must be unique within a workload.
	MilestoneName *string `min:"3" type:"string"`

	// The milestone number.
	//
	// A workload can have a maximum of 100 milestones.
	MilestoneNumber *int64 `min:"1" type:"integer"`

	// The date and time recorded.
	RecordedAt *time.Time `type:"timestamp"`

	// A workload summary return object.
	WorkloadSummary *WorkloadSummary `type:"structure"`
	// contains filtered or unexported fields
}

A milestone summary return object.

func (MilestoneSummary) GoString

func (s MilestoneSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MilestoneSummary) SetMilestoneName

func (s *MilestoneSummary) SetMilestoneName(v string) *MilestoneSummary

SetMilestoneName sets the MilestoneName field's value.

func (*MilestoneSummary) SetMilestoneNumber

func (s *MilestoneSummary) SetMilestoneNumber(v int64) *MilestoneSummary

SetMilestoneNumber sets the MilestoneNumber field's value.

func (*MilestoneSummary) SetRecordedAt

func (s *MilestoneSummary) SetRecordedAt(v time.Time) *MilestoneSummary

SetRecordedAt sets the RecordedAt field's value.

func (*MilestoneSummary) SetWorkloadSummary

func (s *MilestoneSummary) SetWorkloadSummary(v *WorkloadSummary) *MilestoneSummary

SetWorkloadSummary sets the WorkloadSummary field's value.

func (MilestoneSummary) String

func (s MilestoneSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type NotificationSummary

type NotificationSummary struct {

	// Summary of lens upgrade.
	LensUpgradeSummary *LensUpgradeSummary `type:"structure"`

	// The type of notification.
	Type *string `type:"string" enum:"NotificationType"`
	// contains filtered or unexported fields
}

A notification summary return object.

func (NotificationSummary) GoString

func (s NotificationSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*NotificationSummary) SetLensUpgradeSummary

func (s *NotificationSummary) SetLensUpgradeSummary(v *LensUpgradeSummary) *NotificationSummary

SetLensUpgradeSummary sets the LensUpgradeSummary field's value.

func (*NotificationSummary) SetType

SetType sets the Type field's value.

func (NotificationSummary) String

func (s NotificationSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PillarDifference

type PillarDifference struct {

	// Indicates the type of change to the pillar.
	DifferenceStatus *string `type:"string" enum:"DifferenceStatus"`

	// The ID used to identify a pillar, for example, security.
	//
	// A pillar is identified by its PillarReviewSummary$PillarId.
	PillarId *string `min:"1" type:"string"`

	// The name of the pillar.
	PillarName *string `min:"1" type:"string"`

	// List of question differences.
	QuestionDifferences []*QuestionDifference `type:"list"`
	// contains filtered or unexported fields
}

A pillar difference return object.

func (PillarDifference) GoString

func (s PillarDifference) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PillarDifference) SetDifferenceStatus

func (s *PillarDifference) SetDifferenceStatus(v string) *PillarDifference

SetDifferenceStatus sets the DifferenceStatus field's value.

func (*PillarDifference) SetPillarId

func (s *PillarDifference) SetPillarId(v string) *PillarDifference

SetPillarId sets the PillarId field's value.

func (*PillarDifference) SetPillarName added in v1.42.15

func (s *PillarDifference) SetPillarName(v string) *PillarDifference

SetPillarName sets the PillarName field's value.

func (*PillarDifference) SetQuestionDifferences

func (s *PillarDifference) SetQuestionDifferences(v []*QuestionDifference) *PillarDifference

SetQuestionDifferences sets the QuestionDifferences field's value.

func (PillarDifference) String

func (s PillarDifference) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PillarMetric added in v1.44.233

type PillarMetric struct {

	// The ID used to identify a pillar, for example, security.
	//
	// A pillar is identified by its PillarReviewSummary$PillarId.
	PillarId *string `min:"1" type:"string"`

	// The questions that have been identified as risks in the pillar.
	Questions []*QuestionMetric `type:"list"`

	// A map from risk names to the count of how many questions have that rating.
	RiskCounts map[string]*int64 `type:"map"`
	// contains filtered or unexported fields
}

A metric for a particular pillar in a lens.

func (PillarMetric) GoString added in v1.44.233

func (s PillarMetric) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PillarMetric) SetPillarId added in v1.44.233

func (s *PillarMetric) SetPillarId(v string) *PillarMetric

SetPillarId sets the PillarId field's value.

func (*PillarMetric) SetQuestions added in v1.44.233

func (s *PillarMetric) SetQuestions(v []*QuestionMetric) *PillarMetric

SetQuestions sets the Questions field's value.

func (*PillarMetric) SetRiskCounts added in v1.44.233

func (s *PillarMetric) SetRiskCounts(v map[string]*int64) *PillarMetric

SetRiskCounts sets the RiskCounts field's value.

func (PillarMetric) String added in v1.44.233

func (s PillarMetric) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PillarReviewSummary

type PillarReviewSummary struct {

	// The notes associated with the workload.
	Notes *string `type:"string"`

	// The ID used to identify a pillar, for example, security.
	//
	// A pillar is identified by its PillarReviewSummary$PillarId.
	PillarId *string `min:"1" type:"string"`

	// The name of the pillar.
	PillarName *string `min:"1" type:"string"`

	// A map from risk names to the count of how many questions have that rating.
	RiskCounts map[string]*int64 `type:"map"`
	// contains filtered or unexported fields
}

A pillar review summary of a lens review.

func (PillarReviewSummary) GoString

func (s PillarReviewSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PillarReviewSummary) SetNotes

SetNotes sets the Notes field's value.

func (*PillarReviewSummary) SetPillarId

func (s *PillarReviewSummary) SetPillarId(v string) *PillarReviewSummary

SetPillarId sets the PillarId field's value.

func (*PillarReviewSummary) SetPillarName

func (s *PillarReviewSummary) SetPillarName(v string) *PillarReviewSummary

SetPillarName sets the PillarName field's value.

func (*PillarReviewSummary) SetRiskCounts

func (s *PillarReviewSummary) SetRiskCounts(v map[string]*int64) *PillarReviewSummary

SetRiskCounts sets the RiskCounts field's value.

func (PillarReviewSummary) String

func (s PillarReviewSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type QuestionDifference

type QuestionDifference struct {

	// Indicates the type of change to the question.
	DifferenceStatus *string `type:"string" enum:"DifferenceStatus"`

	// The ID of the question.
	QuestionId *string `min:"1" type:"string"`

	// The title of the question.
	QuestionTitle *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

A question difference return object.

func (QuestionDifference) GoString

func (s QuestionDifference) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*QuestionDifference) SetDifferenceStatus

func (s *QuestionDifference) SetDifferenceStatus(v string) *QuestionDifference

SetDifferenceStatus sets the DifferenceStatus field's value.

func (*QuestionDifference) SetQuestionId

func (s *QuestionDifference) SetQuestionId(v string) *QuestionDifference

SetQuestionId sets the QuestionId field's value.

func (*QuestionDifference) SetQuestionTitle

func (s *QuestionDifference) SetQuestionTitle(v string) *QuestionDifference

SetQuestionTitle sets the QuestionTitle field's value.

func (QuestionDifference) String

func (s QuestionDifference) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type QuestionMetric added in v1.44.233

type QuestionMetric struct {

	// The best practices, or choices, that have been identified as contributing
	// to risk in a question.
	BestPractices []*BestPractice `type:"list"`

	// The ID of the question.
	QuestionId *string `min:"1" type:"string"`

	// The risk for a given workload, lens review, pillar, or question.
	Risk *string `type:"string" enum:"Risk"`
	// contains filtered or unexported fields
}

A metric for a particular question in the pillar.

func (QuestionMetric) GoString added in v1.44.233

func (s QuestionMetric) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*QuestionMetric) SetBestPractices added in v1.44.233

func (s *QuestionMetric) SetBestPractices(v []*BestPractice) *QuestionMetric

SetBestPractices sets the BestPractices field's value.

func (*QuestionMetric) SetQuestionId added in v1.44.233

func (s *QuestionMetric) SetQuestionId(v string) *QuestionMetric

SetQuestionId sets the QuestionId field's value.

func (*QuestionMetric) SetRisk added in v1.44.233

func (s *QuestionMetric) SetRisk(v string) *QuestionMetric

SetRisk sets the Risk field's value.

func (QuestionMetric) String added in v1.44.233

func (s QuestionMetric) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ResourceNotFoundException

type ResourceNotFoundException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// Description of the error.
	Message_ *string `locationName:"Message" type:"string"`

	// Identifier of the resource affected.
	//
	// ResourceId is a required field
	ResourceId *string `type:"string" required:"true"`

	// Type of the resource affected.
	//
	// ResourceType is a required field
	ResourceType *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

The requested resource was not found.

func (*ResourceNotFoundException) Code

Code returns the exception type name.

func (*ResourceNotFoundException) Error

func (s *ResourceNotFoundException) Error() string

func (ResourceNotFoundException) GoString

func (s ResourceNotFoundException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResourceNotFoundException) Message

func (s *ResourceNotFoundException) Message() string

Message returns the exception's message.

func (*ResourceNotFoundException) OrigErr

func (s *ResourceNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceNotFoundException) RequestID

func (s *ResourceNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceNotFoundException) StatusCode

func (s *ResourceNotFoundException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ResourceNotFoundException) String

func (s ResourceNotFoundException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ServiceQuotaExceededException

type ServiceQuotaExceededException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// Description of the error.
	Message_ *string `locationName:"Message" type:"string"`

	// Service Quotas requirement to identify originating quota.
	//
	// QuotaCode is a required field
	QuotaCode *string `type:"string" required:"true"`

	// Identifier of the resource affected.
	ResourceId *string `type:"string"`

	// Type of the resource affected.
	ResourceType *string `type:"string"`

	// Service Quotas requirement to identify originating service.
	//
	// ServiceCode is a required field
	ServiceCode *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

The user has reached their resource quota.

func (*ServiceQuotaExceededException) Code

Code returns the exception type name.

func (*ServiceQuotaExceededException) Error

func (ServiceQuotaExceededException) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ServiceQuotaExceededException) Message

Message returns the exception's message.

func (*ServiceQuotaExceededException) OrigErr

func (s *ServiceQuotaExceededException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ServiceQuotaExceededException) RequestID

func (s *ServiceQuotaExceededException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ServiceQuotaExceededException) StatusCode

func (s *ServiceQuotaExceededException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ServiceQuotaExceededException) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

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 `min:"1" type:"string"`

	// The ARN for the lens.
	LensArn *string `type:"string"`

	// The ID assigned to the share invitation.
	ShareInvitationId *string `type:"string"`

	// The resource type of the share invitation.
	ShareResourceType *string `type:"string" enum:"ShareResourceType"`

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

The share invitation.

func (ShareInvitation) GoString

func (s ShareInvitation) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ShareInvitation) SetLensAlias added in v1.42.15

func (s *ShareInvitation) SetLensAlias(v string) *ShareInvitation

SetLensAlias sets the LensAlias field's value.

func (*ShareInvitation) SetLensArn added in v1.42.15

func (s *ShareInvitation) SetLensArn(v string) *ShareInvitation

SetLensArn sets the LensArn field's value.

func (*ShareInvitation) SetShareInvitationId

func (s *ShareInvitation) SetShareInvitationId(v string) *ShareInvitation

SetShareInvitationId sets the ShareInvitationId field's value.

func (*ShareInvitation) SetShareResourceType added in v1.42.15

func (s *ShareInvitation) SetShareResourceType(v string) *ShareInvitation

SetShareResourceType sets the ShareResourceType field's value.

func (*ShareInvitation) SetWorkloadId

func (s *ShareInvitation) SetWorkloadId(v string) *ShareInvitation

SetWorkloadId sets the WorkloadId field's value.

func (ShareInvitation) String

func (s ShareInvitation) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ShareInvitationSummary

type ShareInvitationSummary struct {

	// The ARN for the lens.
	LensArn *string `type:"string"`

	// The full name of the lens.
	LensName *string `min:"1" type:"string"`

	// Permission granted on a workload share.
	PermissionType *string `type:"string" enum:"PermissionType"`

	// The ID assigned to the share invitation.
	ShareInvitationId *string `type:"string"`

	// The resource type of the share invitation.
	ShareResourceType *string `type:"string" enum:"ShareResourceType"`

	// An Amazon Web Services account ID.
	SharedBy *string `type:"string"`

	// The Amazon Web Services account ID, IAM role, organization ID, or organizational
	// unit (OU) ID with which the workload is shared.
	SharedWith *string `min:"12" type:"string"`

	// The ID assigned to the workload. This ID is unique within an Amazon Web Services
	// Region.
	WorkloadId *string `type:"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 `min:"3" type:"string"`
	// contains filtered or unexported fields
}

A share invitation summary return object.

func (ShareInvitationSummary) GoString

func (s ShareInvitationSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ShareInvitationSummary) SetLensArn added in v1.42.15

SetLensArn sets the LensArn field's value.

func (*ShareInvitationSummary) SetLensName added in v1.42.15

SetLensName sets the LensName field's value.

func (*ShareInvitationSummary) SetPermissionType

func (s *ShareInvitationSummary) SetPermissionType(v string) *ShareInvitationSummary

SetPermissionType sets the PermissionType field's value.

func (*ShareInvitationSummary) SetShareInvitationId

func (s *ShareInvitationSummary) SetShareInvitationId(v string) *ShareInvitationSummary

SetShareInvitationId sets the ShareInvitationId field's value.

func (*ShareInvitationSummary) SetShareResourceType added in v1.42.15

func (s *ShareInvitationSummary) SetShareResourceType(v string) *ShareInvitationSummary

SetShareResourceType sets the ShareResourceType field's value.

func (*ShareInvitationSummary) SetSharedBy

SetSharedBy sets the SharedBy field's value.

func (*ShareInvitationSummary) SetSharedWith

SetSharedWith sets the SharedWith field's value.

func (*ShareInvitationSummary) SetWorkloadId

SetWorkloadId sets the WorkloadId field's value.

func (*ShareInvitationSummary) SetWorkloadName

func (s *ShareInvitationSummary) SetWorkloadName(v string) *ShareInvitationSummary

SetWorkloadName sets the WorkloadName field's value.

func (ShareInvitationSummary) String

func (s ShareInvitationSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TagResourceInput added in v1.37.23

type TagResourceInput struct {

	// The tags for the resource.
	//
	// Tags is a required field
	Tags map[string]*string `min:"1" type:"map" required:"true"`

	// The ARN for the workload.
	//
	// WorkloadArn is a required field
	WorkloadArn *string `location:"uri" locationName:"WorkloadArn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (TagResourceInput) GoString added in v1.37.23

func (s TagResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TagResourceInput) SetTags added in v1.37.23

func (s *TagResourceInput) SetTags(v map[string]*string) *TagResourceInput

SetTags sets the Tags field's value.

func (*TagResourceInput) SetWorkloadArn added in v1.37.23

func (s *TagResourceInput) SetWorkloadArn(v string) *TagResourceInput

SetWorkloadArn sets the WorkloadArn field's value.

func (TagResourceInput) String added in v1.37.23

func (s TagResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TagResourceInput) Validate added in v1.37.23

func (s *TagResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TagResourceOutput added in v1.37.23

type TagResourceOutput struct {
	// contains filtered or unexported fields
}

func (TagResourceOutput) GoString added in v1.37.23

func (s TagResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (TagResourceOutput) String added in v1.37.23

func (s TagResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ThrottlingException

type ThrottlingException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// Description of the error.
	Message_ *string `locationName:"Message" type:"string"`

	// Service Quotas requirement to identify originating quota.
	QuotaCode *string `type:"string"`

	// Service Quotas requirement to identify originating service.
	ServiceCode *string `type:"string"`
	// contains filtered or unexported fields
}

Request was denied due to request throttling.

func (*ThrottlingException) Code

func (s *ThrottlingException) Code() string

Code returns the exception type name.

func (*ThrottlingException) Error

func (s *ThrottlingException) Error() string

func (ThrottlingException) GoString

func (s ThrottlingException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ThrottlingException) Message

func (s *ThrottlingException) Message() string

Message returns the exception's message.

func (*ThrottlingException) OrigErr

func (s *ThrottlingException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ThrottlingException) RequestID

func (s *ThrottlingException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ThrottlingException) StatusCode

func (s *ThrottlingException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ThrottlingException) String

func (s ThrottlingException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UntagResourceInput added in v1.37.23

type UntagResourceInput struct {

	// A list of tag keys. Existing tags of the resource whose keys are members
	// of this list are removed from the resource.
	//
	// TagKeys is a required field
	TagKeys []*string `location:"querystring" locationName:"tagKeys" min:"1" type:"list" required:"true"`

	// The ARN for the workload.
	//
	// WorkloadArn is a required field
	WorkloadArn *string `location:"uri" locationName:"WorkloadArn" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UntagResourceInput) GoString added in v1.37.23

func (s UntagResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UntagResourceInput) SetTagKeys added in v1.37.23

func (s *UntagResourceInput) SetTagKeys(v []*string) *UntagResourceInput

SetTagKeys sets the TagKeys field's value.

func (*UntagResourceInput) SetWorkloadArn added in v1.37.23

func (s *UntagResourceInput) SetWorkloadArn(v string) *UntagResourceInput

SetWorkloadArn sets the WorkloadArn field's value.

func (UntagResourceInput) String added in v1.37.23

func (s UntagResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UntagResourceInput) Validate added in v1.37.23

func (s *UntagResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UntagResourceOutput added in v1.37.23

type UntagResourceOutput struct {
	// contains filtered or unexported fields
}

func (UntagResourceOutput) GoString added in v1.37.23

func (s UntagResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (UntagResourceOutput) String added in v1.37.23

func (s UntagResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateAnswerInput

type UpdateAnswerInput struct {

	// A list of choices to update on a question in your workload. The String key
	// corresponds to the choice ID to be updated.
	ChoiceUpdates map[string]*ChoiceUpdate `type:"map"`

	// Defines whether this question is applicable to a lens review.
	IsApplicable *bool `type:"boolean"`

	// 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 is a required field
	LensAlias *string `location:"uri" locationName:"LensAlias" min:"1" type:"string" required:"true"`

	// The notes associated with the workload.
	Notes *string `type:"string"`

	// The ID of the question.
	//
	// QuestionId is a required field
	QuestionId *string `location:"uri" locationName:"QuestionId" min:"1" type:"string" required:"true"`

	// The reason why a question is not applicable to your workload.
	Reason *string `type:"string" enum:"AnswerReason"`

	// List of selected choice IDs in a question answer.
	//
	// The values entered replace the previously selected choices.
	SelectedChoices []*string `type:"list"`

	// The ID assigned to the workload. This ID is unique within an Amazon Web Services
	// Region.
	//
	// WorkloadId is a required field
	WorkloadId *string `location:"uri" locationName:"WorkloadId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Input to update answer.

func (UpdateAnswerInput) GoString

func (s UpdateAnswerInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateAnswerInput) SetChoiceUpdates added in v1.40.0

func (s *UpdateAnswerInput) SetChoiceUpdates(v map[string]*ChoiceUpdate) *UpdateAnswerInput

SetChoiceUpdates sets the ChoiceUpdates field's value.

func (*UpdateAnswerInput) SetIsApplicable

func (s *UpdateAnswerInput) SetIsApplicable(v bool) *UpdateAnswerInput

SetIsApplicable sets the IsApplicable field's value.

func (*UpdateAnswerInput) SetLensAlias

func (s *UpdateAnswerInput) SetLensAlias(v string) *UpdateAnswerInput

SetLensAlias sets the LensAlias field's value.

func (*UpdateAnswerInput) SetNotes

func (s *UpdateAnswerInput) SetNotes(v string) *UpdateAnswerInput

SetNotes sets the Notes field's value.

func (*UpdateAnswerInput) SetQuestionId

func (s *UpdateAnswerInput) SetQuestionId(v string) *UpdateAnswerInput

SetQuestionId sets the QuestionId field's value.

func (*UpdateAnswerInput) SetReason added in v1.40.0

func (s *UpdateAnswerInput) SetReason(v string) *UpdateAnswerInput

SetReason sets the Reason field's value.

func (*UpdateAnswerInput) SetSelectedChoices

func (s *UpdateAnswerInput) SetSelectedChoices(v []*string) *UpdateAnswerInput

SetSelectedChoices sets the SelectedChoices field's value.

func (*UpdateAnswerInput) SetWorkloadId

func (s *UpdateAnswerInput) SetWorkloadId(v string) *UpdateAnswerInput

SetWorkloadId sets the WorkloadId field's value.

func (UpdateAnswerInput) String

func (s UpdateAnswerInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateAnswerInput) Validate

func (s *UpdateAnswerInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateAnswerOutput

type UpdateAnswerOutput struct {

	// An answer of the question.
	Answer *Answer `type:"structure"`

	// 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 `min:"1" type:"string"`

	// The ARN for the lens.
	LensArn *string `type:"string"`

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

Output of a update answer call.

func (UpdateAnswerOutput) GoString

func (s UpdateAnswerOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateAnswerOutput) SetAnswer

func (s *UpdateAnswerOutput) SetAnswer(v *Answer) *UpdateAnswerOutput

SetAnswer sets the Answer field's value.

func (*UpdateAnswerOutput) SetLensAlias

func (s *UpdateAnswerOutput) SetLensAlias(v string) *UpdateAnswerOutput

SetLensAlias sets the LensAlias field's value.

func (*UpdateAnswerOutput) SetLensArn added in v1.42.15

func (s *UpdateAnswerOutput) SetLensArn(v string) *UpdateAnswerOutput

SetLensArn sets the LensArn field's value.

func (*UpdateAnswerOutput) SetWorkloadId

func (s *UpdateAnswerOutput) SetWorkloadId(v string) *UpdateAnswerOutput

SetWorkloadId sets the WorkloadId field's value.

func (UpdateAnswerOutput) String

func (s UpdateAnswerOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateGlobalSettingsInput added in v1.44.46

type UpdateGlobalSettingsInput struct {

	// The status of discovery support settings.
	DiscoveryIntegrationStatus *string `type:"string" enum:"DiscoveryIntegrationStatus"`

	// The status of organization sharing settings.
	OrganizationSharingStatus *string `type:"string" enum:"OrganizationSharingStatus"`
	// contains filtered or unexported fields
}

func (UpdateGlobalSettingsInput) GoString added in v1.44.46

func (s UpdateGlobalSettingsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateGlobalSettingsInput) SetDiscoveryIntegrationStatus added in v1.44.256

func (s *UpdateGlobalSettingsInput) SetDiscoveryIntegrationStatus(v string) *UpdateGlobalSettingsInput

SetDiscoveryIntegrationStatus sets the DiscoveryIntegrationStatus field's value.

func (*UpdateGlobalSettingsInput) SetOrganizationSharingStatus added in v1.44.46

func (s *UpdateGlobalSettingsInput) SetOrganizationSharingStatus(v string) *UpdateGlobalSettingsInput

SetOrganizationSharingStatus sets the OrganizationSharingStatus field's value.

func (UpdateGlobalSettingsInput) String added in v1.44.46

func (s UpdateGlobalSettingsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateGlobalSettingsOutput added in v1.44.46

type UpdateGlobalSettingsOutput struct {
	// contains filtered or unexported fields
}

func (UpdateGlobalSettingsOutput) GoString added in v1.44.46

func (s UpdateGlobalSettingsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (UpdateGlobalSettingsOutput) String added in v1.44.46

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateLensReviewInput

type UpdateLensReviewInput 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 is a required field
	LensAlias *string `location:"uri" locationName:"LensAlias" min:"1" type:"string" required:"true"`

	// The notes associated with the workload.
	LensNotes *string `type:"string"`

	// List of pillar notes of a lens review in a workload.
	PillarNotes map[string]*string `type:"map"`

	// The ID assigned to the workload. This ID is unique within an Amazon Web Services
	// Region.
	//
	// WorkloadId is a required field
	WorkloadId *string `location:"uri" locationName:"WorkloadId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Input for update lens review.

func (UpdateLensReviewInput) GoString

func (s UpdateLensReviewInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateLensReviewInput) SetLensAlias

SetLensAlias sets the LensAlias field's value.

func (*UpdateLensReviewInput) SetLensNotes

SetLensNotes sets the LensNotes field's value.

func (*UpdateLensReviewInput) SetPillarNotes

func (s *UpdateLensReviewInput) SetPillarNotes(v map[string]*string) *UpdateLensReviewInput

SetPillarNotes sets the PillarNotes field's value.

func (*UpdateLensReviewInput) SetWorkloadId

func (s *UpdateLensReviewInput) SetWorkloadId(v string) *UpdateLensReviewInput

SetWorkloadId sets the WorkloadId field's value.

func (UpdateLensReviewInput) String

func (s UpdateLensReviewInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateLensReviewInput) Validate

func (s *UpdateLensReviewInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateLensReviewOutput

type UpdateLensReviewOutput struct {

	// A lens review of a question.
	LensReview *LensReview `type:"structure"`

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

Output of a update lens review call.

func (UpdateLensReviewOutput) GoString

func (s UpdateLensReviewOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateLensReviewOutput) SetLensReview

SetLensReview sets the LensReview field's value.

func (*UpdateLensReviewOutput) SetWorkloadId

SetWorkloadId sets the WorkloadId field's value.

func (UpdateLensReviewOutput) String

func (s UpdateLensReviewOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateShareInvitationInput

type UpdateShareInvitationInput struct {

	// Share invitation action taken by contributor.
	//
	// ShareInvitationAction is a required field
	ShareInvitationAction *string `type:"string" required:"true" enum:"ShareInvitationAction"`

	// The ID assigned to the share invitation.
	//
	// ShareInvitationId is a required field
	ShareInvitationId *string `location:"uri" locationName:"ShareInvitationId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Input for Update Share Invitation

func (UpdateShareInvitationInput) GoString

func (s UpdateShareInvitationInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateShareInvitationInput) SetShareInvitationAction

func (s *UpdateShareInvitationInput) SetShareInvitationAction(v string) *UpdateShareInvitationInput

SetShareInvitationAction sets the ShareInvitationAction field's value.

func (*UpdateShareInvitationInput) SetShareInvitationId

func (s *UpdateShareInvitationInput) SetShareInvitationId(v string) *UpdateShareInvitationInput

SetShareInvitationId sets the ShareInvitationId field's value.

func (UpdateShareInvitationInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateShareInvitationInput) Validate

func (s *UpdateShareInvitationInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateShareInvitationOutput

type UpdateShareInvitationOutput struct {

	// The updated workload or custom lens share invitation.
	ShareInvitation *ShareInvitation `type:"structure"`
	// contains filtered or unexported fields
}

func (UpdateShareInvitationOutput) GoString

func (s UpdateShareInvitationOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateShareInvitationOutput) SetShareInvitation

SetShareInvitation sets the ShareInvitation field's value.

func (UpdateShareInvitationOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateWorkloadInput

type UpdateWorkloadInput struct {

	// The list of Amazon Web Services account IDs associated with the workload.
	AccountIds []*string `type:"list"`

	// List of AppRegistry application ARNs to associate to the workload.
	Applications []*string `type:"list"`

	// The URL of the architectural design for the workload.
	ArchitecturalDesign *string `type:"string"`

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

	// The description for the workload.
	Description *string `min:"3" type:"string"`

	// Well-Architected discovery configuration settings to associate to the workload.
	DiscoveryConfig *WorkloadDiscoveryConfig `type:"structure"`

	// The environment for the workload.
	Environment *string `type:"string" enum:"WorkloadEnvironment"`

	// The improvement status for a workload.
	ImprovementStatus *string `type:"string" enum:"WorkloadImprovementStatus"`

	// The industry for the workload.
	Industry *string `type:"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 `type:"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 `type:"boolean"`

	// The list of non-Amazon Web Services Regions associated with the workload.
	NonAwsRegions []*string `type:"list"`

	// The notes associated with the workload.
	Notes *string `type:"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 `type:"list"`

	// 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 `min:"3" type:"string"`

	// The ID assigned to the workload. This ID is unique within an Amazon Web Services
	// Region.
	//
	// WorkloadId is a required field
	WorkloadId *string `location:"uri" locationName:"WorkloadId" type:"string" required:"true"`

	// 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 `min:"3" type:"string"`
	// contains filtered or unexported fields
}

Input to update a workload.

func (UpdateWorkloadInput) GoString

func (s UpdateWorkloadInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateWorkloadInput) SetAccountIds

func (s *UpdateWorkloadInput) SetAccountIds(v []*string) *UpdateWorkloadInput

SetAccountIds sets the AccountIds field's value.

func (*UpdateWorkloadInput) SetApplications added in v1.44.132

func (s *UpdateWorkloadInput) SetApplications(v []*string) *UpdateWorkloadInput

SetApplications sets the Applications field's value.

func (*UpdateWorkloadInput) SetArchitecturalDesign

func (s *UpdateWorkloadInput) SetArchitecturalDesign(v string) *UpdateWorkloadInput

SetArchitecturalDesign sets the ArchitecturalDesign field's value.

func (*UpdateWorkloadInput) SetAwsRegions

func (s *UpdateWorkloadInput) SetAwsRegions(v []*string) *UpdateWorkloadInput

SetAwsRegions sets the AwsRegions field's value.

func (*UpdateWorkloadInput) SetDescription

func (s *UpdateWorkloadInput) SetDescription(v string) *UpdateWorkloadInput

SetDescription sets the Description field's value.

func (*UpdateWorkloadInput) SetDiscoveryConfig added in v1.44.132

SetDiscoveryConfig sets the DiscoveryConfig field's value.

func (*UpdateWorkloadInput) SetEnvironment

func (s *UpdateWorkloadInput) SetEnvironment(v string) *UpdateWorkloadInput

SetEnvironment sets the Environment field's value.

func (*UpdateWorkloadInput) SetImprovementStatus

func (s *UpdateWorkloadInput) SetImprovementStatus(v string) *UpdateWorkloadInput

SetImprovementStatus sets the ImprovementStatus field's value.

func (*UpdateWorkloadInput) SetIndustry

func (s *UpdateWorkloadInput) SetIndustry(v string) *UpdateWorkloadInput

SetIndustry sets the Industry field's value.

func (*UpdateWorkloadInput) SetIndustryType

func (s *UpdateWorkloadInput) SetIndustryType(v string) *UpdateWorkloadInput

SetIndustryType sets the IndustryType field's value.

func (*UpdateWorkloadInput) SetIsReviewOwnerUpdateAcknowledged

func (s *UpdateWorkloadInput) SetIsReviewOwnerUpdateAcknowledged(v bool) *UpdateWorkloadInput

SetIsReviewOwnerUpdateAcknowledged sets the IsReviewOwnerUpdateAcknowledged field's value.

func (*UpdateWorkloadInput) SetNonAwsRegions

func (s *UpdateWorkloadInput) SetNonAwsRegions(v []*string) *UpdateWorkloadInput

SetNonAwsRegions sets the NonAwsRegions field's value.

func (*UpdateWorkloadInput) SetNotes

SetNotes sets the Notes field's value.

func (*UpdateWorkloadInput) SetPillarPriorities

func (s *UpdateWorkloadInput) SetPillarPriorities(v []*string) *UpdateWorkloadInput

SetPillarPriorities sets the PillarPriorities field's value.

func (*UpdateWorkloadInput) SetReviewOwner

func (s *UpdateWorkloadInput) SetReviewOwner(v string) *UpdateWorkloadInput

SetReviewOwner sets the ReviewOwner field's value.

func (*UpdateWorkloadInput) SetWorkloadId

func (s *UpdateWorkloadInput) SetWorkloadId(v string) *UpdateWorkloadInput

SetWorkloadId sets the WorkloadId field's value.

func (*UpdateWorkloadInput) SetWorkloadName

func (s *UpdateWorkloadInput) SetWorkloadName(v string) *UpdateWorkloadInput

SetWorkloadName sets the WorkloadName field's value.

func (UpdateWorkloadInput) String

func (s UpdateWorkloadInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateWorkloadInput) Validate

func (s *UpdateWorkloadInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateWorkloadOutput

type UpdateWorkloadOutput struct {

	// A workload return object.
	Workload *Workload `type:"structure"`
	// contains filtered or unexported fields
}

Output of an update workload call.

func (UpdateWorkloadOutput) GoString

func (s UpdateWorkloadOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateWorkloadOutput) SetWorkload

SetWorkload sets the Workload field's value.

func (UpdateWorkloadOutput) String

func (s UpdateWorkloadOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateWorkloadShareInput

type UpdateWorkloadShareInput struct {

	// Permission granted on a workload share.
	//
	// PermissionType is a required field
	PermissionType *string `type:"string" required:"true" enum:"PermissionType"`

	// The ID associated with the workload share.
	//
	// ShareId is a required field
	ShareId *string `location:"uri" locationName:"ShareId" type:"string" required:"true"`

	// The ID assigned to the workload. This ID is unique within an Amazon Web Services
	// Region.
	//
	// WorkloadId is a required field
	WorkloadId *string `location:"uri" locationName:"WorkloadId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Input for Update Workload Share

func (UpdateWorkloadShareInput) GoString

func (s UpdateWorkloadShareInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateWorkloadShareInput) SetPermissionType

func (s *UpdateWorkloadShareInput) SetPermissionType(v string) *UpdateWorkloadShareInput

SetPermissionType sets the PermissionType field's value.

func (*UpdateWorkloadShareInput) SetShareId

SetShareId sets the ShareId field's value.

func (*UpdateWorkloadShareInput) SetWorkloadId

SetWorkloadId sets the WorkloadId field's value.

func (UpdateWorkloadShareInput) String

func (s UpdateWorkloadShareInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateWorkloadShareInput) Validate

func (s *UpdateWorkloadShareInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateWorkloadShareOutput

type UpdateWorkloadShareOutput struct {

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

	// A workload share return object.
	WorkloadShare *WorkloadShare `type:"structure"`
	// contains filtered or unexported fields
}

Input for Update Workload Share

func (UpdateWorkloadShareOutput) GoString

func (s UpdateWorkloadShareOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateWorkloadShareOutput) SetWorkloadId

SetWorkloadId sets the WorkloadId field's value.

func (*UpdateWorkloadShareOutput) SetWorkloadShare

SetWorkloadShare sets the WorkloadShare field's value.

func (UpdateWorkloadShareOutput) String

func (s UpdateWorkloadShareOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpgradeLensReviewInput

type UpgradeLensReviewInput struct {

	// A unique case-sensitive string used to ensure that this request is idempotent
	// (executes only once).
	//
	// You should not reuse the same token for other requests. If you retry a request
	// with the same client request token and the same parameters after the original
	// request has completed successfully, the result of the original request is
	// returned.
	//
	// This token is listed as required, however, if you do not specify it, the
	// Amazon Web Services SDKs automatically generate one for you. If you are not
	// using the Amazon Web Services SDK or the CLI, you must provide this token
	// or the request will fail.
	ClientRequestToken *string `type:"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 is a required field
	LensAlias *string `location:"uri" locationName:"LensAlias" min:"1" type:"string" required:"true"`

	// The name of the milestone in a workload.
	//
	// Milestone names must be unique within a workload.
	//
	// MilestoneName is a required field
	MilestoneName *string `min:"3" type:"string" required:"true"`

	// The ID assigned to the workload. This ID is unique within an Amazon Web Services
	// Region.
	//
	// WorkloadId is a required field
	WorkloadId *string `location:"uri" locationName:"WorkloadId" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpgradeLensReviewInput) GoString

func (s UpgradeLensReviewInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpgradeLensReviewInput) SetClientRequestToken

func (s *UpgradeLensReviewInput) SetClientRequestToken(v string) *UpgradeLensReviewInput

SetClientRequestToken sets the ClientRequestToken field's value.

func (*UpgradeLensReviewInput) SetLensAlias

SetLensAlias sets the LensAlias field's value.

func (*UpgradeLensReviewInput) SetMilestoneName

func (s *UpgradeLensReviewInput) SetMilestoneName(v string) *UpgradeLensReviewInput

SetMilestoneName sets the MilestoneName field's value.

func (*UpgradeLensReviewInput) SetWorkloadId

SetWorkloadId sets the WorkloadId field's value.

func (UpgradeLensReviewInput) String

func (s UpgradeLensReviewInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpgradeLensReviewInput) Validate

func (s *UpgradeLensReviewInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpgradeLensReviewOutput

type UpgradeLensReviewOutput struct {
	// contains filtered or unexported fields
}

func (UpgradeLensReviewOutput) GoString

func (s UpgradeLensReviewOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (UpgradeLensReviewOutput) String

func (s UpgradeLensReviewOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ValidationException

type ValidationException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	// The fields that caused the error, if applicable.
	Fields []*ValidationExceptionField `type:"list"`

	// Description of the error.
	Message_ *string `locationName:"Message" type:"string"`

	// The reason why the request failed validation.
	Reason *string `type:"string" enum:"ValidationExceptionReason"`
	// contains filtered or unexported fields
}

The user input is not valid.

func (*ValidationException) Code

func (s *ValidationException) Code() string

Code returns the exception type name.

func (*ValidationException) Error

func (s *ValidationException) Error() string

func (ValidationException) GoString

func (s ValidationException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ValidationException) Message

func (s *ValidationException) Message() string

Message returns the exception's message.

func (*ValidationException) OrigErr

func (s *ValidationException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ValidationException) RequestID

func (s *ValidationException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ValidationException) StatusCode

func (s *ValidationException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ValidationException) String

func (s ValidationException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ValidationExceptionField

type ValidationExceptionField struct {

	// Description of the error.
	//
	// Message is a required field
	Message *string `type:"string" required:"true"`

	// The field name for which validation failed.
	//
	// Name is a required field
	Name *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

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

func (ValidationExceptionField) GoString

func (s ValidationExceptionField) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ValidationExceptionField) SetMessage

SetMessage sets the Message field's value.

func (*ValidationExceptionField) SetName

SetName sets the Name field's value.

func (ValidationExceptionField) String

func (s ValidationExceptionField) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type VersionDifferences

type VersionDifferences struct {

	// The differences between the base and latest versions of the lens.
	PillarDifferences []*PillarDifference `type:"list"`
	// contains filtered or unexported fields
}

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

func (VersionDifferences) GoString

func (s VersionDifferences) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*VersionDifferences) SetPillarDifferences

func (s *VersionDifferences) SetPillarDifferences(v []*PillarDifference) *VersionDifferences

SetPillarDifferences sets the PillarDifferences field's value.

func (VersionDifferences) String

func (s VersionDifferences) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type WellArchitected

type WellArchitected struct {
	*client.Client
}

WellArchitected provides the API operation methods for making requests to AWS Well-Architected Tool. See this package's package overview docs for details on the service.

WellArchitected methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New

New creates a new instance of the WellArchitected client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example:

mySession := session.Must(session.NewSession())

// Create a WellArchitected client from just a session.
svc := wellarchitected.New(mySession)

// Create a WellArchitected client with additional configuration
svc := wellarchitected.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*WellArchitected) AssociateLenses

func (c *WellArchitected) AssociateLenses(input *AssociateLensesInput) (*AssociateLensesOutput, error)

AssociateLenses API operation for AWS Well-Architected Tool.

Associate a lens to a workload.

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

Disclaimer

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Well-Architected Tool's API operation AssociateLenses for usage and error information.

Returned Error Types:

  • ValidationException The user input is not valid.

  • ResourceNotFoundException The requested resource was not found.

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

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

  • AccessDeniedException User does not have sufficient access to perform this action.

  • ThrottlingException Request was denied due to request throttling.

See also, https://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/AssociateLenses

func (*WellArchitected) AssociateLensesRequest

func (c *WellArchitected) AssociateLensesRequest(input *AssociateLensesInput) (req *request.Request, output *AssociateLensesOutput)

AssociateLensesRequest generates a "aws/request.Request" representing the client's request for the AssociateLenses operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See AssociateLenses for more information on using the AssociateLenses API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the AssociateLensesRequest method.
req, resp := client.AssociateLensesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/AssociateLenses

func (*WellArchitected) AssociateLensesWithContext

func (c *WellArchitected) AssociateLensesWithContext(ctx aws.Context, input *AssociateLensesInput, opts ...request.Option) (*AssociateLensesOutput, error)

AssociateLensesWithContext is the same as AssociateLenses with the addition of the ability to pass a context and additional request options.

See AssociateLenses for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WellArchitected) CreateLensShare added in v1.42.15

func (c *WellArchitected) CreateLensShare(input *CreateLensShareInput) (*CreateLensShareOutput, error)

CreateLensShare API operation for AWS Well-Architected Tool.

Create a lens share.

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

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

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

For more information, see Sharing a custom lens (https://docs.aws.amazon.com/wellarchitected/latest/userguide/lenses-sharing.html) in the Well-Architected Tool User Guide.

Disclaimer

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Well-Architected Tool's API operation CreateLensShare for usage and error information.

Returned Error Types:

  • ValidationException The user input is not valid.

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

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

  • ResourceNotFoundException The requested resource was not found.

  • ServiceQuotaExceededException The user has reached their resource quota.

  • AccessDeniedException User does not have sufficient access to perform this action.

  • ThrottlingException Request was denied due to request throttling.

See also, https://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/CreateLensShare

func (*WellArchitected) CreateLensShareRequest added in v1.42.15

func (c *WellArchitected) CreateLensShareRequest(input *CreateLensShareInput) (req *request.Request, output *CreateLensShareOutput)

CreateLensShareRequest generates a "aws/request.Request" representing the client's request for the CreateLensShare operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateLensShare for more information on using the CreateLensShare API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateLensShareRequest method.
req, resp := client.CreateLensShareRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/CreateLensShare

func (*WellArchitected) CreateLensShareWithContext added in v1.42.15

func (c *WellArchitected) CreateLensShareWithContext(ctx aws.Context, input *CreateLensShareInput, opts ...request.Option) (*CreateLensShareOutput, error)

CreateLensShareWithContext is the same as CreateLensShare with the addition of the ability to pass a context and additional request options.

See CreateLensShare for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WellArchitected) CreateLensVersion added in v1.42.15

func (c *WellArchitected) CreateLensVersion(input *CreateLensVersionInput) (*CreateLensVersionOutput, error)

CreateLensVersion API operation for AWS Well-Architected Tool.

Create a new lens version.

A lens can have up to 100 versions.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Well-Architected Tool's API operation CreateLensVersion for usage and error information.

Returned Error Types:

  • ValidationException The user input is not valid.

  • ResourceNotFoundException The requested resource was not found.

  • ServiceQuotaExceededException The user has reached their resource quota.

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

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

  • AccessDeniedException User does not have sufficient access to perform this action.

  • ThrottlingException Request was denied due to request throttling.

See also, https://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/CreateLensVersion

func (*WellArchitected) CreateLensVersionRequest added in v1.42.15

func (c *WellArchitected) CreateLensVersionRequest(input *CreateLensVersionInput) (req *request.Request, output *CreateLensVersionOutput)

CreateLensVersionRequest generates a "aws/request.Request" representing the client's request for the CreateLensVersion operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateLensVersion for more information on using the CreateLensVersion API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateLensVersionRequest method.
req, resp := client.CreateLensVersionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/CreateLensVersion

func (*WellArchitected) CreateLensVersionWithContext added in v1.42.15

func (c *WellArchitected) CreateLensVersionWithContext(ctx aws.Context, input *CreateLensVersionInput, opts ...request.Option) (*CreateLensVersionOutput, error)

CreateLensVersionWithContext is the same as CreateLensVersion with the addition of the ability to pass a context and additional request options.

See CreateLensVersion for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WellArchitected) CreateMilestone

func (c *WellArchitected) CreateMilestone(input *CreateMilestoneInput) (*CreateMilestoneOutput, error)

CreateMilestone API operation for AWS Well-Architected Tool.

Create a milestone for an existing workload.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Well-Architected Tool's API operation CreateMilestone for usage and error information.

Returned Error Types:

  • ValidationException The user input is not valid.

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

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

  • ResourceNotFoundException The requested resource was not found.

  • ServiceQuotaExceededException The user has reached their resource quota.

  • AccessDeniedException User does not have sufficient access to perform this action.

  • ThrottlingException Request was denied due to request throttling.

See also, https://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/CreateMilestone

func (*WellArchitected) CreateMilestoneRequest

func (c *WellArchitected) CreateMilestoneRequest(input *CreateMilestoneInput) (req *request.Request, output *CreateMilestoneOutput)

CreateMilestoneRequest generates a "aws/request.Request" representing the client's request for the CreateMilestone operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateMilestone for more information on using the CreateMilestone API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateMilestoneRequest method.
req, resp := client.CreateMilestoneRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/CreateMilestone

func (*WellArchitected) CreateMilestoneWithContext

func (c *WellArchitected) CreateMilestoneWithContext(ctx aws.Context, input *CreateMilestoneInput, opts ...request.Option) (*CreateMilestoneOutput, error)

CreateMilestoneWithContext is the same as CreateMilestone with the addition of the ability to pass a context and additional request options.

See CreateMilestone for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WellArchitected) CreateWorkload

func (c *WellArchitected) CreateWorkload(input *CreateWorkloadInput) (*CreateWorkloadOutput, error)

CreateWorkload API operation for AWS Well-Architected Tool.

Create a new workload.

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

For more information, see Defining a Workload (https://docs.aws.amazon.com/wellarchitected/latest/userguide/define-workload.html) in the Well-Architected Tool User Guide.

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

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Well-Architected Tool's API operation CreateWorkload for usage and error information.

Returned Error Types:

  • ValidationException The user input is not valid.

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

  • ServiceQuotaExceededException The user has reached their resource quota.

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

  • AccessDeniedException User does not have sufficient access to perform this action.

  • ResourceNotFoundException The requested resource was not found.

  • ThrottlingException Request was denied due to request throttling.

See also, https://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/CreateWorkload

func (*WellArchitected) CreateWorkloadRequest

func (c *WellArchitected) CreateWorkloadRequest(input *CreateWorkloadInput) (req *request.Request, output *CreateWorkloadOutput)

CreateWorkloadRequest generates a "aws/request.Request" representing the client's request for the CreateWorkload operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateWorkload for more information on using the CreateWorkload API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateWorkloadRequest method.
req, resp := client.CreateWorkloadRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/CreateWorkload

func (*WellArchitected) CreateWorkloadShare

func (c *WellArchitected) CreateWorkloadShare(input *CreateWorkloadShareInput) (*CreateWorkloadShareOutput, error)

CreateWorkloadShare API operation for AWS Well-Architected Tool.

Create a workload share.

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

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

For more information, see Sharing a workload (https://docs.aws.amazon.com/wellarchitected/latest/userguide/workloads-sharing.html) in the Well-Architected Tool User Guide.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Well-Architected Tool's API operation CreateWorkloadShare for usage and error information.

Returned Error Types:

  • ValidationException The user input is not valid.

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

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

  • ResourceNotFoundException The requested resource was not found.

  • ServiceQuotaExceededException The user has reached their resource quota.

  • AccessDeniedException User does not have sufficient access to perform this action.

  • ThrottlingException Request was denied due to request throttling.

See also, https://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/CreateWorkloadShare

func (*WellArchitected) CreateWorkloadShareRequest

func (c *WellArchitected) CreateWorkloadShareRequest(input *CreateWorkloadShareInput) (req *request.Request, output *CreateWorkloadShareOutput)

CreateWorkloadShareRequest generates a "aws/request.Request" representing the client's request for the CreateWorkloadShare operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateWorkloadShare for more information on using the CreateWorkloadShare API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateWorkloadShareRequest method.
req, resp := client.CreateWorkloadShareRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/CreateWorkloadShare

func (*WellArchitected) CreateWorkloadShareWithContext

func (c *WellArchitected) CreateWorkloadShareWithContext(ctx aws.Context, input *CreateWorkloadShareInput, opts ...request.Option) (*CreateWorkloadShareOutput, error)

CreateWorkloadShareWithContext is the same as CreateWorkloadShare with the addition of the ability to pass a context and additional request options.

See CreateWorkloadShare for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WellArchitected) CreateWorkloadWithContext

func (c *WellArchitected) CreateWorkloadWithContext(ctx aws.Context, input *CreateWorkloadInput, opts ...request.Option) (*CreateWorkloadOutput, error)

CreateWorkloadWithContext is the same as CreateWorkload with the addition of the ability to pass a context and additional request options.

See CreateWorkload for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WellArchitected) DeleteLens added in v1.42.15

func (c *WellArchitected) DeleteLens(input *DeleteLensInput) (*DeleteLensOutput, error)

DeleteLens API operation for AWS Well-Architected Tool.

Delete an existing lens.

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

Disclaimer

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Well-Architected Tool's API operation DeleteLens for usage and error information.

Returned Error Types:

  • ValidationException The user input is not valid.

  • ResourceNotFoundException The requested resource was not found.

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

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

  • AccessDeniedException User does not have sufficient access to perform this action.

  • ThrottlingException Request was denied due to request throttling.

See also, https://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/DeleteLens

func (*WellArchitected) DeleteLensRequest added in v1.42.15

func (c *WellArchitected) DeleteLensRequest(input *DeleteLensInput) (req *request.Request, output *DeleteLensOutput)

DeleteLensRequest generates a "aws/request.Request" representing the client's request for the DeleteLens operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteLens for more information on using the DeleteLens API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteLensRequest method.
req, resp := client.DeleteLensRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/DeleteLens

func (*WellArchitected) DeleteLensShare added in v1.42.15

func (c *WellArchitected) DeleteLensShare(input *DeleteLensShareInput) (*DeleteLensShareOutput, error)

DeleteLensShare API operation for AWS Well-Architected Tool.

Delete a lens share.

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

Disclaimer

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Well-Architected Tool's API operation DeleteLensShare for usage and error information.

Returned Error Types:

  • ValidationException The user input is not valid.

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

  • ResourceNotFoundException The requested resource was not found.

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

  • AccessDeniedException User does not have sufficient access to perform this action.

  • ThrottlingException Request was denied due to request throttling.

See also, https://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/DeleteLensShare

func (*WellArchitected) DeleteLensShareRequest added in v1.42.15

func (c *WellArchitected) DeleteLensShareRequest(input *DeleteLensShareInput) (req *request.Request, output *DeleteLensShareOutput)

DeleteLensShareRequest generates a "aws/request.Request" representing the client's request for the DeleteLensShare operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteLensShare for more information on using the DeleteLensShare API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteLensShareRequest method.
req, resp := client.DeleteLensShareRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/DeleteLensShare

func (*WellArchitected) DeleteLensShareWithContext added in v1.42.15

func (c *WellArchitected) DeleteLensShareWithContext(ctx aws.Context, input *DeleteLensShareInput, opts ...request.Option) (*DeleteLensShareOutput, error)

DeleteLensShareWithContext is the same as DeleteLensShare with the addition of the ability to pass a context and additional request options.

See DeleteLensShare for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WellArchitected) DeleteLensWithContext added in v1.42.15

func (c *WellArchitected) DeleteLensWithContext(ctx aws.Context, input *DeleteLensInput, opts ...request.Option) (*DeleteLensOutput, error)

DeleteLensWithContext is the same as DeleteLens with the addition of the ability to pass a context and additional request options.

See DeleteLens for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WellArchitected) DeleteWorkload

func (c *WellArchitected) DeleteWorkload(input *DeleteWorkloadInput) (*DeleteWorkloadOutput, error)

DeleteWorkload API operation for AWS Well-Architected Tool.

Delete an existing workload.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Well-Architected Tool's API operation DeleteWorkload for usage and error information.

Returned Error Types:

  • ValidationException The user input is not valid.

  • ResourceNotFoundException The requested resource was not found.

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

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

  • AccessDeniedException User does not have sufficient access to perform this action.

  • ThrottlingException Request was denied due to request throttling.

See also, https://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/DeleteWorkload

func (*WellArchitected) DeleteWorkloadRequest

func (c *WellArchitected) DeleteWorkloadRequest(input *DeleteWorkloadInput) (req *request.Request, output *DeleteWorkloadOutput)

DeleteWorkloadRequest generates a "aws/request.Request" representing the client's request for the DeleteWorkload operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteWorkload for more information on using the DeleteWorkload API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteWorkloadRequest method.
req, resp := client.DeleteWorkloadRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/DeleteWorkload

func (*WellArchitected) DeleteWorkloadShare

func (c *WellArchitected) DeleteWorkloadShare(input *DeleteWorkloadShareInput) (*DeleteWorkloadShareOutput, error)

DeleteWorkloadShare API operation for AWS Well-Architected Tool.

Delete a workload share.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Well-Architected Tool's API operation DeleteWorkloadShare for usage and error information.

Returned Error Types:

  • ValidationException The user input is not valid.

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

  • ResourceNotFoundException The requested resource was not found.

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

  • AccessDeniedException User does not have sufficient access to perform this action.

  • ThrottlingException Request was denied due to request throttling.

See also, https://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/DeleteWorkloadShare

func (*WellArchitected) DeleteWorkloadShareRequest

func (c *WellArchitected) DeleteWorkloadShareRequest(input *DeleteWorkloadShareInput) (req *request.Request, output *DeleteWorkloadShareOutput)

DeleteWorkloadShareRequest generates a "aws/request.Request" representing the client's request for the DeleteWorkloadShare operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteWorkloadShare for more information on using the DeleteWorkloadShare API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteWorkloadShareRequest method.
req, resp := client.DeleteWorkloadShareRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/DeleteWorkloadShare

func (*WellArchitected) DeleteWorkloadShareWithContext

func (c *WellArchitected) DeleteWorkloadShareWithContext(ctx aws.Context, input *DeleteWorkloadShareInput, opts ...request.Option) (*DeleteWorkloadShareOutput, error)

DeleteWorkloadShareWithContext is the same as DeleteWorkloadShare with the addition of the ability to pass a context and additional request options.

See DeleteWorkloadShare for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WellArchitected) DeleteWorkloadWithContext

func (c *WellArchitected) DeleteWorkloadWithContext(ctx aws.Context, input *DeleteWorkloadInput, opts ...request.Option) (*DeleteWorkloadOutput, error)

DeleteWorkloadWithContext is the same as DeleteWorkload with the addition of the ability to pass a context and additional request options.

See DeleteWorkload for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WellArchitected) DisassociateLenses

func (c *WellArchitected) DisassociateLenses(input *DisassociateLensesInput) (*DisassociateLensesOutput, error)

DisassociateLenses API operation for AWS Well-Architected Tool.

Disassociate a lens from a workload.

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

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Well-Architected Tool's API operation DisassociateLenses for usage and error information.

Returned Error Types:

  • ValidationException The user input is not valid.

  • ResourceNotFoundException The requested resource was not found.

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

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

  • AccessDeniedException User does not have sufficient access to perform this action.

  • ThrottlingException Request was denied due to request throttling.

See also, https://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/DisassociateLenses

func (*WellArchitected) DisassociateLensesRequest

func (c *WellArchitected) DisassociateLensesRequest(input *DisassociateLensesInput) (req *request.Request, output *DisassociateLensesOutput)

DisassociateLensesRequest generates a "aws/request.Request" representing the client's request for the DisassociateLenses operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DisassociateLenses for more information on using the DisassociateLenses API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DisassociateLensesRequest method.
req, resp := client.DisassociateLensesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/DisassociateLenses

func (*WellArchitected) DisassociateLensesWithContext

func (c *WellArchitected) DisassociateLensesWithContext(ctx aws.Context, input *DisassociateLensesInput, opts ...request.Option) (*DisassociateLensesOutput, error)

DisassociateLensesWithContext is the same as DisassociateLenses with the addition of the ability to pass a context and additional request options.

See DisassociateLenses for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WellArchitected) ExportLens added in v1.42.15

func (c *WellArchitected) ExportLens(input *ExportLensInput) (*ExportLensOutput, error)

ExportLens API operation for AWS Well-Architected Tool.

Export an existing lens.

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

Lenses are defined in JSON. For more information, see JSON format specification (https://docs.aws.amazon.com/wellarchitected/latest/userguide/lenses-format-specification.html) in the Well-Architected Tool User Guide.

Disclaimer

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Well-Architected Tool's API operation ExportLens for usage and error information.

Returned Error Types:

  • ValidationException The user input is not valid.

  • ResourceNotFoundException The requested resource was not found.

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

  • AccessDeniedException User does not have sufficient access to perform this action.

  • ThrottlingException Request was denied due to request throttling.

See also, https://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ExportLens

func (*WellArchitected) ExportLensRequest added in v1.42.15

func (c *WellArchitected) ExportLensRequest(input *ExportLensInput) (req *request.Request, output *ExportLensOutput)

ExportLensRequest generates a "aws/request.Request" representing the client's request for the ExportLens operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ExportLens for more information on using the ExportLens API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ExportLensRequest method.
req, resp := client.ExportLensRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ExportLens

func (*WellArchitected) ExportLensWithContext added in v1.42.15

func (c *WellArchitected) ExportLensWithContext(ctx aws.Context, input *ExportLensInput, opts ...request.Option) (*ExportLensOutput, error)

ExportLensWithContext is the same as ExportLens with the addition of the ability to pass a context and additional request options.

See ExportLens for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WellArchitected) GetAnswer

func (c *WellArchitected) GetAnswer(input *GetAnswerInput) (*GetAnswerOutput, error)

GetAnswer API operation for AWS Well-Architected Tool.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Well-Architected Tool's API operation GetAnswer for usage and error information.

Returned Error Types:

  • ValidationException The user input is not valid.

  • ResourceNotFoundException The requested resource was not found.

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

  • AccessDeniedException User does not have sufficient access to perform this action.

  • ThrottlingException Request was denied due to request throttling.

See also, https://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/GetAnswer

func (*WellArchitected) GetAnswerRequest

func (c *WellArchitected) GetAnswerRequest(input *GetAnswerInput) (req *request.Request, output *GetAnswerOutput)

GetAnswerRequest generates a "aws/request.Request" representing the client's request for the GetAnswer operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetAnswer for more information on using the GetAnswer API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetAnswerRequest method.
req, resp := client.GetAnswerRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/GetAnswer

func (*WellArchitected) GetAnswerWithContext

func (c *WellArchitected) GetAnswerWithContext(ctx aws.Context, input *GetAnswerInput, opts ...request.Option) (*GetAnswerOutput, error)

GetAnswerWithContext is the same as GetAnswer with the addition of the ability to pass a context and additional request options.

See GetAnswer for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WellArchitected) GetConsolidatedReport added in v1.44.233

func (c *WellArchitected) GetConsolidatedReport(input *GetConsolidatedReportInput) (*GetConsolidatedReportOutput, error)

GetConsolidatedReport API operation for AWS Well-Architected Tool.

Get a consolidated report of your workloads.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Well-Architected Tool's API operation GetConsolidatedReport for usage and error information.

Returned Error Types:

  • ValidationException The user input is not valid.

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

  • AccessDeniedException User does not have sufficient access to perform this action.

  • ThrottlingException Request was denied due to request throttling.

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

See also, https://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/GetConsolidatedReport

func (*WellArchitected) GetConsolidatedReportPages added in v1.44.233

func (c *WellArchitected) GetConsolidatedReportPages(input *GetConsolidatedReportInput, fn func(*GetConsolidatedReportOutput, bool) bool) error

GetConsolidatedReportPages iterates over the pages of a GetConsolidatedReport operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See GetConsolidatedReport method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a GetConsolidatedReport operation.
pageNum := 0
err := client.GetConsolidatedReportPages(params,
    func(page *wellarchitected.GetConsolidatedReportOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*WellArchitected) GetConsolidatedReportPagesWithContext added in v1.44.233

func (c *WellArchitected) GetConsolidatedReportPagesWithContext(ctx aws.Context, input *GetConsolidatedReportInput, fn func(*GetConsolidatedReportOutput, bool) bool, opts ...request.Option) error

GetConsolidatedReportPagesWithContext same as GetConsolidatedReportPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WellArchitected) GetConsolidatedReportRequest added in v1.44.233

func (c *WellArchitected) GetConsolidatedReportRequest(input *GetConsolidatedReportInput) (req *request.Request, output *GetConsolidatedReportOutput)

GetConsolidatedReportRequest generates a "aws/request.Request" representing the client's request for the GetConsolidatedReport operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetConsolidatedReport for more information on using the GetConsolidatedReport API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetConsolidatedReportRequest method.
req, resp := client.GetConsolidatedReportRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/GetConsolidatedReport

func (*WellArchitected) GetConsolidatedReportWithContext added in v1.44.233

func (c *WellArchitected) GetConsolidatedReportWithContext(ctx aws.Context, input *GetConsolidatedReportInput, opts ...request.Option) (*GetConsolidatedReportOutput, error)

GetConsolidatedReportWithContext is the same as GetConsolidatedReport with the addition of the ability to pass a context and additional request options.

See GetConsolidatedReport for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WellArchitected) GetLens added in v1.42.15

func (c *WellArchitected) GetLens(input *GetLensInput) (*GetLensOutput, error)

GetLens API operation for AWS Well-Architected Tool.

Get an existing lens.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Well-Architected Tool's API operation GetLens for usage and error information.

Returned Error Types:

  • ValidationException The user input is not valid.

  • ResourceNotFoundException The requested resource was not found.

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

  • AccessDeniedException User does not have sufficient access to perform this action.

  • ThrottlingException Request was denied due to request throttling.

See also, https://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/GetLens

func (*WellArchitected) GetLensRequest added in v1.42.15

func (c *WellArchitected) GetLensRequest(input *GetLensInput) (req *request.Request, output *GetLensOutput)

GetLensRequest generates a "aws/request.Request" representing the client's request for the GetLens operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetLens for more information on using the GetLens API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetLensRequest method.
req, resp := client.GetLensRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/GetLens

func (*WellArchitected) GetLensReview

func (c *WellArchitected) GetLensReview(input *GetLensReviewInput) (*GetLensReviewOutput, error)

GetLensReview API operation for AWS Well-Architected Tool.

Get lens review.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Well-Architected Tool's API operation GetLensReview for usage and error information.

Returned Error Types:

  • ValidationException The user input is not valid.

  • ResourceNotFoundException The requested resource was not found.

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

  • AccessDeniedException User does not have sufficient access to perform this action.

  • ThrottlingException Request was denied due to request throttling.

See also, https://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/GetLensReview

func (*WellArchitected) GetLensReviewReport

func (c *WellArchitected) GetLensReviewReport(input *GetLensReviewReportInput) (*GetLensReviewReportOutput, error)

GetLensReviewReport API operation for AWS Well-Architected Tool.

Get lens review report.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Well-Architected Tool's API operation GetLensReviewReport for usage and error information.

Returned Error Types:

  • ValidationException The user input is not valid.

  • ResourceNotFoundException The requested resource was not found.

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

  • AccessDeniedException User does not have sufficient access to perform this action.

  • ThrottlingException Request was denied due to request throttling.

See also, https://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/GetLensReviewReport

func (*WellArchitected) GetLensReviewReportRequest

func (c *WellArchitected) GetLensReviewReportRequest(input *GetLensReviewReportInput) (req *request.Request, output *GetLensReviewReportOutput)

GetLensReviewReportRequest generates a "aws/request.Request" representing the client's request for the GetLensReviewReport operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetLensReviewReport for more information on using the GetLensReviewReport API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetLensReviewReportRequest method.
req, resp := client.GetLensReviewReportRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/GetLensReviewReport

func (*WellArchitected) GetLensReviewReportWithContext

func (c *WellArchitected) GetLensReviewReportWithContext(ctx aws.Context, input *GetLensReviewReportInput, opts ...request.Option) (*GetLensReviewReportOutput, error)

GetLensReviewReportWithContext is the same as GetLensReviewReport with the addition of the ability to pass a context and additional request options.

See GetLensReviewReport for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WellArchitected) GetLensReviewRequest

func (c *WellArchitected) GetLensReviewRequest(input *GetLensReviewInput) (req *request.Request, output *GetLensReviewOutput)

GetLensReviewRequest generates a "aws/request.Request" representing the client's request for the GetLensReview operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetLensReview for more information on using the GetLensReview API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetLensReviewRequest method.
req, resp := client.GetLensReviewRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/GetLensReview

func (*WellArchitected) GetLensReviewWithContext

func (c *WellArchitected) GetLensReviewWithContext(ctx aws.Context, input *GetLensReviewInput, opts ...request.Option) (*GetLensReviewOutput, error)

GetLensReviewWithContext is the same as GetLensReview with the addition of the ability to pass a context and additional request options.

See GetLensReview for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WellArchitected) GetLensVersionDifference

GetLensVersionDifference API operation for AWS Well-Architected Tool.

Get lens version differences.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Well-Architected Tool's API operation GetLensVersionDifference for usage and error information.

Returned Error Types:

  • ValidationException The user input is not valid.

  • ResourceNotFoundException The requested resource was not found.

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

  • AccessDeniedException User does not have sufficient access to perform this action.

  • ThrottlingException Request was denied due to request throttling.

See also, https://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/GetLensVersionDifference

func (*WellArchitected) GetLensVersionDifferenceRequest

func (c *WellArchitected) GetLensVersionDifferenceRequest(input *GetLensVersionDifferenceInput) (req *request.Request, output *GetLensVersionDifferenceOutput)

GetLensVersionDifferenceRequest generates a "aws/request.Request" representing the client's request for the GetLensVersionDifference operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetLensVersionDifference for more information on using the GetLensVersionDifference API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetLensVersionDifferenceRequest method.
req, resp := client.GetLensVersionDifferenceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/GetLensVersionDifference

func (*WellArchitected) GetLensVersionDifferenceWithContext

func (c *WellArchitected) GetLensVersionDifferenceWithContext(ctx aws.Context, input *GetLensVersionDifferenceInput, opts ...request.Option) (*GetLensVersionDifferenceOutput, error)

GetLensVersionDifferenceWithContext is the same as GetLensVersionDifference with the addition of the ability to pass a context and additional request options.

See GetLensVersionDifference for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WellArchitected) GetLensWithContext added in v1.42.15

func (c *WellArchitected) GetLensWithContext(ctx aws.Context, input *GetLensInput, opts ...request.Option) (*GetLensOutput, error)

GetLensWithContext is the same as GetLens with the addition of the ability to pass a context and additional request options.

See GetLens for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WellArchitected) GetMilestone

func (c *WellArchitected) GetMilestone(input *GetMilestoneInput) (*GetMilestoneOutput, error)

GetMilestone API operation for AWS Well-Architected Tool.

Get a milestone for an existing workload.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Well-Architected Tool's API operation GetMilestone for usage and error information.

Returned Error Types:

  • ValidationException The user input is not valid.

  • ResourceNotFoundException The requested resource was not found.

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

  • AccessDeniedException User does not have sufficient access to perform this action.

  • ThrottlingException Request was denied due to request throttling.

See also, https://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/GetMilestone

func (*WellArchitected) GetMilestoneRequest

func (c *WellArchitected) GetMilestoneRequest(input *GetMilestoneInput) (req *request.Request, output *GetMilestoneOutput)

GetMilestoneRequest generates a "aws/request.Request" representing the client's request for the GetMilestone operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetMilestone for more information on using the GetMilestone API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetMilestoneRequest method.
req, resp := client.GetMilestoneRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/GetMilestone

func (*WellArchitected) GetMilestoneWithContext

func (c *WellArchitected) GetMilestoneWithContext(ctx aws.Context, input *GetMilestoneInput, opts ...request.Option) (*GetMilestoneOutput, error)

GetMilestoneWithContext is the same as GetMilestone with the addition of the ability to pass a context and additional request options.

See GetMilestone for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WellArchitected) GetWorkload

func (c *WellArchitected) GetWorkload(input *GetWorkloadInput) (*GetWorkloadOutput, error)

GetWorkload API operation for AWS Well-Architected Tool.

Get an existing workload.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Well-Architected Tool's API operation GetWorkload for usage and error information.

Returned Error Types:

  • ValidationException The user input is not valid.

  • ResourceNotFoundException The requested resource was not found.

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

  • AccessDeniedException User does not have sufficient access to perform this action.

  • ThrottlingException Request was denied due to request throttling.

See also, https://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/GetWorkload

func (*WellArchitected) GetWorkloadRequest

func (c *WellArchitected) GetWorkloadRequest(input *GetWorkloadInput) (req *request.Request, output *GetWorkloadOutput)

GetWorkloadRequest generates a "aws/request.Request" representing the client's request for the GetWorkload operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See GetWorkload for more information on using the GetWorkload API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the GetWorkloadRequest method.
req, resp := client.GetWorkloadRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/GetWorkload

func (*WellArchitected) GetWorkloadWithContext

func (c *WellArchitected) GetWorkloadWithContext(ctx aws.Context, input *GetWorkloadInput, opts ...request.Option) (*GetWorkloadOutput, error)

GetWorkloadWithContext is the same as GetWorkload with the addition of the ability to pass a context and additional request options.

See GetWorkload for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WellArchitected) ImportLens added in v1.42.15

func (c *WellArchitected) ImportLens(input *ImportLensInput) (*ImportLensOutput, error)

ImportLens API operation for AWS Well-Architected Tool.

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

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

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

Lenses are defined in JSON. For more information, see JSON format specification (https://docs.aws.amazon.com/wellarchitected/latest/userguide/lenses-format-specification.html) in the Well-Architected Tool User Guide.

A custom lens cannot exceed 500 KB in size.

Disclaimer

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Well-Architected Tool's API operation ImportLens for usage and error information.

Returned Error Types:

  • ValidationException The user input is not valid.

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

  • ResourceNotFoundException The requested resource was not found.

  • ServiceQuotaExceededException The user has reached their resource quota.

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

  • AccessDeniedException User does not have sufficient access to perform this action.

  • ThrottlingException Request was denied due to request throttling.

See also, https://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ImportLens

func (*WellArchitected) ImportLensRequest added in v1.42.15

func (c *WellArchitected) ImportLensRequest(input *ImportLensInput) (req *request.Request, output *ImportLensOutput)

ImportLensRequest generates a "aws/request.Request" representing the client's request for the ImportLens operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ImportLens for more information on using the ImportLens API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ImportLensRequest method.
req, resp := client.ImportLensRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ImportLens

func (*WellArchitected) ImportLensWithContext added in v1.42.15

func (c *WellArchitected) ImportLensWithContext(ctx aws.Context, input *ImportLensInput, opts ...request.Option) (*ImportLensOutput, error)

ImportLensWithContext is the same as ImportLens with the addition of the ability to pass a context and additional request options.

See ImportLens for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WellArchitected) ListAnswers

func (c *WellArchitected) ListAnswers(input *ListAnswersInput) (*ListAnswersOutput, error)

ListAnswers API operation for AWS Well-Architected Tool.

List of answers for a particular workload and lens.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Well-Architected Tool's API operation ListAnswers for usage and error information.

Returned Error Types:

  • ValidationException The user input is not valid.

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

  • ResourceNotFoundException The requested resource was not found.

  • AccessDeniedException User does not have sufficient access to perform this action.

  • ThrottlingException Request was denied due to request throttling.

See also, https://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ListAnswers

func (*WellArchitected) ListAnswersPages

func (c *WellArchitected) ListAnswersPages(input *ListAnswersInput, fn func(*ListAnswersOutput, bool) bool) error

ListAnswersPages iterates over the pages of a ListAnswers operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListAnswers method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListAnswers operation.
pageNum := 0
err := client.ListAnswersPages(params,
    func(page *wellarchitected.ListAnswersOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*WellArchitected) ListAnswersPagesWithContext

func (c *WellArchitected) ListAnswersPagesWithContext(ctx aws.Context, input *ListAnswersInput, fn func(*ListAnswersOutput, bool) bool, opts ...request.Option) error

ListAnswersPagesWithContext same as ListAnswersPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WellArchitected) ListAnswersRequest

func (c *WellArchitected) ListAnswersRequest(input *ListAnswersInput) (req *request.Request, output *ListAnswersOutput)

ListAnswersRequest generates a "aws/request.Request" representing the client's request for the ListAnswers operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListAnswers for more information on using the ListAnswers API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListAnswersRequest method.
req, resp := client.ListAnswersRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ListAnswers

func (*WellArchitected) ListAnswersWithContext

func (c *WellArchitected) ListAnswersWithContext(ctx aws.Context, input *ListAnswersInput, opts ...request.Option) (*ListAnswersOutput, error)

ListAnswersWithContext is the same as ListAnswers with the addition of the ability to pass a context and additional request options.

See ListAnswers for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WellArchitected) ListCheckDetails added in v1.44.132

func (c *WellArchitected) ListCheckDetails(input *ListCheckDetailsInput) (*ListCheckDetailsOutput, error)

ListCheckDetails API operation for AWS Well-Architected Tool.

List of Trusted Advisor check details by account related to the workload.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Well-Architected Tool's API operation ListCheckDetails for usage and error information.

Returned Error Types:

  • ValidationException The user input is not valid.

  • ResourceNotFoundException The requested resource was not found.

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

  • AccessDeniedException User does not have sufficient access to perform this action.

  • ThrottlingException Request was denied due to request throttling.

See also, https://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ListCheckDetails

func (*WellArchitected) ListCheckDetailsPages added in v1.44.132

func (c *WellArchitected) ListCheckDetailsPages(input *ListCheckDetailsInput, fn func(*ListCheckDetailsOutput, bool) bool) error

ListCheckDetailsPages iterates over the pages of a ListCheckDetails operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListCheckDetails method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListCheckDetails operation.
pageNum := 0
err := client.ListCheckDetailsPages(params,
    func(page *wellarchitected.ListCheckDetailsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*WellArchitected) ListCheckDetailsPagesWithContext added in v1.44.132

func (c *WellArchitected) ListCheckDetailsPagesWithContext(ctx aws.Context, input *ListCheckDetailsInput, fn func(*ListCheckDetailsOutput, bool) bool, opts ...request.Option) error

ListCheckDetailsPagesWithContext same as ListCheckDetailsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WellArchitected) ListCheckDetailsRequest added in v1.44.132

func (c *WellArchitected) ListCheckDetailsRequest(input *ListCheckDetailsInput) (req *request.Request, output *ListCheckDetailsOutput)

ListCheckDetailsRequest generates a "aws/request.Request" representing the client's request for the ListCheckDetails operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListCheckDetails for more information on using the ListCheckDetails API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListCheckDetailsRequest method.
req, resp := client.ListCheckDetailsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ListCheckDetails

func (*WellArchitected) ListCheckDetailsWithContext added in v1.44.132

func (c *WellArchitected) ListCheckDetailsWithContext(ctx aws.Context, input *ListCheckDetailsInput, opts ...request.Option) (*ListCheckDetailsOutput, error)

ListCheckDetailsWithContext is the same as ListCheckDetails with the addition of the ability to pass a context and additional request options.

See ListCheckDetails for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WellArchitected) ListCheckSummaries added in v1.44.132

func (c *WellArchitected) ListCheckSummaries(input *ListCheckSummariesInput) (*ListCheckSummariesOutput, error)

ListCheckSummaries API operation for AWS Well-Architected Tool.

List of Trusted Advisor checks summarized for all accounts related to the workload.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Well-Architected Tool's API operation ListCheckSummaries for usage and error information.

Returned Error Types:

  • ValidationException The user input is not valid.

  • ResourceNotFoundException The requested resource was not found.

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

  • AccessDeniedException User does not have sufficient access to perform this action.

  • ThrottlingException Request was denied due to request throttling.

See also, https://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ListCheckSummaries

func (*WellArchitected) ListCheckSummariesPages added in v1.44.132

func (c *WellArchitected) ListCheckSummariesPages(input *ListCheckSummariesInput, fn func(*ListCheckSummariesOutput, bool) bool) error

ListCheckSummariesPages iterates over the pages of a ListCheckSummaries operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListCheckSummaries method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListCheckSummaries operation.
pageNum := 0
err := client.ListCheckSummariesPages(params,
    func(page *wellarchitected.ListCheckSummariesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*WellArchitected) ListCheckSummariesPagesWithContext added in v1.44.132

func (c *WellArchitected) ListCheckSummariesPagesWithContext(ctx aws.Context, input *ListCheckSummariesInput, fn func(*ListCheckSummariesOutput, bool) bool, opts ...request.Option) error

ListCheckSummariesPagesWithContext same as ListCheckSummariesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WellArchitected) ListCheckSummariesRequest added in v1.44.132

func (c *WellArchitected) ListCheckSummariesRequest(input *ListCheckSummariesInput) (req *request.Request, output *ListCheckSummariesOutput)

ListCheckSummariesRequest generates a "aws/request.Request" representing the client's request for the ListCheckSummaries operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListCheckSummaries for more information on using the ListCheckSummaries API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListCheckSummariesRequest method.
req, resp := client.ListCheckSummariesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ListCheckSummaries

func (*WellArchitected) ListCheckSummariesWithContext added in v1.44.132

func (c *WellArchitected) ListCheckSummariesWithContext(ctx aws.Context, input *ListCheckSummariesInput, opts ...request.Option) (*ListCheckSummariesOutput, error)

ListCheckSummariesWithContext is the same as ListCheckSummaries with the addition of the ability to pass a context and additional request options.

See ListCheckSummaries for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WellArchitected) ListLensReviewImprovements

ListLensReviewImprovements API operation for AWS Well-Architected Tool.

List lens review improvements.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Well-Architected Tool's API operation ListLensReviewImprovements for usage and error information.

Returned Error Types:

  • ValidationException The user input is not valid.

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

  • ResourceNotFoundException The requested resource was not found.

  • AccessDeniedException User does not have sufficient access to perform this action.

  • ThrottlingException Request was denied due to request throttling.

See also, https://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ListLensReviewImprovements

func (*WellArchitected) ListLensReviewImprovementsPages

func (c *WellArchitected) ListLensReviewImprovementsPages(input *ListLensReviewImprovementsInput, fn func(*ListLensReviewImprovementsOutput, bool) bool) error

ListLensReviewImprovementsPages iterates over the pages of a ListLensReviewImprovements operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListLensReviewImprovements method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListLensReviewImprovements operation.
pageNum := 0
err := client.ListLensReviewImprovementsPages(params,
    func(page *wellarchitected.ListLensReviewImprovementsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*WellArchitected) ListLensReviewImprovementsPagesWithContext

func (c *WellArchitected) ListLensReviewImprovementsPagesWithContext(ctx aws.Context, input *ListLensReviewImprovementsInput, fn func(*ListLensReviewImprovementsOutput, bool) bool, opts ...request.Option) error

ListLensReviewImprovementsPagesWithContext same as ListLensReviewImprovementsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WellArchitected) ListLensReviewImprovementsRequest

func (c *WellArchitected) ListLensReviewImprovementsRequest(input *ListLensReviewImprovementsInput) (req *request.Request, output *ListLensReviewImprovementsOutput)

ListLensReviewImprovementsRequest generates a "aws/request.Request" representing the client's request for the ListLensReviewImprovements operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListLensReviewImprovements for more information on using the ListLensReviewImprovements API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListLensReviewImprovementsRequest method.
req, resp := client.ListLensReviewImprovementsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ListLensReviewImprovements

func (*WellArchitected) ListLensReviewImprovementsWithContext

func (c *WellArchitected) ListLensReviewImprovementsWithContext(ctx aws.Context, input *ListLensReviewImprovementsInput, opts ...request.Option) (*ListLensReviewImprovementsOutput, error)

ListLensReviewImprovementsWithContext is the same as ListLensReviewImprovements with the addition of the ability to pass a context and additional request options.

See ListLensReviewImprovements for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WellArchitected) ListLensReviews

func (c *WellArchitected) ListLensReviews(input *ListLensReviewsInput) (*ListLensReviewsOutput, error)

ListLensReviews API operation for AWS Well-Architected Tool.

List lens reviews for a particular workload.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Well-Architected Tool's API operation ListLensReviews for usage and error information.

Returned Error Types:

  • ValidationException The user input is not valid.

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

  • ResourceNotFoundException The requested resource was not found.

  • AccessDeniedException User does not have sufficient access to perform this action.

  • ThrottlingException Request was denied due to request throttling.

See also, https://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ListLensReviews

func (*WellArchitected) ListLensReviewsPages

func (c *WellArchitected) ListLensReviewsPages(input *ListLensReviewsInput, fn func(*ListLensReviewsOutput, bool) bool) error

ListLensReviewsPages iterates over the pages of a ListLensReviews operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListLensReviews method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListLensReviews operation.
pageNum := 0
err := client.ListLensReviewsPages(params,
    func(page *wellarchitected.ListLensReviewsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*WellArchitected) ListLensReviewsPagesWithContext

func (c *WellArchitected) ListLensReviewsPagesWithContext(ctx aws.Context, input *ListLensReviewsInput, fn func(*ListLensReviewsOutput, bool) bool, opts ...request.Option) error

ListLensReviewsPagesWithContext same as ListLensReviewsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WellArchitected) ListLensReviewsRequest

func (c *WellArchitected) ListLensReviewsRequest(input *ListLensReviewsInput) (req *request.Request, output *ListLensReviewsOutput)

ListLensReviewsRequest generates a "aws/request.Request" representing the client's request for the ListLensReviews operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListLensReviews for more information on using the ListLensReviews API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListLensReviewsRequest method.
req, resp := client.ListLensReviewsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ListLensReviews

func (*WellArchitected) ListLensReviewsWithContext

func (c *WellArchitected) ListLensReviewsWithContext(ctx aws.Context, input *ListLensReviewsInput, opts ...request.Option) (*ListLensReviewsOutput, error)

ListLensReviewsWithContext is the same as ListLensReviews with the addition of the ability to pass a context and additional request options.

See ListLensReviews for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WellArchitected) ListLensShares added in v1.42.15

func (c *WellArchitected) ListLensShares(input *ListLensSharesInput) (*ListLensSharesOutput, error)

ListLensShares API operation for AWS Well-Architected Tool.

List the lens shares associated with the lens.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Well-Architected Tool's API operation ListLensShares for usage and error information.

Returned Error Types:

  • ValidationException The user input is not valid.

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

  • ResourceNotFoundException The requested resource was not found.

  • AccessDeniedException User does not have sufficient access to perform this action.

  • ThrottlingException Request was denied due to request throttling.

See also, https://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ListLensShares

func (*WellArchitected) ListLensSharesPages added in v1.42.15

func (c *WellArchitected) ListLensSharesPages(input *ListLensSharesInput, fn func(*ListLensSharesOutput, bool) bool) error

ListLensSharesPages iterates over the pages of a ListLensShares operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListLensShares method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListLensShares operation.
pageNum := 0
err := client.ListLensSharesPages(params,
    func(page *wellarchitected.ListLensSharesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*WellArchitected) ListLensSharesPagesWithContext added in v1.42.15

func (c *WellArchitected) ListLensSharesPagesWithContext(ctx aws.Context, input *ListLensSharesInput, fn func(*ListLensSharesOutput, bool) bool, opts ...request.Option) error

ListLensSharesPagesWithContext same as ListLensSharesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WellArchitected) ListLensSharesRequest added in v1.42.15

func (c *WellArchitected) ListLensSharesRequest(input *ListLensSharesInput) (req *request.Request, output *ListLensSharesOutput)

ListLensSharesRequest generates a "aws/request.Request" representing the client's request for the ListLensShares operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListLensShares for more information on using the ListLensShares API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListLensSharesRequest method.
req, resp := client.ListLensSharesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ListLensShares

func (*WellArchitected) ListLensSharesWithContext added in v1.42.15

func (c *WellArchitected) ListLensSharesWithContext(ctx aws.Context, input *ListLensSharesInput, opts ...request.Option) (*ListLensSharesOutput, error)

ListLensSharesWithContext is the same as ListLensShares with the addition of the ability to pass a context and additional request options.

See ListLensShares for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WellArchitected) ListLenses

func (c *WellArchitected) ListLenses(input *ListLensesInput) (*ListLensesOutput, error)

ListLenses API operation for AWS Well-Architected Tool.

List the available lenses.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Well-Architected Tool's API operation ListLenses for usage and error information.

Returned Error Types:

  • ValidationException The user input is not valid.

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

  • AccessDeniedException User does not have sufficient access to perform this action.

  • ThrottlingException Request was denied due to request throttling.

See also, https://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ListLenses

func (*WellArchitected) ListLensesPages

func (c *WellArchitected) ListLensesPages(input *ListLensesInput, fn func(*ListLensesOutput, bool) bool) error

ListLensesPages iterates over the pages of a ListLenses operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListLenses method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListLenses operation.
pageNum := 0
err := client.ListLensesPages(params,
    func(page *wellarchitected.ListLensesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*WellArchitected) ListLensesPagesWithContext

func (c *WellArchitected) ListLensesPagesWithContext(ctx aws.Context, input *ListLensesInput, fn func(*ListLensesOutput, bool) bool, opts ...request.Option) error

ListLensesPagesWithContext same as ListLensesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WellArchitected) ListLensesRequest

func (c *WellArchitected) ListLensesRequest(input *ListLensesInput) (req *request.Request, output *ListLensesOutput)

ListLensesRequest generates a "aws/request.Request" representing the client's request for the ListLenses operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListLenses for more information on using the ListLenses API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListLensesRequest method.
req, resp := client.ListLensesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ListLenses

func (*WellArchitected) ListLensesWithContext

func (c *WellArchitected) ListLensesWithContext(ctx aws.Context, input *ListLensesInput, opts ...request.Option) (*ListLensesOutput, error)

ListLensesWithContext is the same as ListLenses with the addition of the ability to pass a context and additional request options.

See ListLenses for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WellArchitected) ListMilestones

func (c *WellArchitected) ListMilestones(input *ListMilestonesInput) (*ListMilestonesOutput, error)

ListMilestones API operation for AWS Well-Architected Tool.

List all milestones for an existing workload.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Well-Architected Tool's API operation ListMilestones for usage and error information.

Returned Error Types:

  • ValidationException The user input is not valid.

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

  • ResourceNotFoundException The requested resource was not found.

  • AccessDeniedException User does not have sufficient access to perform this action.

  • ThrottlingException Request was denied due to request throttling.

See also, https://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ListMilestones

func (*WellArchitected) ListMilestonesPages

func (c *WellArchitected) ListMilestonesPages(input *ListMilestonesInput, fn func(*ListMilestonesOutput, bool) bool) error

ListMilestonesPages iterates over the pages of a ListMilestones operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListMilestones method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListMilestones operation.
pageNum := 0
err := client.ListMilestonesPages(params,
    func(page *wellarchitected.ListMilestonesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*WellArchitected) ListMilestonesPagesWithContext

func (c *WellArchitected) ListMilestonesPagesWithContext(ctx aws.Context, input *ListMilestonesInput, fn func(*ListMilestonesOutput, bool) bool, opts ...request.Option) error

ListMilestonesPagesWithContext same as ListMilestonesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WellArchitected) ListMilestonesRequest

func (c *WellArchitected) ListMilestonesRequest(input *ListMilestonesInput) (req *request.Request, output *ListMilestonesOutput)

ListMilestonesRequest generates a "aws/request.Request" representing the client's request for the ListMilestones operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListMilestones for more information on using the ListMilestones API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListMilestonesRequest method.
req, resp := client.ListMilestonesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ListMilestones

func (*WellArchitected) ListMilestonesWithContext

func (c *WellArchitected) ListMilestonesWithContext(ctx aws.Context, input *ListMilestonesInput, opts ...request.Option) (*ListMilestonesOutput, error)

ListMilestonesWithContext is the same as ListMilestones with the addition of the ability to pass a context and additional request options.

See ListMilestones for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WellArchitected) ListNotifications

func (c *WellArchitected) ListNotifications(input *ListNotificationsInput) (*ListNotificationsOutput, error)

ListNotifications API operation for AWS Well-Architected Tool.

List lens notifications.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Well-Architected Tool's API operation ListNotifications for usage and error information.

Returned Error Types:

  • ValidationException The user input is not valid.

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

  • AccessDeniedException User does not have sufficient access to perform this action.

  • ThrottlingException Request was denied due to request throttling.

See also, https://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ListNotifications

func (*WellArchitected) ListNotificationsPages

func (c *WellArchitected) ListNotificationsPages(input *ListNotificationsInput, fn func(*ListNotificationsOutput, bool) bool) error

ListNotificationsPages iterates over the pages of a ListNotifications operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListNotifications method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListNotifications operation.
pageNum := 0
err := client.ListNotificationsPages(params,
    func(page *wellarchitected.ListNotificationsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*WellArchitected) ListNotificationsPagesWithContext

func (c *WellArchitected) ListNotificationsPagesWithContext(ctx aws.Context, input *ListNotificationsInput, fn func(*ListNotificationsOutput, bool) bool, opts ...request.Option) error

ListNotificationsPagesWithContext same as ListNotificationsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WellArchitected) ListNotificationsRequest

func (c *WellArchitected) ListNotificationsRequest(input *ListNotificationsInput) (req *request.Request, output *ListNotificationsOutput)

ListNotificationsRequest generates a "aws/request.Request" representing the client's request for the ListNotifications operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListNotifications for more information on using the ListNotifications API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListNotificationsRequest method.
req, resp := client.ListNotificationsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ListNotifications

func (*WellArchitected) ListNotificationsWithContext

func (c *WellArchitected) ListNotificationsWithContext(ctx aws.Context, input *ListNotificationsInput, opts ...request.Option) (*ListNotificationsOutput, error)

ListNotificationsWithContext is the same as ListNotifications with the addition of the ability to pass a context and additional request options.

See ListNotifications for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WellArchitected) ListShareInvitations

func (c *WellArchitected) ListShareInvitations(input *ListShareInvitationsInput) (*ListShareInvitationsOutput, error)

ListShareInvitations API operation for AWS Well-Architected Tool.

List the workload invitations.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Well-Architected Tool's API operation ListShareInvitations for usage and error information.

Returned Error Types:

  • ValidationException The user input is not valid.

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

  • AccessDeniedException User does not have sufficient access to perform this action.

  • ThrottlingException Request was denied due to request throttling.

See also, https://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ListShareInvitations

func (*WellArchitected) ListShareInvitationsPages

func (c *WellArchitected) ListShareInvitationsPages(input *ListShareInvitationsInput, fn func(*ListShareInvitationsOutput, bool) bool) error

ListShareInvitationsPages iterates over the pages of a ListShareInvitations operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListShareInvitations method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListShareInvitations operation.
pageNum := 0
err := client.ListShareInvitationsPages(params,
    func(page *wellarchitected.ListShareInvitationsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*WellArchitected) ListShareInvitationsPagesWithContext

func (c *WellArchitected) ListShareInvitationsPagesWithContext(ctx aws.Context, input *ListShareInvitationsInput, fn func(*ListShareInvitationsOutput, bool) bool, opts ...request.Option) error

ListShareInvitationsPagesWithContext same as ListShareInvitationsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WellArchitected) ListShareInvitationsRequest

func (c *WellArchitected) ListShareInvitationsRequest(input *ListShareInvitationsInput) (req *request.Request, output *ListShareInvitationsOutput)

ListShareInvitationsRequest generates a "aws/request.Request" representing the client's request for the ListShareInvitations operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListShareInvitations for more information on using the ListShareInvitations API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListShareInvitationsRequest method.
req, resp := client.ListShareInvitationsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ListShareInvitations

func (*WellArchitected) ListShareInvitationsWithContext

func (c *WellArchitected) ListShareInvitationsWithContext(ctx aws.Context, input *ListShareInvitationsInput, opts ...request.Option) (*ListShareInvitationsOutput, error)

ListShareInvitationsWithContext is the same as ListShareInvitations with the addition of the ability to pass a context and additional request options.

See ListShareInvitations for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WellArchitected) ListTagsForResource added in v1.37.23

func (c *WellArchitected) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error)

ListTagsForResource API operation for AWS Well-Architected Tool.

List the tags for a resource.

The WorkloadArn parameter can be either a workload ARN or a custom lens ARN.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Well-Architected Tool's API operation ListTagsForResource for usage and error information.

Returned Error Types:

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

  • ResourceNotFoundException The requested resource was not found.

See also, https://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ListTagsForResource

func (*WellArchitected) ListTagsForResourceRequest added in v1.37.23

func (c *WellArchitected) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req *request.Request, output *ListTagsForResourceOutput)

ListTagsForResourceRequest generates a "aws/request.Request" representing the client's request for the ListTagsForResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListTagsForResource for more information on using the ListTagsForResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListTagsForResourceRequest method.
req, resp := client.ListTagsForResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ListTagsForResource

func (*WellArchitected) ListTagsForResourceWithContext added in v1.37.23

func (c *WellArchitected) ListTagsForResourceWithContext(ctx aws.Context, input *ListTagsForResourceInput, opts ...request.Option) (*ListTagsForResourceOutput, error)

ListTagsForResourceWithContext is the same as ListTagsForResource with the addition of the ability to pass a context and additional request options.

See ListTagsForResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WellArchitected) ListWorkloadShares

func (c *WellArchitected) ListWorkloadShares(input *ListWorkloadSharesInput) (*ListWorkloadSharesOutput, error)

ListWorkloadShares API operation for AWS Well-Architected Tool.

List the workload shares associated with the workload.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Well-Architected Tool's API operation ListWorkloadShares for usage and error information.

Returned Error Types:

  • ValidationException The user input is not valid.

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

  • ResourceNotFoundException The requested resource was not found.

  • AccessDeniedException User does not have sufficient access to perform this action.

  • ThrottlingException Request was denied due to request throttling.

See also, https://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ListWorkloadShares

func (*WellArchitected) ListWorkloadSharesPages

func (c *WellArchitected) ListWorkloadSharesPages(input *ListWorkloadSharesInput, fn func(*ListWorkloadSharesOutput, bool) bool) error

ListWorkloadSharesPages iterates over the pages of a ListWorkloadShares operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListWorkloadShares method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListWorkloadShares operation.
pageNum := 0
err := client.ListWorkloadSharesPages(params,
    func(page *wellarchitected.ListWorkloadSharesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*WellArchitected) ListWorkloadSharesPagesWithContext

func (c *WellArchitected) ListWorkloadSharesPagesWithContext(ctx aws.Context, input *ListWorkloadSharesInput, fn func(*ListWorkloadSharesOutput, bool) bool, opts ...request.Option) error

ListWorkloadSharesPagesWithContext same as ListWorkloadSharesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WellArchitected) ListWorkloadSharesRequest

func (c *WellArchitected) ListWorkloadSharesRequest(input *ListWorkloadSharesInput) (req *request.Request, output *ListWorkloadSharesOutput)

ListWorkloadSharesRequest generates a "aws/request.Request" representing the client's request for the ListWorkloadShares operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListWorkloadShares for more information on using the ListWorkloadShares API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListWorkloadSharesRequest method.
req, resp := client.ListWorkloadSharesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ListWorkloadShares

func (*WellArchitected) ListWorkloadSharesWithContext

func (c *WellArchitected) ListWorkloadSharesWithContext(ctx aws.Context, input *ListWorkloadSharesInput, opts ...request.Option) (*ListWorkloadSharesOutput, error)

ListWorkloadSharesWithContext is the same as ListWorkloadShares with the addition of the ability to pass a context and additional request options.

See ListWorkloadShares for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WellArchitected) ListWorkloads

func (c *WellArchitected) ListWorkloads(input *ListWorkloadsInput) (*ListWorkloadsOutput, error)

ListWorkloads API operation for AWS Well-Architected Tool.

Paginated list of workloads.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Well-Architected Tool's API operation ListWorkloads for usage and error information.

Returned Error Types:

  • ValidationException The user input is not valid.

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

  • AccessDeniedException User does not have sufficient access to perform this action.

  • ThrottlingException Request was denied due to request throttling.

See also, https://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ListWorkloads

func (*WellArchitected) ListWorkloadsPages

func (c *WellArchitected) ListWorkloadsPages(input *ListWorkloadsInput, fn func(*ListWorkloadsOutput, bool) bool) error

ListWorkloadsPages iterates over the pages of a ListWorkloads operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListWorkloads method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListWorkloads operation.
pageNum := 0
err := client.ListWorkloadsPages(params,
    func(page *wellarchitected.ListWorkloadsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*WellArchitected) ListWorkloadsPagesWithContext

func (c *WellArchitected) ListWorkloadsPagesWithContext(ctx aws.Context, input *ListWorkloadsInput, fn func(*ListWorkloadsOutput, bool) bool, opts ...request.Option) error

ListWorkloadsPagesWithContext same as ListWorkloadsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WellArchitected) ListWorkloadsRequest

func (c *WellArchitected) ListWorkloadsRequest(input *ListWorkloadsInput) (req *request.Request, output *ListWorkloadsOutput)

ListWorkloadsRequest generates a "aws/request.Request" representing the client's request for the ListWorkloads operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListWorkloads for more information on using the ListWorkloads API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListWorkloadsRequest method.
req, resp := client.ListWorkloadsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/ListWorkloads

func (*WellArchitected) ListWorkloadsWithContext

func (c *WellArchitected) ListWorkloadsWithContext(ctx aws.Context, input *ListWorkloadsInput, opts ...request.Option) (*ListWorkloadsOutput, error)

ListWorkloadsWithContext is the same as ListWorkloads with the addition of the ability to pass a context and additional request options.

See ListWorkloads for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WellArchitected) TagResource added in v1.37.23

func (c *WellArchitected) TagResource(input *TagResourceInput) (*TagResourceOutput, error)

TagResource API operation for AWS Well-Architected Tool.

Adds one or more tags to the specified resource.

The WorkloadArn parameter can be either a workload ARN or a custom lens ARN.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Well-Architected Tool's API operation TagResource for usage and error information.

Returned Error Types:

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

  • ResourceNotFoundException The requested resource was not found.

See also, https://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/TagResource

func (*WellArchitected) TagResourceRequest added in v1.37.23

func (c *WellArchitected) TagResourceRequest(input *TagResourceInput) (req *request.Request, output *TagResourceOutput)

TagResourceRequest generates a "aws/request.Request" representing the client's request for the TagResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See TagResource for more information on using the TagResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the TagResourceRequest method.
req, resp := client.TagResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/TagResource

func (*WellArchitected) TagResourceWithContext added in v1.37.23

func (c *WellArchitected) TagResourceWithContext(ctx aws.Context, input *TagResourceInput, opts ...request.Option) (*TagResourceOutput, error)

TagResourceWithContext is the same as TagResource with the addition of the ability to pass a context and additional request options.

See TagResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WellArchitected) UntagResource added in v1.37.23

func (c *WellArchitected) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error)

UntagResource API operation for AWS Well-Architected Tool.

Deletes specified tags from a resource.

The WorkloadArn parameter can be either a workload ARN or a custom lens ARN.

To specify multiple tags, use separate tagKeys parameters, for example:

DELETE /tags/WorkloadArn?tagKeys=key1&tagKeys=key2

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Well-Architected Tool's API operation UntagResource for usage and error information.

Returned Error Types:

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

  • ResourceNotFoundException The requested resource was not found.

See also, https://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/UntagResource

func (*WellArchitected) UntagResourceRequest added in v1.37.23

func (c *WellArchitected) UntagResourceRequest(input *UntagResourceInput) (req *request.Request, output *UntagResourceOutput)

UntagResourceRequest generates a "aws/request.Request" representing the client's request for the UntagResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UntagResource for more information on using the UntagResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UntagResourceRequest method.
req, resp := client.UntagResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/UntagResource

func (*WellArchitected) UntagResourceWithContext added in v1.37.23

func (c *WellArchitected) UntagResourceWithContext(ctx aws.Context, input *UntagResourceInput, opts ...request.Option) (*UntagResourceOutput, error)

UntagResourceWithContext is the same as UntagResource with the addition of the ability to pass a context and additional request options.

See UntagResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WellArchitected) UpdateAnswer

func (c *WellArchitected) UpdateAnswer(input *UpdateAnswerInput) (*UpdateAnswerOutput, error)

UpdateAnswer API operation for AWS Well-Architected Tool.

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

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Well-Architected Tool's API operation UpdateAnswer for usage and error information.

Returned Error Types:

  • ValidationException The user input is not valid.

  • ResourceNotFoundException The requested resource was not found.

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

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

  • AccessDeniedException User does not have sufficient access to perform this action.

  • ThrottlingException Request was denied due to request throttling.

See also, https://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/UpdateAnswer

func (*WellArchitected) UpdateAnswerRequest

func (c *WellArchitected) UpdateAnswerRequest(input *UpdateAnswerInput) (req *request.Request, output *UpdateAnswerOutput)

UpdateAnswerRequest generates a "aws/request.Request" representing the client's request for the UpdateAnswer operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateAnswer for more information on using the UpdateAnswer API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdateAnswerRequest method.
req, resp := client.UpdateAnswerRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/UpdateAnswer

func (*WellArchitected) UpdateAnswerWithContext

func (c *WellArchitected) UpdateAnswerWithContext(ctx aws.Context, input *UpdateAnswerInput, opts ...request.Option) (*UpdateAnswerOutput, error)

UpdateAnswerWithContext is the same as UpdateAnswer with the addition of the ability to pass a context and additional request options.

See UpdateAnswer for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WellArchitected) UpdateGlobalSettings added in v1.44.46

func (c *WellArchitected) UpdateGlobalSettings(input *UpdateGlobalSettingsInput) (*UpdateGlobalSettingsOutput, error)

UpdateGlobalSettings API operation for AWS Well-Architected Tool.

Updates whether the Amazon Web Services account is opted into organization sharing and discovery integration features.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Well-Architected Tool's API operation UpdateGlobalSettings for usage and error information.

Returned Error Types:

  • ValidationException The user input is not valid.

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

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

  • AccessDeniedException User does not have sufficient access to perform this action.

  • ThrottlingException Request was denied due to request throttling.

See also, https://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/UpdateGlobalSettings

func (*WellArchitected) UpdateGlobalSettingsRequest added in v1.44.46

func (c *WellArchitected) UpdateGlobalSettingsRequest(input *UpdateGlobalSettingsInput) (req *request.Request, output *UpdateGlobalSettingsOutput)

UpdateGlobalSettingsRequest generates a "aws/request.Request" representing the client's request for the UpdateGlobalSettings operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateGlobalSettings for more information on using the UpdateGlobalSettings API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdateGlobalSettingsRequest method.
req, resp := client.UpdateGlobalSettingsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/UpdateGlobalSettings

func (*WellArchitected) UpdateGlobalSettingsWithContext added in v1.44.46

func (c *WellArchitected) UpdateGlobalSettingsWithContext(ctx aws.Context, input *UpdateGlobalSettingsInput, opts ...request.Option) (*UpdateGlobalSettingsOutput, error)

UpdateGlobalSettingsWithContext is the same as UpdateGlobalSettings with the addition of the ability to pass a context and additional request options.

See UpdateGlobalSettings for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WellArchitected) UpdateLensReview

func (c *WellArchitected) UpdateLensReview(input *UpdateLensReviewInput) (*UpdateLensReviewOutput, error)

UpdateLensReview API operation for AWS Well-Architected Tool.

Update lens review for a particular workload.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Well-Architected Tool's API operation UpdateLensReview for usage and error information.

Returned Error Types:

  • ValidationException The user input is not valid.

  • ResourceNotFoundException The requested resource was not found.

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

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

  • AccessDeniedException User does not have sufficient access to perform this action.

  • ThrottlingException Request was denied due to request throttling.

See also, https://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/UpdateLensReview

func (*WellArchitected) UpdateLensReviewRequest

func (c *WellArchitected) UpdateLensReviewRequest(input *UpdateLensReviewInput) (req *request.Request, output *UpdateLensReviewOutput)

UpdateLensReviewRequest generates a "aws/request.Request" representing the client's request for the UpdateLensReview operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateLensReview for more information on using the UpdateLensReview API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdateLensReviewRequest method.
req, resp := client.UpdateLensReviewRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/UpdateLensReview

func (*WellArchitected) UpdateLensReviewWithContext

func (c *WellArchitected) UpdateLensReviewWithContext(ctx aws.Context, input *UpdateLensReviewInput, opts ...request.Option) (*UpdateLensReviewOutput, error)

UpdateLensReviewWithContext is the same as UpdateLensReview with the addition of the ability to pass a context and additional request options.

See UpdateLensReview for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WellArchitected) UpdateShareInvitation

func (c *WellArchitected) UpdateShareInvitation(input *UpdateShareInvitationInput) (*UpdateShareInvitationOutput, error)

UpdateShareInvitation API operation for AWS Well-Architected Tool.

Update a workload or custom lens share invitation.

This API operation can be called independently of any resource. Previous documentation implied that a workload ARN must be specified.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Well-Architected Tool's API operation UpdateShareInvitation for usage and error information.

Returned Error Types:

  • ValidationException The user input is not valid.

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

  • ResourceNotFoundException The requested resource was not found.

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

  • AccessDeniedException User does not have sufficient access to perform this action.

  • ThrottlingException Request was denied due to request throttling.

See also, https://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/UpdateShareInvitation

func (*WellArchitected) UpdateShareInvitationRequest

func (c *WellArchitected) UpdateShareInvitationRequest(input *UpdateShareInvitationInput) (req *request.Request, output *UpdateShareInvitationOutput)

UpdateShareInvitationRequest generates a "aws/request.Request" representing the client's request for the UpdateShareInvitation operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateShareInvitation for more information on using the UpdateShareInvitation API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdateShareInvitationRequest method.
req, resp := client.UpdateShareInvitationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/UpdateShareInvitation

func (*WellArchitected) UpdateShareInvitationWithContext

func (c *WellArchitected) UpdateShareInvitationWithContext(ctx aws.Context, input *UpdateShareInvitationInput, opts ...request.Option) (*UpdateShareInvitationOutput, error)

UpdateShareInvitationWithContext is the same as UpdateShareInvitation with the addition of the ability to pass a context and additional request options.

See UpdateShareInvitation for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WellArchitected) UpdateWorkload

func (c *WellArchitected) UpdateWorkload(input *UpdateWorkloadInput) (*UpdateWorkloadOutput, error)

UpdateWorkload API operation for AWS Well-Architected Tool.

Update an existing workload.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Well-Architected Tool's API operation UpdateWorkload for usage and error information.

Returned Error Types:

  • ValidationException The user input is not valid.

  • ResourceNotFoundException The requested resource was not found.

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

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

  • AccessDeniedException User does not have sufficient access to perform this action.

  • ThrottlingException Request was denied due to request throttling.

See also, https://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/UpdateWorkload

func (*WellArchitected) UpdateWorkloadRequest

func (c *WellArchitected) UpdateWorkloadRequest(input *UpdateWorkloadInput) (req *request.Request, output *UpdateWorkloadOutput)

UpdateWorkloadRequest generates a "aws/request.Request" representing the client's request for the UpdateWorkload operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateWorkload for more information on using the UpdateWorkload API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdateWorkloadRequest method.
req, resp := client.UpdateWorkloadRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/UpdateWorkload

func (*WellArchitected) UpdateWorkloadShare

func (c *WellArchitected) UpdateWorkloadShare(input *UpdateWorkloadShareInput) (*UpdateWorkloadShareOutput, error)

UpdateWorkloadShare API operation for AWS Well-Architected Tool.

Update a workload share.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Well-Architected Tool's API operation UpdateWorkloadShare for usage and error information.

Returned Error Types:

  • ValidationException The user input is not valid.

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

  • ResourceNotFoundException The requested resource was not found.

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

  • AccessDeniedException User does not have sufficient access to perform this action.

  • ThrottlingException Request was denied due to request throttling.

See also, https://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/UpdateWorkloadShare

func (*WellArchitected) UpdateWorkloadShareRequest

func (c *WellArchitected) UpdateWorkloadShareRequest(input *UpdateWorkloadShareInput) (req *request.Request, output *UpdateWorkloadShareOutput)

UpdateWorkloadShareRequest generates a "aws/request.Request" representing the client's request for the UpdateWorkloadShare operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateWorkloadShare for more information on using the UpdateWorkloadShare API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdateWorkloadShareRequest method.
req, resp := client.UpdateWorkloadShareRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/UpdateWorkloadShare

func (*WellArchitected) UpdateWorkloadShareWithContext

func (c *WellArchitected) UpdateWorkloadShareWithContext(ctx aws.Context, input *UpdateWorkloadShareInput, opts ...request.Option) (*UpdateWorkloadShareOutput, error)

UpdateWorkloadShareWithContext is the same as UpdateWorkloadShare with the addition of the ability to pass a context and additional request options.

See UpdateWorkloadShare for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WellArchitected) UpdateWorkloadWithContext

func (c *WellArchitected) UpdateWorkloadWithContext(ctx aws.Context, input *UpdateWorkloadInput, opts ...request.Option) (*UpdateWorkloadOutput, error)

UpdateWorkloadWithContext is the same as UpdateWorkload with the addition of the ability to pass a context and additional request options.

See UpdateWorkload for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*WellArchitected) UpgradeLensReview

func (c *WellArchitected) UpgradeLensReview(input *UpgradeLensReviewInput) (*UpgradeLensReviewOutput, error)

UpgradeLensReview API operation for AWS Well-Architected Tool.

Upgrade lens review for a particular workload.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Well-Architected Tool's API operation UpgradeLensReview for usage and error information.

Returned Error Types:

  • ValidationException The user input is not valid.

  • ResourceNotFoundException The requested resource was not found.

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

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

  • AccessDeniedException User does not have sufficient access to perform this action.

  • ThrottlingException Request was denied due to request throttling.

See also, https://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/UpgradeLensReview

func (*WellArchitected) UpgradeLensReviewRequest

func (c *WellArchitected) UpgradeLensReviewRequest(input *UpgradeLensReviewInput) (req *request.Request, output *UpgradeLensReviewOutput)

UpgradeLensReviewRequest generates a "aws/request.Request" representing the client's request for the UpgradeLensReview operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpgradeLensReview for more information on using the UpgradeLensReview API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpgradeLensReviewRequest method.
req, resp := client.UpgradeLensReviewRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31/UpgradeLensReview

func (*WellArchitected) UpgradeLensReviewWithContext

func (c *WellArchitected) UpgradeLensReviewWithContext(ctx aws.Context, input *UpgradeLensReviewInput, opts ...request.Option) (*UpgradeLensReviewOutput, error)

UpgradeLensReviewWithContext is the same as UpgradeLensReview with the addition of the ability to pass a context and additional request options.

See UpgradeLensReview for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

type Workload

type Workload struct {

	// The list of Amazon Web Services account IDs associated with the workload.
	AccountIds []*string `type:"list"`

	// List of AppRegistry application ARNs associated to the workload.
	Applications []*string `type:"list"`

	// The URL of the architectural design for the workload.
	ArchitecturalDesign *string `type:"string"`

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

	// The description for the workload.
	Description *string `min:"3" type:"string"`

	// Discovery configuration associated to the workload.
	DiscoveryConfig *WorkloadDiscoveryConfig `type:"structure"`

	// The environment for the workload.
	Environment *string `type:"string" enum:"WorkloadEnvironment"`

	// The improvement status for a workload.
	ImprovementStatus *string `type:"string" enum:"WorkloadImprovementStatus"`

	// The industry for the workload.
	Industry *string `type:"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 `type:"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 `type:"boolean"`

	// The list of lenses associated with the workload. Each lens is identified
	// by its LensSummary$LensAlias.
	Lenses []*string `type:"list"`

	// The list of non-Amazon Web Services Regions associated with the workload.
	NonAwsRegions []*string `type:"list"`

	// The notes associated with the workload.
	Notes *string `type:"string"`

	// An Amazon Web Services account ID.
	Owner *string `type:"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 `type:"list"`

	// 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 `min:"3" type:"string"`

	// The date and time recorded.
	ReviewRestrictionDate *time.Time `type:"timestamp"`

	// A map from risk names to the count of how many questions have that rating.
	RiskCounts map[string]*int64 `type:"map"`

	// The ID assigned to the share invitation.
	ShareInvitationId *string `type:"string"`

	// The tags associated with the workload.
	Tags map[string]*string `min:"1" type:"map"`

	// The date and time recorded.
	UpdatedAt *time.Time `type:"timestamp"`

	// The ARN for the workload.
	WorkloadArn *string `type:"string"`

	// The ID assigned to the workload. This ID is unique within an Amazon Web Services
	// Region.
	WorkloadId *string `type:"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 `min:"3" type:"string"`
	// contains filtered or unexported fields
}

A workload return object.

func (Workload) GoString

func (s Workload) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Workload) SetAccountIds

func (s *Workload) SetAccountIds(v []*string) *Workload

SetAccountIds sets the AccountIds field's value.

func (*Workload) SetApplications added in v1.44.132

func (s *Workload) SetApplications(v []*string) *Workload

SetApplications sets the Applications field's value.

func (*Workload) SetArchitecturalDesign

func (s *Workload) SetArchitecturalDesign(v string) *Workload

SetArchitecturalDesign sets the ArchitecturalDesign field's value.

func (*Workload) SetAwsRegions

func (s *Workload) SetAwsRegions(v []*string) *Workload

SetAwsRegions sets the AwsRegions field's value.

func (*Workload) SetDescription

func (s *Workload) SetDescription(v string) *Workload

SetDescription sets the Description field's value.

func (*Workload) SetDiscoveryConfig added in v1.44.132

func (s *Workload) SetDiscoveryConfig(v *WorkloadDiscoveryConfig) *Workload

SetDiscoveryConfig sets the DiscoveryConfig field's value.

func (*Workload) SetEnvironment

func (s *Workload) SetEnvironment(v string) *Workload

SetEnvironment sets the Environment field's value.

func (*Workload) SetImprovementStatus

func (s *Workload) SetImprovementStatus(v string) *Workload

SetImprovementStatus sets the ImprovementStatus field's value.

func (*Workload) SetIndustry

func (s *Workload) SetIndustry(v string) *Workload

SetIndustry sets the Industry field's value.

func (*Workload) SetIndustryType

func (s *Workload) SetIndustryType(v string) *Workload

SetIndustryType sets the IndustryType field's value.

func (*Workload) SetIsReviewOwnerUpdateAcknowledged

func (s *Workload) SetIsReviewOwnerUpdateAcknowledged(v bool) *Workload

SetIsReviewOwnerUpdateAcknowledged sets the IsReviewOwnerUpdateAcknowledged field's value.

func (*Workload) SetLenses

func (s *Workload) SetLenses(v []*string) *Workload

SetLenses sets the Lenses field's value.

func (*Workload) SetNonAwsRegions

func (s *Workload) SetNonAwsRegions(v []*string) *Workload

SetNonAwsRegions sets the NonAwsRegions field's value.

func (*Workload) SetNotes

func (s *Workload) SetNotes(v string) *Workload

SetNotes sets the Notes field's value.

func (*Workload) SetOwner

func (s *Workload) SetOwner(v string) *Workload

SetOwner sets the Owner field's value.

func (*Workload) SetPillarPriorities

func (s *Workload) SetPillarPriorities(v []*string) *Workload

SetPillarPriorities sets the PillarPriorities field's value.

func (*Workload) SetReviewOwner

func (s *Workload) SetReviewOwner(v string) *Workload

SetReviewOwner sets the ReviewOwner field's value.

func (*Workload) SetReviewRestrictionDate

func (s *Workload) SetReviewRestrictionDate(v time.Time) *Workload

SetReviewRestrictionDate sets the ReviewRestrictionDate field's value.

func (*Workload) SetRiskCounts

func (s *Workload) SetRiskCounts(v map[string]*int64) *Workload

SetRiskCounts sets the RiskCounts field's value.

func (*Workload) SetShareInvitationId

func (s *Workload) SetShareInvitationId(v string) *Workload

SetShareInvitationId sets the ShareInvitationId field's value.

func (*Workload) SetTags added in v1.37.23

func (s *Workload) SetTags(v map[string]*string) *Workload

SetTags sets the Tags field's value.

func (*Workload) SetUpdatedAt

func (s *Workload) SetUpdatedAt(v time.Time) *Workload

SetUpdatedAt sets the UpdatedAt field's value.

func (*Workload) SetWorkloadArn

func (s *Workload) SetWorkloadArn(v string) *Workload

SetWorkloadArn sets the WorkloadArn field's value.

func (*Workload) SetWorkloadId

func (s *Workload) SetWorkloadId(v string) *Workload

SetWorkloadId sets the WorkloadId field's value.

func (*Workload) SetWorkloadName

func (s *Workload) SetWorkloadName(v string) *Workload

SetWorkloadName sets the WorkloadName field's value.

func (Workload) String

func (s Workload) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type WorkloadDiscoveryConfig added in v1.44.132

type WorkloadDiscoveryConfig struct {

	// Discovery integration status in respect to Trusted Advisor for the workload.
	TrustedAdvisorIntegrationStatus *string `type:"string" enum:"TrustedAdvisorIntegrationStatus"`

	// The mode to use for identifying resources associated with the workload.
	//
	// You can specify WORKLOAD_METADATA, APP_REGISTRY, or both.
	WorkloadResourceDefinition []*string `type:"list" enum:"DefinitionType"`
	// contains filtered or unexported fields
}

Discovery configuration associated to the workload.

func (WorkloadDiscoveryConfig) GoString added in v1.44.132

func (s WorkloadDiscoveryConfig) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*WorkloadDiscoveryConfig) SetTrustedAdvisorIntegrationStatus added in v1.44.132

func (s *WorkloadDiscoveryConfig) SetTrustedAdvisorIntegrationStatus(v string) *WorkloadDiscoveryConfig

SetTrustedAdvisorIntegrationStatus sets the TrustedAdvisorIntegrationStatus field's value.

func (*WorkloadDiscoveryConfig) SetWorkloadResourceDefinition added in v1.44.256

func (s *WorkloadDiscoveryConfig) SetWorkloadResourceDefinition(v []*string) *WorkloadDiscoveryConfig

SetWorkloadResourceDefinition sets the WorkloadResourceDefinition field's value.

func (WorkloadDiscoveryConfig) String added in v1.44.132

func (s WorkloadDiscoveryConfig) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type WorkloadShare

type WorkloadShare struct {

	// Permission granted on a workload share.
	PermissionType *string `type:"string" enum:"PermissionType"`

	// The ID associated with the workload share.
	ShareId *string `type:"string"`

	// An Amazon Web Services account ID.
	SharedBy *string `type:"string"`

	// The Amazon Web Services account ID, IAM role, organization ID, or organizational
	// unit (OU) ID with which the workload is shared.
	SharedWith *string `min:"12" type:"string"`

	// The status of a workload share.
	Status *string `type:"string" enum:"ShareStatus"`

	// The ID assigned to the workload. This ID is unique within an Amazon Web Services
	// Region.
	WorkloadId *string `type:"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 `min:"3" type:"string"`
	// contains filtered or unexported fields
}

A workload share return object.

func (WorkloadShare) GoString

func (s WorkloadShare) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*WorkloadShare) SetPermissionType

func (s *WorkloadShare) SetPermissionType(v string) *WorkloadShare

SetPermissionType sets the PermissionType field's value.

func (*WorkloadShare) SetShareId

func (s *WorkloadShare) SetShareId(v string) *WorkloadShare

SetShareId sets the ShareId field's value.

func (*WorkloadShare) SetSharedBy

func (s *WorkloadShare) SetSharedBy(v string) *WorkloadShare

SetSharedBy sets the SharedBy field's value.

func (*WorkloadShare) SetSharedWith

func (s *WorkloadShare) SetSharedWith(v string) *WorkloadShare

SetSharedWith sets the SharedWith field's value.

func (*WorkloadShare) SetStatus

func (s *WorkloadShare) SetStatus(v string) *WorkloadShare

SetStatus sets the Status field's value.

func (*WorkloadShare) SetWorkloadId

func (s *WorkloadShare) SetWorkloadId(v string) *WorkloadShare

SetWorkloadId sets the WorkloadId field's value.

func (*WorkloadShare) SetWorkloadName

func (s *WorkloadShare) SetWorkloadName(v string) *WorkloadShare

SetWorkloadName sets the WorkloadName field's value.

func (WorkloadShare) String

func (s WorkloadShare) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type WorkloadShareSummary

type WorkloadShareSummary struct {

	// Permission granted on a workload share.
	PermissionType *string `type:"string" enum:"PermissionType"`

	// The ID associated with the workload share.
	ShareId *string `type:"string"`

	// The Amazon Web Services account ID, IAM role, organization ID, or organizational
	// unit (OU) ID with which the workload is shared.
	SharedWith *string `min:"12" type:"string"`

	// The status of a workload share.
	Status *string `type:"string" enum:"ShareStatus"`

	// Optional message to compliment the Status field.
	StatusMessage *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

A workload share summary return object.

func (WorkloadShareSummary) GoString

func (s WorkloadShareSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*WorkloadShareSummary) SetPermissionType

func (s *WorkloadShareSummary) SetPermissionType(v string) *WorkloadShareSummary

SetPermissionType sets the PermissionType field's value.

func (*WorkloadShareSummary) SetShareId

SetShareId sets the ShareId field's value.

func (*WorkloadShareSummary) SetSharedWith

func (s *WorkloadShareSummary) SetSharedWith(v string) *WorkloadShareSummary

SetSharedWith sets the SharedWith field's value.

func (*WorkloadShareSummary) SetStatus

SetStatus sets the Status field's value.

func (*WorkloadShareSummary) SetStatusMessage added in v1.44.46

func (s *WorkloadShareSummary) SetStatusMessage(v string) *WorkloadShareSummary

SetStatusMessage sets the StatusMessage field's value.

func (WorkloadShareSummary) String

func (s WorkloadShareSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type WorkloadSummary

type WorkloadSummary struct {

	// The improvement status for a workload.
	ImprovementStatus *string `type:"string" enum:"WorkloadImprovementStatus"`

	// The list of lenses associated with the workload. Each lens is identified
	// by its LensSummary$LensAlias.
	Lenses []*string `type:"list"`

	// An Amazon Web Services account ID.
	Owner *string `type:"string"`

	// A map from risk names to the count of how many questions have that rating.
	RiskCounts map[string]*int64 `type:"map"`

	// The date and time recorded.
	UpdatedAt *time.Time `type:"timestamp"`

	// The ARN for the workload.
	WorkloadArn *string `type:"string"`

	// The ID assigned to the workload. This ID is unique within an Amazon Web Services
	// Region.
	WorkloadId *string `type:"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 `min:"3" type:"string"`
	// contains filtered or unexported fields
}

A workload summary return object.

func (WorkloadSummary) GoString

func (s WorkloadSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*WorkloadSummary) SetImprovementStatus

func (s *WorkloadSummary) SetImprovementStatus(v string) *WorkloadSummary

SetImprovementStatus sets the ImprovementStatus field's value.

func (*WorkloadSummary) SetLenses

func (s *WorkloadSummary) SetLenses(v []*string) *WorkloadSummary

SetLenses sets the Lenses field's value.

func (*WorkloadSummary) SetOwner

func (s *WorkloadSummary) SetOwner(v string) *WorkloadSummary

SetOwner sets the Owner field's value.

func (*WorkloadSummary) SetRiskCounts

func (s *WorkloadSummary) SetRiskCounts(v map[string]*int64) *WorkloadSummary

SetRiskCounts sets the RiskCounts field's value.

func (*WorkloadSummary) SetUpdatedAt

func (s *WorkloadSummary) SetUpdatedAt(v time.Time) *WorkloadSummary

SetUpdatedAt sets the UpdatedAt field's value.

func (*WorkloadSummary) SetWorkloadArn

func (s *WorkloadSummary) SetWorkloadArn(v string) *WorkloadSummary

SetWorkloadArn sets the WorkloadArn field's value.

func (*WorkloadSummary) SetWorkloadId

func (s *WorkloadSummary) SetWorkloadId(v string) *WorkloadSummary

SetWorkloadId sets the WorkloadId field's value.

func (*WorkloadSummary) SetWorkloadName

func (s *WorkloadSummary) SetWorkloadName(v string) *WorkloadSummary

SetWorkloadName sets the WorkloadName field's value.

func (WorkloadSummary) String

func (s WorkloadSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

Directories

Path Synopsis
Package wellarchitectediface provides an interface to enable mocking the AWS Well-Architected Tool service client for testing your code.
Package wellarchitectediface provides an interface to enable mocking the AWS Well-Architected Tool service client for testing your code.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL