openapi-directory

Version:

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

github.com/httptoolkit/openapi-directory-js

1 lines • 235 kB

JSON

{"openapi":"3.0.0","info":{"version":"2020-03-31","x-release":"v4","title":"AWS Well-Architected Tool","description":"<fullname>Well-Architected Tool</fullname> This is the Well-Architected Tool API Reference. The WA Tool API provides programmatic access to the <a href=\"http://aws.amazon.com/well-architected-tool\">Well-Architected Tool</a> in the <a href=\"https://console.aws.amazon.com/wellarchitected\">Amazon Web Services Management Console</a>. For information about the Well-Architected Tool, see the <a href=\"https://docs.aws.amazon.com/wellarchitected/latest/userguide/intro.html\">Well-Architected Tool User Guide</a>.","x-logo":{"url":"https://twitter.com/awscloud/profile_image?size=original","backgroundColor":"#FFFFFF"},"termsOfService":"https://aws.amazon.com/service-terms/","contact":{"name":"Mike Ralphson","email":"mike.ralphson@gmail.com","url":"https://github.com/mermade/aws2openapi","x-twitter":"PermittedSoc"},"license":{"name":"Apache 2.0 License","url":"http://www.apache.org/licenses/"},"x-providerName":"amazonaws.com","x-serviceName":"wellarchitected","x-aws-signingName":"wellarchitected","x-origin":[{"contentType":"application/json","url":"https://raw.githubusercontent.com/aws/aws-sdk-js/master/apis/wellarchitected-2020-03-31.normal.json","converter":{"url":"https://github.com/mermade/aws2openapi","version":"1.0.0"},"x-apisguru-driver":"external"}],"x-apiClientRegistration":{"url":"https://portal.aws.amazon.com/gp/aws/developer/registration/index.html?nc2=h_ct"},"x-apisguru-categories":["cloud"],"x-preferred":true},"externalDocs":{"description":"Amazon Web Services documentation","url":"https://docs.aws.amazon.com/wellarchitected/"},"servers":[{"url":"http://wellarchitected.{region}.amazonaws.com","variables":{"region":{"description":"The AWS region","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-west-1","us-gov-east-1","ca-central-1","eu-north-1","eu-west-1","eu-west-2","eu-west-3","eu-central-1","eu-south-1","af-south-1","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-east-1","ap-south-1","sa-east-1","me-south-1"],"default":"us-east-1"}},"description":"The Well-Architected multi-region endpoint"},{"url":"https://wellarchitected.{region}.amazonaws.com","variables":{"region":{"description":"The AWS region","enum":["us-east-1","us-east-2","us-west-1","us-west-2","us-gov-west-1","us-gov-east-1","ca-central-1","eu-north-1","eu-west-1","eu-west-2","eu-west-3","eu-central-1","eu-south-1","af-south-1","ap-northeast-1","ap-northeast-2","ap-northeast-3","ap-southeast-1","ap-southeast-2","ap-east-1","ap-south-1","sa-east-1","me-south-1"],"default":"us-east-1"}},"description":"The Well-Architected multi-region endpoint"},{"url":"http://wellarchitected.{region}.amazonaws.com.cn","variables":{"region":{"description":"The AWS region","enum":["cn-north-1","cn-northwest-1"],"default":"cn-north-1"}},"description":"The Well-Architected endpoint for China (Beijing) and China (Ningxia)"},{"url":"https://wellarchitected.{region}.amazonaws.com.cn","variables":{"region":{"description":"The AWS region","enum":["cn-north-1","cn-northwest-1"],"default":"cn-north-1"}},"description":"The Well-Architected endpoint for China (Beijing) and China (Ningxia)"}],"x-hasEquivalentPaths":true,"paths":{"/workloads/{WorkloadId}/associateLenses":{"patch":{"operationId":"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. <note> 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. </note>","responses":{"200":{"description":"Success"},"480":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"481":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"482":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"483":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"484":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"485":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}}},"parameters":[{"name":"WorkloadId","in":"path","required":true,"description":"","schema":{"type":"string","pattern":"[0-9a-f]{32}","description":"The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.","minLength":32,"maxLength":32}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["LensAliases"],"properties":{"LensAliases":{"description":"List of lens aliases to associate or disassociate with a workload. Up to 10 lenses can be specified. Identify a lens using its <a>LensSummary$LensAlias</a>.","type":"array","items":{"$ref":"#/components/schemas/LensAlias"},"minItems":1}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/workloads/{WorkloadId}/associateProfiles":{"patch":{"operationId":"AssociateProfiles","description":"Associate a profile with a workload.","responses":{"200":{"description":"Success"},"480":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"481":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"482":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"483":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"484":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"485":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}}},"parameters":[{"name":"WorkloadId","in":"path","required":true,"description":"","schema":{"type":"string","pattern":"[0-9a-f]{32}","description":"The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.","minLength":32,"maxLength":32}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ProfileArns"],"properties":{"ProfileArns":{"description":"The list of profile ARNs to associate with the workload.","type":"array","items":{"$ref":"#/components/schemas/ProfileArn"},"minItems":1}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/lenses/{LensAlias}/shares":{"post":{"operationId":"CreateLensShare","description":"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 <a href=\"https://docs.aws.amazon.com/wellarchitected/latest/userguide/lenses-sharing.html\">Sharing a custom lens</a> in the Well-Architected Tool User Guide. <note> Disclaimer By sharing your custom lenses with other Amazon Web Services accounts, you acknowledge that Amazon Web Services will make your custom lenses available to those other accounts. Those other accounts may continue to access and use your shared custom lenses even if you delete the custom lenses from your own Amazon Web Services account or terminate your Amazon Web Services account. </note>","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateLensShareOutput"}}}},"480":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"481":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"482":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"483":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"484":{"description":"ServiceQuotaExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceQuotaExceededException"}}}},"485":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"486":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}}},"parameters":[{"name":"LensAlias","in":"path","required":true,"description":"","schema":{"type":"string","description":"The alias of the lens. For Amazon Web Services official lenses, this is either the lens alias, such as <code>serverless</code>, or the lens ARN, such as <code>arn:aws:wellarchitected:us-east-1::lens/serverless</code>. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses. For custom lenses, this is the lens ARN, such as <code>arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef</code>. Each lens is identified by its <a>LensSummary$LensAlias</a>.","minLength":1,"maxLength":128}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["SharedWith","ClientRequestToken"],"properties":{"SharedWith":{"description":"The Amazon Web Services account ID, IAM role, organization ID, or organizational unit (OU) ID with which the workload, lens, or profile is shared.","type":"string","minLength":12,"maxLength":2048},"ClientRequestToken":{"description":"A unique case-sensitive string used to ensure that this request is idempotent (executes only once). You should not reuse the same token for other requests. If you retry a request with the same client request token and the same parameters after the original request has completed successfully, the result of the original request is returned. <important> This token is listed as required, however, if you do not specify it, the Amazon Web Services SDKs automatically generate one for you. If you are not using the Amazon Web Services SDK or the CLI, you must provide this token or the request will fail. </important>","type":"string","minLength":1,"maxLength":2048}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"ListLensShares","description":"List the lens shares associated with the lens.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListLensSharesOutput"}}}},"480":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"481":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"482":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"483":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"484":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}}},"parameters":[{"name":"LensAlias","in":"path","required":true,"description":"","schema":{"type":"string","description":"The alias of the lens. For Amazon Web Services official lenses, this is either the lens alias, such as <code>serverless</code>, or the lens ARN, such as <code>arn:aws:wellarchitected:us-east-1::lens/serverless</code>. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses. For custom lenses, this is the lens ARN, such as <code>arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef</code>. Each lens is identified by its <a>LensSummary$LensAlias</a>.","minLength":1,"maxLength":128}},{"name":"SharedWithPrefix","in":"query","required":false,"description":"The Amazon Web Services account ID, IAM role, organization ID, or organizational unit (OU) ID with which the lens is shared.","schema":{"type":"string","maxLength":100}},{"name":"NextToken","in":"query","required":false,"description":"","schema":{"type":"string","description":"The token to use to retrieve the next set of results."}},{"name":"MaxResults","in":"query","required":false,"description":"The maximum number of results to return for this request.","schema":{"type":"integer","minimum":1,"maximum":50}},{"name":"Status","in":"query","required":false,"description":"","schema":{"type":"string","enum":["ACCEPTED","REJECTED","PENDING","REVOKED","EXPIRED","ASSOCIATING","ASSOCIATED","FAILED"],"description":"The status of the share request."}}]}},"/lenses/{LensAlias}/versions":{"post":{"operationId":"CreateLensVersion","description":"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 <code>LensAlias</code> 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. ","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateLensVersionOutput"}}}},"480":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"481":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"482":{"description":"ServiceQuotaExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceQuotaExceededException"}}}},"483":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"484":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"485":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"486":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}}},"parameters":[{"name":"LensAlias","in":"path","required":true,"description":"","schema":{"type":"string","description":"The alias of the lens. For Amazon Web Services official lenses, this is either the lens alias, such as <code>serverless</code>, or the lens ARN, such as <code>arn:aws:wellarchitected:us-east-1::lens/serverless</code>. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses. For custom lenses, this is the lens ARN, such as <code>arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef</code>. Each lens is identified by its <a>LensSummary$LensAlias</a>.","minLength":1,"maxLength":128}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["LensVersion","ClientRequestToken"],"properties":{"LensVersion":{"description":"The version of the lens being created.","type":"string","minLength":1,"maxLength":32},"IsMajorVersion":{"description":"Set to true if this new major lens version.","type":"boolean"},"ClientRequestToken":{"description":"A unique case-sensitive string used to ensure that this request is idempotent (executes only once). You should not reuse the same token for other requests. If you retry a request with the same client request token and the same parameters after the original request has completed successfully, the result of the original request is returned. <important> This token is listed as required, however, if you do not specify it, the Amazon Web Services SDKs automatically generate one for you. If you are not using the Amazon Web Services SDK or the CLI, you must provide this token or the request will fail. </important>","type":"string","minLength":1,"maxLength":2048}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/workloads/{WorkloadId}/milestones":{"post":{"operationId":"CreateMilestone","description":"Create a milestone for an existing workload.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateMilestoneOutput"}}}},"480":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"481":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"482":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"483":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"484":{"description":"ServiceQuotaExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceQuotaExceededException"}}}},"485":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"486":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}}},"parameters":[{"name":"WorkloadId","in":"path","required":true,"description":"","schema":{"type":"string","pattern":"[0-9a-f]{32}","description":"The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.","minLength":32,"maxLength":32}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["MilestoneName","ClientRequestToken"],"properties":{"MilestoneName":{"description":"The name of the milestone in a workload. Milestone names must be unique within a workload.","type":"string","minLength":3,"maxLength":100},"ClientRequestToken":{"description":"A unique case-sensitive string used to ensure that this request is idempotent (executes only once). You should not reuse the same token for other requests. If you retry a request with the same client request token and the same parameters after the original request has completed successfully, the result of the original request is returned. <important> This token is listed as required, however, if you do not specify it, the Amazon Web Services SDKs automatically generate one for you. If you are not using the Amazon Web Services SDK or the CLI, you must provide this token or the request will fail. </important>","type":"string","minLength":1,"maxLength":2048}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/profiles":{"post":{"operationId":"CreateProfile","description":"Create a profile.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateProfileOutput"}}}},"480":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"481":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"482":{"description":"ServiceQuotaExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceQuotaExceededException"}}}},"483":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"484":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"485":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}}},"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["ProfileName","ProfileDescription","ProfileQuestions","ClientRequestToken"],"properties":{"ProfileName":{"description":"Name of the profile.","type":"string","pattern":"^[A-Za-z0-9-_.,:/()@!&?#+'’\\s]+$","minLength":3,"maxLength":100},"ProfileDescription":{"description":"The profile description.","type":"string","pattern":"^[A-Za-z0-9-_.,:/()@!&?#+'’\\s]+$","minLength":3,"maxLength":100},"ProfileQuestions":{"description":"The profile questions.","type":"array","items":{"$ref":"#/components/schemas/ProfileQuestionUpdate"}},"ClientRequestToken":{"description":"A unique case-sensitive string used to ensure that this request is idempotent (executes only once). You should not reuse the same token for other requests. If you retry a request with the same client request token and the same parameters after the original request has completed successfully, the result of the original request is returned. <important> This token is listed as required, however, if you do not specify it, the Amazon Web Services SDKs automatically generate one for you. If you are not using the Amazon Web Services SDK or the CLI, you must provide this token or the request will fail. </important>","type":"string","minLength":1,"maxLength":2048},"Tags":{"description":"The tags assigned to the profile.","type":"object","minProperties":1,"maxProperties":50,"additionalProperties":{"$ref":"#/components/schemas/TagValue"}}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/profiles/{ProfileArn}/shares":{"post":{"operationId":"CreateProfileShare","description":"Create a profile share.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateProfileShareOutput"}}}},"480":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"481":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"482":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"483":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"484":{"description":"ServiceQuotaExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceQuotaExceededException"}}}},"485":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"486":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}}},"parameters":[{"name":"ProfileArn","in":"path","required":true,"description":"The profile ARN.","schema":{"type":"string","pattern":"arn:aws[-a-z]*:wellarchitected:[a-z]{2}(-gov)?-[a-z]+-\\d:\\d{12}:profile/[a-z0-9]+","maxLength":2084}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["SharedWith","ClientRequestToken"],"properties":{"SharedWith":{"description":"The Amazon Web Services account ID, IAM role, organization ID, or organizational unit (OU) ID with which the workload, lens, or profile is shared.","type":"string","minLength":12,"maxLength":2048},"ClientRequestToken":{"description":"A unique case-sensitive string used to ensure that this request is idempotent (executes only once). You should not reuse the same token for other requests. If you retry a request with the same client request token and the same parameters after the original request has completed successfully, the result of the original request is returned. <important> This token is listed as required, however, if you do not specify it, the Amazon Web Services SDKs automatically generate one for you. If you are not using the Amazon Web Services SDK or the CLI, you must provide this token or the request will fail. </important>","type":"string","minLength":1,"maxLength":2048}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"ListProfileShares","description":"List profile shares.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListProfileSharesOutput"}}}},"480":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"481":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"482":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"483":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"484":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}}},"parameters":[{"name":"ProfileArn","in":"path","required":true,"description":"The profile ARN.","schema":{"type":"string","pattern":"arn:aws[-a-z]*:wellarchitected:[a-z]{2}(-gov)?-[a-z]+-\\d:\\d{12}:profile/[a-z0-9]+","maxLength":2084}},{"name":"SharedWithPrefix","in":"query","required":false,"description":"The Amazon Web Services account ID, IAM role, organization ID, or organizational unit (OU) ID with which the profile is shared.","schema":{"type":"string","maxLength":100}},{"name":"NextToken","in":"query","required":false,"description":"","schema":{"type":"string","description":"The token to use to retrieve the next set of results."}},{"name":"MaxResults","in":"query","required":false,"description":"The maximum number of results to return for this request.","schema":{"type":"integer","minimum":1,"maximum":50}},{"name":"Status","in":"query","required":false,"description":"","schema":{"type":"string","enum":["ACCEPTED","REJECTED","PENDING","REVOKED","EXPIRED","ASSOCIATING","ASSOCIATED","FAILED"],"description":"The status of the share request."}}]}},"/workloads":{"post":{"operationId":"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 <a href=\"https://docs.aws.amazon.com/wellarchitected/latest/userguide/define-workload.html\">Defining a Workload</a> in the Well-Architected Tool User Guide. <important> Either <code>AwsRegions</code>, <code>NonAwsRegions</code>, or both must be specified when creating a workload. You also must specify <code>ReviewOwner</code>, even though the parameter is listed as not being required in the following section. </important>","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateWorkloadOutput"}}}},"480":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"481":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"482":{"description":"ServiceQuotaExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceQuotaExceededException"}}}},"483":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"484":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"485":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"486":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}}},"parameters":[],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["WorkloadName","Description","Environment","Lenses","ClientRequestToken"],"properties":{"WorkloadName":{"description":"The name of the workload. The name must be unique within an account within an Amazon Web Services Region. Spaces and capitalization are ignored when checking for uniqueness.","type":"string","minLength":3,"maxLength":100},"Description":{"description":"The description for the workload.","type":"string","minLength":3,"maxLength":250},"Environment":{"description":"The environment for the workload.","type":"string","enum":["PRODUCTION","PREPRODUCTION"]},"AccountIds":{"description":"The list of Amazon Web Services account IDs associated with the workload.","type":"array","items":{"$ref":"#/components/schemas/AwsAccountId"},"maxItems":100},"AwsRegions":{"description":"The list of Amazon Web Services Regions associated with the workload, for example, <code>us-east-2</code>, or <code>ca-central-1</code>.","type":"array","items":{"$ref":"#/components/schemas/AwsRegion"},"maxItems":50},"NonAwsRegions":{"description":" The list of non-Amazon Web Services Regions associated with the workload.","type":"array","items":{"$ref":"#/components/schemas/WorkloadNonAwsRegion"},"maxItems":5},"PillarPriorities":{"description":"The priorities of the pillars, which are used to order items in the improvement plan. Each pillar is represented by its <a>PillarReviewSummary$PillarId</a>.","type":"array","items":{"$ref":"#/components/schemas/PillarId"}},"ArchitecturalDesign":{"description":"The URL of the architectural design for the workload.","type":"string","pattern":"^(|(https?|ftp):\\/\\/[^\\s/$.?#].[^\\s]*)$","maxLength":2048},"ReviewOwner":{"description":"The review owner of the workload. The name, email address, or identifier for the primary group or individual that owns the workload review process.","type":"string","minLength":3,"maxLength":255},"IndustryType":{"description":"The industry type for the workload. If specified, must be one of the following: <ul> <li> <code>Agriculture</code> </li> <li> <code>Automobile</code> </li> <li> <code>Defense</code> </li> <li> <code>Design and Engineering</code> </li> <li> <code>Digital Advertising</code> </li> <li> <code>Education</code> </li> <li> <code>Environmental Protection</code> </li> <li> <code>Financial Services</code> </li> <li> <code>Gaming</code> </li> <li> <code>General Public Services</code> </li> <li> <code>Healthcare</code> </li> <li> <code>Hospitality</code> </li> <li> <code>InfoTech</code> </li> <li> <code>Justice and Public Safety</code> </li> <li> <code>Life Sciences</code> </li> <li> <code>Manufacturing</code> </li> <li> <code>Media & Entertainment</code> </li> <li> <code>Mining & Resources</code> </li> <li> <code>Oil & Gas</code> </li> <li> <code>Power & Utilities</code> </li> <li> <code>Professional Services</code> </li> <li> <code>Real Estate & Construction</code> </li> <li> <code>Retail & Wholesale</code> </li> <li> <code>Social Protection</code> </li> <li> <code>Telecommunications</code> </li> <li> <code>Travel, Transportation & Logistics</code> </li> <li> <code>Other</code> </li> </ul>","type":"string","maxLength":100},"Industry":{"description":"The industry for the workload.","type":"string","maxLength":100},"Lenses":{"description":"The list of lenses associated with the workload. Each lens is identified by its <a>LensSummary$LensAlias</a>.","type":"array","items":{"$ref":"#/components/schemas/LensAlias"}},"Notes":{"description":"The notes associated with the workload.","type":"string","maxLength":2084},"ClientRequestToken":{"description":"A unique case-sensitive string used to ensure that this request is idempotent (executes only once). You should not reuse the same token for other requests. If you retry a request with the same client request token and the same parameters after the original request has completed successfully, the result of the original request is returned. <important> This token is listed as required, however, if you do not specify it, the Amazon Web Services SDKs automatically generate one for you. If you are not using the Amazon Web Services SDK or the CLI, you must provide this token or the request will fail. </important>","type":"string","minLength":1,"maxLength":2048},"Tags":{"description":"The tags to be associated with the workload.","type":"object","minProperties":1,"maxProperties":50,"additionalProperties":{"$ref":"#/components/schemas/TagValue"}},"DiscoveryConfig":{"description":"Discovery configuration associated to the workload.","type":"object","properties":{"TrustedAdvisorIntegrationStatus":{"allOf":[{"$ref":"#/components/schemas/TrustedAdvisorIntegrationStatus"},{"description":"Discovery integration status in respect to Trusted Advisor for the workload."}]},"WorkloadResourceDefinition":{"allOf":[{"$ref":"#/components/schemas/WorkloadResourceDefinition"},{"description":"The mode to use for identifying resources associated with the workload. You can specify <code>WORKLOAD_METADATA</code>, <code>APP_REGISTRY</code>, or both."}]}}},"Applications":{"description":"List of AppRegistry application ARNs associated to the workload.","type":"array","items":{"$ref":"#/components/schemas/ApplicationArn"},"maxItems":1},"ProfileArns":{"description":"The list of profile ARNs associated with the workload.","type":"array","items":{"$ref":"#/components/schemas/ProfileArn"},"maxItems":1}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/workloads/{WorkloadId}/shares":{"post":{"operationId":"CreateWorkloadShare","description":"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 <a href=\"https://docs.aws.amazon.com/wellarchitected/latest/userguide/workloads-sharing.html\">Sharing a workload</a> in the Well-Architected Tool User Guide.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateWorkloadShareOutput"}}}},"480":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"481":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"482":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"483":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"484":{"description":"ServiceQuotaExceededException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceQuotaExceededException"}}}},"485":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"486":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}}},"parameters":[{"name":"WorkloadId","in":"path","required":true,"description":"","schema":{"type":"string","pattern":"[0-9a-f]{32}","description":"The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.","minLength":32,"maxLength":32}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["SharedWith","PermissionType","ClientRequestToken"],"properties":{"SharedWith":{"description":"The Amazon Web Services account ID, IAM role, organization ID, or organizational unit (OU) ID with which the workload, lens, or profile is shared.","type":"string","minLength":12,"maxLength":2048},"PermissionType":{"description":"Permission granted on a share request.","type":"string","enum":["READONLY","CONTRIBUTOR"]},"ClientRequestToken":{"description":"A unique case-sensitive string used to ensure that this request is idempotent (executes only once). You should not reuse the same token for other requests. If you retry a request with the same client request token and the same parameters after the original request has completed successfully, the result of the original request is returned. <important> This token is listed as required, however, if you do not specify it, the Amazon Web Services SDKs automatically generate one for you. If you are not using the Amazon Web Services SDK or the CLI, you must provide this token or the request will fail. </important>","type":"string","minLength":1,"maxLength":2048}}}}}}},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}],"get":{"operationId":"ListWorkloadShares","description":"List the workload shares associated with the workload.","responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListWorkloadSharesOutput"}}}},"480":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"481":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"482":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"483":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"484":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}}},"parameters":[{"name":"WorkloadId","in":"path","required":true,"description":"","schema":{"type":"string","pattern":"[0-9a-f]{32}","description":"The ID assigned to the workload. This ID is unique within an Amazon Web Services Region.","minLength":32,"maxLength":32}},{"name":"SharedWithPrefix","in":"query","required":false,"description":"The Amazon Web Services account ID, IAM role, organization ID, or organizational unit (OU) ID with which the workload is shared.","schema":{"type":"string","maxLength":100}},{"name":"NextToken","in":"query","required":false,"description":"","schema":{"type":"string","description":"The token to use to retrieve the next set of results."}},{"name":"MaxResults","in":"query","required":false,"description":"The maximum number of results to return for this request.","schema":{"type":"integer","minimum":1,"maximum":50}},{"name":"Status","in":"query","required":false,"description":"","schema":{"type":"string","enum":["ACCEPTED","REJECTED","PENDING","REVOKED","EXPIRED","ASSOCIATING","ASSOCIATED","FAILED"],"description":"The status of the share request."}}]}},"/lenses/{LensAlias}#ClientRequestToken&LensStatus":{"delete":{"operationId":"DeleteLens","description":"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. <note> Disclaimer By sharing your custom lenses with other Amazon Web Services accounts, you acknowledge that Amazon Web Services will make your custom lenses available to those other accounts. Those other accounts may continue to access and use your shared custom lenses even if you delete the custom lenses from your own Amazon Web Services account or terminate your Amazon Web Services account. </note>","responses":{"200":{"description":"Success"},"480":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"481":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"482":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"483":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"484":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"485":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}}},"parameters":[{"name":"LensAlias","in":"path","required":true,"description":"","schema":{"type":"string","description":"The alias of the lens. For Amazon Web Services official lenses, this is either the lens alias, such as <code>serverless</code>, or the lens ARN, such as <code>arn:aws:wellarchitected:us-east-1::lens/serverless</code>. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses. For custom lenses, this is the lens ARN, such as <code>arn:aws:wellarchitected:us-west-2:123456789012:lens/0123456789abcdef01234567890abcdef</code>. Each lens is identified by its <a>LensSummary$LensAlias</a>.","minLength":1,"maxLength":128}},{"name":"ClientRequestToken","in":"query","required":true,"description":"","schema":{"type":"string","description":"A unique case-sensitive string used to ensure that this request is idempotent (executes only once). You should not reuse the same token for other requests. If you retry a request with the same client request token and the same parameters after the original request has completed successfully, the result of the original request is returned. <important> This token is listed as required, however, if you do not specify it, the Amazon Web Services SDKs automatically generate one for you. If you are not using the Amazon Web Services SDK or the CLI, you must provide this token or the request will fail. </important>","minLength":1,"maxLength":2048}},{"name":"LensStatus","in":"query","required":true,"description":"The status of the lens to be deleted.","schema":{"type":"string","enum":["ALL","DRAFT","PUBLISHED"]}}]},"parameters":[{"$ref":"#/components/parameters/X-Amz-Content-Sha256"},{"$ref":"#/components/parameters/X-Amz-Date"},{"$ref":"#/components/parameters/X-Amz-Algorithm"},{"$ref":"#/components/parameters/X-Amz-Credential"},{"$ref":"#/components/parameters/X-Amz-Security-Token"},{"$ref":"#/components/parameters/X-Amz-Signature"},{"$ref":"#/components/parameters/X-Amz-SignedHeaders"}]},"/lenses/{LensAlias}/shares/{ShareId}#ClientRequestToken":{"delete":{"operationId":"DeleteLensShare","description":"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. <note> Disclaimer By sharing your custom lenses with other Amazon Web Services accounts, you acknowledge that Amazon Web Services will make your custom lenses available to those other accounts. Those other accounts may continue to access and use your shared custom lenses even if you delete the custom lenses from your own Amazon Web Services account or terminate your Amazon Web Services account. </note>","responses":{"200":{"description":"Success"},"480":{"description":"ValidationException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ValidationException"}}}},"481":{"description":"InternalServerException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InternalServerException"}}}},"482":{"description":"ResourceNotFoundException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResourceNotFoundException"}}}},"483":{"description":"ConflictException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictException"}}}},"484":{"description":"AccessDeniedException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessDeniedException"}}}},"485":{"description":"ThrottlingException","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ThrottlingException"}}}}},"parameters":[{"name":"ShareId","in":"path","required":true,"description":"","schema":{"type":"string","pattern":"[0-9a-f]{32}","description":"The ID associated with the share."}},{"name":"LensAlias","in":"path","required":true,"description":"","schema":{"type":"string","description":"The alias of the lens. For Amazon Web Services official lenses, this is either the lens alias, such as <code>serverless</code>, or the lens ARN, such as <code>arn:aws:wellarchitected:us-east-1::lens/serverless</code>. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on Amazon Web Services official lenses. For custom lenses, this is the lens ARN, such as <code>arn:aws:wellarchitected:us-west