Amazon Web Services Workloads API

openapi: 3.1.0
info:
  title: Amazon Web Services accessanalyzer 2012 09 25 Workloads API
  description: <p>Identity and Access Management Access Analyzer helps you to set, verify, and refine your IAM policies by providing a suite of capabilities. Its features include findings for external and unused access, basic and custom policy checks for validating policies, and policy generation to generate fine-grained policies. To start using IAM Access Analyzer to identify external or unused access, you first need to create an analyzer.</p> <p> <b>External access analyzers</b> help identify potential risks of accessing resources by enabling you to identify any resource policies that grant access to an external principal. It does this by using logic-based reasoning to analyze resource-based policies in your Amazon Web Services environment. An external principal can be another Amazon Web Services account, a root user, an IAM user or role, a federated user, an Amazon Web Services service, or an anonymous user. You can also use IAM Access Analyzer to preview public and cross-account access to your resources before deploying permissions changes.</p> <p> <b>Unused access analyzers</b> help identify potential identity access risks by enabling you to identify unused IAM roles, unused access keys, unused console passwords, and IAM principals with unused service and action-level permissions.</p> <p>Beyond findings, IAM Access Analyzer provides basic and custom policy checks to validate IAM policies before deploying permissions changes. You can use policy generation to refine permissions by attaching a policy generated using access activity logged in CloudTrail logs. </p> <p>This guide describes the IAM Access Analyzer operations that you can call programmatically. For general information about IAM Access Analyzer, see <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/what-is-access-analyzer.html">Identity and Access Management Access Analyzer</a> in the <b>IAM User Guide</b>.</p>
