wellarchitected

package module
v1.2.0 Latest Latest
Warning

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

 Go to latest Published: Mar 18, 2021 License: Apache-2.0 Imports: 30 Imported by: 8

Documentation

Overview

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

AWS Well-Architected Tool This is the AWS Well-Architected Tool API Reference. The AWS Well-Architected Tool API provides programmatic access to the AWS Well-Architected Tool (http://aws.amazon.com/well-architected-tool) in the AWS Management Console (https://console.aws.amazon.com/wellarchitected). For information about the AWS Well-Architected Tool, see the AWS 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 

func WithEndpointResolver(v EndpointResolver) func(*Options)

WithEndpointResolver returns a functional option for setting the Client's EndpointResolver option.

Types

type AssociateLensesInput 

type AssociateLensesInput struct {

	// List of lens aliases to associate or disassociate with a workload. 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 AWS Region.
	//
	// This member is required.
	WorkloadId *string
}

Input to associate lens reviews.

type AssociateLensesOutput 

type AssociateLensesOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

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.

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) 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 AWS accounts and IAM users in the same AWS 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 AWS Well-Architected Tool User Guide.

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 AWS accounts and IAM users in the same AWS Region. Shared access to a workload is not removed until the workload invitation is deleted. For more information, see Sharing a Workload (https://docs.aws.amazon.com/wellarchitected/latest/userguide/workloads-sharing.html) in the AWS Well-Architected Tool User Guide.

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. The AWS Well-Architected Framework lens (wellarchitected) cannot be removed from a workload.

func (*Client) GetAnswer 

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

Get lens review.

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

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

Get an existing workload.

func (*Client) ListAnswers 

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

List of answers.

func (*Client) ListLensReviewImprovements 

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

List lens review improvements.

func (*Client) ListLensReviews 

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

List lens reviews.

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

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

List the workload invitations.

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.

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)

List workloads. Paginated.

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.

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.

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

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

Update lens review.

func (*Client) UpdateShareInvitation 

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

Update a workload invitation.

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.

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 it 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 AWS SDKs automatically generate one for you. If you are not using the AWS
	// SDK or the AWS 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 AWS Region.
	//
	// This member is required.
	WorkloadId *string
}

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 AWS Region.
	WorkloadId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Output of a create milestone call.

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 it 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 AWS SDKs automatically generate one for you. If you are not using the AWS
	// SDK or the AWS 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.
	//
	// This member is required.
	Lenses []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.
	//
	// This member is required.
	ReviewOwner *string

	// The name of the workload. The name must be unique within an account within a
	// Region. Spaces and capitalization are ignored when checking for uniqueness.
	//
	// This member is required.
	WorkloadName *string

	// The list of AWS account IDs associated with the workload.
	AccountIds []string

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

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

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

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

	// The notes associated with the workload.
	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 tags to be associated with the workload.
	Tags map[string]string
}

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 AWS Region.
	WorkloadId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

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 it 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 AWS SDKs automatically generate one for you. If you are not using the AWS
	// SDK or the AWS CLI, you must provide this token or the request will fail.
	//
	// This member is required.
	ClientRequestToken *string

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

	// The AWS account ID or IAM role with which the workload is shared.
	//
	// This member is required.
	SharedWith *string

	// The ID assigned to the workload. This ID is unique within an AWS Region.
	//
	// This member is required.
	WorkloadId *string
}

Input for Create Workload Share

type CreateWorkloadShareOutput 

type CreateWorkloadShareOutput struct {

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

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Input for Create Workload Share

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 it 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 AWS SDKs automatically generate one for you. If you are not using the AWS
	// SDK or the AWS 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 AWS Region.
	//
	// This member is required.
	WorkloadId *string
}

Input for workload deletion.

type DeleteWorkloadOutput 

type DeleteWorkloadOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

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 it 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 AWS SDKs automatically generate one for you. If you are not using the AWS
	// SDK or the AWS CLI, you must provide this token or the request will fail.
	//
	// This member is required.
	ClientRequestToken *string

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

	// The ID assigned to the workload. This ID is unique within an AWS Region.
	//
	// This member is required.
	WorkloadId *string
}

