discord-bot-cdk-construct
Version:
A quick CDK Construct for creating a serverless Discord bot in AWS!
805 lines • 90.1 kB
TypeScript
import {Request} from '../lib/request';
import {Response} from '../lib/response';
import {AWSError} from '../lib/error';
import {Service} from '../lib/service';
import {ServiceConfigurationOptions} from '../lib/service';
import {ConfigBase as Config} from '../lib/config-base';
interface Blob {}
declare class WellArchitected extends Service {
/**
* Constructs a service object. This object has one method for each API operation.
*/
constructor(options?: WellArchitected.Types.ClientConfiguration)
config: Config & WellArchitected.Types.ClientConfiguration;
/**
* 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.
*/
associateLenses(params: WellArchitected.Types.AssociateLensesInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* 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.
*/
associateLenses(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Associate a profile with a workload.
*/
associateProfiles(params: WellArchitected.Types.AssociateProfilesInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Associate a profile with a workload.
*/
associateProfiles(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* 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. 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.
*/
createLensShare(params: WellArchitected.Types.CreateLensShareInput, callback?: (err: AWSError, data: WellArchitected.Types.CreateLensShareOutput) => void): Request<WellArchitected.Types.CreateLensShareOutput, AWSError>;
/**
* 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. 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.
*/
createLensShare(callback?: (err: AWSError, data: WellArchitected.Types.CreateLensShareOutput) => void): Request<WellArchitected.Types.CreateLensShareOutput, AWSError>;
/**
* 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.
*/
createLensVersion(params: WellArchitected.Types.CreateLensVersionInput, callback?: (err: AWSError, data: WellArchitected.Types.CreateLensVersionOutput) => void): Request<WellArchitected.Types.CreateLensVersionOutput, AWSError>;
/**
* 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.
*/
createLensVersion(callback?: (err: AWSError, data: WellArchitected.Types.CreateLensVersionOutput) => void): Request<WellArchitected.Types.CreateLensVersionOutput, AWSError>;
/**
* Create a milestone for an existing workload.
*/
createMilestone(params: WellArchitected.Types.CreateMilestoneInput, callback?: (err: AWSError, data: WellArchitected.Types.CreateMilestoneOutput) => void): Request<WellArchitected.Types.CreateMilestoneOutput, AWSError>;
/**
* Create a milestone for an existing workload.
*/
createMilestone(callback?: (err: AWSError, data: WellArchitected.Types.CreateMilestoneOutput) => void): Request<WellArchitected.Types.CreateMilestoneOutput, AWSError>;
/**
* Create a profile.
*/
createProfile(params: WellArchitected.Types.CreateProfileInput, callback?: (err: AWSError, data: WellArchitected.Types.CreateProfileOutput) => void): Request<WellArchitected.Types.CreateProfileOutput, AWSError>;
/**
* Create a profile.
*/
createProfile(callback?: (err: AWSError, data: WellArchitected.Types.CreateProfileOutput) => void): Request<WellArchitected.Types.CreateProfileOutput, AWSError>;
/**
* Create a profile share.
*/
createProfileShare(params: WellArchitected.Types.CreateProfileShareInput, callback?: (err: AWSError, data: WellArchitected.Types.CreateProfileShareOutput) => void): Request<WellArchitected.Types.CreateProfileShareOutput, AWSError>;
/**
* Create a profile share.
*/
createProfileShare(callback?: (err: AWSError, data: WellArchitected.Types.CreateProfileShareOutput) => void): Request<WellArchitected.Types.CreateProfileShareOutput, AWSError>;
/**
* 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.
*/
createWorkload(params: WellArchitected.Types.CreateWorkloadInput, callback?: (err: AWSError, data: WellArchitected.Types.CreateWorkloadOutput) => void): Request<WellArchitected.Types.CreateWorkloadOutput, AWSError>;
/**
* 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.
*/
createWorkload(callback?: (err: AWSError, data: WellArchitected.Types.CreateWorkloadOutput) => void): Request<WellArchitected.Types.CreateWorkloadOutput, AWSError>;
/**
* 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.
*/
createWorkloadShare(params: WellArchitected.Types.CreateWorkloadShareInput, callback?: (err: AWSError, data: WellArchitected.Types.CreateWorkloadShareOutput) => void): Request<WellArchitected.Types.CreateWorkloadShareOutput, AWSError>;
/**
* 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.
*/
createWorkloadShare(callback?: (err: AWSError, data: WellArchitected.Types.CreateWorkloadShareOutput) => void): Request<WellArchitected.Types.CreateWorkloadShareOutput, AWSError>;
/**
* 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. 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.
*/
deleteLens(params: WellArchitected.Types.DeleteLensInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* 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. 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.
*/
deleteLens(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* 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. 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.
*/
deleteLensShare(params: WellArchitected.Types.DeleteLensShareInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* 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. 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.
*/
deleteLensShare(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Delete a profile. Disclaimer By sharing your profile with other Amazon Web Services accounts, you acknowledge that Amazon Web Services will make your profile available to those other accounts. Those other accounts may continue to access and use your shared profile even if you delete the profile from your own Amazon Web Services account or terminate your Amazon Web Services account.
*/
deleteProfile(params: WellArchitected.Types.DeleteProfileInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Delete a profile. Disclaimer By sharing your profile with other Amazon Web Services accounts, you acknowledge that Amazon Web Services will make your profile available to those other accounts. Those other accounts may continue to access and use your shared profile even if you delete the profile from your own Amazon Web Services account or terminate your Amazon Web Services account.
*/
deleteProfile(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Delete a profile share.
*/
deleteProfileShare(params: WellArchitected.Types.DeleteProfileShareInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Delete a profile share.
*/
deleteProfileShare(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Delete an existing workload.
*/
deleteWorkload(params: WellArchitected.Types.DeleteWorkloadInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Delete an existing workload.
*/
deleteWorkload(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Delete a workload share.
*/
deleteWorkloadShare(params: WellArchitected.Types.DeleteWorkloadShareInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Delete a workload share.
*/
deleteWorkloadShare(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* 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.
*/
disassociateLenses(params: WellArchitected.Types.DisassociateLensesInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* 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.
*/
disassociateLenses(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Disassociate a profile from a workload.
*/
disassociateProfiles(params: WellArchitected.Types.DisassociateProfilesInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Disassociate a profile from a workload.
*/
disassociateProfiles(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* 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. Disclaimer Do not include or gather personal identifiable information (PII) of end users or other identifiable individuals in or via your custom lenses. If your custom lens or those shared with you and used in your account do include or collect PII you are responsible for: ensuring that the included PII is processed in accordance with applicable law, providing adequate privacy notices, and obtaining necessary consents for processing such data.
*/
exportLens(params: WellArchitected.Types.ExportLensInput, callback?: (err: AWSError, data: WellArchitected.Types.ExportLensOutput) => void): Request<WellArchitected.Types.ExportLensOutput, AWSError>;
/**
* 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. Disclaimer Do not include or gather personal identifiable information (PII) of end users or other identifiable individuals in or via your custom lenses. If your custom lens or those shared with you and used in your account do include or collect PII you are responsible for: ensuring that the included PII is processed in accordance with applicable law, providing adequate privacy notices, and obtaining necessary consents for processing such data.
*/
exportLens(callback?: (err: AWSError, data: WellArchitected.Types.ExportLensOutput) => void): Request<WellArchitected.Types.ExportLensOutput, AWSError>;
/**
* Get the answer to a specific question in a workload review.
*/
getAnswer(params: WellArchitected.Types.GetAnswerInput, callback?: (err: AWSError, data: WellArchitected.Types.GetAnswerOutput) => void): Request<WellArchitected.Types.GetAnswerOutput, AWSError>;
/**
* Get the answer to a specific question in a workload review.
*/
getAnswer(callback?: (err: AWSError, data: WellArchitected.Types.GetAnswerOutput) => void): Request<WellArchitected.Types.GetAnswerOutput, AWSError>;
/**
* Get a consolidated report of your workloads. You can optionally choose to include workloads that have been shared with you.
*/
getConsolidatedReport(params: WellArchitected.Types.GetConsolidatedReportInput, callback?: (err: AWSError, data: WellArchitected.Types.GetConsolidatedReportOutput) => void): Request<WellArchitected.Types.GetConsolidatedReportOutput, AWSError>;
/**
* Get a consolidated report of your workloads. You can optionally choose to include workloads that have been shared with you.
*/
getConsolidatedReport(callback?: (err: AWSError, data: WellArchitected.Types.GetConsolidatedReportOutput) => void): Request<WellArchitected.Types.GetConsolidatedReportOutput, AWSError>;
/**
* Get an existing lens.
*/
getLens(params: WellArchitected.Types.GetLensInput, callback?: (err: AWSError, data: WellArchitected.Types.GetLensOutput) => void): Request<WellArchitected.Types.GetLensOutput, AWSError>;
/**
* Get an existing lens.
*/
getLens(callback?: (err: AWSError, data: WellArchitected.Types.GetLensOutput) => void): Request<WellArchitected.Types.GetLensOutput, AWSError>;
/**
* Get lens review.
*/
getLensReview(params: WellArchitected.Types.GetLensReviewInput, callback?: (err: AWSError, data: WellArchitected.Types.GetLensReviewOutput) => void): Request<WellArchitected.Types.GetLensReviewOutput, AWSError>;
/**
* Get lens review.
*/
getLensReview(callback?: (err: AWSError, data: WellArchitected.Types.GetLensReviewOutput) => void): Request<WellArchitected.Types.GetLensReviewOutput, AWSError>;
/**
* Get lens review report.
*/
getLensReviewReport(params: WellArchitected.Types.GetLensReviewReportInput, callback?: (err: AWSError, data: WellArchitected.Types.GetLensReviewReportOutput) => void): Request<WellArchitected.Types.GetLensReviewReportOutput, AWSError>;
/**
* Get lens review report.
*/
getLensReviewReport(callback?: (err: AWSError, data: WellArchitected.Types.GetLensReviewReportOutput) => void): Request<WellArchitected.Types.GetLensReviewReportOutput, AWSError>;
/**
* Get lens version differences.
*/
getLensVersionDifference(params: WellArchitected.Types.GetLensVersionDifferenceInput, callback?: (err: AWSError, data: WellArchitected.Types.GetLensVersionDifferenceOutput) => void): Request<WellArchitected.Types.GetLensVersionDifferenceOutput, AWSError>;
/**
* Get lens version differences.
*/
getLensVersionDifference(callback?: (err: AWSError, data: WellArchitected.Types.GetLensVersionDifferenceOutput) => void): Request<WellArchitected.Types.GetLensVersionDifferenceOutput, AWSError>;
/**
* Get a milestone for an existing workload.
*/
getMilestone(params: WellArchitected.Types.GetMilestoneInput, callback?: (err: AWSError, data: WellArchitected.Types.GetMilestoneOutput) => void): Request<WellArchitected.Types.GetMilestoneOutput, AWSError>;
/**
* Get a milestone for an existing workload.
*/
getMilestone(callback?: (err: AWSError, data: WellArchitected.Types.GetMilestoneOutput) => void): Request<WellArchitected.Types.GetMilestoneOutput, AWSError>;
/**
* Get profile information.
*/
getProfile(params: WellArchitected.Types.GetProfileInput, callback?: (err: AWSError, data: WellArchitected.Types.GetProfileOutput) => void): Request<WellArchitected.Types.GetProfileOutput, AWSError>;
/**
* Get profile information.
*/
getProfile(callback?: (err: AWSError, data: WellArchitected.Types.GetProfileOutput) => void): Request<WellArchitected.Types.GetProfileOutput, AWSError>;
/**
* Get profile template.
*/
getProfileTemplate(params: WellArchitected.Types.GetProfileTemplateInput, callback?: (err: AWSError, data: WellArchitected.Types.GetProfileTemplateOutput) => void): Request<WellArchitected.Types.GetProfileTemplateOutput, AWSError>;
/**
* Get profile template.
*/
getProfileTemplate(callback?: (err: AWSError, data: WellArchitected.Types.GetProfileTemplateOutput) => void): Request<WellArchitected.Types.GetProfileTemplateOutput, AWSError>;
/**
* Get an existing workload.
*/
getWorkload(params: WellArchitected.Types.GetWorkloadInput, callback?: (err: AWSError, data: WellArchitected.Types.GetWorkloadOutput) => void): Request<WellArchitected.Types.GetWorkloadOutput, AWSError>;
/**
* Get an existing workload.
*/
getWorkload(callback?: (err: AWSError, data: WellArchitected.Types.GetWorkloadOutput) => void): Request<WellArchitected.Types.GetWorkloadOutput, AWSError>;
/**
* 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. Disclaimer Do not include or gather personal identifiable information (PII) of end users or other identifiable individuals in or via your custom lenses. If your custom lens or those shared with you and used in your account do include or collect PII you are responsible for: ensuring that the included PII is processed in accordance with applicable law, providing adequate privacy notices, and obtaining necessary consents for processing such data.
*/
importLens(params: WellArchitected.Types.ImportLensInput, callback?: (err: AWSError, data: WellArchitected.Types.ImportLensOutput) => void): Request<WellArchitected.Types.ImportLensOutput, AWSError>;
/**
* 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. Disclaimer Do not include or gather personal identifiable information (PII) of end users or other identifiable individuals in or via your custom lenses. If your custom lens or those shared with you and used in your account do include or collect PII you are responsible for: ensuring that the included PII is processed in accordance with applicable law, providing adequate privacy notices, and obtaining necessary consents for processing such data.
*/
importLens(callback?: (err: AWSError, data: WellArchitected.Types.ImportLensOutput) => void): Request<WellArchitected.Types.ImportLensOutput, AWSError>;
/**
* List of answers for a particular workload and lens.
*/
listAnswers(params: WellArchitected.Types.ListAnswersInput, callback?: (err: AWSError, data: WellArchitected.Types.ListAnswersOutput) => void): Request<WellArchitected.Types.ListAnswersOutput, AWSError>;
/**
* List of answers for a particular workload and lens.
*/
listAnswers(callback?: (err: AWSError, data: WellArchitected.Types.ListAnswersOutput) => void): Request<WellArchitected.Types.ListAnswersOutput, AWSError>;
/**
* List of Trusted Advisor check details by account related to the workload.
*/
listCheckDetails(params: WellArchitected.Types.ListCheckDetailsInput, callback?: (err: AWSError, data: WellArchitected.Types.ListCheckDetailsOutput) => void): Request<WellArchitected.Types.ListCheckDetailsOutput, AWSError>;
/**
* List of Trusted Advisor check details by account related to the workload.
*/
listCheckDetails(callback?: (err: AWSError, data: WellArchitected.Types.ListCheckDetailsOutput) => void): Request<WellArchitected.Types.ListCheckDetailsOutput, AWSError>;
/**
* List of Trusted Advisor checks summarized for all accounts related to the workload.
*/
listCheckSummaries(params: WellArchitected.Types.ListCheckSummariesInput, callback?: (err: AWSError, data: WellArchitected.Types.ListCheckSummariesOutput) => void): Request<WellArchitected.Types.ListCheckSummariesOutput, AWSError>;
/**
* List of Trusted Advisor checks summarized for all accounts related to the workload.
*/
listCheckSummaries(callback?: (err: AWSError, data: WellArchitected.Types.ListCheckSummariesOutput) => void): Request<WellArchitected.Types.ListCheckSummariesOutput, AWSError>;
/**
* List lens review improvements.
*/
listLensReviewImprovements(params: WellArchitected.Types.ListLensReviewImprovementsInput, callback?: (err: AWSError, data: WellArchitected.Types.ListLensReviewImprovementsOutput) => void): Request<WellArchitected.Types.ListLensReviewImprovementsOutput, AWSError>;
/**
* List lens review improvements.
*/
listLensReviewImprovements(callback?: (err: AWSError, data: WellArchitected.Types.ListLensReviewImprovementsOutput) => void): Request<WellArchitected.Types.ListLensReviewImprovementsOutput, AWSError>;
/**
* List lens reviews for a particular workload.
*/
listLensReviews(params: WellArchitected.Types.ListLensReviewsInput, callback?: (err: AWSError, data: WellArchitected.Types.ListLensReviewsOutput) => void): Request<WellArchitected.Types.ListLensReviewsOutput, AWSError>;
/**
* List lens reviews for a particular workload.
*/
listLensReviews(callback?: (err: AWSError, data: WellArchitected.Types.ListLensReviewsOutput) => void): Request<WellArchitected.Types.ListLensReviewsOutput, AWSError>;
/**
* List the lens shares associated with the lens.
*/
listLensShares(params: WellArchitected.Types.ListLensSharesInput, callback?: (err: AWSError, data: WellArchitected.Types.ListLensSharesOutput) => void): Request<WellArchitected.Types.ListLensSharesOutput, AWSError>;
/**
* List the lens shares associated with the lens.
*/
listLensShares(callback?: (err: AWSError, data: WellArchitected.Types.ListLensSharesOutput) => void): Request<WellArchitected.Types.ListLensSharesOutput, AWSError>;
/**
* List the available lenses.
*/
listLenses(params: WellArchitected.Types.ListLensesInput, callback?: (err: AWSError, data: WellArchitected.Types.ListLensesOutput) => void): Request<WellArchitected.Types.ListLensesOutput, AWSError>;
/**
* List the available lenses.
*/
listLenses(callback?: (err: AWSError, data: WellArchitected.Types.ListLensesOutput) => void): Request<WellArchitected.Types.ListLensesOutput, AWSError>;
/**
* List all milestones for an existing workload.
*/
listMilestones(params: WellArchitected.Types.ListMilestonesInput, callback?: (err: AWSError, data: WellArchitected.Types.ListMilestonesOutput) => void): Request<WellArchitected.Types.ListMilestonesOutput, AWSError>;
/**
* List all milestones for an existing workload.
*/
listMilestones(callback?: (err: AWSError, data: WellArchitected.Types.ListMilestonesOutput) => void): Request<WellArchitected.Types.ListMilestonesOutput, AWSError>;
/**
* List lens notifications.
*/
listNotifications(params: WellArchitected.Types.ListNotificationsInput, callback?: (err: AWSError, data: WellArchitected.Types.ListNotificationsOutput) => void): Request<WellArchitected.Types.ListNotificationsOutput, AWSError>;
/**
* List lens notifications.
*/
listNotifications(callback?: (err: AWSError, data: WellArchitected.Types.ListNotificationsOutput) => void): Request<WellArchitected.Types.ListNotificationsOutput, AWSError>;
/**
* List profile notifications.
*/
listProfileNotifications(params: WellArchitected.Types.ListProfileNotificationsInput, callback?: (err: AWSError, data: WellArchitected.Types.ListProfileNotificationsOutput) => void): Request<WellArchitected.Types.ListProfileNotificationsOutput, AWSError>;
/**
* List profile notifications.
*/
listProfileNotifications(callback?: (err: AWSError, data: WellArchitected.Types.ListProfileNotificationsOutput) => void): Request<WellArchitected.Types.ListProfileNotificationsOutput, AWSError>;
/**
* List profile shares.
*/
listProfileShares(params: WellArchitected.Types.ListProfileSharesInput, callback?: (err: AWSError, data: WellArchitected.Types.ListProfileSharesOutput) => void): Request<WellArchitected.Types.ListProfileSharesOutput, AWSError>;
/**
* List profile shares.
*/
listProfileShares(callback?: (err: AWSError, data: WellArchitected.Types.ListProfileSharesOutput) => void): Request<WellArchitected.Types.ListProfileSharesOutput, AWSError>;
/**
* List profiles.
*/
listProfiles(params: WellArchitected.Types.ListProfilesInput, callback?: (err: AWSError, data: WellArchitected.Types.ListProfilesOutput) => void): Request<WellArchitected.Types.ListProfilesOutput, AWSError>;
/**
* List profiles.
*/
listProfiles(callback?: (err: AWSError, data: WellArchitected.Types.ListProfilesOutput) => void): Request<WellArchitected.Types.ListProfilesOutput, AWSError>;
/**
* List the workload invitations.
*/
listShareInvitations(params: WellArchitected.Types.ListShareInvitationsInput, callback?: (err: AWSError, data: WellArchitected.Types.ListShareInvitationsOutput) => void): Request<WellArchitected.Types.ListShareInvitationsOutput, AWSError>;
/**
* List the workload invitations.
*/
listShareInvitations(callback?: (err: AWSError, data: WellArchitected.Types.ListShareInvitationsOutput) => void): Request<WellArchitected.Types.ListShareInvitationsOutput, AWSError>;
/**
* List the tags for a resource. The WorkloadArn parameter can be a workload ARN, a custom lens ARN, or a profile ARN.
*/
listTagsForResource(params: WellArchitected.Types.ListTagsForResourceInput, callback?: (err: AWSError, data: WellArchitected.Types.ListTagsForResourceOutput) => void): Request<WellArchitected.Types.ListTagsForResourceOutput, AWSError>;
/**
* List the tags for a resource. The WorkloadArn parameter can be a workload ARN, a custom lens ARN, or a profile ARN.
*/
listTagsForResource(callback?: (err: AWSError, data: WellArchitected.Types.ListTagsForResourceOutput) => void): Request<WellArchitected.Types.ListTagsForResourceOutput, AWSError>;
/**
* List the workload shares associated with the workload.
*/
listWorkloadShares(params: WellArchitected.Types.ListWorkloadSharesInput, callback?: (err: AWSError, data: WellArchitected.Types.ListWorkloadSharesOutput) => void): Request<WellArchitected.Types.ListWorkloadSharesOutput, AWSError>;
/**
* List the workload shares associated with the workload.
*/
listWorkloadShares(callback?: (err: AWSError, data: WellArchitected.Types.ListWorkloadSharesOutput) => void): Request<WellArchitected.Types.ListWorkloadSharesOutput, AWSError>;
/**
* Paginated list of workloads.
*/
listWorkloads(params: WellArchitected.Types.ListWorkloadsInput, callback?: (err: AWSError, data: WellArchitected.Types.ListWorkloadsOutput) => void): Request<WellArchitected.Types.ListWorkloadsOutput, AWSError>;
/**
* Paginated list of workloads.
*/
listWorkloads(callback?: (err: AWSError, data: WellArchitected.Types.ListWorkloadsOutput) => void): Request<WellArchitected.Types.ListWorkloadsOutput, AWSError>;
/**
* Adds one or more tags to the specified resource. The WorkloadArn parameter can be a workload ARN, a custom lens ARN, or a profile ARN.
*/
tagResource(params: WellArchitected.Types.TagResourceInput, callback?: (err: AWSError, data: WellArchitected.Types.TagResourceOutput) => void): Request<WellArchitected.Types.TagResourceOutput, AWSError>;
/**
* Adds one or more tags to the specified resource. The WorkloadArn parameter can be a workload ARN, a custom lens ARN, or a profile ARN.
*/
tagResource(callback?: (err: AWSError, data: WellArchitected.Types.TagResourceOutput) => void): Request<WellArchitected.Types.TagResourceOutput, AWSError>;
/**
* Deletes specified tags from a resource. The WorkloadArn parameter can be a workload ARN, a custom lens ARN, or a profile ARN. To specify multiple tags, use separate tagKeys parameters, for example: DELETE /tags/WorkloadArn?tagKeys=key1&tagKeys=key2
*/
untagResource(params: WellArchitected.Types.UntagResourceInput, callback?: (err: AWSError, data: WellArchitected.Types.UntagResourceOutput) => void): Request<WellArchitected.Types.UntagResourceOutput, AWSError>;
/**
* Deletes specified tags from a resource. The WorkloadArn parameter can be a workload ARN, a custom lens ARN, or a profile ARN. To specify multiple tags, use separate tagKeys parameters, for example: DELETE /tags/WorkloadArn?tagKeys=key1&tagKeys=key2
*/
untagResource(callback?: (err: AWSError, data: WellArchitected.Types.UntagResourceOutput) => void): Request<WellArchitected.Types.UntagResourceOutput, AWSError>;
/**
* Update the answer to a specific question in a workload review.
*/
updateAnswer(params: WellArchitected.Types.UpdateAnswerInput, callback?: (err: AWSError, data: WellArchitected.Types.UpdateAnswerOutput) => void): Request<WellArchitected.Types.UpdateAnswerOutput, AWSError>;
/**
* Update the answer to a specific question in a workload review.
*/
updateAnswer(callback?: (err: AWSError, data: WellArchitected.Types.UpdateAnswerOutput) => void): Request<WellArchitected.Types.UpdateAnswerOutput, AWSError>;
/**
* Updates whether the Amazon Web Services account is opted into organization sharing and discovery integration features.
*/
updateGlobalSettings(params: WellArchitected.Types.UpdateGlobalSettingsInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Updates whether the Amazon Web Services account is opted into organization sharing and discovery integration features.
*/
updateGlobalSettings(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Update lens review for a particular workload.
*/
updateLensReview(params: WellArchitected.Types.UpdateLensReviewInput, callback?: (err: AWSError, data: WellArchitected.Types.UpdateLensReviewOutput) => void): Request<WellArchitected.Types.UpdateLensReviewOutput, AWSError>;
/**
* Update lens review for a particular workload.
*/
updateLensReview(callback?: (err: AWSError, data: WellArchitected.Types.UpdateLensReviewOutput) => void): Request<WellArchitected.Types.UpdateLensReviewOutput, AWSError>;
/**
* Update a profile.
*/
updateProfile(params: WellArchitected.Types.UpdateProfileInput, callback?: (err: AWSError, data: WellArchitected.Types.UpdateProfileOutput) => void): Request<WellArchitected.Types.UpdateProfileOutput, AWSError>;
/**
* Update a profile.
*/
updateProfile(callback?: (err: AWSError, data: WellArchitected.Types.UpdateProfileOutput) => void): Request<WellArchitected.Types.UpdateProfileOutput, AWSError>;
/**
* Update a workload or custom lens share invitation. This API operation can be called independently of any resource. Previous documentation implied that a workload ARN must be specified.
*/
updateShareInvitation(params: WellArchitected.Types.UpdateShareInvitationInput, callback?: (err: AWSError, data: WellArchitected.Types.UpdateShareInvitationOutput) => void): Request<WellArchitected.Types.UpdateShareInvitationOutput, AWSError>;
/**
* Update a workload or custom lens share invitation. This API operation can be called independently of any resource. Previous documentation implied that a workload ARN must be specified.
*/
updateShareInvitation(callback?: (err: AWSError, data: WellArchitected.Types.UpdateShareInvitationOutput) => void): Request<WellArchitected.Types.UpdateShareInvitationOutput, AWSError>;
/**
* Update an existing workload.
*/
updateWorkload(params: WellArchitected.Types.UpdateWorkloadInput, callback?: (err: AWSError, data: WellArchitected.Types.UpdateWorkloadOutput) => void): Request<WellArchitected.Types.UpdateWorkloadOutput, AWSError>;
/**
* Update an existing workload.
*/
updateWorkload(callback?: (err: AWSError, data: WellArchitected.Types.UpdateWorkloadOutput) => void): Request<WellArchitected.Types.UpdateWorkloadOutput, AWSError>;
/**
* Update a workload share.
*/
updateWorkloadShare(params: WellArchitected.Types.UpdateWorkloadShareInput, callback?: (err: AWSError, data: WellArchitected.Types.UpdateWorkloadShareOutput) => void): Request<WellArchitected.Types.UpdateWorkloadShareOutput, AWSError>;
/**
* Update a workload share.
*/
updateWorkloadShare(callback?: (err: AWSError, data: WellArchitected.Types.UpdateWorkloadShareOutput) => void): Request<WellArchitected.Types.UpdateWorkloadShareOutput, AWSError>;
/**
* Upgrade lens review for a particular workload.
*/
upgradeLensReview(params: WellArchitected.Types.UpgradeLensReviewInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Upgrade lens review for a particular workload.
*/
upgradeLensReview(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Upgrade a profile.
*/
upgradeProfileVersion(params: WellArchitected.Types.UpgradeProfileVersionInput, callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
/**
* Upgrade a profile.
*/
upgradeProfileVersion(callback?: (err: AWSError, data: {}) => void): Request<{}, AWSError>;
}
declare namespace WellArchitected {
export type AccountSummary = {[key: string]: CheckStatusCount};
export type AdditionalResourceType = "HELPFUL_RESOURCE"|"IMPROVEMENT_PLAN"|string;
export interface AdditionalResources {
/**
* Type of additional resource for a custom lens.
*/
Type?: AdditionalResourceType;
/**
* The URLs for additional resources, either helpful resources or improvement plans, for a custom lens. Up to five additional URLs can be specified.
*/
Content?: Urls;
}
export type AdditionalResourcesList = AdditionalResources[];
export interface Answer {
QuestionId?: QuestionId;
PillarId?: PillarId;
QuestionTitle?: QuestionTitle;
QuestionDescription?: QuestionDescription;
ImprovementPlanUrl?: ImprovementPlanUrl;
HelpfulResourceUrl?: HelpfulResourceUrl;
/**
* The helpful resource text to be displayed for a custom lens. This field does not apply to Amazon Web Services official lenses.
*/
HelpfulResourceDisplayText?: DisplayText;
Choices?: Choices;
SelectedChoices?: SelectedChoices;
/**
* A list of selected choices to a question in your workload.
*/
ChoiceAnswers?: ChoiceAnswers;
IsApplicable?: IsApplicable;
Risk?: Risk;
Notes?: Notes;
/**
* The reason why the question is not applicable to your workload.
*/
Reason?: AnswerReason;
}
export type AnswerReason = "OUT_OF_SCOPE"|"BUSINESS_PRIORITIES"|"ARCHITECTURE_CONSTRAINTS"|"OTHER"|"NONE"|string;
export type AnswerSummaries = AnswerSummary[];
export interface AnswerSummary {
QuestionId?: QuestionId;
PillarId?: PillarId;
QuestionTitle?: QuestionTitle;
Choices?: Choices;
SelectedChoices?: SelectedChoices;
/**
* A list of selected choices to a question in your workload.
*/
ChoiceAnswerSummaries?: ChoiceAnswerSummaries;
IsApplicable?: IsApplicable;
Risk?: Risk;
/**
* The reason why a choice is non-applicable to a question in your workload.
*/
Reason?: AnswerReason;
/**
* The type of the question.
*/
QuestionType?: QuestionType;
}
export type ApplicationArn = string;
export interface AssociateLensesInput {
WorkloadId: WorkloadId;
LensAliases: LensAliases;
}
export interface AssociateProfilesInput {
WorkloadId: WorkloadId;
/**
* The list of profile ARNs to associate with the workload.
*/
ProfileArns: ProfileArns;
}
export type AwsAccountId = string;
export type AwsRegion = string;
export type Base64String = string;
export interface BestPractice {
ChoiceId?: ChoiceId;
ChoiceTitle?: ChoiceTitle;
}
export type BestPractices = BestPractice[];
export type CheckDescription = string;
export interface CheckDetail {
/**
* Trusted Advisor check ID.
*/
Id?: CheckId;
/**
* Trusted Advisor check name.
*/
Name?: CheckName;
/**
* Trusted Advisor check description.
*/
Description?: CheckDescription;
/**
* Provider of the check related to the best practice.
*/
Provider?: CheckProvider;
/**
* Well-Architected Lens ARN associated to the check.
*/
LensArn?: LensArn;
PillarId?: PillarId;
QuestionId?: QuestionId;
ChoiceId?: ChoiceId;
/**
* Status associated to the check.
*/
Status?: CheckStatus;
AccountId?: AwsAccountId;
/**
* Count of flagged resources associated to the check.
*/
FlaggedResources?: FlaggedResources;
/**
* Reason associated to the check.
*/
Reason?: CheckFailureReason;
UpdatedAt?: Timestamp;
}
export type CheckDetails = CheckDetail[];
export type CheckFailureReason = "ASSUME_ROLE_ERROR"|"ACCESS_DENIED"|"UNKNOWN_ERROR"|"PREMIUM_SUPPORT_REQUIRED"|string;
export type CheckId = string;
export type CheckName = string;
export type CheckProvider = "TRUSTED_ADVISOR"|string;
export type CheckStatus = "OKAY"|"WARNING"|"ERROR"|"NOT_AVAILABLE"|"FETCH_FAILED"|string;
export type CheckStatusCount = number;
export type CheckSummaries = CheckSummary[];
export interface CheckSummary {
/**
* Trusted Advisor check ID.
*/
Id?: CheckId;
/**
* Trusted Advisor check name.
*/
Name?: CheckName;
/**
* Provider of the check related to the best practice.
*/
Provider?: CheckProvider;
/**
* Trusted Advisor check description.
*/
Description?: CheckDescription;
UpdatedAt?: Timestamp;
/**
* Well-Architected Lens ARN associated to the check.
*/
LensArn?: LensArn;
PillarId?: PillarId;
QuestionId?: QuestionId;
ChoiceId?: ChoiceId;
/**
* Status associated to the check.
*/
Status?: CheckStatus;
/**
* Account summary associated to the check.
*/
AccountSummary?: AccountSummary;
}
export interface Choice {
ChoiceId?: ChoiceId;
Title?: ChoiceTitle;
Description?: ChoiceDescription;
/**
* The helpful resource (both text and URL) for a particular choice. This field only applies to custom lenses. Each choice can have only one helpful resource.
*/
HelpfulResource?: ChoiceContent;
/**
* The improvement plan (both text and URL) for a particular choice. This field only applies to custom lenses. Each choice can have only one improvement plan.
*/
ImprovementPlan?: ChoiceContent;
/**
* The additional resources for a choice in a custom lens. A choice can have up to two additional resources: one of type HELPFUL_RESOURCE, one of type IMPROVEMENT_PLAN, or both.
*/
AdditionalResources?: AdditionalResourcesList;
}
export interface ChoiceAnswer {
ChoiceId?: ChoiceId;
/**
* The status of a choice.
*/
Status?: ChoiceStatus;
/**
* The reason why a choice is non-applicable to a question in your workload.
*/
Reason?: ChoiceReason;
/**
* The notes associated with a choice.
*/
Notes?: ChoiceNotes;
}
export type ChoiceAnswerSummaries = ChoiceAnswerSummary[];
export interface ChoiceAnswerSummary {
ChoiceId?: ChoiceId;
/**
* The status of a choice.
*/
Status?: ChoiceStatus;
/**
* The reason why a choice is non-applicable to a question in your workload.
*/
Reason?: ChoiceReason;
}
export type ChoiceAnswers = ChoiceAnswer[];
export interface ChoiceContent {
/**
* The display text for the choice content.
*/
DisplayText?: ChoiceContentDisplayText;
/**
* The URL for the choice content.
*/
Url?: ChoiceContentUrl;
}
export type ChoiceContentDisplayText = string;
export type ChoiceContentUrl = string;
export type ChoiceDescription = string;
export type ChoiceId = string;
export interface ChoiceImprovementPlan {
ChoiceId?: ChoiceId;
/**
* The display text for the improvement plan.
*/
DisplayText?: DisplayText;
ImprovementPlanUrl?: ImprovementPlanUrl;
}
export type ChoiceImprovementPlans = ChoiceImprovementPlan[];
export type ChoiceNotes = string;
export type ChoiceReason = "OUT_OF_SCOPE"|"BUSINESS_PRIORITIES"|"ARCHITECTURE_CONSTRAINTS"|"OTHER"|"NONE"|string;
export type ChoiceStatus = "SELECTED"|"NOT_APPLICABLE"|"UNSELECTED"|string;
export type ChoiceTitle = string;
export interface ChoiceUpdate {
/**
* The status of a choice.
*/
Status: ChoiceStatus;
/**
* The reason why a choice is non-applicable to a question in your workload.
*/
Reason?: ChoiceReason;
/**
* The notes associated with a choice.
*/
Notes?: ChoiceNotes;
}
export type ChoiceUpdates = {[key: string]: ChoiceUpdate};
export type Choices = Choice[];
export type ClientRequestToken = string;
export interface ConsolidatedReportMetric {
/**
* The metric type of a metric in the consolidated report. Currently only WORKLOAD metric types are supported.
*/
MetricType?: MetricType;
RiskCounts?: RiskCounts;
WorkloadId?: WorkloadId;
WorkloadName?: WorkloadName;
WorkloadArn?: WorkloadArn;
UpdatedAt?: Timestamp;
/**
* The metrics for the lenses in the workload.
*/
Lenses?: LensMetrics;
/**
* The total number of lenses applied to the workload.
*/
LensesAppliedCount?: LensesAppliedCount;
}
export type ConsolidatedReportMetrics = ConsolidatedReportMetric[];
export type Count = number;
export interface CreateLensShareInput {
LensAlias: LensAlias;
SharedWith: SharedWith;
ClientRequestToken: ClientRequestToken;
}
export interface CreateLensShareOutput {
ShareId?: ShareId;
}
export interface CreateLensVersionInput {
LensAlias: LensAlias;
/**
* The version of the lens being created.
*/
LensVersion: LensVersion;
/**
* Set to true if this new major lens version.
*/
IsMajorVersion?: IsMajorVersion;
ClientRequestToken: ClientRequestToken;
}
export interface CreateLensVersionOutput {
/**
* The ARN for the lens.
*/
LensArn?: LensArn;
/**
* The version of the lens.
*/
LensVersion?: LensVersion;
}
export interface CreateMilestoneInput {
WorkloadId: WorkloadId;
MilestoneName: MilestoneName;
ClientRequestToken: ClientRequestToken;
}
export interface CreateMilestoneOutput {
WorkloadId?: WorkloadId;
MilestoneNumber?: MilestoneNumber;
}
export interface CreateProfileInput {
/**
* Name of the profile.
*/
ProfileName: ProfileName;
/**
* The profile description.
*/
ProfileDescription: ProfileDescription;
/**
* The profile questions.
*/
ProfileQuestions: ProfileQuestionUpdates;
ClientRequestToken: ClientRequestToken;
/**
* The tags assigned to the profile.
*/
Tags?: TagMap;
}
export interface CreateProfileOutput {
/**
* The profile ARN.
*/
ProfileArn?: ProfileArn;
/**
* Version of the profile.
*/
ProfileVersion?: ProfileVersion;
}
export interface