tags:
- name: Workloads
paths:
  /workloads/{WorkloadId}/associateLenses:
    PATCH:
      summary: Amazon Web Services Associatelenses
      description: 'Associate a lens to a workload. Up to 10 lenses can be associated with a workload in a single API operation. A maximum of 20 lenses can be associated with a workload.   Disclaimer  By accessing and/or applying custom lenses created by another Amazon Web Services user or account, you acknowledge that custom lenses created by other users and shared with you are Third Party Content as defined in the Amazon Web Services Customer Agreement.  '
      operationId: amazonWebServicesAssociateLenses
      tags:
      - Workloads
  /workloads/{WorkloadId}/associateProfiles:
    PATCH:
      summary: Amazon Web Services Associateprofiles
      description: Associate a profile with a workload.
      operationId: amazonWebServicesAssociateProfiles
      tags:
      - Workloads
  /workloads/{WorkloadId}/milestones:
    POST:
      summary: Amazon Web Services Createmilestone
      description: Create a milestone for an existing workload.
      operationId: amazonWebServicesCreateMilestone
      tags:
      - Workloads
  /workloads:
    POST:
      summary: Amazon Web Services Createworkload
      description: '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.  Either AwsRegions, NonAwsRegions, or both must be specified when creating a workload. You also must specify ReviewOwner, even though the parameter is listed as not being required in the following section.   When creating a workload using a review template, you must have the following IAM permissions:    wellarchitected:GetReviewTemplate     wellarchitected:GetReviewTemplateAnswer     wellarchitected:ListReviewTemplateAnswers     wellarchitected:GetReviewTemplateLensReview   '
      operationId: amazonWebServicesCreateWorkload
      tags:
      - Workloads
  /workloads/{WorkloadId}/shares:
    GET:
      summary: Amazon Web Services Listworkloadshares
      description: List the workload shares associated with the workload.
      operationId: amazonWebServicesListWorkloadShares
      tags:
      - Workloads
  /workloads/{WorkloadId}:
    PATCH:
      summary: Amazon Web Services Updateworkload
      description: Update an existing workload.
      operationId: amazonWebServicesUpdateWorkload
      tags:
      - Workloads
  /workloads/{WorkloadId}/shares/{ShareId}:
    PATCH:
      summary: Amazon Web Services Updateworkloadshare
      description: Update a workload share.
      operationId: amazonWebServicesUpdateWorkloadShare
      tags:
      - Workloads
  /workloads/{WorkloadId}/disassociateLenses:
    PATCH:
      summary: Amazon Web Services Disassociatelenses
      description: 'Disassociate a lens from a workload. Up to 10 lenses can be disassociated from a workload in a single API operation.  The Amazon Web Services Well-Architected Framework lens (wellarchitected) cannot be removed from a workload. '
      operationId: amazonWebServicesDisassociateLenses
      tags:
      - Workloads
  /workloads/{WorkloadId}/disassociateProfiles:
    PATCH:
      summary: Amazon Web Services Disassociateprofiles
      description: Disassociate a profile from a workload.
      operationId: amazonWebServicesDisassociateProfiles
      tags:
      - Workloads
  /workloads/{WorkloadId}/lensReviews/{LensAlias}/answers/{QuestionId}:
    PATCH:
      summary: Amazon Web Services Updateanswer
      description: Update the answer to a specific question in a workload review.
      operationId: amazonWebServicesUpdateAnswer
      tags:
      - Workloads
  /workloads/{WorkloadId}/lensReviews/{LensAlias}:
    PATCH:
      summary: Amazon Web Services Updatelensreview
      description: Update lens review for a particular workload.
      operationId: amazonWebServicesUpdateLensReview
      tags:
      - Workloads
  /workloads/{WorkloadId}/lensReviews/{LensAlias}/report:
    GET:
      summary: Amazon Web Services Getlensreviewreport
      description: Get lens review report.
      operationId: amazonWebServicesGetLensReviewReport
      tags:
      - Workloads
  /workloads/{WorkloadId}/milestones/{MilestoneNumber}:
    GET:
      summary: Amazon Web Services Getmilestone
      description: Get a milestone for an existing workload.
      operationId: amazonWebServicesGetMilestone
      tags:
      - Workloads
  /workloads/{WorkloadId}/lensReviews/{LensAlias}/answers:
    GET:
      summary: Amazon Web Services Listanswers
      description: List of answers for a particular workload and lens.
      operationId: amazonWebServicesListAnswers
      tags:
      - Workloads
  /workloads/{WorkloadId}/checks:
    POST:
      summary: Amazon Web Services Listcheckdetails
      description: List of Trusted Advisor check details by account related to the workload.
      operationId: amazonWebServicesListCheckDetails
      tags:
      - Workloads
  /workloads/{WorkloadId}/checkSummaries:
    POST:
      summary: Amazon Web Services Listchecksummaries
      description: List of Trusted Advisor checks summarized for all accounts related to the workload.
      operationId: amazonWebServicesListCheckSummaries
      tags:
      - Workloads
  /workloads/{WorkloadId}/lensReviews/{LensAlias}/improvements:
    GET:
      summary: Amazon Web Services Listlensreviewimprovements
      description: List lens review improvements.
      operationId: amazonWebServicesListLensReviewImprovements
      tags:
      - Workloads
  /workloads/{WorkloadId}/lensReviews:
    GET:
      summary: Amazon Web Services Listlensreviews
      description: List lens reviews for a particular workload.
      operationId: amazonWebServicesListLensReviews
      tags:
      - Workloads
  /workloads/{WorkloadId}/milestonesSummaries:
    POST:
      summary: Amazon Web Services Listmilestones
      description: List all milestones for an existing workload.
      operationId: amazonWebServicesListMilestones
      tags:
      - Workloads
  /workloads/{WorkloadId}/lensReviews/{LensAlias}/upgrade:
    PUT:
      summary: Amazon Web Services Upgradelensreview
      description: Upgrade lens review for a particular workload.
      operationId: amazonWebServicesUpgradeLensReview
      tags:
      - Workloads
  /workloads/{WorkloadId}/profiles/{ProfileArn}/upgrade:
    PUT:
      summary: Amazon Web Services Upgradeprofileversion
      description: Upgrade a profile.
      operationId: amazonWebServicesUpgradeProfileVersion
      tags:
      - Workloads