The London Perl and Raku Workshop takes place on 26th Oct 2024. If your company depends on Perl, please consider sponsoring and/or attending.

NAME

Paws::WellArchitected - Perl Interface to AWS AWS Well-Architected Tool

SYNOPSIS

  use Paws;

  my $obj = Paws->service('WellArchitected');
  my $res = $obj->Method(
    Arg1 => $val1,
    Arg2 => [ 'V1', 'V2' ],
    # if Arg3 is an object, the HashRef will be used as arguments to the constructor
    # of the arguments type
    Arg3 => { Att1 => 'Val1' },
    # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
    # the constructor of the arguments type
    Arg4 => [ { Att1 => 'Val1'  }, { Att1 => 'Val2' } ],
  );

DESCRIPTION

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

For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/wellarchitected-2020-03-31

METHODS

AssociateLenses

LensAliases => ArrayRef[Str|Undef]
WorkloadId => Str

Each argument is described in detail in: Paws::WellArchitected::AssociateLenses

Returns: nothing

Associate a lens to a workload.

CreateMilestone

ClientRequestToken => Str
MilestoneName => Str
WorkloadId => Str

Each argument is described in detail in: Paws::WellArchitected::CreateMilestone

Returns: a Paws::WellArchitected::CreateMilestoneOutput instance

Create a milestone for an existing workload.

CreateWorkload

ClientRequestToken => Str
Description => Str
Environment => Str
Lenses => ArrayRef[Str|Undef]
ReviewOwner => Str
WorkloadName => Str
[AccountIds => ArrayRef[Str|Undef]]
[ArchitecturalDesign => Str]
[AwsRegions => ArrayRef[Str|Undef]]
[Industry => Str]
[IndustryType => Str]
[NonAwsRegions => ArrayRef[Str|Undef]]
[Notes => Str]
[PillarPriorities => ArrayRef[Str|Undef]]
[Tags => Paws::WellArchitected::TagMap]

Each argument is described in detail in: Paws::WellArchitected::CreateWorkload

Returns: a Paws::WellArchitected::CreateWorkloadOutput instance

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.

CreateWorkloadShare

ClientRequestToken => Str
PermissionType => Str
SharedWith => Str
WorkloadId => Str

Each argument is described in detail in: Paws::WellArchitected::CreateWorkloadShare

Returns: a Paws::WellArchitected::CreateWorkloadShareOutput instance

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.

DeleteWorkload

ClientRequestToken => Str
WorkloadId => Str

Each argument is described in detail in: Paws::WellArchitected::DeleteWorkload

Returns: nothing

Delete an existing workload.

DeleteWorkloadShare

ClientRequestToken => Str
ShareId => Str
WorkloadId => Str

Each argument is described in detail in: Paws::WellArchitected::DeleteWorkloadShare

Returns: nothing

Delete a workload share.

DisassociateLenses

LensAliases => ArrayRef[Str|Undef]
WorkloadId => Str

Each argument is described in detail in: Paws::WellArchitected::DisassociateLenses

Returns: nothing

Disassociate a lens from a workload.

The AWS Well-Architected Framework lens (wellarchitected) cannot be removed from a workload.

GetAnswer

LensAlias => Str
QuestionId => Str
WorkloadId => Str
[MilestoneNumber => Int]

Each argument is described in detail in: Paws::WellArchitected::GetAnswer

Returns: a Paws::WellArchitected::GetAnswerOutput instance

Get lens review.

GetLensReview

LensAlias => Str
WorkloadId => Str
[MilestoneNumber => Int]

Each argument is described in detail in: Paws::WellArchitected::GetLensReview

Returns: a Paws::WellArchitected::GetLensReviewOutput instance

Get lens review.

GetLensReviewReport

LensAlias => Str
WorkloadId => Str
[MilestoneNumber => Int]

Each argument is described in detail in: Paws::WellArchitected::GetLensReviewReport

Returns: a Paws::WellArchitected::GetLensReviewReportOutput instance

Get lens review report.

GetLensVersionDifference

BaseLensVersion => Str
LensAlias => Str

Each argument is described in detail in: Paws::WellArchitected::GetLensVersionDifference

Returns: a Paws::WellArchitected::GetLensVersionDifferenceOutput instance

Get lens version differences.

GetMilestone

MilestoneNumber => Int
WorkloadId => Str

Each argument is described in detail in: Paws::WellArchitected::GetMilestone

Returns: a Paws::WellArchitected::GetMilestoneOutput instance

Get a milestone for an existing workload.

GetWorkload

WorkloadId => Str

Each argument is described in detail in: Paws::WellArchitected::GetWorkload

Returns: a Paws::WellArchitected::GetWorkloadOutput instance

Get an existing workload.

ListAnswers

LensAlias => Str
WorkloadId => Str
[MaxResults => Int]
[MilestoneNumber => Int]
[NextToken => Str]
[PillarId => Str]

Each argument is described in detail in: Paws::WellArchitected::ListAnswers

Returns: a Paws::WellArchitected::ListAnswersOutput instance

List of answers.

ListLenses