Input for Delete Workload Share

type DeleteWorkloadShareOutput 

type DeleteWorkloadShareOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type DisassociateLensesInput 

type DisassociateLensesInput struct {

	// List of lens aliases to associate or disassociate with a workload. 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 AWS Region.
	//
	// This member is required.
	WorkloadId *string
}

Input to disassociate lens reviews.

type DisassociateLensesOutput 

type DisassociateLensesOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

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 GetAnswerInput 

type GetAnswerInput struct {

	// The alias of the lens, for example, serverless. 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 AWS Region.
	//
	// This member is required.
	WorkloadId *string

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

Input to get answer.

type GetAnswerOutput 

type GetAnswerOutput struct {

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

	// The alias of the lens, for example, serverless. Each lens is identified by its
	// LensSummary$LensAlias.
	LensAlias *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 AWS Region.
	WorkloadId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Output of a get answer call.

type GetLensReviewInput 

type GetLensReviewInput struct {

	// The alias of the lens, for example, serverless. 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 AWS Region.
	//
	// This member is required.
	WorkloadId *string

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

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 AWS Region.
	WorkloadId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Output of a get lens review call.

type GetLensReviewReportInput 

type GetLensReviewReportInput struct {

	// The alias of the lens, for example, serverless. 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 AWS Region.
	//
	// This member is required.
	WorkloadId *string

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

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 AWS Region.
	WorkloadId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Output of a get lens review report call.

type GetLensVersionDifferenceInput 

type GetLensVersionDifferenceInput struct {

	// The base version of the lens.
	//
	// This member is required.
	BaseLensVersion *string

	// The alias of the lens, for example, serverless. Each lens is identified by its
	// LensSummary$LensAlias.
	//
	// This member is required.
	LensAlias *string
}

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 example, serverless. Each lens is identified by its
	// LensSummary$LensAlias.
	LensAlias *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
}

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 AWS Region.
	//
	// This member is required.
	WorkloadId *string
}

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 AWS Region.
	WorkloadId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Output of a get milestone call.

type GetWorkloadInput 

type GetWorkloadInput struct {

	// The ID assigned to the workload. This ID is unique within an AWS Region.
	//
	// This member is required.
	WorkloadId *string
}

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
}

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 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 example, serverless. 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 AWS 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
}

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 example, serverless. Each lens is identified by its
	// LensSummary$LensAlias.
	LensAlias *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 AWS Region.
	WorkloadId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

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 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 example, serverless. 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 AWS 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
}

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 example, serverless. Each lens is identified by its
	// LensSummary$LensAlias.
	LensAlias *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 AWS Region.
	WorkloadId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

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 

func NewListLensReviewImprovementsPaginator(client ListLensReviewImprovementsAPIClient, params *ListLensReviewImprovementsInput, optFns ...func(*ListLensReviewImprovementsPaginatorOptions)) *ListLensReviewImprovementsPaginator

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 

func (p *ListLensReviewImprovementsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListLensReviewImprovementsOutput, error)

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 AWS 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
}

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 AWS Region.
	WorkloadId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

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 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 maximum number of results to return for this request.
	MaxResults int32

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

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
}

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 AWS 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
}

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 AWS Region.
	WorkloadId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

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 ID assigned to the workload. This ID is unique within an AWS Region.
	WorkloadId *string
}

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
}

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

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

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
}

Input for List Share Invitations

type ListShareInvitationsPaginator 

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

ListShareInvitationsPaginator is a paginator for ListShareInvitations

func NewListShareInvitationsPaginator 

func NewListShareInvitationsPaginator(client ListShareInvitationsAPIClient, params *ListShareInvitationsInput, optFns ...func(*ListShareInvitationsPaginatorOptions)) *ListShareInvitationsPaginator

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 

