wellarchitected

package module
v1.30.0 Latest Latest
Warning

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

Go to latest
Published: Apr 16, 2024 License: Apache-2.0 Imports: 41 Imported by: 8

Documentation

Overview

Package wellarchitected provides the API client, operations, and parameter types for AWS Well-Architected Tool.

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) .

Index

Constants

View Source
const ServiceAPIVersion = "2020-03-31"
View Source
const ServiceID = "WellArchitected"

Variables

This section is empty.

Functions

func NewDefaultEndpointResolver

func NewDefaultEndpointResolver() *internalendpoints.Resolver

NewDefaultEndpointResolver constructs a new service endpoint resolver

func WithAPIOptions added in v1.0.0

func WithAPIOptions(optFns ...func(*middleware.Stack) error) func(*Options)

WithAPIOptions returns a functional option for setting the Client's APIOptions option.

func WithEndpointResolver deprecated

func WithEndpointResolver(v EndpointResolver) func(*Options)

Deprecated: EndpointResolver and WithEndpointResolver. Providing a value for this field will likely prevent you from using any endpoint-related service features released after the introduction of EndpointResolverV2 and BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom endpoint, set the client option BaseEndpoint instead.

func WithEndpointResolverV2 added in v1.22.0

func WithEndpointResolverV2(v EndpointResolverV2) func(*Options)

WithEndpointResolverV2 returns a functional option for setting the Client's EndpointResolverV2 option.

func WithSigV4SigningName added in v1.26.2

func WithSigV4SigningName(name string) func(*Options)

WithSigV4SigningName applies an override to the authentication workflow to use the given signing name for SigV4-authenticated operations.

This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing name from both auth scheme resolution and endpoint resolution.

func WithSigV4SigningRegion added in v1.26.2

func WithSigV4SigningRegion(region string) func(*Options)

WithSigV4SigningRegion applies an override to the authentication workflow to use the given signing region for SigV4-authenticated operations.

This is an advanced setting. The value here is FINAL, taking precedence over the resolved signing region from both auth scheme resolution and endpoint resolution.

Types

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 .
	//
	// This member is required.
	LensAliases []string

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

Input to associate lens reviews.

type AssociateLensesOutput

type AssociateLensesOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type AssociateProfilesInput added in v1.21.0

type AssociateProfilesInput struct {

	// The list of profile ARNs to associate with the workload.
	//
	// This member is required.
	ProfileArns []string

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

type AssociateProfilesOutput added in v1.21.0

type AssociateProfilesOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type AuthResolverParameters added in v1.26.2

type AuthResolverParameters struct {
	// The name of the operation being invoked.
	Operation string

	// The region in which the operation is being invoked.
	Region string
}

AuthResolverParameters contains the set of inputs necessary for auth scheme resolution.

type AuthSchemeResolver added in v1.26.2

type AuthSchemeResolver interface {
	ResolveAuthSchemes(context.Context, *AuthResolverParameters) ([]*smithyauth.Option, error)
}

AuthSchemeResolver returns a set of possible authentication options for an operation.

type Client

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

Client provides the API client to make operations call for AWS Well-Architected Tool.

func New

func New(options Options, optFns ...func(*Options)) *Client

New returns an initialized Client based on the functional options. Provide additional functional options to further configure the behavior of the client, such as changing the client's endpoint or adding custom middleware behavior.

func NewFromConfig

func NewFromConfig(cfg aws.Config, optFns ...func(*Options)) *Client

NewFromConfig returns a new client from the provided config.

func (*Client) AssociateLenses

func (c *Client) AssociateLenses(ctx context.Context, params *AssociateLensesInput, optFns ...func(*Options)) (*AssociateLensesOutput, error)

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.

func (*Client) AssociateProfiles added in v1.21.0

func (c *Client) AssociateProfiles(ctx context.Context, params *AssociateProfilesInput, optFns ...func(*Options)) (*AssociateProfilesOutput, error)

Associate a profile with a workload.

func (*Client) CreateLensShare added in v1.9.0

func (c *Client) CreateLensShare(ctx context.Context, params *CreateLensShareInput, optFns ...func(*Options)) (*CreateLensShareOutput, error)

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.

func (*Client) CreateLensVersion added in v1.9.0

func (c *Client) CreateLensVersion(ctx context.Context, params *CreateLensVersionInput, optFns ...func(*Options)) (*CreateLensVersionOutput, error)

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.

func (*Client) CreateMilestone

func (c *Client) CreateMilestone(ctx context.Context, params *CreateMilestoneInput, optFns ...func(*Options)) (*CreateMilestoneOutput, error)

Create a milestone for an existing workload.

func (*Client) CreateProfile added in v1.21.0

func (c *Client) CreateProfile(ctx context.Context, params *CreateProfileInput, optFns ...func(*Options)) (*CreateProfileOutput, error)

Create a profile.

func (*Client) CreateProfileShare added in v1.21.0

func (c *Client) CreateProfileShare(ctx context.Context, params *CreateProfileShareInput, optFns ...func(*Options)) (*CreateProfileShareOutput, error)

Create a profile share.

func (*Client) CreateReviewTemplate added in v1.23.0

func (c *Client) CreateReviewTemplate(ctx context.Context, params *CreateReviewTemplateInput, optFns ...func(*Options)) (*CreateReviewTemplateOutput, error)

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

func (*Client) CreateTemplateShare added in v1.23.0

func (c *Client) CreateTemplateShare(ctx context.Context, params *CreateTemplateShareInput, optFns ...func(*Options)) (*CreateTemplateShareOutput, error)

Create a review template share. The owner of a review template can share it with other Amazon Web Services accounts, users, an organization, and organizational units (OUs) in the same Amazon Web Services Region. Shared access to a review template is not removed until the review template share invitation is deleted. If you share a review template with an organization or OU, all accounts in the organization or OU are granted access to the review template. Disclaimer By sharing your review template with other Amazon Web Services accounts, you acknowledge that Amazon Web Services will make your review template available to those other accounts.

func (*Client) CreateWorkload

func (c *Client) CreateWorkload(ctx context.Context, params *CreateWorkloadInput, optFns ...func(*Options)) (*CreateWorkloadOutput, error)

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. When creating a workload using a review template, you must have the following IAM permissions:

  • wellarchitected:GetReviewTemplate
  • wellarchitected:GetReviewTemplateAnswer
  • wellarchitected:ListReviewTemplateAnswers
  • wellarchitected:GetReviewTemplateLensReview

func (*Client) CreateWorkloadShare

func (c *Client) CreateWorkloadShare(ctx context.Context, params *CreateWorkloadShareInput, optFns ...func(*Options)) (*CreateWorkloadShareOutput, error)

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.

func (*Client) DeleteLens added in v1.9.0

func (c *Client) DeleteLens(ctx context.Context, params *DeleteLensInput, optFns ...func(*Options)) (*DeleteLensOutput, error)

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.

func (*Client) DeleteLensShare added in v1.9.0

func (c *Client) DeleteLensShare(ctx context.Context, params *DeleteLensShareInput, optFns ...func(*Options)) (*DeleteLensShareOutput, error)

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.

func (*Client) DeleteProfile added in v1.21.0

func (c *Client) DeleteProfile(ctx context.Context, params *DeleteProfileInput, optFns ...func(*Options)) (*DeleteProfileOutput, error)

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

func (*Client) DeleteProfileShare added in v1.21.0

func (c *Client) DeleteProfileShare(ctx context.Context, params *DeleteProfileShareInput, optFns ...func(*Options)) (*DeleteProfileShareOutput, error)

Delete a profile share.

func (*Client) DeleteReviewTemplate added in v1.23.0

func (c *Client) DeleteReviewTemplate(ctx context.Context, params *DeleteReviewTemplateInput, optFns ...func(*Options)) (*DeleteReviewTemplateOutput, error)

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

func (*Client) DeleteTemplateShare added in v1.23.0

func (c *Client) DeleteTemplateShare(ctx context.Context, params *DeleteTemplateShareInput, optFns ...func(*Options)) (*DeleteTemplateShareOutput, error)

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

func (*Client) DeleteWorkload

func (c *Client) DeleteWorkload(ctx context.Context, params *DeleteWorkloadInput, optFns ...func(*Options)) (*DeleteWorkloadOutput, error)

Delete an existing workload.

func (*Client) DeleteWorkloadShare

func (c *Client) DeleteWorkloadShare(ctx context.Context, params *DeleteWorkloadShareInput, optFns ...func(*Options)) (*DeleteWorkloadShareOutput, error)

Delete a workload share.

func (*Client) DisassociateLenses

func (c *Client) DisassociateLenses(ctx context.Context, params *DisassociateLensesInput, optFns ...func(*Options)) (*DisassociateLensesOutput, error)

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.

func (*Client) DisassociateProfiles added in v1.21.0

func (c *Client) DisassociateProfiles(ctx context.Context, params *DisassociateProfilesInput, optFns ...func(*Options)) (*DisassociateProfilesOutput, error)

Disassociate a profile from a workload.

func (*Client) ExportLens added in v1.9.0

func (c *Client) ExportLens(ctx context.Context, params *ExportLensInput, optFns ...func(*Options)) (*ExportLensOutput, error)

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.

func (*Client) GetAnswer

func (c *Client) GetAnswer(ctx context.Context, params *GetAnswerInput, optFns ...func(*Options)) (*GetAnswerOutput, error)

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

func (*Client) GetConsolidatedReport added in v1.19.0

func (c *Client) GetConsolidatedReport(ctx context.Context, params *GetConsolidatedReportInput, optFns ...func(*Options)) (*GetConsolidatedReportOutput, error)

Get a consolidated report of your workloads. You can optionally choose to include workloads that have been shared with you.

func (*Client) GetGlobalSettings added in v1.30.0

func (c *Client) GetGlobalSettings(ctx context.Context, params *GetGlobalSettingsInput, optFns ...func(*Options)) (*GetGlobalSettingsOutput, error)

Global settings for all workloads.

func (*Client) GetLens added in v1.9.0

func (c *Client) GetLens(ctx context.Context, params *GetLensInput, optFns ...func(*Options)) (*GetLensOutput, error)

Get an existing lens.

func (*Client) GetLensReview

func (c *Client) GetLensReview(ctx context.Context, params *GetLensReviewInput, optFns ...func(*Options)) (*GetLensReviewOutput, error)

Get lens review.

func (*Client) GetLensReviewReport

func (c *Client) GetLensReviewReport(ctx context.Context, params *GetLensReviewReportInput, optFns ...func(*Options)) (*GetLensReviewReportOutput, error)

Get lens review report.

func (*Client) GetLensVersionDifference

func (c *Client) GetLensVersionDifference(ctx context.Context, params *GetLensVersionDifferenceInput, optFns ...func(*Options)) (*GetLensVersionDifferenceOutput, error)

Get lens version differences.

func (*Client) GetMilestone

func (c *Client) GetMilestone(ctx context.Context, params *GetMilestoneInput, optFns ...func(*Options)) (*GetMilestoneOutput, error)

Get a milestone for an existing workload.

func (*Client) GetProfile added in v1.21.0

func (c *Client) GetProfile(ctx context.Context, params *GetProfileInput, optFns ...func(*Options)) (*GetProfileOutput, error)

Get profile information.

func (*Client) GetProfileTemplate added in v1.21.0

func (c *Client) GetProfileTemplate(ctx context.Context, params *GetProfileTemplateInput, optFns ...func(*Options)) (*GetProfileTemplateOutput, error)

Get profile template.

func (*Client) GetReviewTemplate added in v1.23.0

func (c *Client) GetReviewTemplate(ctx context.Context, params *GetReviewTemplateInput, optFns ...func(*Options)) (*GetReviewTemplateOutput, error)

Get review template.

func (*Client) GetReviewTemplateAnswer added in v1.23.0

func (c *Client) GetReviewTemplateAnswer(ctx context.Context, params *GetReviewTemplateAnswerInput, optFns ...func(*Options)) (*GetReviewTemplateAnswerOutput, error)

Get review template answer.

func (*Client) GetReviewTemplateLensReview added in v1.23.0

func (c *Client) GetReviewTemplateLensReview(ctx context.Context, params *GetReviewTemplateLensReviewInput, optFns ...func(*Options)) (*GetReviewTemplateLensReviewOutput, error)

Get a lens review associated with a review template.

func (*Client) GetWorkload

func (c *Client) GetWorkload(ctx context.Context, params *GetWorkloadInput, optFns ...func(*Options)) (*GetWorkloadOutput, error)

Get an existing workload.

func (*Client) ImportLens added in v1.9.0

func (c *Client) ImportLens(ctx context.Context, params *ImportLensInput, optFns ...func(*Options)) (*ImportLensOutput, error)

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.

func (*Client) ListAnswers

func (c *Client) ListAnswers(ctx context.Context, params *ListAnswersInput, optFns ...func(*Options)) (*ListAnswersOutput, error)

List of answers for a particular workload and lens.

func (*Client) ListCheckDetails added in v1.17.0

func (c *Client) ListCheckDetails(ctx context.Context, params *ListCheckDetailsInput, optFns ...func(*Options)) (*ListCheckDetailsOutput, error)

List of Trusted Advisor check details by account related to the workload.

func (*Client) ListCheckSummaries added in v1.17.0

func (c *Client) ListCheckSummaries(ctx context.Context, params *ListCheckSummariesInput, optFns ...func(*Options)) (*ListCheckSummariesOutput, error)

List of Trusted Advisor checks summarized for all accounts related to the workload.

func (*Client) ListLensReviewImprovements

func (c *Client) ListLensReviewImprovements(ctx context.Context, params *ListLensReviewImprovementsInput, optFns ...func(*Options)) (*ListLensReviewImprovementsOutput, error)

List the improvements of a particular lens review.

func (*Client) ListLensReviews

func (c *Client) ListLensReviews(ctx context.Context, params *ListLensReviewsInput, optFns ...func(*Options)) (*ListLensReviewsOutput, error)

List lens reviews for a particular workload.

func (*Client) ListLensShares added in v1.9.0

func (c *Client) ListLensShares(ctx context.Context, params *ListLensSharesInput, optFns ...func(*Options)) (*ListLensSharesOutput, error)

List the lens shares associated with the lens.

func (*Client) ListLenses

func (c *Client) ListLenses(ctx context.Context, params *ListLensesInput, optFns ...func(*Options)) (*ListLensesOutput, error)

List the available lenses.

func (*Client) ListMilestones

func (c *Client) ListMilestones(ctx context.Context, params *ListMilestonesInput, optFns ...func(*Options)) (*ListMilestonesOutput, error)

List all milestones for an existing workload.

func (*Client) ListNotifications

func (c *Client) ListNotifications(ctx context.Context, params *ListNotificationsInput, optFns ...func(*Options)) (*ListNotificationsOutput, error)

List lens notifications.

func (*Client) ListProfileNotifications added in v1.21.0

func (c *Client) ListProfileNotifications(ctx context.Context, params *ListProfileNotificationsInput, optFns ...func(*Options)) (*ListProfileNotificationsOutput, error)

List profile notifications.

func (*Client) ListProfileShares added in v1.21.0

func (c *Client) ListProfileShares(ctx context.Context, params *ListProfileSharesInput, optFns ...func(*Options)) (*ListProfileSharesOutput, error)

List profile shares.

func (*Client) ListProfiles added in v1.21.0

func (c *Client) ListProfiles(ctx context.Context, params *ListProfilesInput, optFns ...func(*Options)) (*ListProfilesOutput, error)

List profiles.

func (*Client) ListReviewTemplateAnswers added in v1.23.0

func (c *Client) ListReviewTemplateAnswers(ctx context.Context, params *ListReviewTemplateAnswersInput, optFns ...func(*Options)) (*ListReviewTemplateAnswersOutput, error)

List the answers of a review template.

func (*Client) ListReviewTemplates added in v1.23.0

func (c *Client) ListReviewTemplates(ctx context.Context, params *ListReviewTemplatesInput, optFns ...func(*Options)) (*ListReviewTemplatesOutput, error)

List review templates.

func (*Client) ListShareInvitations

func (c *Client) ListShareInvitations(ctx context.Context, params *ListShareInvitationsInput, optFns ...func(*Options)) (*ListShareInvitationsOutput, error)

List the share invitations. WorkloadNamePrefix , LensNamePrefix , ProfileNamePrefix , and TemplateNamePrefix are mutually exclusive. Use the parameter that matches your ShareResourceType .

func (*Client) ListTagsForResource added in v1.2.0

func (c *Client) ListTagsForResource(ctx context.Context, params *ListTagsForResourceInput, optFns ...func(*Options)) (*ListTagsForResourceOutput, error)

List the tags for a resource. The WorkloadArn parameter can be a workload ARN, a custom lens ARN, a profile ARN, or review template ARN.

func (*Client) ListTemplateShares added in v1.23.0

func (c *Client) ListTemplateShares(ctx context.Context, params *ListTemplateSharesInput, optFns ...func(*Options)) (*ListTemplateSharesOutput, error)

List review template shares.

func (*Client) ListWorkloadShares

func (c *Client) ListWorkloadShares(ctx context.Context, params *ListWorkloadSharesInput, optFns ...func(*Options)) (*ListWorkloadSharesOutput, error)

List the workload shares associated with the workload.

func (*Client) ListWorkloads

func (c *Client) ListWorkloads(ctx context.Context, params *ListWorkloadsInput, optFns ...func(*Options)) (*ListWorkloadsOutput, error)

Paginated list of workloads.

func (*Client) Options added in v1.27.0

func (c *Client) Options() Options

Options returns a copy of the client configuration.

Callers SHOULD NOT perform mutations on any inner structures within client config. Config overrides should instead be made on a per-operation basis through functional options.

func (*Client) TagResource added in v1.2.0

func (c *Client) TagResource(ctx context.Context, params *TagResourceInput, optFns ...func(*Options)) (*TagResourceOutput, error)

Adds one or more tags to the specified resource. The WorkloadArn parameter can be a workload ARN, a custom lens ARN, a profile ARN, or review template ARN.

func (*Client) UntagResource added in v1.2.0

func (c *Client) UntagResource(ctx context.Context, params *UntagResourceInput, optFns ...func(*Options)) (*UntagResourceOutput, error)

Deletes specified tags from a resource. The WorkloadArn parameter can be a workload ARN, a custom lens ARN, a profile ARN, or review template ARN. To specify multiple tags, use separate tagKeys parameters, for example: DELETE /tags/WorkloadArn?tagKeys=key1&tagKeys=key2

func (*Client) UpdateAnswer

func (c *Client) UpdateAnswer(ctx context.Context, params *UpdateAnswerInput, optFns ...func(*Options)) (*UpdateAnswerOutput, error)

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

func (*Client) UpdateGlobalSettings added in v1.16.0

func (c *Client) UpdateGlobalSettings(ctx context.Context, params *UpdateGlobalSettingsInput, optFns ...func(*Options)) (*UpdateGlobalSettingsOutput, error)

Update whether the Amazon Web Services account is opted into organization sharing and discovery integration features.

func (*Client) UpdateIntegration added in v1.30.0

func (c *Client) UpdateIntegration(ctx context.Context, params *UpdateIntegrationInput, optFns ...func(*Options)) (*UpdateIntegrationOutput, error)

Update integration features.

func (*Client) UpdateLensReview

func (c *Client) UpdateLensReview(ctx context.Context, params *UpdateLensReviewInput, optFns ...func(*Options)) (*UpdateLensReviewOutput, error)

Update lens review for a particular workload.

func (*Client) UpdateProfile added in v1.21.0

func (c *Client) UpdateProfile(ctx context.Context, params *UpdateProfileInput, optFns ...func(*Options)) (*UpdateProfileOutput, error)

Update a profile.

func (*Client) UpdateReviewTemplate added in v1.23.0

func (c *Client) UpdateReviewTemplate(ctx context.Context, params *UpdateReviewTemplateInput, optFns ...func(*Options)) (*UpdateReviewTemplateOutput, error)

Update a review template.

func (*Client) UpdateReviewTemplateAnswer added in v1.23.0

func (c *Client) UpdateReviewTemplateAnswer(ctx context.Context, params *UpdateReviewTemplateAnswerInput, optFns ...func(*Options)) (*UpdateReviewTemplateAnswerOutput, error)

Update a review template answer.

func (*Client) UpdateReviewTemplateLensReview added in v1.23.0

func (c *Client) UpdateReviewTemplateLensReview(ctx context.Context, params *UpdateReviewTemplateLensReviewInput, optFns ...func(*Options)) (*UpdateReviewTemplateLensReviewOutput, error)

Update a lens review associated with a review template.

func (*Client) UpdateShareInvitation

func (c *Client) UpdateShareInvitation(ctx context.Context, params *UpdateShareInvitationInput, optFns ...func(*Options)) (*UpdateShareInvitationOutput, error)

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.

func (*Client) UpdateWorkload

func (c *Client) UpdateWorkload(ctx context.Context, params *UpdateWorkloadInput, optFns ...func(*Options)) (*UpdateWorkloadOutput, error)

Update an existing workload.

func (*Client) UpdateWorkloadShare

func (c *Client) UpdateWorkloadShare(ctx context.Context, params *UpdateWorkloadShareInput, optFns ...func(*Options)) (*UpdateWorkloadShareOutput, error)

Update a workload share.

func (*Client) UpgradeLensReview

func (c *Client) UpgradeLensReview(ctx context.Context, params *UpgradeLensReviewInput, optFns ...func(*Options)) (*UpgradeLensReviewOutput, error)

Upgrade lens review for a particular workload.

func (*Client) UpgradeProfileVersion added in v1.21.0

func (c *Client) UpgradeProfileVersion(ctx context.Context, params *UpgradeProfileVersionInput, optFns ...func(*Options)) (*UpgradeProfileVersionOutput, error)

Upgrade a profile.

func (*Client) UpgradeReviewTemplateLensReview added in v1.23.0

func (c *Client) UpgradeReviewTemplateLensReview(ctx context.Context, params *UpgradeReviewTemplateLensReviewInput, optFns ...func(*Options)) (*UpgradeReviewTemplateLensReviewOutput, error)

Upgrade the lens review of a review template.

type CreateLensShareInput added in v1.9.0

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.
	//
	// This member is required.
	ClientRequestToken *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 .
	//
	// This member is required.
	LensAlias *string

	// The Amazon Web Services account ID, organization ID, or organizational unit
	// (OU) ID with which the workload, lens, profile, or review template is shared.
	//
	// This member is required.
	SharedWith *string
	// contains filtered or unexported fields
}

type CreateLensShareOutput added in v1.9.0

type CreateLensShareOutput struct {

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateLensVersionInput added in v1.9.0

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.
	//
	// This member is required.
	ClientRequestToken *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 .
	//
	// This member is required.
	LensAlias *string

	// The version of the lens being created.
	//
	// This member is required.
	LensVersion *string

	// Set to true if this new major lens version.
	IsMajorVersion *bool
	// contains filtered or unexported fields
}

type CreateLensVersionOutput added in v1.9.0

type CreateLensVersionOutput struct {

	// The ARN for the lens.
	LensArn *string

	// The version of the lens.
	LensVersion *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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.
	//
	// This member is required.
	ClientRequestToken *string

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

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

Input for milestone creation.

type CreateMilestoneOutput

type CreateMilestoneOutput struct {

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

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Output of a create milestone call.

type CreateProfileInput added in v1.21.0

type CreateProfileInput 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.
	//
	// This member is required.
	ClientRequestToken *string

	// The profile description.
	//
	// This member is required.
	ProfileDescription *string

	// Name of the profile.
	//
	// This member is required.
	ProfileName *string

	// The profile questions.
	//
	// This member is required.
	ProfileQuestions []types.ProfileQuestionUpdate

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

type CreateProfileOutput added in v1.21.0

type CreateProfileOutput struct {

	// The profile ARN.
	ProfileArn *string

	// Version of the profile.
	ProfileVersion *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateProfileShareInput added in v1.21.0

type CreateProfileShareInput 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.
	//
	// This member is required.
	ClientRequestToken *string

	// The profile ARN.
	//
	// This member is required.
	ProfileArn *string

	// The Amazon Web Services account ID, organization ID, or organizational unit
	// (OU) ID with which the workload, lens, profile, or review template is shared.
	//
	// This member is required.
	SharedWith *string
	// contains filtered or unexported fields
}

type CreateProfileShareOutput added in v1.21.0

type CreateProfileShareOutput struct {

	// The profile ARN.
	ProfileArn *string

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateReviewTemplateInput added in v1.23.0

type CreateReviewTemplateInput 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.
	//
	// This member is required.
	ClientRequestToken *string

	// The review template description.
	//
	// This member is required.
	Description *string

	// Lenses applied to the review template.
	//
	// This member is required.
	Lenses []string

	// Name of the review template.
	//
	// This member is required.
	TemplateName *string

	// The notes associated with the workload. For a review template, these are the
	// notes that will be associated with the workload when the template is applied.
	Notes *string

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

type CreateReviewTemplateOutput added in v1.23.0

type CreateReviewTemplateOutput struct {

	// The review template ARN.
	TemplateArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateTemplateShareInput added in v1.23.0

type CreateTemplateShareInput 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.
	//
	// This member is required.
	ClientRequestToken *string

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

	// The review template ARN.
	//
	// This member is required.
	TemplateArn *string
	// contains filtered or unexported fields
}

type CreateTemplateShareOutput added in v1.23.0

type CreateTemplateShareOutput struct {

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

	// The review template ARN.
	TemplateArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type CreateWorkloadInput

type CreateWorkloadInput 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.
	//
	// This member is required.
	ClientRequestToken *string

	// The description for the workload.
	//
	// This member is required.
	Description *string

	// The environment for the workload.
	//
	// This member is required.
	Environment types.WorkloadEnvironment

	// The list of lenses associated with the workload. Each lens is identified by its
	// LensSummary$LensAlias . If a review template that specifies lenses is applied to
	// the workload, those lenses are applied to the workload in addition to these
	// lenses.
	//
	// This member is required.
	Lenses []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.
	//
	// This member is required.
	WorkloadName *string

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

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

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

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

	// Well-Architected discovery configuration settings associated to the workload.
	DiscoveryConfig *types.WorkloadDiscoveryConfig

	// The industry for the workload.
	Industry *string

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

	// Jira configuration settings when creating a workload.
	JiraConfiguration *types.WorkloadJiraConfigurationInput

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

	// The notes associated with the workload. For a review template, these are the
	// notes that will be associated with the workload when the template is applied.
	Notes *string

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

	// The list of profile ARNs associated with the workload.
	ProfileArns []string

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

	// The list of review template ARNs to associate with the workload.
	ReviewTemplateArns []string

	// The tags to be associated with the workload.
	Tags map[string]string
	// contains filtered or unexported fields
}

Input for workload creation.

type CreateWorkloadOutput

type CreateWorkloadOutput struct {

	// The ARN for the workload.
	WorkloadArn *string

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Output of a create workload call.

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.
	//
	// This member is required.
	ClientRequestToken *string

	// Permission granted on a share request.
	//
	// This member is required.
	PermissionType types.PermissionType

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

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

Input for Create Workload Share

type CreateWorkloadShareOutput

type CreateWorkloadShareOutput struct {

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

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Input for Create Workload Share

type DeleteLensInput added in v1.9.0

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.
	//
	// This member is required.
	ClientRequestToken *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 .
	//
	// This member is required.
	LensAlias *string

	// The status of the lens to be deleted.
	//
	// This member is required.
	LensStatus types.LensStatusType
	// contains filtered or unexported fields
}

type DeleteLensOutput added in v1.9.0

type DeleteLensOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteLensShareInput added in v1.9.0

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.
	//
	// This member is required.
	ClientRequestToken *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 .
	//
	// This member is required.
	LensAlias *string

	// The ID associated with the share.
	//
	// This member is required.
	ShareId *string
	// contains filtered or unexported fields
}

type DeleteLensShareOutput added in v1.9.0

type DeleteLensShareOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteProfileInput added in v1.21.0

type DeleteProfileInput 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.
	//
	// This member is required.
	ClientRequestToken *string

	// The profile ARN.
	//
	// This member is required.
	ProfileArn *string
	// contains filtered or unexported fields
}

type DeleteProfileOutput added in v1.21.0

type DeleteProfileOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteProfileShareInput added in v1.21.0

type DeleteProfileShareInput 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.
	//
	// This member is required.
	ClientRequestToken *string

	// The profile ARN.
	//
	// This member is required.
	ProfileArn *string

	// The ID associated with the share.
	//
	// This member is required.
	ShareId *string
	// contains filtered or unexported fields
}

type DeleteProfileShareOutput added in v1.21.0

type DeleteProfileShareOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteReviewTemplateInput added in v1.23.0

type DeleteReviewTemplateInput 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.
	//
	// This member is required.
	ClientRequestToken *string

	// The review template ARN.
	//
	// This member is required.
	TemplateArn *string
	// contains filtered or unexported fields
}

type DeleteReviewTemplateOutput added in v1.23.0

type DeleteReviewTemplateOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DeleteTemplateShareInput added in v1.23.0

type DeleteTemplateShareInput 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.
	//
	// This member is required.
	ClientRequestToken *string

	// The ID associated with the share.
	//
	// This member is required.
	ShareId *string

	// The review template ARN.
	//
	// This member is required.
	TemplateArn *string
	// contains filtered or unexported fields
}

type DeleteTemplateShareOutput added in v1.23.0

type DeleteTemplateShareOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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.
	//
	// This member is required.
	ClientRequestToken *string

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

Input for workload deletion.

type DeleteWorkloadOutput

type DeleteWorkloadOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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.
	//
	// This member is required.
	ClientRequestToken *string

	// The ID associated with the share.
	//
	// This member is required.
	ShareId *string

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

Input for Delete Workload Share

type DeleteWorkloadShareOutput

type DeleteWorkloadShareOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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 .
	//
	// This member is required.
	LensAliases []string

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

Input to disassociate lens reviews.

type DisassociateLensesOutput

type DisassociateLensesOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type DisassociateProfilesInput added in v1.21.0

type DisassociateProfilesInput struct {

	// The list of profile ARNs to disassociate from the workload.
	//
	// This member is required.
	ProfileArns []string

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

type DisassociateProfilesOutput added in v1.21.0

type DisassociateProfilesOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type EndpointParameters added in v1.22.0

type EndpointParameters struct {
	// The AWS region used to dispatch the request.
	//
	// Parameter is
	// required.
	//
	// AWS::Region
	Region *string

	// When true, use the dual-stack endpoint. If the configured endpoint does not
	// support dual-stack, dispatching the request MAY return an error.
	//
	// Defaults to
	// false if no value is provided.
	//
	// AWS::UseDualStack
	UseDualStack *bool

	// When true, send this request to the FIPS-compliant regional endpoint. If the
	// configured endpoint does not have a FIPS compliant endpoint, dispatching the
	// request will return an error.
	//
	// Defaults to false if no value is
	// provided.
	//
	// AWS::UseFIPS
	UseFIPS *bool

	// Override the endpoint used to send this request
	//
	// Parameter is
	// required.
	//
	// SDK::Endpoint
	Endpoint *string
}

EndpointParameters provides the parameters that influence how endpoints are resolved.

func (EndpointParameters) ValidateRequired added in v1.22.0

func (p EndpointParameters) ValidateRequired() error

ValidateRequired validates required parameters are set.

func (EndpointParameters) WithDefaults added in v1.22.0

func (p EndpointParameters) WithDefaults() EndpointParameters

WithDefaults returns a shallow copy of EndpointParameterswith default values applied to members where applicable.

type EndpointResolver

type EndpointResolver interface {
	ResolveEndpoint(region string, options EndpointResolverOptions) (aws.Endpoint, error)
}

EndpointResolver interface for resolving service endpoints.

func EndpointResolverFromURL added in v1.1.0

func EndpointResolverFromURL(url string, optFns ...func(*aws.Endpoint)) EndpointResolver

EndpointResolverFromURL returns an EndpointResolver configured using the provided endpoint url. By default, the resolved endpoint resolver uses the client region as signing region, and the endpoint source is set to EndpointSourceCustom.You can provide functional options to configure endpoint values for the resolved endpoint.

type EndpointResolverFunc

type EndpointResolverFunc func(region string, options EndpointResolverOptions) (aws.Endpoint, error)

EndpointResolverFunc is a helper utility that wraps a function so it satisfies the EndpointResolver interface. This is useful when you want to add additional endpoint resolving logic, or stub out specific endpoints with custom values.

func (EndpointResolverFunc) ResolveEndpoint

func (fn EndpointResolverFunc) ResolveEndpoint(region string, options EndpointResolverOptions) (endpoint aws.Endpoint, err error)

type EndpointResolverOptions

type EndpointResolverOptions = internalendpoints.Options

EndpointResolverOptions is the service endpoint resolver options

type EndpointResolverV2 added in v1.22.0

type EndpointResolverV2 interface {
	// ResolveEndpoint attempts to resolve the endpoint with the provided options,
	// returning the endpoint if found. Otherwise an error is returned.
	ResolveEndpoint(ctx context.Context, params EndpointParameters) (
		smithyendpoints.Endpoint, error,
	)
}

EndpointResolverV2 provides the interface for resolving service endpoints.

func NewDefaultEndpointResolverV2 added in v1.22.0

func NewDefaultEndpointResolverV2() EndpointResolverV2

type ExportLensInput added in v1.9.0

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 .
	//
	// This member is required.
	LensAlias *string

	// The lens version to be exported.
	LensVersion *string
	// contains filtered or unexported fields
}

type ExportLensOutput added in v1.9.0