[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::WellArchitected::ListLenses

Returns: a Paws::WellArchitected::ListLensesOutput instance

List the available lenses.

ListLensReviewImprovements

LensAlias => Str
WorkloadId => Str
[MaxResults => Int]
[MilestoneNumber => Int]
[NextToken => Str]
[PillarId => Str]

Each argument is described in detail in: Paws::WellArchitected::ListLensReviewImprovements

Returns: a Paws::WellArchitected::ListLensReviewImprovementsOutput instance

List lens review improvements.

ListLensReviews

WorkloadId => Str
[MaxResults => Int]
[MilestoneNumber => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::WellArchitected::ListLensReviews

Returns: a Paws::WellArchitected::ListLensReviewsOutput instance

List lens reviews.

ListMilestones

WorkloadId => Str
[MaxResults => Int]
[NextToken => Str]

Each argument is described in detail in: Paws::WellArchitected::ListMilestones

Returns: a Paws::WellArchitected::ListMilestonesOutput instance

List all milestones for an existing workload.

ListNotifications

[MaxResults => Int]
[NextToken => Str]
[WorkloadId => Str]

Each argument is described in detail in: Paws::WellArchitected::ListNotifications

Returns: a Paws::WellArchitected::ListNotificationsOutput instance

List lens notifications.

ListShareInvitations

[MaxResults => Int]
[NextToken => Str]
[WorkloadNamePrefix => Str]

Each argument is described in detail in: Paws::WellArchitected::ListShareInvitations

Returns: a Paws::WellArchitected::ListShareInvitationsOutput instance

List the workload invitations.

ListTagsForResource

WorkloadArn => Str

Each argument is described in detail in: Paws::WellArchitected::ListTagsForResource

Returns: a Paws::WellArchitected::ListTagsForResourceOutput instance

List the tags for a resource.

ListWorkloads

[MaxResults => Int]
[NextToken => Str]
[WorkloadNamePrefix => Str]

Each argument is described in detail in: Paws::WellArchitected::ListWorkloads

Returns: a Paws::WellArchitected::ListWorkloadsOutput instance

List workloads. Paginated.

ListWorkloadShares

WorkloadId => Str
[MaxResults => Int]
[NextToken => Str]
[SharedWithPrefix => Str]

Each argument is described in detail in: Paws::WellArchitected::ListWorkloadShares

Returns: a Paws::WellArchitected::ListWorkloadSharesOutput instance

List the workload shares associated with the workload.

TagResource

Tags => Paws::WellArchitected::TagMap
WorkloadArn => Str

Each argument is described in detail in: Paws::WellArchitected::TagResource

Returns: a Paws::WellArchitected::TagResourceOutput instance

Adds one or more tags to the specified resource.

UntagResource

TagKeys => ArrayRef[Str|Undef]
WorkloadArn => Str

Each argument is described in detail in: Paws::WellArchitected::UntagResource

Returns: a Paws::WellArchitected::UntagResourceOutput instance

Deletes specified tags from a resource.

UpdateAnswer

LensAlias => Str
QuestionId => Str
WorkloadId => Str
[IsApplicable => Bool]
[Notes => Str]
[SelectedChoices => ArrayRef[Str|Undef]]

Each argument is described in detail in: Paws::WellArchitected::UpdateAnswer

Returns: a Paws::WellArchitected::UpdateAnswerOutput instance

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

UpdateLensReview

LensAlias => Str
WorkloadId => Str
[LensNotes => Str]
[PillarNotes => Paws::WellArchitected::PillarNotes]

Each argument is described in detail in: Paws::WellArchitected::UpdateLensReview

Returns: a Paws::WellArchitected::UpdateLensReviewOutput instance

Update lens review.

UpdateShareInvitation

ShareInvitationAction => Str
ShareInvitationId => Str

Each argument is described in detail in: Paws::WellArchitected::UpdateShareInvitation

Returns: a Paws::WellArchitected::UpdateShareInvitationOutput instance

Update a workload invitation.

UpdateWorkload

WorkloadId => Str
[AccountIds => ArrayRef[Str|Undef]]
[ArchitecturalDesign => Str]
[AwsRegions => ArrayRef[Str|Undef]]
[Description => Str]
[Environment => Str]
[ImprovementStatus => Str]
[Industry => Str]
[IndustryType => Str]
[IsReviewOwnerUpdateAcknowledged => Bool]
[NonAwsRegions => ArrayRef[Str|Undef]]
[Notes => Str]
[PillarPriorities => ArrayRef[Str|Undef]]
[ReviewOwner => Str]
[WorkloadName => Str]

Each argument is described in detail in: Paws::WellArchitected::UpdateWorkload

Returns: a Paws::WellArchitected::UpdateWorkloadOutput instance

Update an existing workload.

UpdateWorkloadShare

PermissionType => Str
ShareId => Str
WorkloadId => Str

Each argument is described in detail in: Paws::WellArchitected::UpdateWorkloadShare

Returns: a Paws::WellArchitected::UpdateWorkloadShareOutput instance

Update a workload share.

UpgradeLensReview

LensAlias => Str
MilestoneName => Str
WorkloadId => Str
[ClientRequestToken => Str]

Each argument is described in detail in: Paws::WellArchitected::UpgradeLensReview

Returns: nothing

Upgrade lens review.

PAGINATORS

Paginator methods are helpers that repetively call methods that return partial results

SEE ALSO

This service class forms part of Paws

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues