AssociateLenses

$result = $client->associateLenses([/* ... */]);
$promise = $client->associateLensesAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->associateLenses([
    'LensAliases' => ['<string>', ...], // REQUIRED
    'WorkloadId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

The user input is not valid.

ResourceNotFoundException:

The requested resource was not found.

ConflictException:

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

InternalServerException:

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

AccessDeniedException:

User does not have sufficient access to perform this action.

ThrottlingException:

Request was denied due to request throttling.

AssociateProfiles

$result = $client->associateProfiles([/* ... */]);
$promise = $client->associateProfilesAsync([/* ... */]);

Associate a profile with a workload.

Parameter Syntax

$result = $client->associateProfiles([
    'ProfileArns' => ['<string>', ...], // REQUIRED
    'WorkloadId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

The user input is not valid.

ResourceNotFoundException:

The requested resource was not found.

ConflictException:

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

InternalServerException:

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

AccessDeniedException:

User does not have sufficient access to perform this action.

ThrottlingException:

Request was denied due to request throttling.

CreateLensShare

$result = $client->createLensShare([/* ... */]);
$promise = $client->createLensShareAsync([/* ... */]);

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 in the Well-Architected Tool User Guide.

Parameter Syntax

$result = $client->createLensShare([
    'ClientRequestToken' => '<string>', // REQUIRED
    'LensAlias' => '<string>', // REQUIRED
    'SharedWith' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ShareId' => '<string>',
]

Result Details

Errors

ValidationException:

The user input is not valid.

ConflictException:

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

InternalServerException:

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

ResourceNotFoundException:

The requested resource was not found.

ServiceQuotaExceededException:

The user has reached their resource quota.

AccessDeniedException:

User does not have sufficient access to perform this action.

ThrottlingException:

Request was denied due to request throttling.

CreateLensVersion

$result = $client->createLensVersion([/* ... */]);
$promise = $client->createLensVersionAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->createLensVersion([
    'ClientRequestToken' => '<string>', // REQUIRED
    'IsMajorVersion' => true || false,
    'LensAlias' => '<string>', // REQUIRED
    'LensVersion' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'LensArn' => '<string>',
    'LensVersion' => '<string>',
]

Result Details

Errors

ValidationException:

The user input is not valid.

ResourceNotFoundException:

The requested resource was not found.

ServiceQuotaExceededException:

The user has reached their resource quota.

ConflictException:

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

InternalServerException:

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

AccessDeniedException:

User does not have sufficient access to perform this action.

ThrottlingException:

Request was denied due to request throttling.

CreateMilestone

$result = $client->createMilestone([/* ... */]);
$promise = $client->createMilestoneAsync([/* ... */]);

Create a milestone for an existing workload.

Parameter Syntax

$result = $client->createMilestone([
    'ClientRequestToken' => '<string>', // REQUIRED
    'MilestoneName' => '<string>', // REQUIRED
    'WorkloadId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'MilestoneNumber' => <integer>,
    'WorkloadId' => '<string>',
]

Result Details

Errors

ValidationException:

The user input is not valid.

ConflictException:

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

InternalServerException:

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

ResourceNotFoundException:

The requested resource was not found.

ServiceQuotaExceededException:

The user has reached their resource quota.

AccessDeniedException:

User does not have sufficient access to perform this action.

ThrottlingException:

Request was denied due to request throttling.

CreateProfile

$result = $client->createProfile([/* ... */]);
$promise = $client->createProfileAsync([/* ... */]);

Create a profile.

Parameter Syntax

$result = $client->createProfile([
    'ClientRequestToken' => '<string>', // REQUIRED
    'ProfileDescription' => '<string>', // REQUIRED
    'ProfileName' => '<string>', // REQUIRED
    'ProfileQuestions' => [ // REQUIRED
        [
            'QuestionId' => '<string>',
            'SelectedChoiceIds' => ['<string>', ...],
        ],
        // ...
    ],
    'Tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'ProfileArn' => '<string>',
    'ProfileVersion' => '<string>',
]

Result Details

Errors

ValidationException:

The user input is not valid.

ConflictException:

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

ServiceQuotaExceededException:

The user has reached their resource quota.

InternalServerException:

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

AccessDeniedException:

User does not have sufficient access to perform this action.

ThrottlingException:

Request was denied due to request throttling.

CreateProfileShare

$result = $client->createProfileShare([/* ... */]);
$promise = $client->createProfileShareAsync([/* ... */]);

Create a profile share.

Parameter Syntax

$result = $client->createProfileShare([
    'ClientRequestToken' => '<string>', // REQUIRED
    'ProfileArn' => '<string>', // REQUIRED
    'SharedWith' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ProfileArn' => '<string>',
    'ShareId' => '<string>',
]

Result Details

Errors

ValidationException:

The user input is not valid.

ConflictException:

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

InternalServerException:

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

ResourceNotFoundException:

The requested resource was not found.

ServiceQuotaExceededException:

The user has reached their resource quota.

AccessDeniedException:

User does not have sufficient access to perform this action.

ThrottlingException:

Request was denied due to request throttling.

CreateReviewTemplate

$result = $client->createReviewTemplate([/* ... */]);
$promise = $client->createReviewTemplateAsync([/* ... */]);

Create a review template.

Parameter Syntax

$result = $client->createReviewTemplate([
    'ClientRequestToken' => '<string>', // REQUIRED
    'Description' => '<string>', // REQUIRED
    'Lenses' => ['<string>', ...], // REQUIRED
    'Notes' => '<string>',
    'Tags' => ['<string>', ...],
    'TemplateName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'TemplateArn' => '<string>',
]

Result Details

Errors

ValidationException:

The user input is not valid.

ConflictException:

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

ServiceQuotaExceededException:

The user has reached their resource quota.

InternalServerException:

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

AccessDeniedException:

User does not have sufficient access to perform this action.

ResourceNotFoundException:

The requested resource was not found.

ThrottlingException:

Request was denied due to request throttling.

CreateTemplateShare

$result = $client->createTemplateShare([/* ... */]);
$promise = $client->createTemplateShareAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->createTemplateShare([
    'ClientRequestToken' => '<string>', // REQUIRED
    'SharedWith' => '<string>', // REQUIRED
    'TemplateArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ShareId' => '<string>',
    'TemplateArn' => '<string>',
]

Result Details

Errors

ValidationException:

The user input is not valid.

ConflictException:

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

InternalServerException:

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

ResourceNotFoundException:

The requested resource was not found.

ServiceQuotaExceededException:

The user has reached their resource quota.

AccessDeniedException:

User does not have sufficient access to perform this action.

ThrottlingException:

Request was denied due to request throttling.

CreateWorkload

$result = $client->createWorkload([/* ... */]);
$promise = $client->createWorkloadAsync([/* ... */]);

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 in the Well-Architected Tool User Guide.

When creating a workload using a review template, you must have the following IAM permissions:

• wellarchitected:GetReviewTemplate

• wellarchitected:GetReviewTemplateAnswer

• wellarchitected:ListReviewTemplateAnswers

• wellarchitected:GetReviewTemplateLensReview

Parameter Syntax

$result = $client->createWorkload([
    'AccountIds' => ['<string>', ...],
    'Applications' => ['<string>', ...],
    'ArchitecturalDesign' => '<string>',
    'AwsRegions' => ['<string>', ...],
    'ClientRequestToken' => '<string>', // REQUIRED
    'Description' => '<string>', // REQUIRED
    'DiscoveryConfig' => [
        'TrustedAdvisorIntegrationStatus' => 'ENABLED|DISABLED',
        'WorkloadResourceDefinition' => ['<string>', ...],
    ],
    'Environment' => 'PRODUCTION|PREPRODUCTION', // REQUIRED
    'Industry' => '<string>',
    'IndustryType' => '<string>',
    'JiraConfiguration' => [
        'IssueManagementStatus' => 'ENABLED|DISABLED|INHERIT',
        'IssueManagementType' => 'AUTO|MANUAL',
        'JiraProjectKey' => '<string>',
    ],
    'Lenses' => ['<string>', ...], // REQUIRED
    'NonAwsRegions' => ['<string>', ...],
    'Notes' => '<string>',
    'PillarPriorities' => ['<string>', ...],
    'ProfileArns' => ['<string>', ...],
    'ReviewOwner' => '<string>',
    'ReviewTemplateArns' => ['<string>', ...],
    'Tags' => ['<string>', ...],
    'WorkloadName' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'WorkloadArn' => '<string>',
    'WorkloadId' => '<string>',
]

Result Details

Errors

ValidationException:

The user input is not valid.

ConflictException:

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

ServiceQuotaExceededException:

The user has reached their resource quota.

InternalServerException:

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

AccessDeniedException:

User does not have sufficient access to perform this action.

ResourceNotFoundException:

The requested resource was not found.

ThrottlingException:

Request was denied due to request throttling.

CreateWorkloadShare

$result = $client->createWorkloadShare([/* ... */]);
$promise = $client->createWorkloadShareAsync([/* ... */]);

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 in the Well-Architected Tool User Guide.

Parameter Syntax

$result = $client->createWorkloadShare([
    'ClientRequestToken' => '<string>', // REQUIRED
    'PermissionType' => 'READONLY|CONTRIBUTOR', // REQUIRED
    'SharedWith' => '<string>', // REQUIRED
    'WorkloadId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ShareId' => '<string>',
    'WorkloadId' => '<string>',
]

Result Details

Errors

ValidationException:

The user input is not valid.

ConflictException:

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

InternalServerException:

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

ResourceNotFoundException:

The requested resource was not found.

ServiceQuotaExceededException:

The user has reached their resource quota.

AccessDeniedException:

User does not have sufficient access to perform this action.

ThrottlingException:

Request was denied due to request throttling.

DeleteLens

$result = $client->deleteLens([/* ... */]);
$promise = $client->deleteLensAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->deleteLens([
    'ClientRequestToken' => '<string>', // REQUIRED
    'LensAlias' => '<string>', // REQUIRED
    'LensStatus' => 'ALL|DRAFT|PUBLISHED', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

The user input is not valid.

ResourceNotFoundException:

The requested resource was not found.

ConflictException:

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

InternalServerException:

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

AccessDeniedException:

User does not have sufficient access to perform this action.

ThrottlingException:

Request was denied due to request throttling.

DeleteLensShare

$result = $client->deleteLensShare([/* ... */]);
$promise = $client->deleteLensShareAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->deleteLensShare([
    'ClientRequestToken' => '<string>', // REQUIRED
    'LensAlias' => '<string>', // REQUIRED
    'ShareId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

The user input is not valid.

InternalServerException:

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

ResourceNotFoundException:

The requested resource was not found.

ConflictException:

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

AccessDeniedException:

User does not have sufficient access to perform this action.

ThrottlingException:

Request was denied due to request throttling.

DeleteProfile

$result = $client->deleteProfile([/* ... */]);
$promise = $client->deleteProfileAsync([/* ... */]);

Delete a profile.

Parameter Syntax

$result = $client->deleteProfile([
    'ClientRequestToken' => '<string>', // REQUIRED
    'ProfileArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

The user input is not valid.

ResourceNotFoundException:

The requested resource was not found.

ConflictException:

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

InternalServerException:

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

AccessDeniedException:

User does not have sufficient access to perform this action.

ThrottlingException:

Request was denied due to request throttling.

DeleteProfileShare

$result = $client->deleteProfileShare([/* ... */]);
$promise = $client->deleteProfileShareAsync([/* ... */]);

Delete a profile share.

Parameter Syntax

$result = $client->deleteProfileShare([
    'ClientRequestToken' => '<string>', // REQUIRED
    'ProfileArn' => '<string>', // REQUIRED
    'ShareId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

The user input is not valid.

InternalServerException:

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

ResourceNotFoundException:

The requested resource was not found.

ConflictException:

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

AccessDeniedException:

User does not have sufficient access to perform this action.

ThrottlingException:

Request was denied due to request throttling.

DeleteReviewTemplate

$result = $client->deleteReviewTemplate([/* ... */]);
$promise = $client->deleteReviewTemplateAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->deleteReviewTemplate([
    'ClientRequestToken' => '<string>', // REQUIRED
    'TemplateArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

The user input is not valid.

ResourceNotFoundException:

The requested resource was not found.

ConflictException:

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

InternalServerException:

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

AccessDeniedException:

User does not have sufficient access to perform this action.

ThrottlingException:

Request was denied due to request throttling.

DeleteTemplateShare

$result = $client->deleteTemplateShare([/* ... */]);
$promise = $client->deleteTemplateShareAsync([/* ... */]);

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.

Parameter Syntax

$result = $client->deleteTemplateShare([
    'ClientRequestToken' => '<string>', // REQUIRED
    'ShareId' => '<string>', // REQUIRED
    'TemplateArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

The user input is not valid.

InternalServerException:

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

ResourceNotFoundException:

The requested resource was not found.

ConflictException:

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

AccessDeniedException:

User does not have sufficient access to perform this action.

ThrottlingException:

Request was denied due to request throttling.

DeleteWorkload

$result = $client->deleteWorkload([/* ... */]);
$promise = $client->deleteWorkloadAsync([/* ... */]);

Delete an existing workload.

Parameter Syntax

$result = $client->deleteWorkload([
    'ClientRequestToken' => '<string>', // REQUIRED
    'WorkloadId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

The user input is not valid.

ResourceNotFoundException:

The requested resource was not found.

ConflictException:

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

InternalServerException:

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

AccessDeniedException:

User does not have sufficient access to perform this action.

ThrottlingException:

Request was denied due to request throttling.

DeleteWorkloadShare

$result = $client->deleteWorkloadShare([/* ... */]);
$promise = $client->deleteWorkloadShareAsync([/* ... */]);

Delete a workload share.

Parameter Syntax

$result = $client->deleteWorkloadShare([
    'ClientRequestToken' => '<string>', // REQUIRED
    'ShareId' => '<string>', // REQUIRED
    'WorkloadId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

The user input is not valid.

InternalServerException:

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

ResourceNotFoundException:

The requested resource was not found.

ConflictException:

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

AccessDeniedException:

User does not have sufficient access to perform this action.

ThrottlingException:

Request was denied due to request throttling.

DisassociateLenses

$result = $client->disassociateLenses([/* ... */]);
$promise = $client->disassociateLensesAsync([/* ... */]);

Disassociate a lens from a workload.

Up to 10 lenses can be disassociated from a workload in a single API operation.

Parameter Syntax

$result = $client->disassociateLenses([
    'LensAliases' => ['<string>', ...], // REQUIRED
    'WorkloadId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

The user input is not valid.

ResourceNotFoundException:

The requested resource was not found.

ConflictException:

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

InternalServerException:

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

AccessDeniedException:

User does not have sufficient access to perform this action.

ThrottlingException:

Request was denied due to request throttling.

DisassociateProfiles

$result = $client->disassociateProfiles([/* ... */]);
$promise = $client->disassociateProfilesAsync([/* ... */]);

Disassociate a profile from a workload.

Parameter Syntax

$result = $client->disassociateProfiles([
    'ProfileArns' => ['<string>', ...], // REQUIRED
    'WorkloadId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

The user input is not valid.

ResourceNotFoundException:

The requested resource was not found.

ConflictException:

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

InternalServerException:

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

AccessDeniedException:

User does not have sufficient access to perform this action.

ThrottlingException:

Request was denied due to request throttling.

ExportLens

$result = $client->exportLens([/* ... */]);
$promise = $client->exportLensAsync([/* ... */]);

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 in the Well-Architected Tool User Guide.

Parameter Syntax

$result = $client->exportLens([
    'LensAlias' => '<string>', // REQUIRED
    'LensVersion' => '<string>',
]);

Parameter Details

Result Syntax

[
    'LensJSON' => '<string>',
]

Result Details

Errors

ValidationException:

The user input is not valid.

ResourceNotFoundException:

The requested resource was not found.

InternalServerException:

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

AccessDeniedException:

User does not have sufficient access to perform this action.

ThrottlingException:

Request was denied due to request throttling.

GetAnswer

$result = $client->getAnswer([/* ... */]);
$promise = $client->getAnswerAsync([/* ... */]);

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

Parameter Syntax

$result = $client->getAnswer([
    'LensAlias' => '<string>', // REQUIRED
    'MilestoneNumber' => <integer>,
    'QuestionId' => '<string>', // REQUIRED
    'WorkloadId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Answer' => [
        'ChoiceAnswers' => [
            [
                'ChoiceId' => '<string>',
                'Notes' => '<string>',
                'Reason' => 'OUT_OF_SCOPE|BUSINESS_PRIORITIES|ARCHITECTURE_CONSTRAINTS|OTHER|NONE',
                'Status' => 'SELECTED|NOT_APPLICABLE|UNSELECTED',
            ],
            // ...
        ],
        'Choices' => [
            [
                'AdditionalResources' => [
                    [
                        'Content' => [
                            [
                                'DisplayText' => '<string>',
                                'Url' => '<string>',
                            ],
                            // ...
                        ],
                        'Type' => 'HELPFUL_RESOURCE|IMPROVEMENT_PLAN',
                    ],
                    // ...
                ],
                'ChoiceId' => '<string>',
                'Description' => '<string>',
                'HelpfulResource' => [
                    'DisplayText' => '<string>',
                    'Url' => '<string>',
                ],
                'ImprovementPlan' => [
                    'DisplayText' => '<string>',
                    'Url' => '<string>',
                ],
                'Title' => '<string>',
            ],
            // ...
        ],
        'HelpfulResourceDisplayText' => '<string>',
        'HelpfulResourceUrl' => '<string>',
        'ImprovementPlanUrl' => '<string>',
        'IsApplicable' => true || false,
        'JiraConfiguration' => [
            'JiraIssueUrl' => '<string>',
            'LastSyncedTime' => <DateTime>,
        ],
        'Notes' => '<string>',
        'PillarId' => '<string>',
        'QuestionDescription' => '<string>',
        'QuestionId' => '<string>',
        'QuestionTitle' => '<string>',
        'Reason' => 'OUT_OF_SCOPE|BUSINESS_PRIORITIES|ARCHITECTURE_CONSTRAINTS|OTHER|NONE',
        'Risk' => 'UNANSWERED|HIGH|MEDIUM|NONE|NOT_APPLICABLE',
        'SelectedChoices' => ['<string>', ...],
    ],
    'LensAlias' => '<string>',
    'LensArn' => '<string>',
    'MilestoneNumber' => <integer>,
    'WorkloadId' => '<string>',
]

Result Details

Errors

ValidationException:

The user input is not valid.

ResourceNotFoundException:

The requested resource was not found.

InternalServerException:

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

AccessDeniedException:

User does not have sufficient access to perform this action.

ThrottlingException:

Request was denied due to request throttling.

GetConsolidatedReport

$result = $client->getConsolidatedReport([/* ... */]);
$promise = $client->getConsolidatedReportAsync([/* ... */]);

Get a consolidated report of your workloads.

You can optionally choose to include workloads that have been shared with you.

Parameter Syntax

$result = $client->getConsolidatedReport([
    'Format' => 'PDF|JSON', // REQUIRED
    'IncludeSharedResources' => true || false,
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Base64String' => '<string>',
    'Metrics' => [
        [
            'Lenses' => [
                [
                    'LensArn' => '<string>',
                    'Pillars' => [
                        [
                            'PillarId' => '<string>',
                            'Questions' => [
                                [
                                    'BestPractices' => [
                                        [
                                            'ChoiceId' => '<string>',
                                            'ChoiceTitle' => '<string>',
                                        ],
                                        // ...
                                    ],
                                    'QuestionId' => '<string>',
                                    'Risk' => 'UNANSWERED|HIGH|MEDIUM|NONE|NOT_APPLICABLE',
                                ],
                                // ...
                            ],
                            'RiskCounts' => [<integer>, ...],
                        ],
                        // ...
                    ],
                    'RiskCounts' => [<integer>, ...],
                ],
                // ...
            ],
            'LensesAppliedCount' => <integer>,
            'MetricType' => 'WORKLOAD',
            'RiskCounts' => [<integer>, ...],
            'UpdatedAt' => <DateTime>,
            'WorkloadArn' => '<string>',
            'WorkloadId' => '<string>',
            'WorkloadName' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

ValidationException:

The user input is not valid.

InternalServerException:

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

AccessDeniedException:

User does not have sufficient access to perform this action.

ThrottlingException:

Request was denied due to request throttling.

ConflictException:

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

GetGlobalSettings

$result = $client->getGlobalSettings([/* ... */]);
$promise = $client->getGlobalSettingsAsync([/* ... */]);

Global settings for all workloads.

Parameter Syntax

$result = $client->getGlobalSettings([
]);

Parameter Details

Result Syntax

[
    'DiscoveryIntegrationStatus' => 'ENABLED|DISABLED',
    'JiraConfiguration' => [
        'IntegrationStatus' => 'CONFIGURED|NOT_CONFIGURED',
        'IssueManagementStatus' => 'ENABLED|DISABLED',
        'IssueManagementType' => 'AUTO|MANUAL',
        'JiraProjectKey' => '<string>',
        'StatusMessage' => '<string>',
        'Subdomain' => '<string>',
    ],
    'OrganizationSharingStatus' => 'ENABLED|DISABLED',
]

Result Details

Errors

ValidationException:

The user input is not valid.

InternalServerException:

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

AccessDeniedException:

User does not have sufficient access to perform this action.

ThrottlingException:

Request was denied due to request throttling.

GetLens

$result = $client->getLens([/* ... */]);
$promise = $client->getLensAsync([/* ... */]);

Get an existing lens.

Parameter Syntax

$result = $client->getLens([
    'LensAlias' => '<string>', // REQUIRED
    'LensVersion' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Lens' => [
        'Description' => '<string>',
        'LensArn' => '<string>',
        'LensVersion' => '<string>',
        'Name' => '<string>',
        'Owner' => '<string>',
        'ShareInvitationId' => '<string>',
        'Tags' => ['<string>', ...],
    ],
]

Result Details

Errors

ValidationException:

The user input is not valid.

ResourceNotFoundException:

The requested resource was not found.

InternalServerException:

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

AccessDeniedException:

User does not have sufficient access to perform this action.

ThrottlingException:

Request was denied due to request throttling.

GetLensReview

$result = $client->getLensReview([/* ... */]);
$promise = $client->getLensReviewAsync([/* ... */]);

Get lens review.

Parameter Syntax

$result = $client->getLensReview([
    'LensAlias' => '<string>', // REQUIRED
    'MilestoneNumber' => <integer>,
    'WorkloadId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'LensReview' => [
        'JiraConfiguration' => [
            'SelectedPillars' => [
                [
                    'PillarId' => '<string>',
                    'SelectedQuestionIds' => ['<string>', ...],
                ],
                // ...
            ],
        ],
        'LensAlias' => '<string>',
        'LensArn' => '<string>',
        'LensName' => '<string>',
        'LensStatus' => 'CURRENT|NOT_CURRENT|DEPRECATED|DELETED|UNSHARED',
        'LensVersion' => '<string>',
        'NextToken' => '<string>',
        'Notes' => '<string>',
        'PillarReviewSummaries' => [
            [
                'Notes' => '<string>',
                'PillarId' => '<string>',
                'PillarName' => '<string>',
                'PrioritizedRiskCounts' => [<integer>, ...],
                'RiskCounts' => [<integer>, ...],
            ],
            // ...
        ],
        'PrioritizedRiskCounts' => [<integer>, ...],
        'Profiles' => [
            [
                'ProfileArn' => '<string>',
                'ProfileVersion' => '<string>',
            ],
            // ...
        ],
        'RiskCounts' => [<integer>, ...],
        'UpdatedAt' => <DateTime>,
    ],
    'MilestoneNumber' => <integer>,
    'WorkloadId' => '<string>',
]

Result Details

Errors

ValidationException:

The user input is not valid.

ResourceNotFoundException:

The requested resource was not found.

InternalServerException:

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

AccessDeniedException:

User does not have sufficient access to perform this action.

ThrottlingException:

Request was denied due to request throttling.

GetLensReviewReport

$result = $client->getLensReviewReport([/* ... */]);
$promise = $client->getLensReviewReportAsync([/* ... */]);

Get lens review report.

Parameter Syntax

$result = $client->getLensReviewReport([
    'LensAlias' => '<string>', // REQUIRED
    'MilestoneNumber' => <integer>,
    'WorkloadId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'LensReviewReport' => [
        'Base64String' => '<string>',
        'LensAlias' => '<string>',
        'LensArn' => '<string>',
    ],
    'MilestoneNumber' => <integer>,
    'WorkloadId' => '<string>',
]

Result Details

Errors

ValidationException:

The user input is not valid.

ResourceNotFoundException:

The requested resource was not found.

InternalServerException:

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

AccessDeniedException:

User does not have sufficient access to perform this action.

ThrottlingException:

Request was denied due to request throttling.

GetLensVersionDifference

$result = $client->getLensVersionDifference([/* ... */]);
$promise = $client->getLensVersionDifferenceAsync([/* ... */]);

Get lens version differences.

Parameter Syntax

$result = $client->getLensVersionDifference([
    'BaseLensVersion' => '<string>',
    'LensAlias' => '<string>', // REQUIRED
    'TargetLensVersion' => '<string>',
]);

Parameter Details

Result Syntax

[
    'BaseLensVersion' => '<string>',
    'LatestLensVersion' => '<string>',
    'LensAlias' => '<string>',
    'LensArn' => '<string>',
    'TargetLensVersion' => '<string>',
    'VersionDifferences' => [
        'PillarDifferences' => [
            [
                'DifferenceStatus' => 'UPDATED|NEW|DELETED',
                'PillarId' => '<string>',
                'PillarName' => '<string>',
                'QuestionDifferences' => [
                    [
                        'DifferenceStatus' => 'UPDATED|NEW|DELETED',
                        'QuestionId' => '<string>',
                        'QuestionTitle' => '<string>',
                    ],
                    // ...
                ],
            ],
            // ...
        ],
    ],
]

Result Details

Errors

ValidationException:

The user input is not valid.

ResourceNotFoundException:

The requested resource was not found.

InternalServerException:

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

AccessDeniedException:

User does not have sufficient access to perform this action.

ThrottlingException:

Request was denied due to request throttling.

GetMilestone

$result = $client->getMilestone([/* ... */]);
$promise = $client->getMilestoneAsync([/* ... */]);

Get a milestone for an existing workload.

Parameter Syntax

$result = $client->getMilestone([
    'MilestoneNumber' => <integer>, // REQUIRED
    'WorkloadId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Milestone' => [
        'MilestoneName' => '<string>',
        'MilestoneNumber' => <integer>,
        'RecordedAt' => <DateTime>,
        'Workload' => [
            'AccountIds' => ['<string>', ...],
            'Applications' => ['<string>', ...],
            'ArchitecturalDesign' => '<string>',
            'AwsRegions' => ['<string>', ...],
            'Description' => '<string>',
            'DiscoveryConfig' => [
                'TrustedAdvisorIntegrationStatus' => 'ENABLED|DISABLED',
                'WorkloadResourceDefinition' => ['<string>', ...],
            ],
            'Environment' => 'PRODUCTION|PREPRODUCTION',
            'ImprovementStatus' => 'NOT_APPLICABLE|NOT_STARTED|IN_PROGRESS|COMPLETE|RISK_ACKNOWLEDGED',
            'Industry' => '<string>',
            'IndustryType' => '<string>',
            'IsReviewOwnerUpdateAcknowledged' => true || false,
            'JiraConfiguration' => [
                'IssueManagementStatus' => 'ENABLED|DISABLED|INHERIT',
                'IssueManagementType' => 'AUTO|MANUAL',
                'JiraProjectKey' => '<string>',
                'StatusMessage' => '<string>',
            ],
            'Lenses' => ['<string>', ...],
            'NonAwsRegions' => ['<string>', ...],
            'Notes' => '<string>',
            'Owner' => '<string>',
            'PillarPriorities' => ['<string>', ...],
            'PrioritizedRiskCounts' => [<integer>, ...],
            'Profiles' => [
                [
                    'ProfileArn' => '<string>',
                    'ProfileVersion' => '<string>',
                ],
                // ...
            ],
            'ReviewOwner' => '<string>',
            'ReviewRestrictionDate' => <DateTime>,
            'RiskCounts' => [<integer>, ...],
            'ShareInvitationId' => '<string>',
            'Tags' => ['<string>', ...],
            'UpdatedAt' => <DateTime>,
            'WorkloadArn' => '<string>',
            'WorkloadId' => '<string>',
            'WorkloadName' => '<string>',
        ],
    ],
    'WorkloadId' => '<string>',
]

Result Details

Errors

ValidationException:

The user input is not valid.

ResourceNotFoundException:

The requested resource was not found.

InternalServerException:

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

AccessDeniedException:

User does not have sufficient access to perform this action.

ThrottlingException:

Request was denied due to request throttling.

GetProfile

$result = $client->getProfile([/* ... */]);
$promise = $client->getProfileAsync([/* ... */]);

Get profile information.

Parameter Syntax

$result = $client->getProfile([
    'ProfileArn' => '<string>', // REQUIRED
    'ProfileVersion' => '<string>',
]);

Parameter Details

Result Syntax

[
    'Profile' => [
        'CreatedAt' => <DateTime>,
        'Owner' => '<string>',
        'ProfileArn' => '<string>',
        'ProfileDescription' => '<string>',
        'ProfileName' => '<string>',
        'ProfileQuestions' => [
            [
                'MaxSelectedChoices' => <integer>,
                'MinSelectedChoices' => <integer>,
                'QuestionChoices' => [
                    [
                        'ChoiceDescription' => '<string>',
                        'ChoiceId' => '<string>',
                        'ChoiceTitle' => '<string>',
                    ],
                    // ...
                ],
                'QuestionDescription' => '<string>',
                'QuestionId' => '<string>',
                'QuestionTitle' => '<string>',
                'SelectedChoiceIds' => ['<string>', ...],
            ],
            // ...
        ],
        'ProfileVersion' => '<string>',
        'ShareInvitationId' => '<string>',
        'Tags' => ['<string>', ...],
        'UpdatedAt' => <DateTime>,
    ],
]

Result Details

Errors

ValidationException:

The user input is not valid.

ResourceNotFoundException:

The requested resource was not found.

InternalServerException:

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

AccessDeniedException:

User does not have sufficient access to perform this action.

ThrottlingException:

Request was denied due to request throttling.

GetProfileTemplate

$result = $client->getProfileTemplate([/* ... */]);
$promise = $client->getProfileTemplateAsync([/* ... */]);

Get profile template.

Parameter Syntax

$result = $client->getProfileTemplate([
]);

Parameter Details

Result Syntax

[
    'ProfileTemplate' => [
        'CreatedAt' => <DateTime>,
        'TemplateName' => '<string>',
        'TemplateQuestions' => [
            [
                'MaxSelectedChoices' => <integer>,
                'MinSelectedChoices' => <integer>,
                'QuestionChoices' => [
                    [
                        'ChoiceDescription' => '<string>',
                        'ChoiceId' => '<string>',
                        'ChoiceTitle' => '<string>',
                    ],
                    // ...
                ],
                'QuestionDescription' => '<string>',
                'QuestionId' => '<string>',
                'QuestionTitle' => '<string>',
            ],
            // ...
        ],
        'UpdatedAt' => <DateTime>,
    ],
]

Result Details

Errors

ValidationException:

The user input is not valid.

ResourceNotFoundException:

The requested resource was not found.

InternalServerException:

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

AccessDeniedException:

User does not have sufficient access to perform this action.

ThrottlingException:

Request was denied due to request throttling.

GetReviewTemplate

$result = $client->getReviewTemplate([/* ... */]);
$promise = $client->getReviewTemplateAsync([/* ... */]);

Get review template.

Parameter Syntax

$result = $client->getReviewTemplate([
    'TemplateArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ReviewTemplate' => [
        'Description' => '<string>',
        'Lenses' => ['<string>', ...],
        'Notes' => '<string>',
        'Owner' => '<string>',
        'QuestionCounts' => [<integer>, ...],
        'ShareInvitationId' => '<string>',
        'Tags' => ['<string>', ...],
        'TemplateArn' => '<string>',
        'TemplateName' => '<string>',
        'UpdateStatus' => 'CURRENT|LENS_NOT_CURRENT',
        'UpdatedAt' => <DateTime>,
    ],
]

Result Details

Errors

ValidationException:

The user input is not valid.

ResourceNotFoundException:

The requested resource was not found.

InternalServerException:

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

AccessDeniedException:

User does not have sufficient access to perform this action.

ThrottlingException:

Request was denied due to request throttling.

GetReviewTemplateAnswer

$result = $client->getReviewTemplateAnswer([/* ... */]);
$promise = $client->getReviewTemplateAnswerAsync([/* ... */]);

Get review template answer.

Parameter Syntax

$result = $client->getReviewTemplateAnswer([
    'LensAlias' => '<string>', // REQUIRED
    'QuestionId' => '<string>', // REQUIRED
    'TemplateArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Answer' => [
        'AnswerStatus' => 'UNANSWERED|ANSWERED',
        'ChoiceAnswers' => [
            [
                'ChoiceId' => '<string>',
                'Notes' => '<string>',
                'Reason' => 'OUT_OF_SCOPE|BUSINESS_PRIORITIES|ARCHITECTURE_CONSTRAINTS|OTHER|NONE',
                'Status' => 'SELECTED|NOT_APPLICABLE|UNSELECTED',
            ],
            // ...
        ],
        'Choices' => [
            [
                'AdditionalResources' => [
                    [
                        'Content' => [
                            [
                                'DisplayText' => '<string>',
                                'Url' => '<string>',
                            ],
                            // ...
                        ],
                        'Type' => 'HELPFUL_RESOURCE|IMPROVEMENT_PLAN',
                    ],
                    // ...
                ],
                'ChoiceId' => '<string>',
                'Description' => '<string>',
                'HelpfulResource' => [
                    'DisplayText' => '<string>',
                    'Url' => '<string>',
                ],
                'ImprovementPlan' => [
                    'DisplayText' => '<string>',
                    'Url' => '<string>',
                ],
                'Title' => '<string>',
            ],
            // ...
        ],
        'HelpfulResourceDisplayText' => '<string>',
        'HelpfulResourceUrl' => '<string>',
        'ImprovementPlanUrl' => '<string>',
        'IsApplicable' => true || false,
        'Notes' => '<string>',
        'PillarId' => '<string>',
        'QuestionDescription' => '<string>',
        'QuestionId' => '<string>',
        'QuestionTitle' => '<string>',
        'Reason' => 'OUT_OF_SCOPE|BUSINESS_PRIORITIES|ARCHITECTURE_CONSTRAINTS|OTHER|NONE',
        'SelectedChoices' => ['<string>', ...],
    ],
    'LensAlias' => '<string>',
    'TemplateArn' => '<string>',
]

Result Details

Errors

ValidationException:

The user input is not valid.

ResourceNotFoundException:

The requested resource was not found.

InternalServerException:

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

AccessDeniedException:

User does not have sufficient access to perform this action.

ThrottlingException:

Request was denied due to request throttling.

GetReviewTemplateLensReview

$result = $client->getReviewTemplateLensReview([/* ... */]);
$promise = $client->getReviewTemplateLensReviewAsync([/* ... */]);

Get a lens review associated with a review template.

Parameter Syntax

$result = $client->getReviewTemplateLensReview([
    'LensAlias' => '<string>', // REQUIRED
    'TemplateArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'LensReview' => [
        'LensAlias' => '<string>',
        'LensArn' => '<string>',
        'LensName' => '<string>',
        'LensStatus' => 'CURRENT|NOT_CURRENT|DEPRECATED|DELETED|UNSHARED',
        'LensVersion' => '<string>',
        'NextToken' => '<string>',
        'Notes' => '<string>',
        'PillarReviewSummaries' => [
            [
                'Notes' => '<string>',
                'PillarId' => '<string>',
                'PillarName' => '<string>',
                'QuestionCounts' => [<integer>, ...],
            ],
            // ...
        ],
        'QuestionCounts' => [<integer>, ...],
        'UpdatedAt' => <DateTime>,
    ],
    'TemplateArn' => '<string>',
]

Result Details

Errors

ValidationException:

The user input is not valid.

ResourceNotFoundException:

The requested resource was not found.

InternalServerException:

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

AccessDeniedException:

User does not have sufficient access to perform this action.

ThrottlingException:

Request was denied due to request throttling.

GetWorkload

$result = $client->getWorkload([/* ... */]);
$promise = $client->getWorkloadAsync([/* ... */]);

Get an existing workload.

Parameter Syntax

$result = $client->getWorkload([
    'WorkloadId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Workload' => [
        'AccountIds' => ['<string>', ...],
        'Applications' => ['<string>', ...],
        'ArchitecturalDesign' => '<string>',
        'AwsRegions' => ['<string>', ...],
        'Description' => '<string>',
        'DiscoveryConfig' => [
            'TrustedAdvisorIntegrationStatus' => 'ENABLED|DISABLED',
            'WorkloadResourceDefinition' => ['<string>', ...],
        ],
        'Environment' => 'PRODUCTION|PREPRODUCTION',
        'ImprovementStatus' => 'NOT_APPLICABLE|NOT_STARTED|IN_PROGRESS|COMPLETE|RISK_ACKNOWLEDGED',
        'Industry' => '<string>',
        'IndustryType' => '<string>',
        'IsReviewOwnerUpdateAcknowledged' => true || false,
        'JiraConfiguration' => [
            'IssueManagementStatus' => 'ENABLED|DISABLED|INHERIT',
            'IssueManagementType' => 'AUTO|MANUAL',
            'JiraProjectKey' => '<string>',
            'StatusMessage' => '<string>',
        ],
        'Lenses' => ['<string>', ...],
        'NonAwsRegions' => ['<string>', ...],
        'Notes' => '<string>',
        'Owner' => '<string>',
        'PillarPriorities' => ['<string>', ...],
        'PrioritizedRiskCounts' => [<integer>, ...],
        'Profiles' => [
            [
                'ProfileArn' => '<string>',
                'ProfileVersion' => '<string>',
            ],
            // ...
        ],
        'ReviewOwner' => '<string>',
        'ReviewRestrictionDate' => <DateTime>,
        'RiskCounts' => [<integer>, ...],
        'ShareInvitationId' => '<string>',
        'Tags' => ['<string>', ...],
        'UpdatedAt' => <DateTime>,
        'WorkloadArn' => '<string>',
        'WorkloadId' => '<string>',
        'WorkloadName' => '<string>',
    ],
]

Result Details

Errors

ValidationException:

The user input is not valid.

ResourceNotFoundException:

The requested resource was not found.

InternalServerException:

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

AccessDeniedException:

User does not have sufficient access to perform this action.

ThrottlingException:

Request was denied due to request throttling.

ImportLens

$result = $client->importLens([/* ... */]);
$promise = $client->importLensAsync([/* ... */]);

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 in the Well-Architected Tool User Guide.

A custom lens cannot exceed 500 KB in size.

Parameter Syntax

$result = $client->importLens([
    'ClientRequestToken' => '<string>', // REQUIRED
    'JSONString' => '<string>', // REQUIRED
    'LensAlias' => '<string>',
    'Tags' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'LensArn' => '<string>',
    'Status' => 'IN_PROGRESS|COMPLETE|ERROR',
]

Result Details

Errors

ValidationException:

The user input is not valid.

ConflictException:

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

ResourceNotFoundException:

The requested resource was not found.

ServiceQuotaExceededException:

The user has reached their resource quota.

InternalServerException:

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

AccessDeniedException:

User does not have sufficient access to perform this action.

ThrottlingException:

Request was denied due to request throttling.

ListAnswers

$result = $client->listAnswers([/* ... */]);
$promise = $client->listAnswersAsync([/* ... */]);

List of answers for a particular workload and lens.

Parameter Syntax

$result = $client->listAnswers([
    'LensAlias' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'MilestoneNumber' => <integer>,
    'NextToken' => '<string>',
    'PillarId' => '<string>',
    'QuestionPriority' => 'PRIORITIZED|NONE',
    'WorkloadId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'AnswerSummaries' => [
        [
            'ChoiceAnswerSummaries' => [
                [
                    'ChoiceId' => '<string>',
                    'Reason' => 'OUT_OF_SCOPE|BUSINESS_PRIORITIES|ARCHITECTURE_CONSTRAINTS|OTHER|NONE',
                    'Status' => 'SELECTED|NOT_APPLICABLE|UNSELECTED',
                ],
                // ...
            ],
            'Choices' => [
                [
                    'AdditionalResources' => [
                        [
                            'Content' => [
                                [
                                    'DisplayText' => '<string>',
                                    'Url' => '<string>',
                                ],
                                // ...
                            ],
                            'Type' => 'HELPFUL_RESOURCE|IMPROVEMENT_PLAN',
                        ],
                        // ...
                    ],
                    'ChoiceId' => '<string>',
                    'Description' => '<string>',
                    'HelpfulResource' => [
                        'DisplayText' => '<string>',
                        'Url' => '<string>',
                    ],
                    'ImprovementPlan' => [
                        'DisplayText' => '<string>',
                        'Url' => '<string>',
                    ],
                    'Title' => '<string>',
                ],
                // ...
            ],
            'IsApplicable' => true || false,
            'JiraConfiguration' => [
                'JiraIssueUrl' => '<string>',
                'LastSyncedTime' => <DateTime>,
            ],
            'PillarId' => '<string>',
            'QuestionId' => '<string>',
            'QuestionTitle' => '<string>',
            'QuestionType' => 'PRIORITIZED|NON_PRIORITIZED',
            'Reason' => 'OUT_OF_SCOPE|BUSINESS_PRIORITIES|ARCHITECTURE_CONSTRAINTS|OTHER|NONE',
            'Risk' => 'UNANSWERED|HIGH|MEDIUM|NONE|NOT_APPLICABLE',
            'SelectedChoices' => ['<string>', ...],
        ],
        // ...
    ],
    'LensAlias' => '<string>',
    'LensArn' => '<string>',
    'MilestoneNumber' => <integer>,
    'NextToken' => '<string>',
    'WorkloadId' => '<string>',
]

Result Details

Errors

ValidationException:

The user input is not valid.

InternalServerException:

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

ResourceNotFoundException:

The requested resource was not found.

AccessDeniedException:

User does not have sufficient access to perform this action.

ThrottlingException:

Request was denied due to request throttling.

ListCheckDetails

$result = $client->listCheckDetails([/* ... */]);
$promise = $client->listCheckDetailsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listCheckDetails([
    'ChoiceId' => '<string>', // REQUIRED
    'LensArn' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'PillarId' => '<string>', // REQUIRED
    'QuestionId' => '<string>', // REQUIRED
    'WorkloadId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'CheckDetails' => [
        [
            'AccountId' => '<string>',
            'ChoiceId' => '<string>',
            'Description' => '<string>',
            'FlaggedResources' => <integer>,
            'Id' => '<string>',
            'LensArn' => '<string>',
            'Name' => '<string>',
            'PillarId' => '<string>',
            'Provider' => 'TRUSTED_ADVISOR',
            'QuestionId' => '<string>',
            'Reason' => 'ASSUME_ROLE_ERROR|ACCESS_DENIED|UNKNOWN_ERROR|PREMIUM_SUPPORT_REQUIRED',
            'Status' => 'OKAY|WARNING|ERROR|NOT_AVAILABLE|FETCH_FAILED',
            'UpdatedAt' => <DateTime>,
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

ValidationException:

The user input is not valid.

ResourceNotFoundException:

The requested resource was not found.

InternalServerException:

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

AccessDeniedException:

User does not have sufficient access to perform this action.

ThrottlingException:

Request was denied due to request throttling.

ListCheckSummaries

$result = $client->listCheckSummaries([/* ... */]);
$promise = $client->listCheckSummariesAsync([/* ... */]);

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

Parameter Syntax

$result = $client->listCheckSummaries([
    'ChoiceId' => '<string>', // REQUIRED
    'LensArn' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'PillarId' => '<string>', // REQUIRED
    'QuestionId' => '<string>', // REQUIRED
    'WorkloadId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'CheckSummaries' => [
        [
            'AccountSummary' => [<integer>, ...],
            'ChoiceId' => '<string>',
            'Description' => '<string>',
            'Id' => '<string>',
            'LensArn' => '<string>',
            'Name' => '<string>',
            'PillarId' => '<string>',
            'Provider' => 'TRUSTED_ADVISOR',
            'QuestionId' => '<string>',
            'Status' => 'OKAY|WARNING|ERROR|NOT_AVAILABLE|FETCH_FAILED',
            'UpdatedAt' => <DateTime>,
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

ValidationException:

The user input is not valid.

ResourceNotFoundException:

The requested resource was not found.

InternalServerException:

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

AccessDeniedException:

User does not have sufficient access to perform this action.

ThrottlingException:

Request was denied due to request throttling.

ListLensReviewImprovements

$result = $client->listLensReviewImprovements([/* ... */]);
$promise = $client->listLensReviewImprovementsAsync([/* ... */]);

List the improvements of a particular lens review.

Parameter Syntax

$result = $client->listLensReviewImprovements([
    'LensAlias' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'MilestoneNumber' => <integer>,
    'NextToken' => '<string>',
    'PillarId' => '<string>',
    'QuestionPriority' => 'PRIORITIZED|NONE',
    'WorkloadId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'ImprovementSummaries' => [
        [
            'ImprovementPlanUrl' => '<string>',
            'ImprovementPlans' => [
                [
                    'ChoiceId' => '<string>',
                    'DisplayText' => '<string>',
                    'ImprovementPlanUrl' => '<string>',
                ],
                // ...
            ],
            'JiraConfiguration' => [
                'JiraIssueUrl' => '<string>',
                'LastSyncedTime' => <DateTime>,
            ],
            'PillarId' => '<string>',
            'QuestionId' => '<string>',
            'QuestionTitle' => '<string>',
            'Risk' => 'UNANSWERED|HIGH|MEDIUM|NONE|NOT_APPLICABLE',
        ],
        // ...
    ],
    'LensAlias' => '<string>',
    'LensArn' => '<string>',
    'MilestoneNumber' => <integer>,
    'NextToken' => '<string>',
    'WorkloadId' => '<string>',
]

Result Details

Errors

ValidationException:

The user input is not valid.

InternalServerException:

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

ResourceNotFoundException:

The requested resource was not found.

AccessDeniedException:

User does not have sufficient access to perform this action.

ThrottlingException:

Request was denied due to request throttling.

ListLensReviews

$result = $client->listLensReviews([/* ... */]);
$promise = $client->listLensReviewsAsync([/* ... */]);

List lens reviews for a particular workload.

Parameter Syntax

$result = $client->listLensReviews([
    'MaxResults' => <integer>,
    'MilestoneNumber' => <integer>,
    'NextToken' => '<string>',
    'WorkloadId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'LensReviewSummaries' => [
        [
            'LensAlias' => '<string>',
            'LensArn' => '<string>',
            'LensName' => '<string>',
            'LensStatus' => 'CURRENT|NOT_CURRENT|DEPRECATED|DELETED|UNSHARED',
            'LensVersion' => '<string>',
            'PrioritizedRiskCounts' => [<integer>, ...],
            'Profiles' => [
                [
                    'ProfileArn' => '<string>',
                    'ProfileVersion' => '<string>',
                ],
                // ...
            ],
            'RiskCounts' => [<integer>, ...],
            'UpdatedAt' => <DateTime>,
        ],
        // ...
    ],
    'MilestoneNumber' => <integer>,
    'NextToken' => '<string>',
    'WorkloadId' => '<string>',
]

Result Details

Errors

ValidationException:

The user input is not valid.

InternalServerException:

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

ResourceNotFoundException:

The requested resource was not found.

AccessDeniedException:

User does not have sufficient access to perform this action.

ThrottlingException:

Request was denied due to request throttling.

ListLensShares

$result = $client->listLensShares([/* ... */]);
$promise = $client->listLensSharesAsync([/* ... */]);

List the lens shares associated with the lens.

Parameter Syntax

$result = $client->listLensShares([
    'LensAlias' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'SharedWithPrefix' => '<string>',
    'Status' => 'ACCEPTED|REJECTED|PENDING|REVOKED|EXPIRED|ASSOCIATING|ASSOCIATED|FAILED',
]);

Parameter Details

Result Syntax

[
    'LensShareSummaries' => [
        [
            'ShareId' => '<string>',
            'SharedWith' => '<string>',
            'Status' => 'ACCEPTED|REJECTED|PENDING|REVOKED|EXPIRED|ASSOCIATING|ASSOCIATED|FAILED',
            'StatusMessage' => '<string>',
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

ValidationException:

The user input is not valid.

InternalServerException:

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

ResourceNotFoundException:

The requested resource was not found.

AccessDeniedException:

User does not have sufficient access to perform this action.

ThrottlingException:

Request was denied due to request throttling.

ListLenses

$result = $client->listLenses([/* ... */]);
$promise = $client->listLensesAsync([/* ... */]);

List the available lenses.

Parameter Syntax

$result = $client->listLenses([
    'LensName' => '<string>',
    'LensStatus' => 'ALL|DRAFT|PUBLISHED',
    'LensType' => 'AWS_OFFICIAL|CUSTOM_SHARED|CUSTOM_SELF',
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'LensSummaries' => [
        [
            'CreatedAt' => <DateTime>,
            'Description' => '<string>',
            'LensAlias' => '<string>',
            'LensArn' => '<string>',
            'LensName' => '<string>',
            'LensStatus' => 'CURRENT|NOT_CURRENT|DEPRECATED|DELETED|UNSHARED',
            'LensType' => 'AWS_OFFICIAL|CUSTOM_SHARED|CUSTOM_SELF',
            'LensVersion' => '<string>',
            'Owner' => '<string>',
            'UpdatedAt' => <DateTime>,
        ],
        // ...
    ],
    'NextToken' => '<string>',
]

Result Details

Errors

ValidationException:

The user input is not valid.

InternalServerException:

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

AccessDeniedException:

User does not have sufficient access to perform this action.

ThrottlingException:

Request was denied due to request throttling.

ListMilestones

$result = $client->listMilestones([/* ... */]);
$promise = $client->listMilestonesAsync([/* ... */]);

List all milestones for an existing workload.

Parameter Syntax

$result = $client->listMilestones([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'WorkloadId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'MilestoneSummaries' => [
        [
            'MilestoneName' => '<string>',
            'MilestoneNumber' => <integer>,
            'RecordedAt' => <DateTime>,
            'WorkloadSummary' => [
                'ImprovementStatus' => 'NOT_APPLICABLE|NOT_STARTED|IN_PROGRESS|COMPLETE|RISK_ACKNOWLEDGED',
                'Lenses' => ['<string>', ...],
                'Owner' => '<string>',
                'PrioritizedRiskCounts' => [<integer>, ...],
                'Profiles' => [
                    [
                        'ProfileArn' => '<string>',
                        'ProfileVersion' => '<string>',
                    ],
                    // ...
                ],
                'RiskCounts' => [<integer>, ...],
                'UpdatedAt' => <DateTime>,
                'WorkloadArn' => '<string>',
                'WorkloadId' => '<string>',
                'WorkloadName' => '<string>',
            ],
        ],
        // ...
    ],
    'NextToken' => '<string>',
    'WorkloadId' => '<string>',
]

Result Details

Errors

ValidationException:

The user input is not valid.

InternalServerException:

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

ResourceNotFoundException:

The requested resource was not found.

AccessDeniedException:

User does not have sufficient access to perform this action.

ThrottlingException:

Request was denied due to request throttling.

ListNotifications

$result = $client->listNotifications([/* ... */]);
$promise = $client->listNotificationsAsync([/* ... */]);

List lens notifications.

Parameter Syntax

$result = $client->listNotifications([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'ResourceArn' => '<string>',
    'WorkloadId' => '<string>',
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'NotificationSummaries' => [
        [
            'LensUpgradeSummary' => [
                'CurrentLensVersion' => '<string>',
                'LatestLensVersion' => '<string>',
                'LensAlias' => '<string>',
                'LensArn' => '<string>',
                'ResourceArn' => '<string>',
                'ResourceName' => '<string>',
                'WorkloadId' => '<string>',
                'WorkloadName' => '<string>',
            ],
            'Type' => 'LENS_VERSION_UPGRADED|LENS_VERSION_DEPRECATED',
        ],
        // ...
    ],
]

Result Details

Errors

ValidationException:

The user input is not valid.

InternalServerException:

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

AccessDeniedException:

User does not have sufficient access to perform this action.

ThrottlingException:

Request was denied due to request throttling.

ListProfileNotifications

$result = $client->listProfileNotifications([/* ... */]);
$promise = $client->listProfileNotificationsAsync([/* ... */]);

List profile notifications.

Parameter Syntax

$result = $client->listProfileNotifications([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'WorkloadId' => '<string>',
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'NotificationSummaries' => [
        [
            'CurrentProfileVersion' => '<string>',
            'LatestProfileVersion' => '<string>',
            'ProfileArn' => '<string>',
            'ProfileName' => '<string>',
            'Type' => 'PROFILE_ANSWERS_UPDATED|PROFILE_DELETED',
            'WorkloadId' => '<string>',
            'WorkloadName' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ValidationException:

The user input is not valid.

InternalServerException:

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

AccessDeniedException:

User does not have sufficient access to perform this action.

ThrottlingException:

Request was denied due to request throttling.

ListProfileShares

$result = $client->listProfileShares([/* ... */]);
$promise = $client->listProfileSharesAsync([/* ... */]);

List profile shares.

Parameter Syntax

$result = $client->listProfileShares([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'ProfileArn' => '<string>', // REQUIRED
    'SharedWithPrefix' => '<string>',
    'Status' => 'ACCEPTED|REJECTED|PENDING|REVOKED|EXPIRED|ASSOCIATING|ASSOCIATED|FAILED',
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'ProfileShareSummaries' => [
        [
            'ShareId' => '<string>',
            'SharedWith' => '<string>',
            'Status' => 'ACCEPTED|REJECTED|PENDING|REVOKED|EXPIRED|ASSOCIATING|ASSOCIATED|FAILED',
            'StatusMessage' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ValidationException:

The user input is not valid.

InternalServerException:

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

ResourceNotFoundException:

The requested resource was not found.

AccessDeniedException:

User does not have sufficient access to perform this action.

ThrottlingException:

Request was denied due to request throttling.

ListProfiles

$result = $client->listProfiles([/* ... */]);
$promise = $client->listProfilesAsync([/* ... */]);

List profiles.

Parameter Syntax

$result = $client->listProfiles([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'ProfileNamePrefix' => '<string>',
    'ProfileOwnerType' => 'SELF|SHARED',
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'ProfileSummaries' => [
        [
            'CreatedAt' => <DateTime>,
            'Owner' => '<string>',
            'ProfileArn' => '<string>',
            'ProfileDescription' => '<string>',
            'ProfileName' => '<string>',
            'ProfileVersion' => '<string>',
            'UpdatedAt' => <DateTime>,
        ],
        // ...
    ],
]

Result Details

Errors

ValidationException:

The user input is not valid.

InternalServerException:

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

AccessDeniedException:

User does not have sufficient access to perform this action.

ThrottlingException:

Request was denied due to request throttling.

ListReviewTemplateAnswers

$result = $client->listReviewTemplateAnswers([/* ... */]);
$promise = $client->listReviewTemplateAnswersAsync([/* ... */]);

List the answers of a review template.

Parameter Syntax

$result = $client->listReviewTemplateAnswers([
    'LensAlias' => '<string>', // REQUIRED
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'PillarId' => '<string>',
    'TemplateArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'AnswerSummaries' => [
        [
            'AnswerStatus' => 'UNANSWERED|ANSWERED',
            'ChoiceAnswerSummaries' => [
                [
                    'ChoiceId' => '<string>',
                    'Reason' => 'OUT_OF_SCOPE|BUSINESS_PRIORITIES|ARCHITECTURE_CONSTRAINTS|OTHER|NONE',
                    'Status' => 'SELECTED|NOT_APPLICABLE|UNSELECTED',
                ],
                // ...
            ],
            'Choices' => [
                [
                    'AdditionalResources' => [
                        [
                            'Content' => [
                                [
                                    'DisplayText' => '<string>',
                                    'Url' => '<string>',
                                ],
                                // ...
                            ],
                            'Type' => 'HELPFUL_RESOURCE|IMPROVEMENT_PLAN',
                        ],
                        // ...
                    ],
                    'ChoiceId' => '<string>',
                    'Description' => '<string>',
                    'HelpfulResource' => [
                        'DisplayText' => '<string>',
                        'Url' => '<string>',
                    ],
                    'ImprovementPlan' => [
                        'DisplayText' => '<string>',
                        'Url' => '<string>',
                    ],
                    'Title' => '<string>',
                ],
                // ...
            ],
            'IsApplicable' => true || false,
            'PillarId' => '<string>',
            'QuestionId' => '<string>',
            'QuestionTitle' => '<string>',
            'QuestionType' => 'PRIORITIZED|NON_PRIORITIZED',
            'Reason' => 'OUT_OF_SCOPE|BUSINESS_PRIORITIES|ARCHITECTURE_CONSTRAINTS|OTHER|NONE',
            'SelectedChoices' => ['<string>', ...],
        ],
        // ...
    ],
    'LensAlias' => '<string>',
    'NextToken' => '<string>',
    'TemplateArn' => '<string>',
]

Result Details

Errors

ValidationException:

The user input is not valid.

InternalServerException:

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

ResourceNotFoundException:

The requested resource was not found.

AccessDeniedException:

User does not have sufficient access to perform this action.

ThrottlingException:

Request was denied due to request throttling.

ListReviewTemplates

$result = $client->listReviewTemplates([/* ... */]);
$promise = $client->listReviewTemplatesAsync([/* ... */]);

List review templates.

Parameter Syntax

$result = $client->listReviewTemplates([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'ReviewTemplates' => [
        [
            'Description' => '<string>',
            'Lenses' => ['<string>', ...],
            'Owner' => '<string>',
            'TemplateArn' => '<string>',
            'TemplateName' => '<string>',
            'UpdateStatus' => 'CURRENT|LENS_NOT_CURRENT',
            'UpdatedAt' => <DateTime>,
        ],
        // ...
    ],
]

Result Details

Errors

ValidationException:

The user input is not valid.

InternalServerException:

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

AccessDeniedException:

User does not have sufficient access to perform this action.

ThrottlingException:

Request was denied due to request throttling.

ListShareInvitations

$result = $client->listShareInvitations([/* ... */]);
$promise = $client->listShareInvitationsAsync([/* ... */]);

List the share invitations.

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

Parameter Syntax

$result = $client->listShareInvitations([
    'LensNamePrefix' => '<string>',
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'ProfileNamePrefix' => '<string>',
    'ShareResourceType' => 'WORKLOAD|LENS|PROFILE|TEMPLATE',
    'TemplateNamePrefix' => '<string>',
    'WorkloadNamePrefix' => '<string>',
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'ShareInvitationSummaries' => [
        [
            'LensArn' => '<string>',
            'LensName' => '<string>',
            'PermissionType' => 'READONLY|CONTRIBUTOR',
            'ProfileArn' => '<string>',
            'ProfileName' => '<string>',
            'ShareInvitationId' => '<string>',
            'ShareResourceType' => 'WORKLOAD|LENS|PROFILE|TEMPLATE',
            'SharedBy' => '<string>',
            'SharedWith' => '<string>',
            'TemplateArn' => '<string>',
            'TemplateName' => '<string>',
            'WorkloadId' => '<string>',
            'WorkloadName' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ValidationException:

The user input is not valid.

InternalServerException:

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

AccessDeniedException:

User does not have sufficient access to perform this action.

ThrottlingException:

Request was denied due to request throttling.

ListTagsForResource

$result = $client->listTagsForResource([/* ... */]);
$promise = $client->listTagsForResourceAsync([/* ... */]);

List the tags for a resource.

Parameter Syntax

$result = $client->listTagsForResource([
    'WorkloadArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Tags' => ['<string>', ...],
]

Result Details

Errors

InternalServerException:

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

ResourceNotFoundException:

The requested resource was not found.

ListTemplateShares

$result = $client->listTemplateShares([/* ... */]);
$promise = $client->listTemplateSharesAsync([/* ... */]);

List review template shares.

Parameter Syntax

$result = $client->listTemplateShares([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'SharedWithPrefix' => '<string>',
    'Status' => 'ACCEPTED|REJECTED|PENDING|REVOKED|EXPIRED|ASSOCIATING|ASSOCIATED|FAILED',
    'TemplateArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'TemplateArn' => '<string>',
    'TemplateShareSummaries' => [
        [
            'ShareId' => '<string>',
            'SharedWith' => '<string>',
            'Status' => 'ACCEPTED|REJECTED|PENDING|REVOKED|EXPIRED|ASSOCIATING|ASSOCIATED|FAILED',
            'StatusMessage' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ValidationException:

The user input is not valid.

InternalServerException:

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

ResourceNotFoundException:

The requested resource was not found.

AccessDeniedException:

User does not have sufficient access to perform this action.

ThrottlingException:

Request was denied due to request throttling.

ListWorkloadShares

$result = $client->listWorkloadShares([/* ... */]);
$promise = $client->listWorkloadSharesAsync([/* ... */]);

List the workload shares associated with the workload.

Parameter Syntax

$result = $client->listWorkloadShares([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'SharedWithPrefix' => '<string>',
    'Status' => 'ACCEPTED|REJECTED|PENDING|REVOKED|EXPIRED|ASSOCIATING|ASSOCIATED|FAILED',
    'WorkloadId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'WorkloadId' => '<string>',
    'WorkloadShareSummaries' => [
        [
            'PermissionType' => 'READONLY|CONTRIBUTOR',
            'ShareId' => '<string>',
            'SharedWith' => '<string>',
            'Status' => 'ACCEPTED|REJECTED|PENDING|REVOKED|EXPIRED|ASSOCIATING|ASSOCIATED|FAILED',
            'StatusMessage' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ValidationException:

The user input is not valid.

InternalServerException:

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

ResourceNotFoundException:

The requested resource was not found.

AccessDeniedException:

User does not have sufficient access to perform this action.

ThrottlingException:

Request was denied due to request throttling.

ListWorkloads

$result = $client->listWorkloads([/* ... */]);
$promise = $client->listWorkloadsAsync([/* ... */]);

Paginated list of workloads.

Parameter Syntax

$result = $client->listWorkloads([
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'WorkloadNamePrefix' => '<string>',
]);

Parameter Details

Result Syntax

[
    'NextToken' => '<string>',
    'WorkloadSummaries' => [
        [
            'ImprovementStatus' => 'NOT_APPLICABLE|NOT_STARTED|IN_PROGRESS|COMPLETE|RISK_ACKNOWLEDGED',
            'Lenses' => ['<string>', ...],
            'Owner' => '<string>',
            'PrioritizedRiskCounts' => [<integer>, ...],
            'Profiles' => [
                [
                    'ProfileArn' => '<string>',
                    'ProfileVersion' => '<string>',
                ],
                // ...
            ],
            'RiskCounts' => [<integer>, ...],
            'UpdatedAt' => <DateTime>,
            'WorkloadArn' => '<string>',
            'WorkloadId' => '<string>',
            'WorkloadName' => '<string>',
        ],
        // ...
    ],
]

Result Details

Errors

ValidationException:

The user input is not valid.

InternalServerException:

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

AccessDeniedException:

User does not have sufficient access to perform this action.

ThrottlingException:

Request was denied due to request throttling.

TagResource

$result = $client->tagResource([/* ... */]);
$promise = $client->tagResourceAsync([/* ... */]);

Adds one or more tags to the specified resource.

Parameter Syntax

$result = $client->tagResource([
    'Tags' => ['<string>', ...], // REQUIRED
    'WorkloadArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalServerException:

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

ResourceNotFoundException:

The requested resource was not found.

UntagResource

$result = $client->untagResource([/* ... */]);
$promise = $client->untagResourceAsync([/* ... */]);

Deletes specified tags from a resource.

To specify multiple tags, use separate tagKeys parameters, for example:

DELETE /tags/WorkloadArn?tagKeys=key1&tagKeys=key2

Parameter Syntax

$result = $client->untagResource([
    'TagKeys' => ['<string>', ...], // REQUIRED
    'WorkloadArn' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

InternalServerException:

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

ResourceNotFoundException:

The requested resource was not found.

UpdateAnswer

$result = $client->updateAnswer([/* ... */]);
$promise = $client->updateAnswerAsync([/* ... */]);

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

Parameter Syntax

$result = $client->updateAnswer([
    'ChoiceUpdates' => [
        '<ChoiceId>' => [
            'Notes' => '<string>',
            'Reason' => 'OUT_OF_SCOPE|BUSINESS_PRIORITIES|ARCHITECTURE_CONSTRAINTS|OTHER|NONE',
            'Status' => 'SELECTED|NOT_APPLICABLE|UNSELECTED', // REQUIRED
        ],
        // ...
    ],
    'IsApplicable' => true || false,
    'LensAlias' => '<string>', // REQUIRED
    'Notes' => '<string>',
    'QuestionId' => '<string>', // REQUIRED
    'Reason' => 'OUT_OF_SCOPE|BUSINESS_PRIORITIES|ARCHITECTURE_CONSTRAINTS|OTHER|NONE',
    'SelectedChoices' => ['<string>', ...],
    'WorkloadId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'Answer' => [
        'ChoiceAnswers' => [
            [
                'ChoiceId' => '<string>',
                'Notes' => '<string>',
                'Reason' => 'OUT_OF_SCOPE|BUSINESS_PRIORITIES|ARCHITECTURE_CONSTRAINTS|OTHER|NONE',
                'Status' => 'SELECTED|NOT_APPLICABLE|UNSELECTED',
            ],
            // ...
        ],
        'Choices' => [
            [
                'AdditionalResources' => [
                    [
                        'Content' => [
                            [
                                'DisplayText' => '<string>',
                                'Url' => '<string>',
                            ],
                            // ...
                        ],
                        'Type' => 'HELPFUL_RESOURCE|IMPROVEMENT_PLAN',
                    ],
                    // ...
                ],
                'ChoiceId' => '<string>',
                'Description' => '<string>',
                'HelpfulResource' => [
                    'DisplayText' => '<string>',
                    'Url' => '<string>',
                ],
                'ImprovementPlan' => [
                    'DisplayText' => '<string>',
                    'Url' => '<string>',
                ],
                'Title' => '<string>',
            ],
            // ...
        ],
        'HelpfulResourceDisplayText' => '<string>',
        'HelpfulResourceUrl' => '<string>',
        'ImprovementPlanUrl' => '<string>',
        'IsApplicable' => true || false,
        'JiraConfiguration' => [
            'JiraIssueUrl' => '<string>',
            'LastSyncedTime' => <DateTime>,
        ],
        'Notes' => '<string>',
        'PillarId' => '<string>',
        'QuestionDescription' => '<string>',
        'QuestionId' => '<string>',
        'QuestionTitle' => '<string>',
        'Reason' => 'OUT_OF_SCOPE|BUSINESS_PRIORITIES|ARCHITECTURE_CONSTRAINTS|OTHER|NONE',
        'Risk' => 'UNANSWERED|HIGH|MEDIUM|NONE|NOT_APPLICABLE',
        'SelectedChoices' => ['<string>', ...],
    ],
    'LensAlias' => '<string>',
    'LensArn' => '<string>',
    'WorkloadId' => '<string>',
]

Result Details

Errors

ValidationException:

The user input is not valid.

ResourceNotFoundException:

The requested resource was not found.

ConflictException:

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

InternalServerException:

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

AccessDeniedException:

User does not have sufficient access to perform this action.

ThrottlingException:

Request was denied due to request throttling.

UpdateGlobalSettings

$result = $client->updateGlobalSettings([/* ... */]);
$promise = $client->updateGlobalSettingsAsync([/* ... */]);

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

Parameter Syntax

$result = $client->updateGlobalSettings([
    'DiscoveryIntegrationStatus' => 'ENABLED|DISABLED',
    'JiraConfiguration' => [
        'IntegrationStatus' => 'NOT_CONFIGURED',
        'IssueManagementStatus' => 'ENABLED|DISABLED',
        'IssueManagementType' => 'AUTO|MANUAL',
        'JiraProjectKey' => '<string>',
    ],
    'OrganizationSharingStatus' => 'ENABLED|DISABLED',
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

The user input is not valid.

ConflictException:

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

InternalServerException:

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

AccessDeniedException:

User does not have sufficient access to perform this action.

ThrottlingException:

Request was denied due to request throttling.

UpdateIntegration

$result = $client->updateIntegration([/* ... */]);
$promise = $client->updateIntegrationAsync([/* ... */]);

Update integration features.

Parameter Syntax

$result = $client->updateIntegration([
    'ClientRequestToken' => '<string>', // REQUIRED
    'IntegratingService' => 'JIRA', // REQUIRED
    'WorkloadId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

ValidationException:

The user input is not valid.

ConflictException:

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

ResourceNotFoundException:

The requested resource was not found.

AccessDeniedException:

User does not have sufficient access to perform this action.

InternalServerException:

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

ThrottlingException:

Request was denied due to request throttling.