func (p *ListShareInvitationsPaginator) NextPage(ctx context.Context, optFns ...func(*Options)) (*ListShareInvitationsOutput, error)

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
}

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
}

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 AWS 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 AWS account ID or IAM role with which the workload is shared.
	SharedWithPrefix *string
}

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 AWS Region.
	WorkloadId *string

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

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
}

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
}

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

	// 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 endpoint options to be used when attempting to resolve an endpoint.
	EndpointOptions EndpointResolverOptions

	// The service endpoint resolver.
	EndpointResolver EndpointResolver

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

	// Retryer guides how HTTP requests should be retried in case of recoverable
	// failures. When nil the API client will use a default retryer.
	Retryer aws.Retryer

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

func (Options) Copy 

func (o Options) Copy() Options

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

type ResolveEndpoint 

type ResolveEndpoint struct {
	Resolver EndpointResolver
	Options  EndpointResolverOptions
}

func (*ResolveEndpoint) HandleSerialize 

func (m *ResolveEndpoint) HandleSerialize(ctx context.Context, in middleware.SerializeInput, next middleware.SerializeHandler) (
	out middleware.SerializeOutput, metadata middleware.Metadata, err error,
)

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
}

type TagResourceOutput added in v1.2.0 

type TagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UntagResourceInput added in v1.2.0 

type UntagResourceInput struct {

	// The keys of the tags to be removed.
	//
	// This member is required.
	TagKeys []string

	// The ARN for the workload.
	//
	// This member is required.
	WorkloadArn *string
}

type UntagResourceOutput added in v1.2.0 

type UntagResourceOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UpdateAnswerInput 

type UpdateAnswerInput struct {

	// The alias of the lens, for example, serverless. 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 AWS Region.
	//
	// This member is required.
	WorkloadId *string

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

	// The notes associated with the workload.
	Notes *string

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

Input to update answer.

type UpdateAnswerOutput 

type UpdateAnswerOutput struct {

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

	// The alias of the lens, for example, serverless. Each lens is identified by its
	// LensSummary$LensAlias.
	LensAlias *string

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Output of a update answer call.

type UpdateLensReviewInput 

type UpdateLensReviewInput struct {

	// The alias of the lens, for example, serverless. 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 AWS Region.
	//
	// This member is required.
	WorkloadId *string

	// The notes associated with the workload.
	LensNotes *string

	// List of pillar notes of a lens review in a workload.
	PillarNotes map[string]string
}

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 AWS Region.
	WorkloadId *string

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Output of a update lens review call.

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
}

Input for Update Share Invitation

type UpdateShareInvitationOutput 

type UpdateShareInvitationOutput struct {

	// The updated workload share invitation.
	ShareInvitation *types.ShareInvitation

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

type UpdateWorkloadInput 

type UpdateWorkloadInput struct {

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

	// The list of AWS account IDs associated with the workload.
	AccountIds []string

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

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

	// The description for the workload.
	Description *string

	// The environment for the workload.
	Environment 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

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

	// The notes associated with the workload.
	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 a
	// Region. Spaces and capitalization are ignored when checking for uniqueness.
	WorkloadName *string
}

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
}

Output of an update workload call.

type UpdateWorkloadShareInput 

type UpdateWorkloadShareInput struct {

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

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

	// The ID assigned to the workload. This ID is unique within an AWS Region.
	//
	// This member is required.
	WorkloadId *string
}

Input for Update Workload Share

type UpdateWorkloadShareOutput 

type UpdateWorkloadShareOutput struct {

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

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

	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Input for Update Workload Share

type UpgradeLensReviewInput 

type UpgradeLensReviewInput struct {

	// The alias of the lens, for example, serverless. 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 AWS 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 it 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 AWS SDKs automatically generate one for you. If you are not using the AWS
	// SDK or the AWS CLI, you must provide this token or the request will fail.
	ClientRequestToken *string
}

type UpgradeLensReviewOutput 

type UpgradeLensReviewOutput struct {
	// Metadata pertaining to the operation's result.
	ResultMetadata middleware.Metadata
}

Source Files

View all Source files

Directories

Path Synopsis
internal
endpoints

Jump to

Keyboard shortcuts

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