type ExportLensOutput struct {

	// The JSON representation of a lens.
	LensJSON *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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 .
	//
	// This member is required.
	LensAlias *string

	// The ID of the question.
	//
	// This member is required.
	QuestionId *string

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

	// The milestone number. A workload can have a maximum of 100 milestones.
	MilestoneNumber *int32
	// contains filtered or unexported fields
}

Input to get answer.

type GetAnswerOutput

type GetAnswerOutput struct {

	// An answer of the question.
	Answer *types.Answer

	// The alias of the lens. For Amazon Web Services official lenses, this is either
	// the lens alias, such as serverless , or the lens ARN, such as
	// arn:aws:wellarchitected:us-east-1::lens/serverless . Note that some operations
	// (such as ExportLens and CreateLensShare) are not permitted on Amazon Web
	// Services official lenses. For custom lenses, this is the lens ARN, such as
	// arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef
	// . Each lens is identified by its LensSummary$LensAlias .
	LensAlias *string

	// The ARN for the lens.
	LensArn *string

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

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Output of a get answer call.

type GetConsolidatedReportAPIClient added in v1.19.0

type GetConsolidatedReportAPIClient interface {
	GetConsolidatedReport(context.Context, *GetConsolidatedReportInput, ...func(*Options)) (*GetConsolidatedReportOutput, error)
}

GetConsolidatedReportAPIClient is a client that implements the GetConsolidatedReport operation.

type GetConsolidatedReportInput added in v1.19.0

type GetConsolidatedReportInput struct {

	// The format of the consolidated report. For PDF , Base64String is returned. For
	// JSON , Metrics is returned.
	//
	// This member is required.
	Format types.ReportFormat

	// Set to true to have shared resources included in the report.
	IncludeSharedResources *bool

	// The maximum number of results to return for this request.
	MaxResults *int32

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

type GetConsolidatedReportOutput added in v1.19.0

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

	// The metrics that make up the consolidated report. Only returned when JSON
	// format is requested.
	Metrics []types.ConsolidatedReportMetric

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetConsolidatedReportPaginator added in v1.19.0

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

GetConsolidatedReportPaginator is a paginator for GetConsolidatedReport

func NewGetConsolidatedReportPaginator added in v1.19.0

NewGetConsolidatedReportPaginator returns a new GetConsolidatedReportPaginator

func (*GetConsolidatedReportPaginator) HasMorePages added in v1.19.0

func (p *GetConsolidatedReportPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*GetConsolidatedReportPaginator) NextPage added in v1.19.0

NextPage retrieves the next GetConsolidatedReport page.

type GetConsolidatedReportPaginatorOptions added in v1.19.0

type GetConsolidatedReportPaginatorOptions struct {
	// The maximum number of results to return for this request.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

GetConsolidatedReportPaginatorOptions is the paginator options for GetConsolidatedReport

type GetGlobalSettingsInput added in v1.30.0

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

type GetGlobalSettingsOutput added in v1.30.0

type GetGlobalSettingsOutput struct {

	// Discovery integration status.
	DiscoveryIntegrationStatus types.DiscoveryIntegrationStatus

	// Jira configuration status.
	JiraConfiguration *types.AccountJiraConfigurationOutput

	// Amazon Web Services Organizations sharing status.
	OrganizationSharingStatus types.OrganizationSharingStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetLensInput added in v1.9.0

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 .
	//
	// This member is required.
	LensAlias *string

	// The lens version to be retrieved.
	LensVersion *string
	// contains filtered or unexported fields
}

type GetLensOutput added in v1.9.0

type GetLensOutput struct {

	// A lens return object.
	Lens *types.Lens

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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 .
	//
	// This member is required.
	LensAlias *string

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

	// The milestone number. A workload can have a maximum of 100 milestones.
	MilestoneNumber *int32
	// contains filtered or unexported fields
}

Input to get lens review.

type GetLensReviewOutput

type GetLensReviewOutput struct {

	// A lens review of a question.
	LensReview *types.LensReview

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

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Output of a get lens review call.

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 .
	//
	// This member is required.
	LensAlias *string

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

	// The milestone number. A workload can have a maximum of 100 milestones.
	MilestoneNumber *int32
	// contains filtered or unexported fields
}

Input to get lens review report.

type GetLensReviewReportOutput

type GetLensReviewReportOutput struct {

	// A report of a lens review.
	LensReviewReport *types.LensReviewReport

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

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Output of a get lens review report call.

type GetLensVersionDifferenceInput

type GetLensVersionDifferenceInput 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 .
	//
	// This member is required.
	LensAlias *string

	// The base version of the lens.
	BaseLensVersion *string

	// The lens version to target a difference for.
	TargetLensVersion *string
	// contains filtered or unexported fields
}

type GetLensVersionDifferenceOutput

type GetLensVersionDifferenceOutput struct {

	// The base version of the lens.
	BaseLensVersion *string

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

	// The alias of the lens. For Amazon Web Services official lenses, this is either
	// the lens alias, such as serverless , or the lens ARN, such as
	// arn:aws:wellarchitected:us-east-1::lens/serverless . Note that some operations
	// (such as ExportLens and CreateLensShare) are not permitted on Amazon Web
	// Services official lenses. For custom lenses, this is the lens ARN, such as
	// arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef
	// . Each lens is identified by its LensSummary$LensAlias .
	LensAlias *string

	// The ARN for the lens.
	LensArn *string

	// The target lens version for the lens.
	TargetLensVersion *string

	// The differences between the base and latest versions of the lens.
	VersionDifferences *types.VersionDifferences

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetMilestoneInput

type GetMilestoneInput struct {

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

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

Input to get a milestone.

type GetMilestoneOutput

type GetMilestoneOutput struct {

	// A milestone return object.
	Milestone *types.Milestone

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Output of a get milestone call.

type GetProfileInput added in v1.21.0

type GetProfileInput struct {

	// The profile ARN.
	//
	// This member is required.
	ProfileArn *string

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

type GetProfileOutput added in v1.21.0

type GetProfileOutput struct {

	// The profile.
	Profile *types.Profile

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetProfileTemplateInput added in v1.21.0

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

type GetProfileTemplateOutput added in v1.21.0

type GetProfileTemplateOutput struct {

	// The profile template.
	ProfileTemplate *types.ProfileTemplate

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetReviewTemplateAnswerInput added in v1.23.0

type GetReviewTemplateAnswerInput 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 .
	//
	// This member is required.
	LensAlias *string

	// The ID of the question.
	//
	// This member is required.
	QuestionId *string

	// The review template ARN.
	//
	// This member is required.
	TemplateArn *string
	// contains filtered or unexported fields
}

type GetReviewTemplateAnswerOutput added in v1.23.0

type GetReviewTemplateAnswerOutput struct {

	// An answer of the question.
	Answer *types.ReviewTemplateAnswer

	// The alias of the lens. For Amazon Web Services official lenses, this is either
	// the lens alias, such as serverless , or the lens ARN, such as
	// arn:aws:wellarchitected:us-east-1::lens/serverless . Note that some operations
	// (such as ExportLens and CreateLensShare) are not permitted on Amazon Web
	// Services official lenses. For custom lenses, this is the lens ARN, such as
	// arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef
	// . Each lens is identified by its LensSummary$LensAlias .
	LensAlias *string

	// The review template ARN.
	TemplateArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetReviewTemplateInput added in v1.23.0

type GetReviewTemplateInput struct {

	// The review template ARN.
	//
	// This member is required.
	TemplateArn *string
	// contains filtered or unexported fields
}

type GetReviewTemplateLensReviewInput added in v1.23.0

type GetReviewTemplateLensReviewInput 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 .
	//
	// This member is required.
	LensAlias *string

	// The review template ARN.
	//
	// This member is required.
	TemplateArn *string
	// contains filtered or unexported fields
}

type GetReviewTemplateLensReviewOutput added in v1.23.0

type GetReviewTemplateLensReviewOutput struct {

	// A lens review of a question.
	LensReview *types.ReviewTemplateLensReview

	// The review template ARN.
	TemplateArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetReviewTemplateOutput added in v1.23.0

type GetReviewTemplateOutput struct {

	// The review template.
	ReviewTemplate *types.ReviewTemplate

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type GetWorkloadInput

type GetWorkloadInput struct {

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

Input to get a workload.

type GetWorkloadOutput

type GetWorkloadOutput struct {

	// A workload return object.
	Workload *types.Workload

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Output of a get workload call.

type HTTPClient

type HTTPClient interface {
	Do(*http.Request) (*http.Response, error)
}

type HTTPSignerV4

type HTTPSignerV4 interface {
	SignHTTP(ctx context.Context, credentials aws.Credentials, r *http.Request, payloadHash string, service string, region string, signingTime time.Time, optFns ...func(*v4.SignerOptions)) error
}

type IdempotencyTokenProvider

type IdempotencyTokenProvider interface {
	GetIdempotencyToken() (string, error)
}

IdempotencyTokenProvider interface for providing idempotency token

type ImportLensInput added in v1.9.0

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.
	//
	// This member is required.
	ClientRequestToken *string

	// The JSON representation of a lens.
	//
	// This member is required.
	JSONString *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

	// Tags to associate to a lens.
	Tags map[string]string
	// contains filtered or unexported fields
}

type ImportLensOutput added in v1.9.0

type ImportLensOutput struct {

	// The ARN for the lens that was created or updated.
	LensArn *string

	// The status of the imported lens.
	Status types.ImportLensStatus

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListAnswersAPIClient

type ListAnswersAPIClient interface {
	ListAnswers(context.Context, *ListAnswersInput, ...func(*Options)) (*ListAnswersOutput, error)
}

ListAnswersAPIClient is a client that implements the ListAnswers operation.

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 .
	//
	// This member is required.
	LensAlias *string

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

	// The maximum number of results to return for this request.
	MaxResults *int32

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

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

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

	// The priority of the question.
	QuestionPriority types.QuestionPriority
	// contains filtered or unexported fields
}

Input to list answers.

type ListAnswersOutput

type ListAnswersOutput struct {

	// List of answer summaries of lens review in a workload.
	AnswerSummaries []types.AnswerSummary

	// The alias of the lens. For Amazon Web Services official lenses, this is either
	// the lens alias, such as serverless , or the lens ARN, such as
	// arn:aws:wellarchitected:us-east-1::lens/serverless . Note that some operations
	// (such as ExportLens and CreateLensShare) are not permitted on Amazon Web
	// Services official lenses. For custom lenses, this is the lens ARN, such as
	// arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef
	// . Each lens is identified by its LensSummary$LensAlias .
	LensAlias *string

	// The ARN for the lens.
	LensArn *string

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

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

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Output of a list answers call.

type ListAnswersPaginator

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

ListAnswersPaginator is a paginator for ListAnswers

func NewListAnswersPaginator

func NewListAnswersPaginator(client ListAnswersAPIClient, params *ListAnswersInput, optFns ...func(*ListAnswersPaginatorOptions)) *ListAnswersPaginator

NewListAnswersPaginator returns a new ListAnswersPaginator

func (*ListAnswersPaginator) HasMorePages

func (p *ListAnswersPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListAnswersPaginator) NextPage

func (p *ListAnswersPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListAnswersOutput, error)

NextPage retrieves the next ListAnswers page.

type ListAnswersPaginatorOptions

type ListAnswersPaginatorOptions struct {
	// The maximum number of results to return for this request.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListAnswersPaginatorOptions is the paginator options for ListAnswers

type ListCheckDetailsAPIClient added in v1.17.0

type ListCheckDetailsAPIClient interface {
	ListCheckDetails(context.Context, *ListCheckDetailsInput, ...func(*Options)) (*ListCheckDetailsOutput, error)
}

ListCheckDetailsAPIClient is a client that implements the ListCheckDetails operation.

type ListCheckDetailsInput added in v1.17.0

type ListCheckDetailsInput struct {

	// The ID of a choice.
	//
	// This member is required.
	ChoiceId *string

	// Well-Architected Lens ARN.
	//
	// This member is required.
	LensArn *string

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

	// The ID of the question.
	//
	// This member is required.
	QuestionId *string

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

	// The maximum number of results to return for this request.
	MaxResults *int32

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

type ListCheckDetailsOutput added in v1.17.0

type ListCheckDetailsOutput struct {

	// The details about the Trusted Advisor checks related to the Well-Architected
	// best practice.
	CheckDetails []types.CheckDetail

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListCheckDetailsPaginator added in v1.17.0

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

ListCheckDetailsPaginator is a paginator for ListCheckDetails

func NewListCheckDetailsPaginator added in v1.17.0

func NewListCheckDetailsPaginator(client ListCheckDetailsAPIClient, params *ListCheckDetailsInput, optFns ...func(*ListCheckDetailsPaginatorOptions)) *ListCheckDetailsPaginator

NewListCheckDetailsPaginator returns a new ListCheckDetailsPaginator

func (*ListCheckDetailsPaginator) HasMorePages added in v1.17.0

func (p *ListCheckDetailsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListCheckDetailsPaginator) NextPage added in v1.17.0

func (p *ListCheckDetailsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListCheckDetailsOutput, error)

NextPage retrieves the next ListCheckDetails page.

type ListCheckDetailsPaginatorOptions added in v1.17.0

type ListCheckDetailsPaginatorOptions struct {
	// The maximum number of results to return for this request.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListCheckDetailsPaginatorOptions is the paginator options for ListCheckDetails

type ListCheckSummariesAPIClient added in v1.17.0

type ListCheckSummariesAPIClient interface {
	ListCheckSummaries(context.Context, *ListCheckSummariesInput, ...func(*Options)) (*ListCheckSummariesOutput, error)
}

ListCheckSummariesAPIClient is a client that implements the ListCheckSummaries operation.

type ListCheckSummariesInput added in v1.17.0

type ListCheckSummariesInput struct {

	// The ID of a choice.
	//
	// This member is required.
	ChoiceId *string

	// Well-Architected Lens ARN.
	//
	// This member is required.
	LensArn *string

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

	// The ID of the question.
	//
	// This member is required.
	QuestionId *string

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

	// The maximum number of results to return for this request.
	MaxResults *int32

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

type ListCheckSummariesOutput added in v1.17.0

type ListCheckSummariesOutput struct {

	// List of Trusted Advisor summaries related to the Well-Architected best practice.
	CheckSummaries []types.CheckSummary

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListCheckSummariesPaginator added in v1.17.0

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

ListCheckSummariesPaginator is a paginator for ListCheckSummaries

func NewListCheckSummariesPaginator added in v1.17.0

func NewListCheckSummariesPaginator(client ListCheckSummariesAPIClient, params *ListCheckSummariesInput, optFns ...func(*ListCheckSummariesPaginatorOptions)) *ListCheckSummariesPaginator

NewListCheckSummariesPaginator returns a new ListCheckSummariesPaginator

func (*ListCheckSummariesPaginator) HasMorePages added in v1.17.0

func (p *ListCheckSummariesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListCheckSummariesPaginator) NextPage added in v1.17.0

func (p *ListCheckSummariesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListCheckSummariesOutput, error)

NextPage retrieves the next ListCheckSummaries page.

type ListCheckSummariesPaginatorOptions added in v1.17.0

type ListCheckSummariesPaginatorOptions struct {
	// The maximum number of results to return for this request.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListCheckSummariesPaginatorOptions is the paginator options for ListCheckSummaries

type ListLensReviewImprovementsAPIClient

type ListLensReviewImprovementsAPIClient interface {
	ListLensReviewImprovements(context.Context, *ListLensReviewImprovementsInput, ...func(*Options)) (*ListLensReviewImprovementsOutput, error)
}

ListLensReviewImprovementsAPIClient is a client that implements the ListLensReviewImprovements operation.

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 .
	//
	// This member is required.
	LensAlias *string

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

	// The maximum number of results to return for this request.
	MaxResults *int32

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

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

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

	// The priority of the question.
	QuestionPriority types.QuestionPriority
	// contains filtered or unexported fields
}

Input to list lens review improvements.

type ListLensReviewImprovementsOutput

type ListLensReviewImprovementsOutput struct {

	// List of improvement summaries of lens review in a workload.
	ImprovementSummaries []types.ImprovementSummary

	// The alias of the lens. For Amazon Web Services official lenses, this is either
	// the lens alias, such as serverless , or the lens ARN, such as
	// arn:aws:wellarchitected:us-east-1::lens/serverless . Note that some operations
	// (such as ExportLens and CreateLensShare) are not permitted on Amazon Web
	// Services official lenses. For custom lenses, this is the lens ARN, such as
	// arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef
	// . Each lens is identified by its LensSummary$LensAlias .
	LensAlias *string

	// The ARN for the lens.
	LensArn *string

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

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

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Output of a list lens review improvements call.

type ListLensReviewImprovementsPaginator

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

ListLensReviewImprovementsPaginator is a paginator for ListLensReviewImprovements

func NewListLensReviewImprovementsPaginator

NewListLensReviewImprovementsPaginator returns a new ListLensReviewImprovementsPaginator

func (*ListLensReviewImprovementsPaginator) HasMorePages

func (p *ListLensReviewImprovementsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListLensReviewImprovementsPaginator) NextPage

NextPage retrieves the next ListLensReviewImprovements page.

type ListLensReviewImprovementsPaginatorOptions

type ListLensReviewImprovementsPaginatorOptions struct {
	// The maximum number of results to return for this request.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListLensReviewImprovementsPaginatorOptions is the paginator options for ListLensReviewImprovements

type ListLensReviewsAPIClient

type ListLensReviewsAPIClient interface {
	ListLensReviews(context.Context, *ListLensReviewsInput, ...func(*Options)) (*ListLensReviewsOutput, error)
}

ListLensReviewsAPIClient is a client that implements the ListLensReviews operation.

type ListLensReviewsInput

type ListLensReviewsInput struct {

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

	// The maximum number of results to return for this request.
	MaxResults *int32

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

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

Input to list lens reviews.

type ListLensReviewsOutput

type ListLensReviewsOutput struct {

	// List of lens summaries of lens reviews of a workload.
	LensReviewSummaries []types.LensReviewSummary

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

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

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Output of a list lens reviews call.

type ListLensReviewsPaginator

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

ListLensReviewsPaginator is a paginator for ListLensReviews

func NewListLensReviewsPaginator

func NewListLensReviewsPaginator(client ListLensReviewsAPIClient, params *ListLensReviewsInput, optFns ...func(*ListLensReviewsPaginatorOptions)) *ListLensReviewsPaginator

NewListLensReviewsPaginator returns a new ListLensReviewsPaginator

func (*ListLensReviewsPaginator) HasMorePages

func (p *ListLensReviewsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListLensReviewsPaginator) NextPage

func (p *ListLensReviewsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListLensReviewsOutput, error)

NextPage retrieves the next ListLensReviews page.

type ListLensReviewsPaginatorOptions

type ListLensReviewsPaginatorOptions struct {
	// The maximum number of results to return for this request.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListLensReviewsPaginatorOptions is the paginator options for ListLensReviews

type ListLensSharesAPIClient added in v1.9.0

type ListLensSharesAPIClient interface {
	ListLensShares(context.Context, *ListLensSharesInput, ...func(*Options)) (*ListLensSharesOutput, error)
}

ListLensSharesAPIClient is a client that implements the ListLensShares operation.

type ListLensSharesInput added in v1.9.0

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 .
	//
	// This member is required.
	LensAlias *string

	// The maximum number of results to return for this request.
	MaxResults *int32

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

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

	// The status of the share request.
	Status types.ShareStatus
	// contains filtered or unexported fields
}

type ListLensSharesOutput added in v1.9.0

type ListLensSharesOutput struct {

	// A list of lens share summaries.
	LensShareSummaries []types.LensShareSummary

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListLensSharesPaginator added in v1.9.0

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

ListLensSharesPaginator is a paginator for ListLensShares

func NewListLensSharesPaginator added in v1.9.0

func NewListLensSharesPaginator(client ListLensSharesAPIClient, params *ListLensSharesInput, optFns ...func(*ListLensSharesPaginatorOptions)) *ListLensSharesPaginator

NewListLensSharesPaginator returns a new ListLensSharesPaginator

func (*ListLensSharesPaginator) HasMorePages added in v1.9.0

func (p *ListLensSharesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListLensSharesPaginator) NextPage added in v1.9.0

func (p *ListLensSharesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListLensSharesOutput, error)

NextPage retrieves the next ListLensShares page.

type ListLensSharesPaginatorOptions added in v1.9.0

type ListLensSharesPaginatorOptions struct {
	// The maximum number of results to return for this request.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListLensSharesPaginatorOptions is the paginator options for ListLensShares

type ListLensesAPIClient

type ListLensesAPIClient interface {
	ListLenses(context.Context, *ListLensesInput, ...func(*Options)) (*ListLensesOutput, error)
}

ListLensesAPIClient is a client that implements the ListLenses operation.

type ListLensesInput

type ListLensesInput struct {

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

	// The status of lenses to be returned.
	LensStatus types.LensStatusType

	// The type of lenses to be returned.
	LensType types.LensType

	// The maximum number of results to return for this request.
	MaxResults *int32

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

Input to list lenses.

type ListLensesOutput

type ListLensesOutput struct {

	// List of lens summaries of available lenses.
	LensSummaries []types.LensSummary

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Output of a list lenses call.

type ListLensesPaginator

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

ListLensesPaginator is a paginator for ListLenses

func NewListLensesPaginator

func NewListLensesPaginator(client ListLensesAPIClient, params *ListLensesInput, optFns ...func(*ListLensesPaginatorOptions)) *ListLensesPaginator

NewListLensesPaginator returns a new ListLensesPaginator

func (*ListLensesPaginator) HasMorePages

func (p *ListLensesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListLensesPaginator) NextPage

func (p *ListLensesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListLensesOutput, error)

NextPage retrieves the next ListLenses page.

type ListLensesPaginatorOptions

type ListLensesPaginatorOptions struct {
	// The maximum number of results to return for this request.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListLensesPaginatorOptions is the paginator options for ListLenses

type ListMilestonesAPIClient

type ListMilestonesAPIClient interface {
	ListMilestones(context.Context, *ListMilestonesInput, ...func(*Options)) (*ListMilestonesOutput, error)
}

ListMilestonesAPIClient is a client that implements the ListMilestones operation.

type ListMilestonesInput

type ListMilestonesInput struct {

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

	// The maximum number of results to return for this request.
	MaxResults *int32

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

Input to list all milestones for a workload.

type ListMilestonesOutput

type ListMilestonesOutput struct {

	// A list of milestone summaries.
	MilestoneSummaries []types.MilestoneSummary

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

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Output of a list milestones call.

type ListMilestonesPaginator

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

ListMilestonesPaginator is a paginator for ListMilestones

func NewListMilestonesPaginator

func NewListMilestonesPaginator(client ListMilestonesAPIClient, params *ListMilestonesInput, optFns ...func(*ListMilestonesPaginatorOptions)) *ListMilestonesPaginator

NewListMilestonesPaginator returns a new ListMilestonesPaginator

func (*ListMilestonesPaginator) HasMorePages

func (p *ListMilestonesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListMilestonesPaginator) NextPage

func (p *ListMilestonesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListMilestonesOutput, error)

NextPage retrieves the next ListMilestones page.

type ListMilestonesPaginatorOptions

type ListMilestonesPaginatorOptions struct {
	// The maximum number of results to return for this request.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListMilestonesPaginatorOptions is the paginator options for ListMilestones

type ListNotificationsAPIClient

type ListNotificationsAPIClient interface {
	ListNotifications(context.Context, *ListNotificationsInput, ...func(*Options)) (*ListNotificationsOutput, error)
}

ListNotificationsAPIClient is a client that implements the ListNotifications operation.

type ListNotificationsInput

type ListNotificationsInput struct {

	// The maximum number of results to return for this request.
	MaxResults *int32

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

	// The ARN for the related resource for the notification. Only one of WorkloadID
	// or ResourceARN should be specified.
	ResourceArn *string

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

type ListNotificationsOutput

type ListNotificationsOutput struct {

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

	// List of lens notification summaries in a workload.
	NotificationSummaries []types.NotificationSummary

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListNotificationsPaginator

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

ListNotificationsPaginator is a paginator for ListNotifications

func NewListNotificationsPaginator

func NewListNotificationsPaginator(client ListNotificationsAPIClient, params *ListNotificationsInput, optFns ...func(*ListNotificationsPaginatorOptions)) *ListNotificationsPaginator

NewListNotificationsPaginator returns a new ListNotificationsPaginator

func (*ListNotificationsPaginator) HasMorePages

func (p *ListNotificationsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListNotificationsPaginator) NextPage

func (p *ListNotificationsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListNotificationsOutput, error)

NextPage retrieves the next ListNotifications page.

type ListNotificationsPaginatorOptions

type ListNotificationsPaginatorOptions struct {
	// The maximum number of results to return for this request.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListNotificationsPaginatorOptions is the paginator options for ListNotifications

type ListProfileNotificationsAPIClient added in v1.21.0

type ListProfileNotificationsAPIClient interface {
	ListProfileNotifications(context.Context, *ListProfileNotificationsInput, ...func(*Options)) (*ListProfileNotificationsOutput, error)
}

ListProfileNotificationsAPIClient is a client that implements the ListProfileNotifications operation.

type ListProfileNotificationsInput added in v1.21.0

type ListProfileNotificationsInput struct {

	// The maximum number of results to return for this request.
	MaxResults *int32

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

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

type ListProfileNotificationsOutput added in v1.21.0

type ListProfileNotificationsOutput struct {

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

	// Notification summaries.
	NotificationSummaries []types.ProfileNotificationSummary

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListProfileNotificationsPaginator added in v1.21.0

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

ListProfileNotificationsPaginator is a paginator for ListProfileNotifications

func NewListProfileNotificationsPaginator added in v1.21.0

NewListProfileNotificationsPaginator returns a new ListProfileNotificationsPaginator

func (*ListProfileNotificationsPaginator) HasMorePages added in v1.21.0

func (p *ListProfileNotificationsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListProfileNotificationsPaginator) NextPage added in v1.21.0

NextPage retrieves the next ListProfileNotifications page.

type ListProfileNotificationsPaginatorOptions added in v1.21.0

type ListProfileNotificationsPaginatorOptions struct {
	// The maximum number of results to return for this request.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListProfileNotificationsPaginatorOptions is the paginator options for ListProfileNotifications

type ListProfileSharesAPIClient added in v1.21.0

type ListProfileSharesAPIClient interface {
	ListProfileShares(context.Context, *ListProfileSharesInput, ...func(*Options)) (*ListProfileSharesOutput, error)
}

ListProfileSharesAPIClient is a client that implements the ListProfileShares operation.

type ListProfileSharesInput added in v1.21.0

type ListProfileSharesInput struct {

	// The profile ARN.
	//
	// This member is required.
	ProfileArn *string

	// The maximum number of results to return for this request.
	MaxResults *int32

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

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

	// The status of the share request.
	Status types.ShareStatus
	// contains filtered or unexported fields
}

type ListProfileSharesOutput added in v1.21.0

type ListProfileSharesOutput struct {

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

	// Profile share summaries.
	ProfileShareSummaries []types.ProfileShareSummary

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListProfileSharesPaginator added in v1.21.0

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

ListProfileSharesPaginator is a paginator for ListProfileShares

func NewListProfileSharesPaginator added in v1.21.0

func NewListProfileSharesPaginator(client ListProfileSharesAPIClient, params *ListProfileSharesInput, optFns ...func(*ListProfileSharesPaginatorOptions)) *ListProfileSharesPaginator

NewListProfileSharesPaginator returns a new ListProfileSharesPaginator

func (*ListProfileSharesPaginator) HasMorePages added in v1.21.0

func (p *ListProfileSharesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListProfileSharesPaginator) NextPage added in v1.21.0

func (p *ListProfileSharesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListProfileSharesOutput, error)

NextPage retrieves the next ListProfileShares page.

type ListProfileSharesPaginatorOptions added in v1.21.0

type ListProfileSharesPaginatorOptions struct {
	// The maximum number of results to return for this request.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListProfileSharesPaginatorOptions is the paginator options for ListProfileShares

type ListProfilesAPIClient added in v1.21.0

type ListProfilesAPIClient interface {
	ListProfiles(context.Context, *ListProfilesInput, ...func(*Options)) (*ListProfilesOutput, error)
}

ListProfilesAPIClient is a client that implements the ListProfiles operation.

type ListProfilesInput added in v1.21.0

type ListProfilesInput struct {

	// The maximum number of results to return for this request.
	MaxResults *int32

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

	// An optional string added to the beginning of each profile name returned in the
	// results.
	ProfileNamePrefix *string

	// Profile owner type.
	ProfileOwnerType types.ProfileOwnerType
	// contains filtered or unexported fields
}

type ListProfilesOutput added in v1.21.0

type ListProfilesOutput struct {

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

	// Profile summaries.
	ProfileSummaries []types.ProfileSummary

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListProfilesPaginator added in v1.21.0

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

ListProfilesPaginator is a paginator for ListProfiles

func NewListProfilesPaginator added in v1.21.0

func NewListProfilesPaginator(client ListProfilesAPIClient, params *ListProfilesInput, optFns ...func(*ListProfilesPaginatorOptions)) *ListProfilesPaginator

NewListProfilesPaginator returns a new ListProfilesPaginator

func (*ListProfilesPaginator) HasMorePages added in v1.21.0

func (p *ListProfilesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListProfilesPaginator) NextPage added in v1.21.0

func (p *ListProfilesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListProfilesOutput, error)

NextPage retrieves the next ListProfiles page.

type ListProfilesPaginatorOptions added in v1.21.0

type ListProfilesPaginatorOptions struct {
	// The maximum number of results to return for this request.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListProfilesPaginatorOptions is the paginator options for ListProfiles

type ListReviewTemplateAnswersAPIClient added in v1.23.0

type ListReviewTemplateAnswersAPIClient interface {
	ListReviewTemplateAnswers(context.Context, *ListReviewTemplateAnswersInput, ...func(*Options)) (*ListReviewTemplateAnswersOutput, error)
}

ListReviewTemplateAnswersAPIClient is a client that implements the ListReviewTemplateAnswers operation.

type ListReviewTemplateAnswersInput added in v1.23.0

type ListReviewTemplateAnswersInput 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 .
	//
	// This member is required.
	LensAlias *string

	// The ARN of the review template.
	//
	// This member is required.
	TemplateArn *string

	// The maximum number of results to return for this request.
	MaxResults *int32

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

	// The ID used to identify a pillar, for example, security . A pillar is identified
	// by its PillarReviewSummary$PillarId .
	PillarId *string
	// contains filtered or unexported fields
}

type ListReviewTemplateAnswersOutput added in v1.23.0

type ListReviewTemplateAnswersOutput struct {

	// List of answer summaries of a lens review in a review template.
	AnswerSummaries []types.ReviewTemplateAnswerSummary

	// The alias of the lens. For Amazon Web Services official lenses, this is either
	// the lens alias, such as serverless , or the lens ARN, such as
	// arn:aws:wellarchitected:us-east-1::lens/serverless . Note that some operations
	// (such as ExportLens and CreateLensShare) are not permitted on Amazon Web
	// Services official lenses. For custom lenses, this is the lens ARN, such as
	// arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef
	// . Each lens is identified by its LensSummary$LensAlias .
	LensAlias *string

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

	// The ARN of the review template.
	TemplateArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListReviewTemplateAnswersPaginator added in v1.23.0

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

ListReviewTemplateAnswersPaginator is a paginator for ListReviewTemplateAnswers

func NewListReviewTemplateAnswersPaginator added in v1.23.0

NewListReviewTemplateAnswersPaginator returns a new ListReviewTemplateAnswersPaginator

func (*ListReviewTemplateAnswersPaginator) HasMorePages added in v1.23.0

func (p *ListReviewTemplateAnswersPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListReviewTemplateAnswersPaginator) NextPage added in v1.23.0

NextPage retrieves the next ListReviewTemplateAnswers page.

type ListReviewTemplateAnswersPaginatorOptions added in v1.23.0

type ListReviewTemplateAnswersPaginatorOptions struct {
	// The maximum number of results to return for this request.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListReviewTemplateAnswersPaginatorOptions is the paginator options for ListReviewTemplateAnswers

type ListReviewTemplatesAPIClient added in v1.23.0

type ListReviewTemplatesAPIClient interface {
	ListReviewTemplates(context.Context, *ListReviewTemplatesInput, ...func(*Options)) (*ListReviewTemplatesOutput, error)
}

ListReviewTemplatesAPIClient is a client that implements the ListReviewTemplates operation.

type ListReviewTemplatesInput added in v1.23.0

type ListReviewTemplatesInput struct {

	// The maximum number of results to return for this request.
	MaxResults *int32

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

type ListReviewTemplatesOutput added in v1.23.0

type ListReviewTemplatesOutput struct {

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

	// List of review templates.
	ReviewTemplates []types.ReviewTemplateSummary

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListReviewTemplatesPaginator added in v1.23.0

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

ListReviewTemplatesPaginator is a paginator for ListReviewTemplates

func NewListReviewTemplatesPaginator added in v1.23.0

func NewListReviewTemplatesPaginator(client ListReviewTemplatesAPIClient, params *ListReviewTemplatesInput, optFns ...func(*ListReviewTemplatesPaginatorOptions)) *ListReviewTemplatesPaginator

NewListReviewTemplatesPaginator returns a new ListReviewTemplatesPaginator

func (*ListReviewTemplatesPaginator) HasMorePages added in v1.23.0

func (p *ListReviewTemplatesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListReviewTemplatesPaginator) NextPage added in v1.23.0

func (p *ListReviewTemplatesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListReviewTemplatesOutput, error)

NextPage retrieves the next ListReviewTemplates page.

type ListReviewTemplatesPaginatorOptions added in v1.23.0

type ListReviewTemplatesPaginatorOptions struct {
	// The maximum number of results to return for this request.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListReviewTemplatesPaginatorOptions is the paginator options for ListReviewTemplates

type ListShareInvitationsAPIClient

type ListShareInvitationsAPIClient interface {
	ListShareInvitations(context.Context, *ListShareInvitationsInput, ...func(*Options)) (*ListShareInvitationsOutput, error)
}

ListShareInvitationsAPIClient is a client that implements the ListShareInvitations operation.

type ListShareInvitationsInput

type ListShareInvitationsInput struct {

	// An optional string added to the beginning of each lens name returned in the
	// results.
	LensNamePrefix *string

	// The maximum number of results to return for this request.
	MaxResults *int32

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

	// An optional string added to the beginning of each profile name returned in the
	// results.
	ProfileNamePrefix *string

	// The type of share invitations to be returned.
	ShareResourceType types.ShareResourceType

	// An optional string added to the beginning of each review template name returned
	// in the results.
	TemplateNamePrefix *string

	// An optional string added to the beginning of each workload name returned in the
	// results.
	WorkloadNamePrefix *string
	// contains filtered or unexported fields
}

Input for List Share Invitations

type ListShareInvitationsOutput

type ListShareInvitationsOutput struct {

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

	// List of share invitation summaries in a workload.
	ShareInvitationSummaries []types.ShareInvitationSummary

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Input for List Share Invitations

type ListShareInvitationsPaginator

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

ListShareInvitationsPaginator is a paginator for ListShareInvitations

func NewListShareInvitationsPaginator

NewListShareInvitationsPaginator returns a new ListShareInvitationsPaginator

func (*ListShareInvitationsPaginator) HasMorePages

func (p *ListShareInvitationsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListShareInvitationsPaginator) NextPage

NextPage retrieves the next ListShareInvitations page.

type ListShareInvitationsPaginatorOptions

type ListShareInvitationsPaginatorOptions struct {
	// The maximum number of results to return for this request.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListShareInvitationsPaginatorOptions is the paginator options for ListShareInvitations

type ListTagsForResourceInput added in v1.2.0

type ListTagsForResourceInput struct {

	// The ARN for the workload.
	//
	// This member is required.
	WorkloadArn *string
	// contains filtered or unexported fields
}

type ListTagsForResourceOutput added in v1.2.0

type ListTagsForResourceOutput struct {

	// The tags for the resource.
	Tags map[string]string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListTemplateSharesAPIClient added in v1.23.0

type ListTemplateSharesAPIClient interface {
	ListTemplateShares(context.Context, *ListTemplateSharesInput, ...func(*Options)) (*ListTemplateSharesOutput, error)
}

ListTemplateSharesAPIClient is a client that implements the ListTemplateShares operation.

type ListTemplateSharesInput added in v1.23.0

type ListTemplateSharesInput struct {

	// The review template ARN.
	//
	// This member is required.
	TemplateArn *string

	// The maximum number of results to return for this request.
	MaxResults *int32

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

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

	// The status of the share request.
	Status types.ShareStatus
	// contains filtered or unexported fields
}

type ListTemplateSharesOutput added in v1.23.0

type ListTemplateSharesOutput struct {

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

	// The review template ARN.
	TemplateArn *string

	// A review template share summary return object.
	TemplateShareSummaries []types.TemplateShareSummary

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type ListTemplateSharesPaginator added in v1.23.0

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

ListTemplateSharesPaginator is a paginator for ListTemplateShares

func NewListTemplateSharesPaginator added in v1.23.0

func NewListTemplateSharesPaginator(client ListTemplateSharesAPIClient, params *ListTemplateSharesInput, optFns ...func(*ListTemplateSharesPaginatorOptions)) *ListTemplateSharesPaginator

NewListTemplateSharesPaginator returns a new ListTemplateSharesPaginator

func (*ListTemplateSharesPaginator) HasMorePages added in v1.23.0

func (p *ListTemplateSharesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListTemplateSharesPaginator) NextPage added in v1.23.0

func (p *ListTemplateSharesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListTemplateSharesOutput, error)

NextPage retrieves the next ListTemplateShares page.

type ListTemplateSharesPaginatorOptions added in v1.23.0

type ListTemplateSharesPaginatorOptions struct {
	// The maximum number of results to return for this request.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListTemplateSharesPaginatorOptions is the paginator options for ListTemplateShares

type ListWorkloadSharesAPIClient

type ListWorkloadSharesAPIClient interface {
	ListWorkloadShares(context.Context, *ListWorkloadSharesInput, ...func(*Options)) (*ListWorkloadSharesOutput, error)
}

ListWorkloadSharesAPIClient is a client that implements the ListWorkloadShares operation.

type ListWorkloadSharesInput

type ListWorkloadSharesInput struct {

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

	// The maximum number of results to return for this request.
	MaxResults *int32

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

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

	// The status of the share request.
	Status types.ShareStatus
	// contains filtered or unexported fields
}

Input for List Workload Share

type ListWorkloadSharesOutput

type ListWorkloadSharesOutput struct {

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

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

	// A list of workload share summaries.
	WorkloadShareSummaries []types.WorkloadShareSummary

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Input for List Workload Share

type ListWorkloadSharesPaginator

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

ListWorkloadSharesPaginator is a paginator for ListWorkloadShares

func NewListWorkloadSharesPaginator

func NewListWorkloadSharesPaginator(client ListWorkloadSharesAPIClient, params *ListWorkloadSharesInput, optFns ...func(*ListWorkloadSharesPaginatorOptions)) *ListWorkloadSharesPaginator

NewListWorkloadSharesPaginator returns a new ListWorkloadSharesPaginator

func (*ListWorkloadSharesPaginator) HasMorePages

func (p *ListWorkloadSharesPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListWorkloadSharesPaginator) NextPage

func (p *ListWorkloadSharesPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListWorkloadSharesOutput, error)

NextPage retrieves the next ListWorkloadShares page.

type ListWorkloadSharesPaginatorOptions

type ListWorkloadSharesPaginatorOptions struct {
	// The maximum number of results to return for this request.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListWorkloadSharesPaginatorOptions is the paginator options for ListWorkloadShares

type ListWorkloadsAPIClient

type ListWorkloadsAPIClient interface {
	ListWorkloads(context.Context, *ListWorkloadsInput, ...func(*Options)) (*ListWorkloadsOutput, error)
}

ListWorkloadsAPIClient is a client that implements the ListWorkloads operation.

type ListWorkloadsInput

type ListWorkloadsInput struct {

	// The maximum number of results to return for this request.
	MaxResults *int32

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

	// An optional string added to the beginning of each workload name returned in the
	// results.
	WorkloadNamePrefix *string
	// contains filtered or unexported fields
}

Input to list all workloads.

type ListWorkloadsOutput

type ListWorkloadsOutput struct {

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

	// A list of workload summaries.
	WorkloadSummaries []types.WorkloadSummary

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Output of a list workloads call.

type ListWorkloadsPaginator

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

ListWorkloadsPaginator is a paginator for ListWorkloads

func NewListWorkloadsPaginator

func NewListWorkloadsPaginator(client ListWorkloadsAPIClient, params *ListWorkloadsInput, optFns ...func(*ListWorkloadsPaginatorOptions)) *ListWorkloadsPaginator

NewListWorkloadsPaginator returns a new ListWorkloadsPaginator

func (*ListWorkloadsPaginator) HasMorePages

func (p *ListWorkloadsPaginator) HasMorePages() bool

HasMorePages returns a boolean indicating whether more pages are available

func (*ListWorkloadsPaginator) NextPage

func (p *ListWorkloadsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListWorkloadsOutput, error)

NextPage retrieves the next ListWorkloads page.

type ListWorkloadsPaginatorOptions

type ListWorkloadsPaginatorOptions struct {
	// The maximum number of results to return for this request.
	Limit int32

	// Set to true if pagination should stop if the service returns a pagination token
	// that matches the most recent token provided to the service.
	StopOnDuplicateToken bool
}

ListWorkloadsPaginatorOptions is the paginator options for ListWorkloads

type Options

type Options struct {
	// Set of options to modify how an operation is invoked. These apply to all
	// operations invoked for this client. Use functional options on operation call to
	// modify this list for per operation behavior.
	APIOptions []func(*middleware.Stack) error

	// The optional application specific identifier appended to the User-Agent header.
	AppID string

	// This endpoint will be given as input to an EndpointResolverV2. It is used for
	// providing a custom base endpoint that is subject to modifications by the
	// processing EndpointResolverV2.
	BaseEndpoint *string

	// Configures the events that will be sent to the configured logger.
	ClientLogMode aws.ClientLogMode

	// The credentials object to use when signing requests.
	Credentials aws.CredentialsProvider

	// The configuration DefaultsMode that the SDK should use when constructing the
	// clients initial default settings.
	DefaultsMode aws.DefaultsMode

	// The endpoint options to be used when attempting to resolve an endpoint.
	EndpointOptions EndpointResolverOptions

	// The service endpoint resolver.
	//
	// Deprecated: Deprecated: EndpointResolver and WithEndpointResolver. Providing a
	// value for this field will likely prevent you from using any endpoint-related
	// service features released after the introduction of EndpointResolverV2 and
	// BaseEndpoint. To migrate an EndpointResolver implementation that uses a custom
	// endpoint, set the client option BaseEndpoint instead.
	EndpointResolver EndpointResolver

	// Resolves the endpoint used for a particular service operation. This should be
	// used over the deprecated EndpointResolver.
	EndpointResolverV2 EndpointResolverV2

	// Signature Version 4 (SigV4) Signer
	HTTPSignerV4 HTTPSignerV4

	// Provides idempotency tokens values that will be automatically populated into
	// idempotent API operations.
	IdempotencyTokenProvider IdempotencyTokenProvider

	// The logger writer interface to write logging messages to.
	Logger logging.Logger

	// The region to send requests to. (Required)
	Region string

	// RetryMaxAttempts specifies the maximum number attempts an API client will call
	// an operation that fails with a retryable error. A value of 0 is ignored, and
	// will not be used to configure the API client created default retryer, or modify
	// per operation call's retry max attempts. If specified in an operation call's
	// functional options with a value that is different than the constructed client's
	// Options, the Client's Retryer will be wrapped to use the operation's specific
	// RetryMaxAttempts value.
	RetryMaxAttempts int

	// RetryMode specifies the retry mode the API client will be created with, if
	// Retryer option is not also specified. When creating a new API Clients this
	// member will only be used if the Retryer Options member is nil. This value will
	// be ignored if Retryer is not nil. Currently does not support per operation call
	// overrides, may in the future.
	RetryMode aws.RetryMode

	// Retryer guides how HTTP requests should be retried in case of recoverable
	// failures. When nil the API client will use a default retryer. The kind of
	// default retry created by the API client can be changed with the RetryMode
	// option.
	Retryer aws.Retryer

	// The RuntimeEnvironment configuration, only populated if the DefaultsMode is set
	// to DefaultsModeAuto and is initialized using config.LoadDefaultConfig . You
	// should not populate this structure programmatically, or rely on the values here
	// within your applications.
	RuntimeEnvironment aws.RuntimeEnvironment

	// The HTTP client to invoke API calls with. Defaults to client's default HTTP
	// implementation if nil.
	HTTPClient HTTPClient

	// The auth scheme resolver which determines how to authenticate for each
	// operation.
	AuthSchemeResolver AuthSchemeResolver

	// The list of auth schemes supported by the client.
	AuthSchemes []smithyhttp.AuthScheme
	// contains filtered or unexported fields
}

func (Options) Copy

func (o Options) Copy() Options

Copy creates a clone where the APIOptions list is deep copied.

func (Options) GetIdentityResolver added in v1.26.2

func (o Options) GetIdentityResolver(schemeID string) smithyauth.IdentityResolver

type ResolveEndpoint

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  EndpointResolverOptions
}

func (*ResolveEndpoint) HandleSerialize

func (*ResolveEndpoint) ID

func (*ResolveEndpoint) ID() string

type TagResourceInput added in v1.2.0

type TagResourceInput struct {

	// The tags for the resource.
	//
	// This member is required.
	Tags map[string]string

	// The ARN for the workload.
	//
	// This member is required.
	WorkloadArn *string
	// contains filtered or unexported fields
}

type TagResourceOutput added in v1.2.0

type TagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UntagResourceInput added in v1.2.0

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.
	//
	// This member is required.
	TagKeys []string

	// The ARN for the workload.
	//
	// This member is required.
	WorkloadArn *string
	// contains filtered or unexported fields
}

type UntagResourceOutput added in v1.2.0

type UntagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateAnswerInput

type UpdateAnswerInput 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 .
	//
	// This member is required.
	LensAlias *string

	// The ID of the question.
	//
	// This member is required.
	QuestionId *string

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

	// 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]types.ChoiceUpdate

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

	// The notes associated with the workload. For a review template, these are the
	// notes that will be associated with the workload when the template is applied.
	Notes *string

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

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

Input to update answer.

type UpdateAnswerOutput

type UpdateAnswerOutput struct {

	// An answer of the question.
	Answer *types.Answer

	// The alias of the lens. For Amazon Web Services official lenses, this is either
	// the lens alias, such as serverless , or the lens ARN, such as
	// arn:aws:wellarchitected:us-east-1::lens/serverless . Note that some operations
	// (such as ExportLens and CreateLensShare) are not permitted on Amazon Web
	// Services official lenses. For custom lenses, this is the lens ARN, such as
	// arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef
	// . Each lens is identified by its LensSummary$LensAlias .
	LensAlias *string

	// The ARN for the lens.
	LensArn *string

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Output of a update answer call.

type UpdateGlobalSettingsInput added in v1.16.0

type UpdateGlobalSettingsInput struct {

	// The status of discovery support settings.
	DiscoveryIntegrationStatus types.DiscoveryIntegrationStatus

	// The status of Jira integration settings.
	JiraConfiguration *types.AccountJiraConfigurationInput

	// The status of organization sharing settings.
	OrganizationSharingStatus types.OrganizationSharingStatus
	// contains filtered or unexported fields
}

type UpdateGlobalSettingsOutput added in v1.16.0

type UpdateGlobalSettingsOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateIntegrationInput added in v1.30.0

type UpdateIntegrationInput 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.
	//
	// This member is required.
	ClientRequestToken *string

	// Which integrated service to update.
	//
	// This member is required.
	IntegratingService types.IntegratingService

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

type UpdateIntegrationOutput added in v1.30.0

type UpdateIntegrationOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

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 .
	//
	// This member is required.
	LensAlias *string

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

	// Configuration of the Jira integration.
	JiraConfiguration *types.JiraSelectedQuestionConfiguration

	// The notes associated with the workload. For a review template, these are the
	// notes that will be associated with the workload when the template is applied.
	LensNotes *string

	// List of pillar notes of a lens review in a workload. For a review template,
	// these are the notes that will be associated with the workload when the template
	// is applied.
	PillarNotes map[string]string
	// contains filtered or unexported fields
}

Input for update lens review.

type UpdateLensReviewOutput

type UpdateLensReviewOutput struct {

	// A lens review of a question.
	LensReview *types.LensReview

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Output of a update lens review call.

type UpdateProfileInput added in v1.21.0

type UpdateProfileInput struct {

	// The profile ARN.
	//
	// This member is required.
	ProfileArn *string

	// The profile description.
	ProfileDescription *string

	// Profile questions.
	ProfileQuestions []types.ProfileQuestionUpdate
	// contains filtered or unexported fields
}

type UpdateProfileOutput added in v1.21.0

type UpdateProfileOutput struct {

	// The profile.
	Profile *types.Profile

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateReviewTemplateAnswerInput added in v1.23.0

type UpdateReviewTemplateAnswerInput 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 .
	//
	// This member is required.
	LensAlias *string

	// The ID of the question.
	//
	// This member is required.
	QuestionId *string

	// The review template ARN.
	//
	// This member is required.
	TemplateArn *string

	// A list of choices to be updated.
	ChoiceUpdates map[string]types.ChoiceUpdate

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

	// The notes associated with the workload. For a review template, these are the
	// notes that will be associated with the workload when the template is applied.
	Notes *string

	// The update reason.
	Reason types.AnswerReason

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

type UpdateReviewTemplateAnswerOutput added in v1.23.0

type UpdateReviewTemplateAnswerOutput struct {

	// An answer of the question.
	Answer *types.ReviewTemplateAnswer

	// The alias of the lens. For Amazon Web Services official lenses, this is either
	// the lens alias, such as serverless , or the lens ARN, such as
	// arn:aws:wellarchitected:us-east-1::lens/serverless . Note that some operations
	// (such as ExportLens and CreateLensShare) are not permitted on Amazon Web
	// Services official lenses. For custom lenses, this is the lens ARN, such as
	// arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef
	// . Each lens is identified by its LensSummary$LensAlias .
	LensAlias *string

	// The review template ARN.
	TemplateArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateReviewTemplateInput added in v1.23.0

type UpdateReviewTemplateInput struct {

	// The review template ARN.
	//
	// This member is required.
	TemplateArn *string

	// The review template description.
	Description *string

	// A list of lens aliases or ARNs to apply to the review template.
	LensesToAssociate []string

	// A list of lens aliases or ARNs to unapply to the review template. The
	// wellarchitected lens cannot be unapplied.
	LensesToDisassociate []string

	// The notes associated with the workload. For a review template, these are the
	// notes that will be associated with the workload when the template is applied.
	Notes *string

	// The review template name.
	TemplateName *string
	// contains filtered or unexported fields
}

type UpdateReviewTemplateLensReviewInput added in v1.23.0

type UpdateReviewTemplateLensReviewInput 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 .
	//
	// This member is required.
	LensAlias *string

	// The review template ARN.
	//
	// This member is required.
	TemplateArn *string

	// The notes associated with the workload. For a review template, these are the
	// notes that will be associated with the workload when the template is applied.
	LensNotes *string

	// List of pillar notes of a lens review in a workload. For a review template,
	// these are the notes that will be associated with the workload when the template
	// is applied.
	PillarNotes map[string]string
	// contains filtered or unexported fields
}

type UpdateReviewTemplateLensReviewOutput added in v1.23.0

type UpdateReviewTemplateLensReviewOutput struct {

	// A lens review of a question.
	LensReview *types.ReviewTemplateLensReview

	// The review template ARN.
	TemplateArn *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateReviewTemplateOutput added in v1.23.0

type UpdateReviewTemplateOutput struct {

	// A review template.
	ReviewTemplate *types.ReviewTemplate

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateShareInvitationInput

type UpdateShareInvitationInput struct {

	// Share invitation action taken by contributor.
	//
	// This member is required.
	ShareInvitationAction types.ShareInvitationAction

	// The ID assigned to the share invitation.
	//
	// This member is required.
	ShareInvitationId *string
	// contains filtered or unexported fields
}

Input for Update Share Invitation

type UpdateShareInvitationOutput

type UpdateShareInvitationOutput struct {

	// The updated workload or custom lens share invitation.
	ShareInvitation *types.ShareInvitation

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpdateWorkloadInput

type UpdateWorkloadInput struct {

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

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

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

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

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

	// The description for the workload.
	Description *string

	// Well-Architected discovery configuration settings to associate to the workload.
	DiscoveryConfig *types.WorkloadDiscoveryConfig

	// The environment for the workload.
	Environment types.WorkloadEnvironment

	// The improvement status for a workload.
	ImprovementStatus types.WorkloadImprovementStatus

	// The industry for the workload.
	Industry *string

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

	// Flag indicating whether the workload owner has acknowledged that the Review
	// owner field is required. If a Review owner is not added to the workload within
	// 60 days of acknowledgement, access to the workload is restricted until an owner
	// is added.
	IsReviewOwnerUpdateAcknowledged *bool

	// Configuration of the Jira integration.
	JiraConfiguration *types.WorkloadJiraConfigurationInput

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

	// The notes associated with the workload. For a review template, these are the
	// notes that will be associated with the workload when the template is applied.
	Notes *string

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

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

	// The name of the workload. The name must be unique within an account within an
	// Amazon Web Services Region. Spaces and capitalization are ignored when checking
	// for uniqueness.
	WorkloadName *string
	// contains filtered or unexported fields
}

Input to update a workload.

type UpdateWorkloadOutput

type UpdateWorkloadOutput struct {

	// A workload return object.
	Workload *types.Workload

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Output of an update workload call.

type UpdateWorkloadShareInput

type UpdateWorkloadShareInput struct {

	// Permission granted on a share request.
	//
	// This member is required.
	PermissionType types.PermissionType

	// The ID associated with the share.
	//
	// This member is required.
	ShareId *string

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

Input for Update Workload Share

type UpdateWorkloadShareOutput

type UpdateWorkloadShareOutput struct {

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

	// A workload share return object.
	WorkloadShare *types.WorkloadShare

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Input for Update Workload Share

type UpgradeLensReviewInput

type UpgradeLensReviewInput 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 .
	//
	// This member is required.
	LensAlias *string

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

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

	// 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
	// contains filtered or unexported fields
}

type UpgradeLensReviewOutput

type UpgradeLensReviewOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpgradeProfileVersionInput added in v1.21.0

type UpgradeProfileVersionInput struct {

	// The profile ARN.
	//
	// This member is required.
	ProfileArn *string

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

	// 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

	// The name of the milestone in a workload. Milestone names must be unique within
	// a workload.
	MilestoneName *string
	// contains filtered or unexported fields
}

type UpgradeProfileVersionOutput added in v1.21.0

type UpgradeProfileVersionOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

type UpgradeReviewTemplateLensReviewInput added in v1.23.0

type UpgradeReviewTemplateLensReviewInput 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 .
	//
	// This member is required.
	LensAlias *string

	// The ARN of the review template.
	//
	// This member is required.
	TemplateArn *string

	// 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
	// contains filtered or unexported fields
}

type UpgradeReviewTemplateLensReviewOutput added in v1.23.0

type UpgradeReviewTemplateLensReviewOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
	// contains filtered or unexported fields
}

Source Files

Directories

Path Synopsis
internal

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL