id
stringlengths 8
78
| source
stringclasses 743
values | chunk_id
int64 1
5.05k
| text
stringlengths 593
49.7k
|
|---|---|---|---|
websdkguide-007 | websdkguide.pdf | 7 | TimezoneRedirectionSetting codes enum. Type: • TimezoneRedirectionSettingCode (constant) TimezoneRedirectionStatus :TimezoneRedirectionStatusCode The TimezoneRedirectionStatus codes enum. Type: • TimezoneRedirectionStatusCode (constant) version The Amazon DCV version with major, minor, patch, revision, extended, and versionStr. Properties: Name major minor patch revision Members Type integer integer integer integer Description The major version number. The minor version number. The patch version number. The revision number. 25 Amazon DCV Name extended versionStr Type string string Web Client SDK Developer Guide Description The extended string. A concatenation of the major, minor, patch, and revision numbers in the form major.minor.patch+ build.revision . (constant) ScreenshotError :ScreenshotErrorCode The ScreenshotError codes enum. Type: • ScreenshotErrorCode (constant) WebcamError :WebcamErrorCode The WebcamError codes enum. Type: • WebcamErrorCode Type and callback definitions List • AudioErrorCode • authenticationCallbacks • AuthenticationErrorCode • authErrorCallback(authentication, error) • authPromptCredentialsCallback(authentication, challenge) • authSuccessCallback(authentication, authenticationData) • Channel Type and callback definitions 26 Web Client SDK Developer Guide Amazon DCV • ChannelErrorCode • clipboardEventCallback(event) • ClosingReasonErrorCode • Colorspace • connectionCallbacks • ConnectionConfig • ConnectionErrorCode • createDirectory(path) • CustomChannelErrorCode • dataChannelCallback(info) • deleteFile(path) • deviceChangeEventCallback() • disconnectCallback(reason) • displayAvailabilityCallback(status, displayId) • DisplayConfigErrorCode • displayLayoutCallback(serverWidth, serverHeight, heads) • feature • featuresUpdateCallback(featuresList) • fileDownloadCallback(fileResource) • filePrintedCallback(printResource) • filestorage • filestorageEnabledCallback(enabled) • FileStorageErrorCode • firstFrameCallback(resizeEnabled, relativeMouseModeEnabled, displayId) • idleWarningNotificationCallback(disconnectionDateTime) • collaboratorListCallback(collaborators) • licenseNotificationCallback(notification) • list(path) Type and callback definitions 27 Amazon DCV • LogLevel • Monitor • MultiMonitorErrorCode • qualityIndicatorStateCallback(state) • renameDirectory(src, dest) • renameFile(src, dest) • ResolutionErrorCode • retrieveFile(path) • screenshotCallback(screenshot) • ScreenshotErrorCode • serverInfo • stats • storeFile(file, dir) • TimezoneRedirectionErrorCode • TimezoneRedirectionSettingCode • TimezoneRedirectionStatusCode • WebcamErrorCode AudioErrorCode The AudioError code enums available in the DCV module • SETTING_AUDIO_FAILED • CHANNEL_NOT_AVAILABLE Type: • number authenticationCallbacks Authentication callbacks Type and callback definitions Web Client SDK Developer Guide 28 Amazon DCV Type: • Object Properties: Web Client SDK Developer Guide Name Type Description promptCredentials authPromptCredentialsCallba ck The callback function to be called when the user is error authErrorCallback success authSuccessCallback challenged for credentials. The callback function to be called when authentication fails. The callback function to be called when authentication succeeds. AuthenticationErrorCode The AuthenticationError code enums available in the DCV module • INVALID_MESSAGE • UNKNOWN_AUTH_MODE • SESSION_NOT_AVAILABLE • NO_SESSIONS • WRONG_CREDENTIALS • SASL_CHALLENGE • SASL_AUTH_MECHANISM • FAILED_COMMUNICATION • AUTHENTICATION_REJECTED • GENERIC_ERROR • WRONG_CREDENTIALS_FORMAT • WRONG_CREDENTIALS_TYPE • UNREQUESTED_CREDENTIALS Type and callback definitions 29 Web Client SDK Developer Guide Amazon DCV • MISSING_CREDENTIAL Type: • number authErrorCallback(authentication, error) The callback function to be called when authentication fails. Parameters: Name Type Description authentication Authentication The Authentication object. error Object The error object raised by the authentication process. Name Type Descripti on code Authentic ationErro The error rCode code. message string The error message. authPromptCredentialsCallback(authentication, challenge) The callback function to be called when the user is challenged for credentials. The user must answer the challenge by providing the requested credentials. Type and callback definitions 30 Amazon DCV Parameters: Web Client SDK Developer Guide Name Type Description authentication Authentication The Authentication object. challenge Object The challenge. Name Type Descripti on requiredC redential Array.<Ob ject> An array s of requested credentia l objects. NameTypeDescripti on namestringThe name of the requested credentia l. typestringThe type of the requested Type and callback definitions 31 Amazon DCV Name Type Description Web Client SDK Developer Guide Name Type Descripti on NameTypeDescripti on credentia l. authSuccessCallback(authentication, authenticationData) The callback function to be called when authentication succeeds. Parameters: Name Type Description authentication Authentication The Authentication object. authenticationData Array.<Object> Type and callback definitions An array of objects that include Amazon DCV session IDs and authentication tokens. Name Type sessionIdstring authTokenstring Descripti on The Amazon DCV session ID. The authentic 32 Amazon DCV Name Web Client SDK Developer Guide Type Description Name Type Descripti on ation token for the Amazon DCV session. Channel The available channels that can be specified. Type: • "clipboard" | "display" | "input" | "audio" | "filestorage" ChannelErrorCode The ChannelError code enums available in the DCV module • ALREADY_OPEN • INITIALIZATION_FAILED • REJECTED Type: • number clipboardEventCallback(event) The callback function to be called when a clipboardEvent is generated. Type and callback definitions 33 Amazon DCV Parameters: Name event Web Client SDK Developer Guide Type Object Description Information about the clipboard event. Name Type Attribute Descripti on s name establish ed | copy | paste | Always present. The name of the dataSizeA event. lert | autoCopyD one | newDataAv ailable | autoPaste Done | remoteErr or | pasteAvai lableData Data Type and callback definitions clipboard Object | string The data in the 34 Amazon DCV Name Type Description Web Client SDK Developer Guide Name Type Attribute Descripti on s clipboard . autoCopyboolean<optional > Indicates whether automatic copying from the session clipboard to the local client clipboard is enabled. maxDataSi number<optional > The maximum ze Type and callback definitions amount of data that can be placed in the clipboard . 35 Amazon DCV Name Type Description Web Client SDK |
websdkguide-008 | websdkguide.pdf | 8 | name of the dataSizeA event. lert | autoCopyD one | newDataAv ailable | autoPaste Done | remoteErr or | pasteAvai lableData Data Type and callback definitions clipboard Object | string The data in the 34 Amazon DCV Name Type Description Web Client SDK Developer Guide Name Type Attribute Descripti on s clipboard . autoCopyboolean<optional > Indicates whether automatic copying from the session clipboard to the local client clipboard is enabled. maxDataSi number<optional > The maximum ze Type and callback definitions amount of data that can be placed in the clipboard . 35 Amazon DCV Name Type Description Web Client SDK Developer Guide Name Type Attribute Descripti on s error string <optional Error informati on if applicabl e. > ClosingReasonErrorCode The ClosingReasonError code enums available in the DCV module • TRANSPORT_ERROR • NO_ERROR • GENERIC_ERROR • INTERNAL_SERVER_ERROR • PROTOCOL_ERROR • AUTHORIZATION_DENIED • AUTHORIZATION_REVOKED • ACCESS_REJECTED • IDLE_TIMEOUT_EXPIRED • DISCONNECT_BY_OWNER • DISCONNECT_BY_USER • EVICTED • EXTERNAL_PROTOCOL_CONNECTION_EVICTED • DISCONNECTION_REQUESTED Type: • number Type and callback definitions 36 Web Client SDK Developer Guide Amazon DCV Colorspace The available colorspaces that can be specified. Type: • "RGB" | "YUV_REC601" | "YUV_REC709" connectionCallbacks The callbacks that are available to be called in the event of a connection error. Type: • Object Properties: Name Type Description disconnect disconnectCallback displayLayout displayLayoutCallback displayAvailability displayAvailabilityCallback firstFrame firstFrameCallback The callback function to be called when the connection ends. The callback function to be called when the display layout or resolution is changed. The callback function to be called when a display's availability changes. The callback function to be called when the first frame is received from the Amazon DCV server. Type and callback definitions 37 Amazon DCV Name Type Description Web Client SDK Developer Guide filePrinted filePrintedCallback fileDownload fileDownloadCallback dataChannel dataChannelCallback licenseNotification licenseNotificationCallback The callback function to be called when a file is printed on the Amazon DCV server. The callback function to be called when a file is ready to be downloaded from the Amazon DCV server. The callback function to be called when the Amazon DCV server sends a notification about the availability of a data channel. The callback function to be called when the Amazon DCV server sends a notification about the license state. idleWarningNotific ation idleWarningNotificationCall back The callback function to be called when the Amazon DCV collaboratorList collaboratorListCallback qualityIndicatorSt qualityIndicatorStateCallback ate server sends an idle timeout warning. The callback function to be called when the Amazon DCV server sends the list of collaborators (since Amazon DCV Web Client SDK version 1.1.0). The callback function to be called when the connectio n quality indicator changes state. Type and callback definitions 38 Amazon DCV Name Type Description Web Client SDK Developer Guide filestorageEnabled filestorageEnabledCallback featuresUpdate featuresUpdateCallback The callback function to be called when file storage is enabled or disabled. The callback function to be called when a feature's status changes. clipboardEvent clipboardEventCallback The callback function to be called when a clipboard Event is generated. deviceChangeEvent deviceChangeEventCallback The callback function to be called when an deviceCha nge event is triggered. screenshot screenshotCallback The callback function to be called when a screenshot is available. ConnectionConfig The configuration for a Amazon DCV connection. Type: • Object Properties: Name url Type string Description The host name and port of the running Amazon DCV server in the following format: https://d Type and callback definitions 39 Amazon DCV Name Type Description Web Client SDK Developer Guide sessionId authToken string string baseUrl string resourceBaseUrl string enabledChannels Array.<Channel> losslessColorspace Colorspace divId string volumeLevel integer cv_host_address:po rt . For example: https:// my-dcv-server:8443 . The Amazon DCV session ID. The authentication token to use when connecting to the server. The absolute or relative URL from which to load SDK files. The absolute or relative URL from which to access DCV resources. Indicates the list of channels that can be enabled. If not specified or an empty array is provided, it defaults to all the available channels. Indicates the colorspace that will be used. If not specified, it defaults to "RGB". The ID of the div object in the HTML DOM where SDK should create the canvas with the remote stream. The preferred volume level. The valid range is 0 to 100. Type and callback definitions 40 Amazon DCV Name Type Description Web Client SDK Developer Guide clipboardAutoSync boolean dynamicAudioTuning boolean clientHiDpiScaling boolean highColorAccuracy boolean enableWebCodecs Boolean observers connectionCallbacks callbacks connectionCallbacks Indicates whether automatic copying from the Amazon DCV session clipboard to the local client clipboard is enabled for compatible web browsers. Indicates whether to dynamically tune the audio based on the Amazon DCV server audio settings when a connection is established. Indicates whether to scale the canvas based on the client's DPI. Indicates whether high color accuracy should be used if available. If not specified, it defaults to false. Indicates whether WebCodecs should be used if available . |
websdkguide-009 | websdkguide.pdf | 9 | Name Type Description Web Client SDK Developer Guide clipboardAutoSync boolean dynamicAudioTuning boolean clientHiDpiScaling boolean highColorAccuracy boolean enableWebCodecs Boolean observers connectionCallbacks callbacks connectionCallbacks Indicates whether automatic copying from the Amazon DCV session clipboard to the local client clipboard is enabled for compatible web browsers. Indicates whether to dynamically tune the audio based on the Amazon DCV server audio settings when a connection is established. Indicates whether to scale the canvas based on the client's DPI. Indicates whether high color accuracy should be used if available. If not specified, it defaults to false. Indicates whether WebCodecs should be used if available . Defaults to false if not specified. The callback functions to call for events that are related to the connection. The same as the observers property, but each callback includes the Connection object as the first parameter. Type and callback definitions 41 Amazon DCV ConnectionErrorCode Web Client SDK Developer Guide The ConnectionError code enums available in the DCV module • ALREADY_OPEN • INVALID_CONFIG • INITIALIZATION_FAILED • REJECTED • MAIN_CHANNEL_ALREADY_OPEN • GENERIC_ERROR (since DCV Server 2021.0) • INTERNAL_SERVER_ERROR (since DCV Server 2021.0) • AUTHENTICATION_FAILED (since DCV Server 2021.0) • PROTOCOL_ERROR (since DCV Server 2021.0) • INVALID_SESSION_ID (since DCV Server 2021.0) • INVALID_CONNECTION_ID (since DCV Server 2021.0) • CONNECTION_LIMIT_REACHED (since DCV Server 2021.0) • SERVER_UNREACHABLE (since DCV Server 2022.1) • GATEWAY_BUSY • UNSUPPORTED_CREDENTIAL (since DCV Server 2022.2) • TRANSPORT_ERROR Type: • number createDirectory(path) Parameters: Name path Type string Description The absolute path on the server where we want to create a directory. It should also include the name of the target directory. Type and callback definitions 42 Amazon DCV Web Client SDK Developer Guide CustomChannelErrorCode The CustomChannelError code enums available in the DCV module • TRANSPORT_ERROR Type: • number dataChannelCallback(info) The callback function to be called when the Amazon DCV server sends a notification about the availability of a data channel. Parameters: Name info Type Object Description Information about the data channel. Name Type name string token string Descripti on The name of the data channel. The authentic ation token for the 43 Type and callback definitions Amazon DCV Name Type Description Web Client SDK Developer Guide deleteFile(path) Parameters: Name path Type string Name Type Descripti on data channel. Description The absolute path on the server identifying the file we want to delete. deviceChangeEventCallback() The callback function to be called when an deviceChange event is triggered. disconnectCallback(reason) The callback function to be called when the connection ends. Parameters: Name reason Type Object Description The reason for the disconnec tion. Type and callback definitions 44 Amazon DCV Name Type Description Web Client SDK Developer Guide Name Type Descripti on code number The message string reason code. The reason message. displayAvailabilityCallback(status, displayId) The callback function to be called when a display's availability changes. Parameters: Name status Type Object Description The status of the display. Name Type Descripti on enabled boolean Indicates if the display is enabled. closed boolean Indicates if the display 45 Type and callback definitions Amazon DCV Name Type Description Web Client SDK Developer Guide Name Type Descripti on is closed. displayId number The identifier for the display. DisplayConfigErrorCode The DisplayConfigError code enums available in the DCV module • INVALID_ARGUMENT • UNSUPPORTED_OPERATION • NO_CHANNEL Type: • number displayLayoutCallback(serverWidth, serverHeight, heads) The callback function to be called when the display layout or resolution is changed. Parameters: Name serverWidth Type number serverHeight number heads Array.<Monitor> Description The width (in pixels) of the primary display. The height (in pixels) of the primary display. The display heads supported by the Amazon DCV server. Type and callback definitions 46 Amazon DCV feature The feature values. Web Client SDK Developer Guide • display - Indicates the availability of a single-display video stream. • display-multi - Indicates the availability of a multi-display video stream. • high-color-accuracy - Indicates the availability of high color accuracy (since Amazon DCV Web Client SDK version 1.1.0). • mouse - Indicates the availability of mouse functionality. • keyboard - Indicates the availability of keyboard functionality. • keyboard-sas - Indicates the availability of SAS sequence (Control + Alt + Delete) functionality. • relative-mouse - Indicates the availability of relative mouse mode. • clipboard-copy - Indicates the availability of clipboard copy functionality from Amazon DCV server to the client. • clipboard-paste - Indicates the availability of clipboard paste functionality from the client to the Amazon DCV server. • audio-in - Indicates the availability of audio input functionality using the microphone. • audio-out - Indicates the availability of audio playback functionality. • webcam - Indicates the availability of webcam streaming functionality. • file-download - Indicates availability of file download functionality from the Amazon DCV server to the client. • file-upload - Indicates availability of file upload functionality from the client to the Amazon DCV server. • timezone-redirection - Indicates the availability of timezone redirection functionality (since Amazon DCV |
websdkguide-010 | websdkguide.pdf | 10 | the client. • clipboard-paste - Indicates the availability of clipboard paste functionality from the client to the Amazon DCV server. • audio-in - Indicates the availability of audio input functionality using the microphone. • audio-out - Indicates the availability of audio playback functionality. • webcam - Indicates the availability of webcam streaming functionality. • file-download - Indicates availability of file download functionality from the Amazon DCV server to the client. • file-upload - Indicates availability of file upload functionality from the client to the Amazon DCV server. • timezone-redirection - Indicates the availability of timezone redirection functionality (since Amazon DCV Web Client SDK version 1.3.0). Type: • string featuresUpdateCallback(featuresList) The callback function to be called when a feature's status changes. Type and callback definitions 47 Amazon DCV Parameters: Web Client SDK Developer Guide Name Type Description featuresList Array.<feature> An array of features that have changed. fileDownloadCallback(fileResource) The callback function to be called when a file is ready to be downloaded from the Amazon DCV server. Parameters: Name fileResource Type Object Description Information about the file that is ready for download. Name Type id string url string Descripti on The identifie r for the file. The URL to use to download the file. Type and callback definitions 48 Amazon DCV Name Type Description Web Client SDK Developer Guide Name Type domain string token string Descripti on The resource domain. The authentic ation token to use to download the file. The token is also included in the URL. filePrintedCallback(printResource) The callback function to be called when a file is printed on the Amazon DCV server. Parameters: Name printResource Type Object Description Information about the printed file. Type and callback definitions 49 Amazon DCV Name Type Description Web Client SDK Developer Guide Name Type id string url string domain string token string Descripti on The identifie r for the printed file. The URL to use to download the printed file. The resource domain. In this case, printer. The authentic ation token to use to download the printed file. 50 Type and callback definitions Amazon DCV Name Web Client SDK Developer Guide Type Description Name Type Descripti on The token is also included in the URL. filestorage Object that allows for exploring and performing actions on the file system. Type: • Object Properties: Name list Type list createDirectory createDirectory retrieveFile retrieveFile Description Function that allows to list the items (files and directori es) present at the supplied path on the server. Function that allows to create a directory at the specified path on the server. Function that allows to locally download a file at the specified path on the server. Type and callback definitions 51 Amazon DCV Name deleteFile Type deleteFile renameFile renameFile renameDirectory renameDirectory storeFile storeFile Web Client SDK Developer Guide Description Function that allows to delete a file at the specified path on the server. Function that allows to rename a file from the specified source path to the specified destination path. Function that allows to rename a directory from the specified source path to the absolute destination path. Function that allows to upload a local file to the supplied path on the server. filestorageEnabledCallback(enabled) The callback function to be called when file storage is enabled. Lazy channel on Internet Explorer 11 only. Parameters: Name enabled Type boolean Description Indicates whether file storage is enabled. FileStorageErrorCode The FileStorageError code enums available in the DCV module • CANCELLED Type and callback definitions 52 Web Client SDK Developer Guide Amazon DCV • ABORTED • INVALID_ARGUMENT • NOT_IMPLEMENTED • ERROR • ALREADY_EXIST • NOT_FOUND Type: • number firstFrameCallback(resizeEnabled, relativeMouseModeEnabled, displayId) The callback function to be called when the first frame is received from the Amazon DCV server. Emitted for each display. Parameters: Name resizeEnabled Type boolean relativeMouseModeE boolean nabled Description Indicates whether the server supports resizing the client display layout. Indicates whether the server supports relative mouse mode. displayId number The identifier for the display. idleWarningNotificationCallback(disconnectionDateTime) The callback function to be called when the Amazon DCV server sends an idle timeout warning. Type and callback definitions 53 Amazon DCV Parameters: Name disconnectionDateT ime Type Date Web Client SDK Developer Guide Description The date and time of the disconnection. collaboratorListCallback(collaborators) The callback function to be called when the Amazon DCV server sends the list of collaborators. Parameters: Name Type Description collaborators Array.<Object> A list of objects containing information on collaborators. Name Type usernamestring Descripti on The username of the collabora tor. owner boolean Indicates whether the collabora tor is the session owner. Type and callback definitions 54 Amazon DCV Name Type Description Web Client SDK Developer Guide Name Type connectio number nId Descripti on Indicates the ID assigned by the server to the connectio n. licenseNotificationCallback(notification) The callback function to be called when the Amazon DCV server sends a notification about the license state. Parameters: Name |
websdkguide-011 | websdkguide.pdf | 11 | when the Amazon DCV server sends the list of collaborators. Parameters: Name Type Description collaborators Array.<Object> A list of objects containing information on collaborators. Name Type usernamestring Descripti on The username of the collabora tor. owner boolean Indicates whether the collabora tor is the session owner. Type and callback definitions 54 Amazon DCV Name Type Description Web Client SDK Developer Guide Name Type connectio number nId Descripti on Indicates the ID assigned by the server to the connectio n. licenseNotificationCallback(notification) The callback function to be called when the Amazon DCV server sends a notification about the license state. Parameters: Name notification Type Object Type and callback definitions Description The notification. Name Type product string status string Descripti on The DCV product. The status of the license. 55 Amazon DCV Name Type Description Web Client SDK Developer Guide Name Type message string Descripti on A message. leftDaysnumber The number of days before the license expires. isDemo boolean Indicates if the license is a demo license. numUnlice number The nsed licensing string Mode documenta string tionUrl number of unlicense d connectio ns. The licensing mode. The URL for the 56 Type and callback definitions Amazon DCV Name list(path) Parameters: Name path Type Description Web Client SDK Developer Guide Name Type Descripti on documenta tion. Type string Description The absolute path on the server of which we want to list the content. LogLevel The available SDK log levels. Type: • TRACE | DEBUG | INFO | WARN | ERROR | SILENT Monitor Type: • Object Properties: Name name Type string Description The name of the display head. Type and callback definitions 57 Amazon DCV Name rect Type Object Type and callback definitions Web Client SDK Developer Guide Description Information about the display head. Name Type Descripti on x number The initial x coordinat e for the display head. y number The initial y coordinat e for the display head. width number The width (in pixels) of the display head. height number The height (in 58 Amazon DCV Name Web Client SDK Developer Guide Type Description Name Type Descripti on pixels) of the display head. primary boolean Indicates whether the display head is the primary display head. This is determined from the remote operating system if available. dpi number The DPI of the display head. MultiMonitorErrorCode The MultiMonitorError code enums available in the DCV module • NO_DISPLAY_CHANNEL • MAX_DISPLAY_NUMBER_REACHED • INVALID_ARGUMENT • DISPLAY_NOT_OPENED_BY_SERVER • REQUEST_TIMEOUT • GENERIC_ERROR • NO_ERROR Type: • number qualityIndicatorStateCallback(state) The callback function to be called when the connection quality indicator changes state. Type and callback definitions 59 Amazon DCV Parameters: Name state Web Client SDK Developer Guide Type Description Array.<Object> Information about the connection quality. Name Type name string Descripti on The name of the indicator . status NORMAL | Descripti on of WARNING the | status. CRITICAL changed boolean Indicates whether the status changed. Type and callback definitions 60 Amazon DCV Web Client SDK Developer Guide renameDirectory(src, dest) Parameters: Name src dest renameFile(src, dest) Parameters: Name src dest Type string string Type string string Description The absolute source path on the server identifying the directory we want to rename. The absolute destination path on the server specifying the target path and directory name. Description The absolute source path on the server identifying the file we want to rename. The absolute destination path on the server specifying the target path and file name. ResolutionErrorCode The ResolutionError code enums available in the DCV module • INVALID_ARGUMENT • NO_CHANNEL • NOT_IMPLEMENTED Type and callback definitions 61 Amazon DCV Type: • number retrieveFile(path) Parameters: Web Client SDK Developer Guide Name path Type string Description The absolute path on the server identifying the file we want to download locally. screenshotCallback(screenshot) The callback function to be called when a screenshot is available. Parameters: Name screenshot Type byte[] ScreenshotErrorCode The ScreenshotError code enums available in the DCV module • NO_CHANNEL • GENERIC_ERROR Type: • number Description Screenshot buffer in PNG format, or null if screenshot retrieval failed. Type and callback definitions 62 Amazon DCV serverInfo Type: • Object Properties: Name name version Type string Object os arch hostname string string string Web Client SDK Developer Guide Description The name of the software. The software version number. Name Type Descripti on major number The major version number. minor number The minor version number. revisionnumber The revision version number. The OS. The architecture. The hostname. Type and callback definitions 63 Amazon DCV stats Type: • Object Properties: Name fps traffic peakTraffic latency currentChannels Type number number number number number openedChannels number channelErrors number storeFile(file, dir) Parameters: Name file Type File Web Client SDK Developer Guide Description The current frames per second. The current traffic in bit/s. The peak of traffic in bit/ s since the connection was established. The current latency in ms. The number of channels that |
websdkguide-012 | websdkguide.pdf | 12 | Name Type Descripti on major number The major version number. minor number The minor version number. revisionnumber The revision version number. The OS. The architecture. The hostname. Type and callback definitions 63 Amazon DCV stats Type: • Object Properties: Name fps traffic peakTraffic latency currentChannels Type number number number number number openedChannels number channelErrors number storeFile(file, dir) Parameters: Name file Type File Web Client SDK Developer Guide Description The current frames per second. The current traffic in bit/s. The peak of traffic in bit/ s since the connection was established. The current latency in ms. The number of channels that have been opened since the connection was established. The number of currently opened channels. The number of channels which have reported an error. Description The file object (for more information see https://d Type and callback definitions 64 Amazon DCV Name Type Description Web Client SDK Developer Guide dir string eveloper.mozilla.org/en-US/ docs/Web/API/File) we want to upload to the server. The absolute path on the server where we want to upload the file. TimezoneRedirectionErrorCode The TimezoneRedirectionError code enums available in the DCV module • INVALID_ARGUMENT • NO_CHANNEL • USER_CANNOT_CHANGE Type: • number TimezoneRedirectionSettingCode The TimezoneRedirectionSetting code enums available in the DCV module • ALWAYS_OFF • ALWAYS_ON • CLIENT_DECIDES Type: • number TimezoneRedirectionStatusCode The TimezoneRedirectionStatus code enums available in the DCV module Type and callback definitions 65 Web Client SDK Developer Guide Amazon DCV • SUCCESS • PERMISSION_ERROR • GENERIC_ERROR Type: • number WebcamErrorCode The WebcamError code enums available in the DCV module • SETTING_WEBCAM_FAILED • CHANNEL_NOT_AVAILABLE Type: • number Connection Class The Connection Class obtained by calling the connect method of the dcv module. For an example showing how to use it, see the Getting started section. Exposes • Methods Methods List • attachDisplay(win, displayConf) → {Promise.<number>|Promise.<{code: MultiMonitorErrorCode, message: string}>} • captureClipboardEvents(enabled, win, displayId) → {void} • detachDisplay(displayId) → {void} • disconnect() → {void} Connection Class 66 Amazon DCV Web Client SDK Developer Guide • disconnectCollaborator(connectionId) → {void} • enableDisplayQualityUpdates(enable) → {void} • enableHighPixelDensity(enable) → {void} • enableTimezoneRedirection(enable) → {Promise|Promise.<{code: TimezoneRedirectionErrorCode, message: string}>} • enterRelativeMouseMode() → {void} • getConnectedDevices() → {Promise.<Array.<MediaDeviceInfo>>|Promise.<{message: string}>} • getFileExplorer() → {Promise.<filestorage>|Promise.<{code: ChannelErrorCode, message: string}>} • getServerInfo() → {serverInfo} • getScreenshot() → {Promise|Promise.<{code: ScreenshotErrorCode, message: string}>} • getStats() → {stats} • latchModifierKey(key, location, isDown) → {boolean} • openChannel(name, authToken, callbacks, namespace) → {Promise|Promise.<{code: ChannelErrorCode, message: string}>} • queryFeature(featureName) → {Promise.<{enabled: boolean, remote?: string, autoCopy?: boolean, autoPaste?: boolean, serviceStatus?: string, available?: boolean}>|Promise.<{message: string}>} • registerKeyboardShortcuts(shortcuts) → {void} • requestDisplayConfig(highColorAccuracy) → {Promise|Promise.<{code: DisplayConfigErrorCode, message: string}>} • requestDisplayLayout(layout) → {Promise|Promise.<{code: ResolutionErrorCode, message: string}>} • requestResolution(width, height) → {Promise|Promise.<{code: ResolutionErrorCode, message: string}>} • sendKeyboardEvent(event) → {boolean} • sendKeyboardShortcut(shortcut) → {void} • setDisplayQuality(min, maxopt) → {void} • setDisplayScale(scaleRatio, displayId) → {Promise|Promise.<{code: ResolutionErrorCode, message: string}>} (DEPRECATED) • setKeyboardQuirks(quirks) → {void} • setMaxDisplayResolution(maxWidth, maxHeight) → {void} Methods 67 Amazon DCV Web Client SDK Developer Guide • setMicrophone(enable) → {Promise|Promise.<{code: AudioErrorCode, message: string}>} • setMinDisplayResolution(minWidth, minHeight) → {void} • setUploadBandwidth(value) → {number} • setVolume(volume) → {void} • setMicrophone(enable, deviceId) → {Promise|Promise.<{code: AudioErrorCode, message: string}>} • setWebcam(enable, deviceId) → {Promise|Promise.<{code: WebcamErrorCode, message: string}>} • syncClipboards() → {boolean} attachDisplay(win, displayConf) → {Promise.<number>|Promise.<{code: MultiMonitorErrorCode, message: string}>} Attaches a specific display to a window. You can't attach the main display. If successful, the function returns the displayId. Parameters: Name win Type Object displayConf Object Methods Description The window to which the display must be attached. The configuration of the display. Name Type Attribute Descripti on s > displayIdnumber<optional The ID of the display. displayDi vName The name of 68 Amazon DCV Name Returns: Type Description Web Client SDK Developer Guide Name Type Attribute Descripti on s the display div. Promise. If rejected, the promise returns an error object. Type Promise.<number> | Promise.<{code: MultiMonitorErrorCode, message: string}> captureClipboardEvents(enabled, win, displayId) → {void} Starts or stops listening to copy-paste events. In the case of interactive clipboards (always in the case of paste) we need to start listening to the copy/paste events. It could be useful to start and stop listening only when it is needed, for example, when a modal is shown. Parameters: Name enabled Type boolean Attributes Description To start listening to events, specify true. To stop listening to events, specify false. The window in which to listen for events. If omitted, the default window is used. win Object <optional> Methods 69 Amazon DCV Name Type Attributes Description Web Client SDK Developer Guide displayId number <optional> The ID of the display that should listen the events. If omitted, the default display of the window is used. Returns: Type void detachDisplay(displayId) → {void} Detaches a specific display. The main display cannot be detached. Type number Description The ID of the display to detach. Parameters: Name displayId Returns: Type void disconnect() → {void} Disconnects from the Amazon DCV server and closes the connection. Methods 70 Amazon DCV Returns: Type void Web Client SDK Developer |
websdkguide-013 | websdkguide.pdf | 13 | the default window is used. win Object <optional> Methods 69 Amazon DCV Name Type Attributes Description Web Client SDK Developer Guide displayId number <optional> The ID of the display that should listen the events. If omitted, the default display of the window is used. Returns: Type void detachDisplay(displayId) → {void} Detaches a specific display. The main display cannot be detached. Type number Description The ID of the display to detach. Parameters: Name displayId Returns: Type void disconnect() → {void} Disconnects from the Amazon DCV server and closes the connection. Methods 70 Amazon DCV Returns: Type void Web Client SDK Developer Guide disconnectCollaborator(connectionId) → {void} Requests disconnect of collaborator connected with the provided connection id (since Amazon DCV Web Client SDK version 1.1.0). Type boolean Description The id of the connection that will be disconnected. Parameters: Name connectionId Returns: Type void enableDisplayQualityUpdates(enable) → {void} Enables or disables display quality updates for streaming areas that do not receive updates. Disabling display quality updates reduces bandwidth usage, but it also decreases the display quality. Parameters: Name enable Type boolean Description To enable display quality updates, specify true. To disable display quality updates, specify false. Methods 71 Web Client SDK Developer Guide Amazon DCV Returns: Type void enableHighPixelDensity(enable) → {void} Enables or disables high pixel density on the client. Type boolean Description Whether or not high pixel density should be enabled. Parameters: Name enable Returns: Type void enableTimezoneRedirection(enable) → {Promise|Promise.<{code: TimezoneRedirectionErrorCode, message: string}>} Enables or disables timezone redirection. Once it is enabled, the client requests the server to make the server desktop timezone match the client timezone. Parameters: Name enable Type boolean Description To enable timezone redirecti on, specify true. To disable timezone redirection, specify false. Methods 72 Amazon DCV Returns: Promise. If rejected, the promise returns an error object. Type Web Client SDK Developer Guide Promise.<number> | Promise.<{code: TimezoneRedirectionErrorCode, message: string}> enterRelativeMouseMode() → {void} Enables relative mouse mode. Returns: Type void getConnectedDevices() → {Promise.<Array.<MediaDeviceInfo>>| Promise.<{message: string}>} Requests a list of the media devices connected to the client computer. Returns: If successful, it returns a Promise that resolves to an array of MediaDeviceInfo objects. For more information, see https://developer.mozilla.org/en-US/docs/Web/API/MediaDeviceInfo. If rejected, the promise returns an error object. Type Promise.<Array.<MediaDeviceInfo>> | Promise.<{message: string}> getFileExplorer() → {Promise.<filestorage>|Promise.<{code: ChannelErrorCode, message: string}>} Gets an object to manage the Amazon DCV server's file storage. Returns: Promise. Resolves to the file explorer object if fulfilled, or an error object if rejected. Methods 73 Amazon DCV Type Web Client SDK Developer Guide Promise.<filestorage> | Promise.<{code: ChannelErrorCode, message: string}> getServerInfo() → {serverInfo} Gets information about the Amazon DCV server. Returns: Information about the server software. Type serverInfo getScreenshot() → {Promise|Promise.<{code: ScreenshotErrorCode, message: string}>} Retrieves the screenshot of the remote desktop in PNG format. The screenshot will be returned in the screenshotCallback observer. null will be returned instead in case of failures. Returns: Promise that resolves if the request is processed. If rejected we receive an error object. Type Promise | Promise.<{code: ScreenshotErrorCode, message: string}> getStats() → {stats} Gets statistics about the Amazon DCV server. Returns: Information about the streaming statistics. Type stats Methods 74 Amazon DCV Web Client SDK Developer Guide latchModifierKey(key, location, isDown) → {boolean} Sends a single keyboard keydown or keyup event for an allowed modifier. Parameters: Name key Type Description Control | Alt | AltGraph | Meta | OS | Shift The key to send. location KeyboardEvent.location isDown boolean The key's location. For more information, see https:// developer.mozilla.org/en- US/docs/Web/API/Keybo ardEvent/location. If the key event to inject is a keydown (true) or a keyup (false). Returns: If the requested combination is valid, the function returns true, otherwise it returns false. Type boolean openChannel(name, authToken, callbacks, namespace) → {Promise| Promise.<{code: ChannelErrorCode, message: string}>} Opens a custom data channel on the connection if it was created on the Amazon DCV Server. Parameters: Name name Methods Type string Description The name of the channel. 75 Amazon DCV Name authToken callbacks namespace Type string Object string Web Client SDK Developer Guide Description The authentication token to use to connect to the channel. The onMessage and onClose callbacks functions to call. The namespace of the channel. Available since Amazon DCV Web Client SDK 1.2.0 and Amazon DCV Server 2022.1. Returns: Promise. If rejected we receive an error object. Type Promise | Promise.<{code: ChannelErrorCode, message: string}> queryFeature(featureName) → {Promise.<{enabled: boolean, remote?: string, autoCopy?: boolean, autoPaste?: boolean, serviceStatus?: string, available?: boolean}>|Promise.<{message: string}>} Queries the status of a specific Amazon DCV server feature. Parameters: Name featureName Type feature Description The name of the feature to query. Methods 76 Amazon DCV Returns: Web Client SDK Developer Guide Promise. If resolved, the function returns a status object that always containes an enabled property, and possibly also other properties. If rejected, the function returns an error object. Type {Promise.<{enabled: boolean, remote?: string, autoCopy?: boolean, autoPaste?: boolean, serviceStatus?: string, available?: boolean}> | |
websdkguide-014 | websdkguide.pdf | 14 | an error object. Type Promise | Promise.<{code: ChannelErrorCode, message: string}> queryFeature(featureName) → {Promise.<{enabled: boolean, remote?: string, autoCopy?: boolean, autoPaste?: boolean, serviceStatus?: string, available?: boolean}>|Promise.<{message: string}>} Queries the status of a specific Amazon DCV server feature. Parameters: Name featureName Type feature Description The name of the feature to query. Methods 76 Amazon DCV Returns: Web Client SDK Developer Guide Promise. If resolved, the function returns a status object that always containes an enabled property, and possibly also other properties. If rejected, the function returns an error object. Type {Promise.<{enabled: boolean, remote?: string, autoCopy?: boolean, autoPaste?: boolean, serviceStatus?: string, available?: boolean}> | Promise.<{message: string}> registerKeyboardShortcuts(shortcuts) → {void} Registers keyboard shortcuts. Parameters: Name Type Description shortcuts Array.<Object> The array of keys and mappings to register. Name Type Descripti on sequenceArray.<Ob ject> The keyboard shortcut to register. NameTypeDescripti on The keyKeyboardE vent.key value of the key 77 Methods Amazon DCV Name Type Description Web Client SDK Developer Guide Name Type Descripti on NameTypeDescripti on pressed by the user. For more informati on, see https:// d eveloper. mozilla.o rg/ en- US/ docs/ Web/ API/ Keybo ardEvent/ key. The KeyboardE location vent.loca array of tion keys to send. The 78 Methods Amazon DCV Name Type Description Web Client SDK Developer Guide Name Type Descripti on NameTypeDescripti on location of the key on the keyboard. For more informati on, see https:// d eveloper. mozilla.o rg/ en- US/ docs/ Web/ API/ Keybo ardEvent/ location. Methods action 79 output Array.<Ob ject> The intended Amazon DCV Name Methods Web Client SDK Developer Guide Type Description Name Type Descripti on to be performed by the shortcut. NameTypeDescripti on The keyKeyboardE value vent.key of the key pressed by the user. For more informati on, see https:// d eveloper. mozilla.o rg/ en- US/ docs/ Web/ API/ 80 Amazon DCV Name Type Description Web Client SDK Developer Guide Name Type Descripti on NameTypeDescripti on Keybo ardEvent/ key. The KeyboardE location array vent.loca tion of keys to send. The location of the key on the keyboard. For more informati on, see https:// d eveloper. mozilla.o rg/ en- US/ 81 Methods Amazon DCV Name Type Description Web Client SDK Developer Guide Name Type Descripti on NameTypeDescripti on docs/ Web/ API/ Keybo ardEvent/ location. Returns: Type void requestDisplayConfig(highColorAccuracy) → {Promise|Promise.<{code: DisplayConfigErrorCode, message: string}>} Requests an updated display config from the Amazon DCV Server. Available since Amazon DCV Web Client SDK 1.1.0 and Amazon DCV Server 2022.0. Parameters: Name Type Description highColorAccuracy boolean Whether or not high color accuracy should be requested. Returns: Promise. If rejected, the promise returns an error object. Methods 82 Amazon DCV Type Web Client SDK Developer Guide Promise | Promise.<{code: DisplayConfigErrorCode, message: string}> requestDisplayLayout(layout) → {Promise|Promise.<{code: ResolutionErrorCode, message: string}>} Requests an updated display layout for the connection. Parameters: Name layout Returns: Type Description Array.<Monitor> The requested displays in the layout. Promise. If rejected we receive an error object. Type Promise | Promise.<{code: ResolutionErrorCode, message: string}> requestResolution(width, height) → {Promise|Promise.<{code: ResolutionErrorCode, message: string}>} Requests an updated display resolution from the Amazon DCV server. Parameters: Name width Methods Type number Description The width to request in pixels. The minimum allowed value is 0. 83 Amazon DCV Name height Returns: Type number Web Client SDK Developer Guide Description The height to request in pixels. The minimum allowed value is 0. Promise. If rejected, the promise returns an error object. Type Promise | Promise.<{code: ResolutionErrorCode, message: string}> sendKeyboardEvent(event) → {boolean} Sends a keyboard shortcut event. For more information about keyboard events, see https:// developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent. Valid Keyboard events include: keydown, keypress, and keyup. For more information about these events, see https:// developer.mozilla.org/en-US/docs/Web/API/KeyboardEvent#events. Parameters: Name event Returns: Type Description KeyboardEvent The keyboard event to send. If the event is not valid, the function returns false. If the event is valid, the function returns true. Type boolean Methods 84 Amazon DCV Web Client SDK Developer Guide sendKeyboardShortcut(shortcut) → {void} Sends a keyboard shortcut. Use this function to send a full keydown or keyup sequence. For example, sending Ctrl + Alt + Del sends the keydown events for all the keys followed by the keyup events. Use this function even if you want to send a single key. Parameters: Name shortcut Type Description Array.<Object> The array of keys to send. Name Type Descripti on key KeyboardE vent.key The value of the key pressed by the user. For more informati on, see https:// d eveloper. mozilla.o rg/en- US/ docs/ Web/ API/ Keybo 85 Methods Amazon DCV Name Type Description Web Client SDK Developer Guide Name Type Descripti on ardEvent/ key. locationKeyboardE vent.loca The array tion of keys to send. The location of the key on the keyboard. For more informati on, see https:// d eveloper. mozilla.o rg/en- US/ docs/ Web/ API/ Keybo ardEvent/ location. Methods 86 Amazon DCV Returns: Type void Web Client SDK Developer Guide setDisplayQuality(min, maxopt) → {void} Sets the |
websdkguide-015 | websdkguide.pdf | 15 | Type Descripti on key KeyboardE vent.key The value of the key pressed by the user. For more informati on, see https:// d eveloper. mozilla.o rg/en- US/ docs/ Web/ API/ Keybo 85 Methods Amazon DCV Name Type Description Web Client SDK Developer Guide Name Type Descripti on ardEvent/ key. locationKeyboardE vent.loca The array tion of keys to send. The location of the key on the keyboard. For more informati on, see https:// d eveloper. mozilla.o rg/en- US/ docs/ Web/ API/ Keybo ardEvent/ location. Methods 86 Amazon DCV Returns: Type void Web Client SDK Developer Guide setDisplayQuality(min, maxopt) → {void} Sets the image quality to use for the connection. Valid range is 0 to 100, with 1 being the lowest image quality and 100 being the highest image quality. Specify 0 to retain the current value. Type number Attributes Description number <optional> The minimum image quality. The maximum image quality. Parameters: Name min max Returns: Type void setDisplayScale(scaleRatio, displayId) → {Promise|Promise.<{code: ResolutionErrorCode, message: string}>} (DEPRECATED) Deprecated since version 1.3.0. There is no need to set the display scale anymore. Mouse coordinates will be managed automatically internally. Notifies the Amazon DCV that the display is scaled on the client side. Use this to notify the server that it needs to scale mouse events to match the client's display ratio. Methods 87 Amazon DCV Parameters: Name scaleRatio Web Client SDK Developer Guide Type float Description The scaling ratio to use. Must be a strictly positive number. displayId number The ID of the display to scale. Returns: Promise. If rejected, the promise returns an error object. Type Promise | Promise.<{code: ResolutionErrorCode, message: string}> setKeyboardQuirks(quirks) → {void} Sets keyboard quirks for the client computer. Parameters: Name quirks Type Object Methods Description The keyboard quirks to enable or disable. Name Type Descripti on macOption boolean To ToAlt map the Option key to Alt for 88 Web Client SDK Developer Guide Type Description Name Type Descripti on macOS, specify true. Otherwise , specify false. macComman boolean To dToContro l map the Command key to Ctrl for macOS, specify true. Otherwise , specify false. Amazon DCV Name Returns: Type void setMaxDisplayResolution(maxWidth, maxHeight) → {void} Sets the maximum display resolution to use for the connection. Methods 89 Amazon DCV Parameters: Name maxWidth Type number maxHeight number Returns: Type void Web Client SDK Developer Guide Description The maximum display width in pixels. The minimum allowed value is 0. The maximum display height in pixels. The minimum allowed value is 0. setMicrophone(enable) → {Promise|Promise.<{code: AudioErrorCode, message: string}>} Enables or disables the microphone. Parameters: Name enable Returns: Type boolean Description To enable the microphone, specify true. To disable the microphone, specify false. Promise. If rejected, the promise returns an error object. Type Promise | Promise.<{code: AudioErrorCode, message: string}> Methods 90 Amazon DCV Web Client SDK Developer Guide setMinDisplayResolution(minWidth, minHeight) → {void} Sets the minimum display resolution to use for the connection. Some applications might require a minimum display resolution. If the minimum required resolution is larger than the maximum resolution supported by the client, a resize strategy is used. Use this function carefully. The resize strategy could cause a less precise mouse and touch input system. Parameters: Name minWidth Type number minHeight number Returns: Type void Description The minimum display width in pixels. The minimum allowed value is 0. The minimum display height in pixels. The minimum allowed value is 0. setUploadBandwidth(value) → {number} Sets the maxmimum bandwidth to use for uploading files to the Amazon DCV server. Parameters: Name value Methods Type number Description The maximum bandwidth limit in kbps. Valid range is 1024 kbps to 102400 kbps. 91 Amazon DCV Returns: Web Client SDK Developer Guide - The set bandwidth limit. null if the file storage feature is disabled on the server. Type number setVolume(volume) → {void} Sets the volume level to use for audio. Valid range is 0 to 100, with 0 being the lowest volume and 100 being the highest volume. Parameters: Type number Description The volume level to use. Name volume Returns: Type void setMicrophone(enable, deviceId) → {Promise|Promise.<{code: AudioErrorCode, message: string}>} [Experimental - might change in the future] Enables or disables the microphone. Parameters: Name enable Type boolean Description To enable the microphone, specify true. To disable the microphone, specify false. Methods 92 Amazon DCV Name deviceId Returns: Type string Web Client SDK Developer Guide Description The device ID of the microphone. If no deviceId is provided, the default deviceId is used. Promise. If rejected, the promise returns an error object. Type Promise | Promise.<{code: AudioErrorCode, message: string}> setWebcam(enable, deviceId) → {Promise|Promise.<{code: WebcamErrorCode, message: string}>} Enables or disables the webcam. Parameters: Name enable Type boolean Description To enable the webcam, specify true. To disable the webcam, specify false. deviceId string The device ID of the webcam. Returns: Promise that, if successful, resolves to the attached/detached webcam deviceId. If |
websdkguide-016 | websdkguide.pdf | 16 | microphone, specify false. Methods 92 Amazon DCV Name deviceId Returns: Type string Web Client SDK Developer Guide Description The device ID of the microphone. If no deviceId is provided, the default deviceId is used. Promise. If rejected, the promise returns an error object. Type Promise | Promise.<{code: AudioErrorCode, message: string}> setWebcam(enable, deviceId) → {Promise|Promise.<{code: WebcamErrorCode, message: string}>} Enables or disables the webcam. Parameters: Name enable Type boolean Description To enable the webcam, specify true. To disable the webcam, specify false. deviceId string The device ID of the webcam. Returns: Promise that, if successful, resolves to the attached/detached webcam deviceId. If rejected, the promise returns an error object. Type Promise.<string> | Promise.<{code: WebcamErrorCode, message: string}> Methods 93 Amazon DCV Web Client SDK Developer Guide syncClipboards() → {boolean} Synchronizes the local client clipboard with the remote Amazon DCV server clipboard. Autocopy must be supported by the browser. Returns: If the clipboards have been synchronized, the function returns true. If the clipboards have not been sycnhronized, or if the browser does not support autocopy, the function returns false. Type boolean Authentication Class The Authentication Class must be used to obtain an authentication token by calling the authenticate method of the dcv module. For an example showing how to use it, see the Getting started section. Exposes • Methods Methods List • retry() → {void} • sendCredentials(credentials) → {void} retry() → {void} Retries the authentication process. Returns: Type void Authentication Class 94 Amazon DCV Web Client SDK Developer Guide sendCredentials(credentials) → {void} Sends the authentication credentials provided by the client to the Amazon DCV server. Parameters: Name credentials Type Object Returns: Type void Resource Class Description The object containing the supplied credentials. The credentials must have the same name and be of the same type that is specified in the challenge. The Resource Class can fetch or discard the corresponding file that was just printed or downloaded. When performing these actions, the corresponding observer functions filePrinted and fileDownload would respectively be invoked with the resource object as their only argument. Such resource can be accepted or declined in order to fetch or discard the file they reference. Exposes • Methods Methods List • accept(urlParameters) → {void} • decline() → {void} Resource Class 95 Amazon DCV Web Client SDK Developer Guide Description The optional object containin g the key/value pairs of the URL search parameters passed to the request to fetch the resource. accept(urlParameters) → {void} Locally downloads the resource. Parameters: Name urlParameters Type Object Returns: Type void decline() → {void} Discards the resource. Returns: Type void Amazon DCV Web UI SDK A JavaScript React component library, currently exporting a single React component called DCVViewer which connects to the Amazon DCV Server and renders the toolbar to interact with the remote stream. Exposes Amazon DCV Web UI SDK 96 Web Client SDK Developer Guide Amazon DCV • Components Components List • DCVViewer DCVViewer The React component rendering the toolbar with all of its functionalities useful to interact with the remote stream. Properties: List • dcv • uiConfig dcv Name dcv Type Object Required Description Yes The object defining the properties necessary to establish the connection to the Amazon DCV Server, setting the log level and the URL from where to load the Amazon DCV Web Client SDK assets and access the DCV resources. Components 97 Amazon DCV Name Type Required Description Web Client SDK Developer Guide NameType RequiredDescripti on sessionId StringYes The Amazon DCV session ID. authToken StringYes The authentic ation token to use when connectin g to the server. serverUrl StringYes The host name and port of the running Amazon DCV server in the 98 Components Amazon DCV Name Type Required Description Web Client SDK Developer Guide NameType RequiredDescripti on following format: https:// d cv_host_a ddress:po rt. For example: https:// m y- dcv- ser ver:8443. baseUrlStringYes The absolute or relative URL from which to load SDK files. Components URL 99 resourceB StringNo aseUrl The (default: absolute or relative "") Amazon DCV Name Type Required Description Web Client SDK Developer Guide NameType RequiredDescripti on from which to access DCV resources . onDisconn functionNo The callback (default: ect () => {}) function invoked when disconnec ting from the Amazon DCV server, and the connectio n is closed. logLevelLogLevelNo The log (default: level LogLevel. to INFO ) use in 100 Components Amazon DCV Name Type Required Description Web Client SDK Developer Guide NameType RequiredDescripti on the viewer. Required Description No (default: {}) The object defining the properties to configure whether the toolbar is visible and whether to display the fullscree n and multimonitor buttons on it. NameType RequiredDescripti on toolbarObjectNo The Object (default: {}) defining the configura tion options for the toolbar. 101 uiConfig Name uiConfig Type Object Components Amazon DCV Name Type Required Description Web Client SDK Developer Guide NameType RequiredDescripti on Name Descripti TypeRequired on |
websdkguide-017 | websdkguide.pdf | 17 | closed. logLevelLogLevelNo The log (default: level LogLevel. to INFO ) use in 100 Components Amazon DCV Name Type Required Description Web Client SDK Developer Guide NameType RequiredDescripti on the viewer. Required Description No (default: {}) The object defining the properties to configure whether the toolbar is visible and whether to display the fullscree n and multimonitor buttons on it. NameType RequiredDescripti on toolbarObjectNo The Object (default: {}) defining the configura tion options for the toolbar. 101 uiConfig Name uiConfig Type Object Components Amazon DCV Name Type Required Description Web Client SDK Developer Guide NameType RequiredDescripti on Name Descripti TypeRequired on The No Boolean visible option (default: to true) define whether to show or hide the toolbar. The Boolean No fullscree option (default: nButton to true) define whether to show or hide the fullscree n button on the toolbar. 102 Components Amazon DCV Name Type Required Description Web Client SDK Developer Guide NameType RequiredDescripti on Name Descripti TypeRequired on The Boolean No multimoni option (default: torButton to true) define whether to show or hide the multimoni tor button on the toolbar. Components 103 Amazon DCV Web Client SDK Developer Guide Release Notes and Document History for Amazon DCV Web Client SDK This page provides the release notes and document history for Amazon DCV Web Client SDK. Topics • Amazon DCV Web Client SDK Release Notes • Document History Amazon DCV Web Client SDK Release Notes This section provides release notes for the Amazon DCV Web Client SDK by release date. Topics • 1.8.7 — October 31, 2024 • 1.8.4 — October 1, 2024 • 1.5.10 — December 19, 2023 • 1.5.6 — November 9, 2023 • 1.4.4 — June 29, 2023 • 1.4.0 — March 28, 2023 • 1.3.1 — December 9, 2022 • 1.3.0 — November 11, 2022 • 1.2.1 — July 21, 2022 • 1.2.0 — June 29, 2022 • 1.1.3 — May 23, 2022 • 1.1.2 — May 19, 2022 • 1.1.1 — March 23, 2022 • 1.1.0 — February 23, 2022 • 1.0.4 — December 20, 2021 • 1.0.3 — September 01, 2021 • 1.0.2 — July 30, 2021 Release Notes 104 Amazon DCV • 1.0.1 — May 31, 2021 • 1.0.0 — March 24, 2021 1.8.7 — October 31, 2024 Build numbers Changes and bug fixes Fixed rendering on Firefox 130 and newer • • • Semantic version: 1.8.7 Build: 858 1.8.4 — October 1, 2024 Build numbers New features • • Semantic version: 1.8.4 Build: 840 The following features were added: Renamed to “Amazon DCV Web Client SDK” Added new API enableHighPixelDensity for high dpi displays Added an experimental API setMicrophone to select the microphone in compatible browsers Added new Connection Errors GATEWAY_B USY, UNSUPPORTED_CREDENTIAL, and TRANSPORT_ERROR • • • • • Web Client SDK Developer Guide Changes and bug fixes Improved Webcam handling Improved audio playback handling Improved WebCodecs handling Improved plug and unplug of microphone and webcam Improved remote window dragging when multimonitor • • • • • • 1.8.7 — October 31, 2024 105 Amazon DCV Build numbers New features Changes and bug fixes Web Client SDK Developer Guide Added new Closing Reasons EXTERNAL_ File storage upload and PROTOCOL_CONNECTION_EVICTED, and DISCONNECTION_REQUESTED download permissions are now correctly propagated • Minor fixes on rendering 1.5.10 — December 19, 2023 Version Release notes • • Semantic version: 1.5.10 Build: 684 Changes and bug fixes • Fix stream decoding errors 1.5.6 — November 9, 2023 Version Release notes • • Semantic version: 1.5.6 Build: 659 Changes and bug fixes • • Performance improvements in the stream decoding and rendering Removed support for Internet Explorer 11 1.4.4 — June 29, 2023 Version Release notes 1.5.10 — December 19, 2023 106 Amazon DCV Version • • Semantic version: 1.4.4 Build: 573 Web Client SDK Developer Guide Release notes Changes and bug fixes • • • • • • • • The viewer UI compoenent now uses the navigator.keyboard.lock browsers that support it to handle special API on keys in full screen. Fixed a problem which could cause wrong colors when using Chrome 114 or newer. Improved WebCodecs detection. Fixed a problem with the mouse button state when entering the window. Fixed a problem which could cause the modifier keys to remain pressed on macOS. Improved audio robustness to degraded network conditions. Fixed memory leaks. Improved logs to include time and level. 1.4.0 — March 28, 2023 Version • • Semantic version: 1.4.0 Build: 476 Release notes New features • 1.4.0 — March 28, 2023 107 Amazon DCV Version Web Client SDK Developer Guide Release notes Added a new uploadFiles method to the FileStorage object to upload multiple files. • • The viewer UI component now supports drag and drop to initiate file upload. The WebCodecs browser API is now used also for audio and webcam. Changes and bug |
websdkguide-018 | websdkguide.pdf | 18 | keys to remain pressed on macOS. Improved audio robustness to degraded network conditions. Fixed memory leaks. Improved logs to include time and level. 1.4.0 — March 28, 2023 Version • • Semantic version: 1.4.0 Build: 476 Release notes New features • 1.4.0 — March 28, 2023 107 Amazon DCV Version Web Client SDK Developer Guide Release notes Added a new uploadFiles method to the FileStorage object to upload multiple files. • • The viewer UI component now supports drag and drop to initiate file upload. The WebCodecs browser API is now used also for audio and webcam. Changes and bug fixes • • • • • • Fixed memory leaks related to repeated connections from the same page. setUploadBandwidth values up to 1 Gbps. now allows Optimized rendering of UI components. Fixed support for animated cursors on Windows. Fixed a problem with clipboard support when both text and image data are present for the same operation. Improved robustness of the Webcam API: settings cannot be changed while a request is already in progress, webcam.se tEnabled now keeps track of device ID for the request is in progress and returns a 1.4.0 — March 28, 2023 108 Amazon DCV Version Web Client SDK Developer Guide Release notes Promise. The viewer UI component shows notification in case of error. 1.3.1 — December 9, 2022 Version Release notes • • Semantic version: 1.3.1 Build: 413 1.3.0 — November 11, 2022 Version • • Semantic version: 1.3.0 Build: 407 Changes and bug fixes • • • • Fixed a problem which could cause the Time Zone redirection UI to go out of synchroni zation with the server. Fixed a memory leak after multiple reconnections. Fixed a problem which caused a blank page on disconnetion. Fixed a bug causing console warnings on audio decoder close. Release notes New features • • Adopted Cloudscape (https://cloudscap e.design) for the UI Viewer component. Added support for Time Zone redirection. 1.3.1 — December 9, 2022 109 Amazon DCV Version Web Client SDK Developer Guide Release notes Changes and bug fixes • • • Fixed missing update on asynchronous clipboard when the DCV viewer is focused. The setDisplayScale function is not needed anymore when scaling the display on client side. The DCVViewer component now automatically calls disconnect() when it is unmounted. 1.2.1 — July 21, 2022 Version Release notes • • Semantic version: 1.2.1 Build: 358 1.2.0 — June 29, 2022 Changes and bug fixes • Fixed a problem that resulted in a failure to connect to Amazon DCV server 2019.1 and older. Version Release notes Semantic version: 1.2.0 • • Build: 352 1.2.1 — July 21, 2022 Changes and bug fixes • 110 Amazon DCV Version Web Client SDK Developer Guide Release notes Fixed crashing bug when the frames received are larger than the maximum supported resolution (4096x2160). • • Resource objects (passed as arguments to fileDownload and filePrinted observers) now have the accept and decline methods that can be called on the object to download and discard the resource respectively. Minor bug fix on automatic clipboard synchronization when disconnecting. 1.1.3 — May 23, 2022 Version Release notes • • Semantic version: 1.1.3 Build: 329 1.1.2 — May 19, 2022 Changes and bug fixes • Fixed a problem preventing successful connection when specifying the web-url-p ath option. Version Release notes Semantic version: 1.1.2 • • Changes and bug fixes • 1.1.3 — May 23, 2022 111 Amazon DCV Version Build: 322 Web Client SDK Developer Guide Release notes Fixed a problem that could cause input to not work correctly after connection. • Fixed mouse coordinates when scale ratio is greater than 1. 1.1.1 — March 23, 2022 Version Release notes • • Semantic version: 1.1.1 Build: 309 1.1.0 — February 23, 2022 Version • • Semantic version: 1.1.0 Build: 295 Changes and bug fixes • • Report Transport Error when communication with the server times out. Fixed a recurring decoding error when streaming large resolutions. Release notes New features • • • Release Amazon DCV Web UI SDK library with DCVViewer React component. Export Amazon DCV Web Client SDK both as UMD and ES modules. Added high color accuracy support. 1.1.1 — March 23, 2022 112 Amazon DCV Version 1.0.4 — December 20, 2021 Version • • Semantic version: 1.0.4 Build: 249 Web Client SDK Developer Guide Release notes • Added the ability to list and interact with clients connected to a session. Added notifications for connection and disconnec tion. Changes and bug fixes • • • Improved webcodecs decoding support. Various keyboard improvements. Fix a bug that was preventing to open a second screen when the clipboard was disabled. Release notes New features • • Support opening multiple connections from the same page. Support loading the SDK from a CDN. 1.0.3 — September 01, 2021 Version Release notes |
websdkguide-019 | websdkguide.pdf | 19 | 1.0.4 — December 20, 2021 Version • • Semantic version: 1.0.4 Build: 249 Web Client SDK Developer Guide Release notes • Added the ability to list and interact with clients connected to a session. Added notifications for connection and disconnec tion. Changes and bug fixes • • • Improved webcodecs decoding support. Various keyboard improvements. Fix a bug that was preventing to open a second screen when the clipboard was disabled. Release notes New features • • Support opening multiple connections from the same page. Support loading the SDK from a CDN. 1.0.3 — September 01, 2021 Version Release notes 1.0.4 — December 20, 2021 113 Amazon DCV Version • • Semantic version: 1.0.3 Build: 202 Web Client SDK Developer Guide Release notes New features • • • Experimental support for WebCodecs. This is disabled by default and must be enabled via the ConnectionConfig object using the new property enableWebCodecs . Clipboard: added support for image/png data type on Chromium based browsers. Added observer/callback to get the server’s screenshot as a PNG image (requires Amazon DCV server 2021.2). Changes and bug fixes • Improved handling of keyboard modifiers. 1.0.2 — July 30, 2021 Version Release notes • • Semantic version: 1.0.2 Build: 167 1.0.1 — May 31, 2021 • • Fixed pressure detection for stylus events. Improved support for Korean keyboard layout on Chrome. Version Release notes 1.0.2 — July 30, 2021 114 Amazon DCV Version • • Semantic version: 1.0.1 Build: 141 Web Client SDK Developer Guide Release notes • • • • Fixed propagation of connection errors and close reasons Fixed filestorage chunk progress update Improved webcam handling Improved audio-in processing 1.0.0 — March 24, 2021 Version Release notes Initial release of the Amazon DCV Web Client SDK. • • Semantic version: 1.0.0 Build: 81 Document History The following table describes the documentation for this release of Amazon DCV Web Client SDK. Change Description Date Amazon DCV Web Client SDK version 1.8.4 Amazon DCV Web Client SDK 1.8.4 is now available. For more information, see SDK v.1.8.4. October 1, 2024 Amazon DCV Web Client SDK version 1.5.6 Amazon DCV Web Client SDK 1.5.6 is now available. For November 9, 2023 1.0.0 — March 24, 2021 115 Amazon DCV Change Web Client SDK Developer Guide Description Date more information, see SDK v.1.5.6. Amazon DCV Web Client SDK version 1.4.4 Amazon DCV Web Client SDK 1.4.4 is now available. For June 29, 2023 more information, see SDK v.1.4.4. Amazon DCV Web Client SDK version 1.4.0 Amazon DCV Web Client SDK 1.4.0 is now available. For March 28, 2023 more information, see SDK v.1.4.0. Amazon DCV Web Client SDK version 1.3.1 Amazon DCV Web Client SDK 1.3.1 is now available. For December 9, 2022 more information, see SDK v.1.3.1. Amazon DCV Web Client SDK version 1.3.0 Amazon DCV Web Client SDK 1.3.0 is now available. For November 11, 2022 more information, see SDK v.1.3.0. Amazon DCV Web Client SDK version 1.2.0 Amazon DCV Web Client SDK 1.2.0 is now available. For June 29, 2022 Amazon DCV Web Client SDK version 1.1.0 more information, see SDK v.1.2.0. Amazon DCV Web Client SDK 1.1.0 is now available. For more information, see SDK v.1.1.0. February 23, 2022 Amazon DCV Web Client SDK version 1.0.1 Fixed some typos. Minor bugs fixed, see SDK v.1.0.1. May 31, 2021 Document History 116 Amazon DCV Change Initial release Web Client SDK Developer Guide Description Date First publication of this content. March 24, 2021 Document History 117 |
wellarchitected-api-001 | wellarchitected-api.pdf | 1 | API Reference AWS Well-Architected Tool API Version 2020-03-31 Copyright © 2025 Amazon Web Services, Inc. and/or its affiliates. All rights reserved. AWS Well-Architected Tool API Reference AWS Well-Architected Tool: API Reference Copyright © 2025 Amazon Web Services, Inc. and/or its affiliates. All rights reserved. Amazon's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who may or may not be affiliated with, connected to, or sponsored by Amazon. AWS Well-Architected Tool Table of Contents API Reference Welcome ........................................................................................................................................... 1 Actions .............................................................................................................................................. 2 AssociateLenses ............................................................................................................................................. 5 Request Syntax ........................................................................................................................................ 5 URI Request Parameters ........................................................................................................................ 5 Request Body ........................................................................................................................................... 6 Response Syntax ...................................................................................................................................... 6 Response Elements ................................................................................................................................. 6 Errors .......................................................................................................................................................... 6 See Also ..................................................................................................................................................... 7 AssociateProfiles ........................................................................................................................................... 8 Request Syntax ........................................................................................................................................ 8 URI Request Parameters ........................................................................................................................ 8 Request Body ........................................................................................................................................... 8 Response Syntax ...................................................................................................................................... 9 Response Elements ................................................................................................................................. 9 Errors .......................................................................................................................................................... 9 See Also .................................................................................................................................................. 10 CreateLensShare ......................................................................................................................................... 11 Request Syntax ...................................................................................................................................... 11 URI Request Parameters ...................................................................................................................... 11 Request Body ......................................................................................................................................... 12 Response Syntax ................................................................................................................................... 13 Response Elements ............................................................................................................................... 13 Errors ....................................................................................................................................................... 13 See Also .................................................................................................................................................. 14 CreateLensVersion ...................................................................................................................................... 16 Request Syntax ...................................................................................................................................... 16 URI Request Parameters ...................................................................................................................... 16 Request Body ......................................................................................................................................... 17 Response Syntax ................................................................................................................................... 18 Response Elements ............................................................................................................................... 18 Errors ....................................................................................................................................................... 18 See Also .................................................................................................................................................. 19 API Version 2020-03-31 iii AWS Well-Architected Tool API Reference CreateMilestone .......................................................................................................................................... 21 Request Syntax ...................................................................................................................................... 21 URI Request Parameters ...................................................................................................................... 21 Request Body ......................................................................................................................................... 21 Response Syntax ................................................................................................................................... 22 Response Elements ............................................................................................................................... 22 Errors ....................................................................................................................................................... 23 See Also .................................................................................................................................................. 24 CreateProfile ................................................................................................................................................ 25 Request Syntax ...................................................................................................................................... 25 URI Request Parameters ...................................................................................................................... 25 Request Body ......................................................................................................................................... 25 Response Syntax ................................................................................................................................... 27 Response Elements ............................................................................................................................... 27 Errors ....................................................................................................................................................... 28 See Also .................................................................................................................................................. 28 CreateProfileShare ...................................................................................................................................... 30 Request Syntax ...................................................................................................................................... 30 URI Request Parameters ...................................................................................................................... 30 Request Body ......................................................................................................................................... 30 Response Syntax ................................................................................................................................... 31 Response Elements ............................................................................................................................... 31 Errors ....................................................................................................................................................... 32 See Also .................................................................................................................................................. 33 CreateReviewTemplate .............................................................................................................................. 34 Request Syntax ...................................................................................................................................... 34 URI Request Parameters ...................................................................................................................... 34 Request Body ......................................................................................................................................... 34 Response Syntax ................................................................................................................................... 36 Response Elements ............................................................................................................................... 37 Errors ....................................................................................................................................................... 37 See Also .................................................................................................................................................. 38 CreateTemplateShare ................................................................................................................................ 39 Request Syntax ...................................................................................................................................... 39 URI Request Parameters ...................................................................................................................... 39 Request Body ......................................................................................................................................... 40 API Version 2020-03-31 iv AWS Well-Architected Tool API Reference Response Syntax ................................................................................................................................... 41 Response Elements ............................................................................................................................... 41 Errors ....................................................................................................................................................... 41 See Also .................................................................................................................................................. 42 CreateWorkload .......................................................................................................................................... 44 Request Syntax ...................................................................................................................................... 44 URI Request Parameters ...................................................................................................................... 45 Request Body ......................................................................................................................................... 45 Response Syntax ................................................................................................................................... 52 Response Elements ............................................................................................................................... 52 Errors ....................................................................................................................................................... 52 See Also .................................................................................................................................................. 53 CreateWorkloadShare ................................................................................................................................ 55 Request Syntax ...................................................................................................................................... 55 URI Request Parameters ...................................................................................................................... 55 Request Body ......................................................................................................................................... 55 Response Syntax ................................................................................................................................... 57 Response Elements ............................................................................................................................... 57 Errors ....................................................................................................................................................... 57 See Also .................................................................................................................................................. 58 DeleteLens ................................................................................................................................................... 60 Request Syntax ...................................................................................................................................... 60 URI Request Parameters ...................................................................................................................... 60 Request Body ......................................................................................................................................... 61 Response Syntax ................................................................................................................................... 62 Response Elements ............................................................................................................................... 62 Errors ....................................................................................................................................................... 62 See Also .................................................................................................................................................. 63 DeleteLensShare ......................................................................................................................................... 64 Request Syntax ...................................................................................................................................... 64 URI Request Parameters ...................................................................................................................... 64 Request Body ......................................................................................................................................... 65 Response Syntax ................................................................................................................................... 65 Response Elements ............................................................................................................................... 65 Errors ....................................................................................................................................................... 66 See Also .................................................................................................................................................. 66 API Version 2020-03-31 v AWS Well-Architected Tool API Reference DeleteProfile ................................................................................................................................................ 68 Request Syntax ...................................................................................................................................... 68 URI Request Parameters ...................................................................................................................... 68 Request Body ......................................................................................................................................... 69 Response Syntax ................................................................................................................................... 69 Response Elements ............................................................................................................................... 69 Errors ....................................................................................................................................................... 69 See Also .................................................................................................................................................. 70 DeleteProfileShare ..................................................................................................................................... 71 Request Syntax ...................................................................................................................................... 71 URI Request Parameters ...................................................................................................................... 71 Request Body ......................................................................................................................................... 72 Response Syntax ................................................................................................................................... 72 Response Elements ............................................................................................................................... 72 Errors ....................................................................................................................................................... 72 See Also .................................................................................................................................................. 73 DeleteReviewTemplate .............................................................................................................................. 74 Request Syntax ...................................................................................................................................... 74 URI Request Parameters ...................................................................................................................... 74 Request Body ......................................................................................................................................... 75 Response Syntax ................................................................................................................................... 75 Response Elements ............................................................................................................................... 75 Errors ....................................................................................................................................................... 75 See Also .................................................................................................................................................. 76 DeleteTemplateShare ................................................................................................................................ 77 Request Syntax ...................................................................................................................................... 77 URI Request Parameters ...................................................................................................................... 77 Request Body ......................................................................................................................................... 78 Response Syntax ................................................................................................................................... 78 Response Elements ............................................................................................................................... 78 Errors ....................................................................................................................................................... 78 See Also .................................................................................................................................................. 79 DeleteWorkload .......................................................................................................................................... 81 Request Syntax ...................................................................................................................................... 81 URI Request Parameters ...................................................................................................................... 81 Request Body ......................................................................................................................................... 82 API Version 2020-03-31 vi AWS Well-Architected Tool API Reference Response Syntax ................................................................................................................................... 82 Response Elements ............................................................................................................................... 82 Errors ....................................................................................................................................................... 82 See Also .................................................................................................................................................. 83 DeleteWorkloadShare ................................................................................................................................ 84 Request Syntax ...................................................................................................................................... 84 URI Request Parameters ...................................................................................................................... 84 Request Body ......................................................................................................................................... 85 Response Syntax ................................................................................................................................... 85 Response Elements ............................................................................................................................... 85 Errors ....................................................................................................................................................... 85 See Also .................................................................................................................................................. 86 DisassociateLenses ..................................................................................................................................... 87 Request Syntax ...................................................................................................................................... 87 URI Request Parameters ...................................................................................................................... 87 Request Body ......................................................................................................................................... 87 Response Syntax ................................................................................................................................... 88 Response Elements ............................................................................................................................... 88 Errors ....................................................................................................................................................... 88 See Also .................................................................................................................................................. 89 DisassociateProfiles .................................................................................................................................... 90 Request Syntax ...................................................................................................................................... 90 URI Request Parameters ...................................................................................................................... 90 Request Body ......................................................................................................................................... 90 Response Syntax |
wellarchitected-api-002 | wellarchitected-api.pdf | 2 | AWS Well-Architected Tool API Reference Response Syntax ................................................................................................................................... 82 Response Elements ............................................................................................................................... 82 Errors ....................................................................................................................................................... 82 See Also .................................................................................................................................................. 83 DeleteWorkloadShare ................................................................................................................................ 84 Request Syntax ...................................................................................................................................... 84 URI Request Parameters ...................................................................................................................... 84 Request Body ......................................................................................................................................... 85 Response Syntax ................................................................................................................................... 85 Response Elements ............................................................................................................................... 85 Errors ....................................................................................................................................................... 85 See Also .................................................................................................................................................. 86 DisassociateLenses ..................................................................................................................................... 87 Request Syntax ...................................................................................................................................... 87 URI Request Parameters ...................................................................................................................... 87 Request Body ......................................................................................................................................... 87 Response Syntax ................................................................................................................................... 88 Response Elements ............................................................................................................................... 88 Errors ....................................................................................................................................................... 88 See Also .................................................................................................................................................. 89 DisassociateProfiles .................................................................................................................................... 90 Request Syntax ...................................................................................................................................... 90 URI Request Parameters ...................................................................................................................... 90 Request Body ......................................................................................................................................... 90 Response Syntax ................................................................................................................................... 91 Response Elements ............................................................................................................................... 91 Errors ....................................................................................................................................................... 91 See Also .................................................................................................................................................. 92 ExportLens ................................................................................................................................................... 93 Request Syntax ...................................................................................................................................... 93 URI Request Parameters ...................................................................................................................... 93 Request Body ......................................................................................................................................... 94 Response Syntax ................................................................................................................................... 94 Response Elements ............................................................................................................................... 94 Errors ....................................................................................................................................................... 94 See Also .................................................................................................................................................. 95 API Version 2020-03-31 vii AWS Well-Architected Tool API Reference GetAnswer .................................................................................................................................................... 97 Request Syntax ...................................................................................................................................... 97 URI Request Parameters ...................................................................................................................... 97 Request Body ......................................................................................................................................... 98 Response Syntax ................................................................................................................................... 98 Response Elements ............................................................................................................................... 99 Errors ..................................................................................................................................................... 101 See Also ................................................................................................................................................ 101 GetConsolidatedReport ........................................................................................................................... 103 Request Syntax .................................................................................................................................... 103 URI Request Parameters ................................................................................................................... 103 Request Body ....................................................................................................................................... 103 Response Syntax ................................................................................................................................. 104 Response Elements ............................................................................................................................ 105 Errors ..................................................................................................................................................... 105 See Also ................................................................................................................................................ 106 GetGlobalSettings .................................................................................................................................... 108 Request Syntax .................................................................................................................................... 108 URI Request Parameters ................................................................................................................... 108 Request Body ....................................................................................................................................... 108 Response Syntax ................................................................................................................................. 108 Response Elements ............................................................................................................................ 108 Errors ..................................................................................................................................................... 109 See Also ................................................................................................................................................ 110 GetLens ...................................................................................................................................................... 111 Request Syntax .................................................................................................................................... 111 URI Request Parameters ................................................................................................................... 111 Request Body ....................................................................................................................................... 111 Response Syntax ................................................................................................................................. 111 Response Elements ............................................................................................................................ 112 Errors ..................................................................................................................................................... 112 See Also ................................................................................................................................................ 113 GetLensReview .......................................................................................................................................... 114 Request Syntax .................................................................................................................................... 114 URI Request Parameters ................................................................................................................... 114 Request Body ....................................................................................................................................... 115 API Version 2020-03-31 viii AWS Well-Architected Tool API Reference Response Syntax ................................................................................................................................. 115 Response Elements ............................................................................................................................ 116 Errors ..................................................................................................................................................... 117 See Also ................................................................................................................................................ 117 GetLensReviewReport ............................................................................................................................. 119 Request Syntax .................................................................................................................................... 119 URI Request Parameters ................................................................................................................... 119 Request Body ....................................................................................................................................... 120 Response Syntax ................................................................................................................................. 120 Response Elements ............................................................................................................................ 120 Errors ..................................................................................................................................................... 121 See Also ................................................................................................................................................ 122 GetLensVersionDifference ...................................................................................................................... 123 Request Syntax .................................................................................................................................... 123 URI Request Parameters ................................................................................................................... 123 Request Body ....................................................................................................................................... 124 Response Syntax ................................................................................................................................. 124 Response Elements ............................................................................................................................ 124 Errors ..................................................................................................................................................... 126 See Also ................................................................................................................................................ 126 GetMilestone ............................................................................................................................................. 128 Request Syntax .................................................................................................................................... 128 URI Request Parameters ................................................................................................................... 128 Request Body ....................................................................................................................................... 128 Response Syntax ................................................................................................................................. 128 Response Elements ............................................................................................................................ 130 Errors ..................................................................................................................................................... 130 See Also ................................................................................................................................................ 131 GetProfile ................................................................................................................................................... 132 Request Syntax .................................................................................................................................... 132 URI Request Parameters ................................................................................................................... 132 Request Body ....................................................................................................................................... 132 Response Syntax ................................................................................................................................. 132 Response Elements ............................................................................................................................ 133 Errors ..................................................................................................................................................... 134 See Also ................................................................................................................................................ 134 API Version 2020-03-31 ix AWS Well-Architected Tool API Reference GetProfileTemplate .................................................................................................................................. 136 Request Syntax .................................................................................................................................... 136 URI Request Parameters ................................................................................................................... 136 Request Body ....................................................................................................................................... 136 Response Syntax ................................................................................................................................. 136 Response Elements ............................................................................................................................ 137 Errors ..................................................................................................................................................... 137 See Also ................................................................................................................................................ 138 GetReviewTemplate ................................................................................................................................. 139 Request Syntax .................................................................................................................................... 139 URI Request Parameters ................................................................................................................... 139 Request Body ....................................................................................................................................... 139 Response Syntax ................................................................................................................................. 139 Response Elements ............................................................................................................................ 140 Errors ..................................................................................................................................................... 140 See Also ................................................................................................................................................ 141 GetReviewTemplateAnswer .................................................................................................................... 142 Request Syntax .................................................................................................................................... 142 URI Request Parameters ................................................................................................................... 142 Request Body ....................................................................................................................................... 143 Response Syntax ................................................................................................................................. 143 Response Elements ............................................................................................................................ 144 Errors ..................................................................................................................................................... 145 See Also ................................................................................................................................................ 146 GetReviewTemplateLensReview ............................................................................................................ 147 Request Syntax .................................................................................................................................... 147 URI Request Parameters ................................................................................................................... 147 Request Body ....................................................................................................................................... 147 Response Syntax ................................................................................................................................. 148 Response Elements ............................................................................................................................ 148 Errors ..................................................................................................................................................... 149 See Also ................................................................................................................................................ 150 GetWorkload ............................................................................................................................................. 151 Request Syntax .................................................................................................................................... 151 URI Request Parameters ................................................................................................................... 151 Request Body ....................................................................................................................................... 151 API Version 2020-03-31 x AWS Well-Architected Tool API Reference Response Syntax ................................................................................................................................. 151 Response Elements ............................................................................................................................ 153 Errors ..................................................................................................................................................... 153 See Also ................................................................................................................................................ 154 ImportLens ................................................................................................................................................ 155 Request Syntax .................................................................................................................................... 155 URI Request Parameters ................................................................................................................... 156 Request Body ....................................................................................................................................... 156 Response Syntax ................................................................................................................................. 157 Response Elements ............................................................................................................................ 158 Errors ..................................................................................................................................................... 158 See Also ................................................................................................................................................ 159 ListAnswers ................................................................................................................................................ 160 Request Syntax .................................................................................................................................... 160 URI Request Parameters ................................................................................................................... 160 Request Body ....................................................................................................................................... 161 Response Syntax ................................................................................................................................. 161 Response Elements ............................................................................................................................ 163 Errors ..................................................................................................................................................... 164 See Also ................................................................................................................................................ 165 ListCheckDetails ........................................................................................................................................ 166 Request Syntax .................................................................................................................................... 166 URI Request Parameters ................................................................................................................... 166 Request Body ....................................................................................................................................... 166 Response Syntax ................................................................................................................................. 168 Response Elements ............................................................................................................................ 168 Errors ..................................................................................................................................................... 169 See Also ................................................................................................................................................ 169 ListCheckSummaries ................................................................................................................................ 171 Request Syntax .................................................................................................................................... 171 URI Request Parameters ................................................................................................................... 171 Request Body ....................................................................................................................................... 171 Response Syntax ................................................................................................................................. 173 Response Elements ............................................................................................................................ 173 Errors ..................................................................................................................................................... 174 See Also ................................................................................................................................................ 174 API Version 2020-03-31 xi AWS Well-Architected Tool API Reference ListLenses ................................................................................................................................................... 176 Request Syntax .................................................................................................................................... 176 URI Request Parameters ................................................................................................................... 176 Request Body ....................................................................................................................................... 176 Response Syntax ................................................................................................................................. 177 Response Elements ............................................................................................................................ 177 Errors ..................................................................................................................................................... 178 See Also ................................................................................................................................................ 178 ListLensReviewImprovements ............................................................................................................... 180 Request Syntax .................................................................................................................................... 180 URI Request Parameters ................................................................................................................... 180 Request Body ....................................................................................................................................... 181 Response Syntax ................................................................................................................................. 181 Response Elements |
wellarchitected-api-003 | wellarchitected-api.pdf | 3 | Errors ..................................................................................................................................................... 169 See Also ................................................................................................................................................ 169 ListCheckSummaries ................................................................................................................................ 171 Request Syntax .................................................................................................................................... 171 URI Request Parameters ................................................................................................................... 171 Request Body ....................................................................................................................................... 171 Response Syntax ................................................................................................................................. 173 Response Elements ............................................................................................................................ 173 Errors ..................................................................................................................................................... 174 See Also ................................................................................................................................................ 174 API Version 2020-03-31 xi AWS Well-Architected Tool API Reference ListLenses ................................................................................................................................................... 176 Request Syntax .................................................................................................................................... 176 URI Request Parameters ................................................................................................................... 176 Request Body ....................................................................................................................................... 176 Response Syntax ................................................................................................................................. 177 Response Elements ............................................................................................................................ 177 Errors ..................................................................................................................................................... 178 See Also ................................................................................................................................................ 178 ListLensReviewImprovements ............................................................................................................... 180 Request Syntax .................................................................................................................................... 180 URI Request Parameters ................................................................................................................... 180 Request Body ....................................................................................................................................... 181 Response Syntax ................................................................................................................................. 181 Response Elements ............................................................................................................................ 182 Errors ..................................................................................................................................................... 183 See Also ................................................................................................................................................ 184 ListLensReviews ........................................................................................................................................ 186 Request Syntax .................................................................................................................................... 186 URI Request Parameters ................................................................................................................... 186 Request Body ....................................................................................................................................... 186 Response Syntax ................................................................................................................................. 187 Response Elements ............................................................................................................................ 187 Errors ..................................................................................................................................................... 188 See Also ................................................................................................................................................ 189 ListLensShares .......................................................................................................................................... 190 Request Syntax .................................................................................................................................... 190 URI Request Parameters ................................................................................................................... 190 Request Body ....................................................................................................................................... 191 Response Syntax ................................................................................................................................. 191 Response Elements ............................................................................................................................ 191 Errors ..................................................................................................................................................... 192 See Also ................................................................................................................................................ 192 ListMilestones ........................................................................................................................................... 194 Request Syntax .................................................................................................................................... 194 URI Request Parameters ................................................................................................................... 194 Request Body ....................................................................................................................................... 194 API Version 2020-03-31 xii AWS Well-Architected Tool API Reference Response Syntax ................................................................................................................................. 195 Response Elements ............................................................................................................................ 196 Errors ..................................................................................................................................................... 196 See Also ................................................................................................................................................ 197 ListNotifications ........................................................................................................................................ 198 Request Syntax .................................................................................................................................... 198 URI Request Parameters ................................................................................................................... 198 Request Body ....................................................................................................................................... 198 Response Syntax ................................................................................................................................. 199 Response Elements ............................................................................................................................ 200 Errors ..................................................................................................................................................... 200 See Also ................................................................................................................................................ 201 ListProfileNotifications ............................................................................................................................ 202 Request Syntax .................................................................................................................................... 202 URI Request Parameters ................................................................................................................... 202 Request Body ....................................................................................................................................... 202 Response Syntax ................................................................................................................................. 202 Response Elements ............................................................................................................................ 203 Errors ..................................................................................................................................................... 203 See Also ................................................................................................................................................ 204 ListProfiles ................................................................................................................................................. 205 Request Syntax .................................................................................................................................... 205 URI Request Parameters ................................................................................................................... 205 Request Body ....................................................................................................................................... 205 Response Syntax ................................................................................................................................. 205 Response Elements ............................................................................................................................ 206 Errors ..................................................................................................................................................... 206 See Also ................................................................................................................................................ 207 ListProfileShares ....................................................................................................................................... 208 Request Syntax .................................................................................................................................... 208 URI Request Parameters ................................................................................................................... 208 Request Body ....................................................................................................................................... 209 Response Syntax ................................................................................................................................. 209 Response Elements ............................................................................................................................ 209 Errors ..................................................................................................................................................... 210 See Also ................................................................................................................................................ 210 API Version 2020-03-31 xiii AWS Well-Architected Tool API Reference ListReviewTemplateAnswers .................................................................................................................. 212 Request Syntax .................................................................................................................................... 212 URI Request Parameters ................................................................................................................... 212 Request Body ....................................................................................................................................... 213 Response Syntax ................................................................................................................................. 213 Response Elements ............................................................................................................................ 214 Errors ..................................................................................................................................................... 215 See Also ................................................................................................................................................ 216 ListReviewTemplates ............................................................................................................................... 217 Request Syntax .................................................................................................................................... 217 URI Request Parameters ................................................................................................................... 217 Request Body ....................................................................................................................................... 217 Response Syntax ................................................................................................................................. 217 Response Elements ............................................................................................................................ 218 Errors ..................................................................................................................................................... 218 See Also ................................................................................................................................................ 219 ListShareInvitations ................................................................................................................................. 220 Request Syntax .................................................................................................................................... 220 URI Request Parameters ................................................................................................................... 220 Request Body ....................................................................................................................................... 221 Response Syntax ................................................................................................................................. 221 Response Elements ............................................................................................................................ 222 Errors ..................................................................................................................................................... 222 See Also ................................................................................................................................................ 223 ListTagsForResource ................................................................................................................................ 224 Request Syntax .................................................................................................................................... 224 URI Request Parameters ................................................................................................................... 224 Request Body ....................................................................................................................................... 224 Response Syntax ................................................................................................................................. 224 Response Elements ............................................................................................................................ 225 Errors ..................................................................................................................................................... 225 See Also ................................................................................................................................................ 225 ListTemplateShares .................................................................................................................................. 227 Request Syntax .................................................................................................................................... 227 URI Request Parameters ................................................................................................................... 227 Request Body ....................................................................................................................................... 228 API Version 2020-03-31 xiv AWS Well-Architected Tool API Reference Response Syntax ................................................................................................................................. 228 Response Elements ............................................................................................................................ 228 Errors ..................................................................................................................................................... 229 See Also ................................................................................................................................................ 230 ListWorkloads ............................................................................................................................................ 231 Request Syntax .................................................................................................................................... 231 URI Request Parameters ................................................................................................................... 231 Request Body ....................................................................................................................................... 231 Response Syntax ................................................................................................................................. 232 Response Elements ............................................................................................................................ 232 Errors ..................................................................................................................................................... 233 See Also ................................................................................................................................................ 233 ListWorkloadShares ................................................................................................................................. 235 Request Syntax .................................................................................................................................... 235 URI Request Parameters ................................................................................................................... 235 Request Body ....................................................................................................................................... 236 Response Syntax ................................................................................................................................. 236 Response Elements ............................................................................................................................ 236 Errors ..................................................................................................................................................... 237 See Also ................................................................................................................................................ 238 TagResource .............................................................................................................................................. 239 Request Syntax .................................................................................................................................... 239 URI Request Parameters ................................................................................................................... 239 Request Body ....................................................................................................................................... 239 Response Syntax ................................................................................................................................. 240 Response Elements ............................................................................................................................ 240 Errors ..................................................................................................................................................... 240 See Also ................................................................................................................................................ 240 UntagResource .......................................................................................................................................... 242 Request Syntax .................................................................................................................................... 242 URI Request Parameters ................................................................................................................... 242 Request Body ....................................................................................................................................... 242 Response Syntax ................................................................................................................................. 243 Response Elements ............................................................................................................................ 243 Errors ..................................................................................................................................................... 243 See Also ................................................................................................................................................ 243 API Version 2020-03-31 xv AWS Well-Architected Tool API Reference UpdateAnswer ........................................................................................................................................... 245 Request Syntax .................................................................................................................................... 245 URI Request Parameters ................................................................................................................... 245 Request Body ....................................................................................................................................... 246 Response Syntax ................................................................................................................................. 247 Response Elements ............................................................................................................................ 249 Errors ..................................................................................................................................................... 250 See Also ................................................................................................................................................ 251 UpdateGlobalSettings ............................................................................................................................. 252 Request Syntax .................................................................................................................................... 252 URI Request Parameters ................................................................................................................... 252 Request Body ....................................................................................................................................... 252 Response Syntax ................................................................................................................................. 253 Response Elements ............................................................................................................................ 253 Errors ..................................................................................................................................................... 253 See Also ................................................................................................................................................ 254 UpdateIntegration .................................................................................................................................... 255 Request Syntax .................................................................................................................................... 255 URI Request Parameters ................................................................................................................... 255 Request Body ....................................................................................................................................... 255 Response Syntax ................................................................................................................................. 256 Response Elements ............................................................................................................................ 256 Errors ..................................................................................................................................................... 256 See Also ................................................................................................................................................ 257 UpdateLensReview ................................................................................................................................... 259 Request Syntax .................................................................................................................................... 259 URI Request Parameters ................................................................................................................... 259 Request Body ....................................................................................................................................... 260 Response Syntax ................................................................................................................................. 261 Response Elements ............................................................................................................................ 262 Errors ..................................................................................................................................................... 262 See Also ................................................................................................................................................ 263 UpdateProfile ............................................................................................................................................ 265 Request Syntax .................................................................................................................................... 265 URI Request Parameters ................................................................................................................... 265 Request Body ....................................................................................................................................... 265 API Version 2020-03-31 xvi AWS Well-Architected Tool API Reference Response Syntax ................................................................................................................................. 266 Response Elements ............................................................................................................................ 267 Errors ..................................................................................................................................................... |
wellarchitected-api-004 | wellarchitected-api.pdf | 4 | Also ................................................................................................................................................ 254 UpdateIntegration .................................................................................................................................... 255 Request Syntax .................................................................................................................................... 255 URI Request Parameters ................................................................................................................... 255 Request Body ....................................................................................................................................... 255 Response Syntax ................................................................................................................................. 256 Response Elements ............................................................................................................................ 256 Errors ..................................................................................................................................................... 256 See Also ................................................................................................................................................ 257 UpdateLensReview ................................................................................................................................... 259 Request Syntax .................................................................................................................................... 259 URI Request Parameters ................................................................................................................... 259 Request Body ....................................................................................................................................... 260 Response Syntax ................................................................................................................................. 261 Response Elements ............................................................................................................................ 262 Errors ..................................................................................................................................................... 262 See Also ................................................................................................................................................ 263 UpdateProfile ............................................................................................................................................ 265 Request Syntax .................................................................................................................................... 265 URI Request Parameters ................................................................................................................... 265 Request Body ....................................................................................................................................... 265 API Version 2020-03-31 xvi AWS Well-Architected Tool API Reference Response Syntax ................................................................................................................................. 266 Response Elements ............................................................................................................................ 267 Errors ..................................................................................................................................................... 267 See Also ................................................................................................................................................ 268 UpdateReviewTemplate .......................................................................................................................... 269 Request Syntax .................................................................................................................................... 269 URI Request Parameters ................................................................................................................... 269 Request Body ....................................................................................................................................... 269 Response Syntax ................................................................................................................................. 271 Response Elements ............................................................................................................................ 271 Errors ..................................................................................................................................................... 272 See Also ................................................................................................................................................ 272 UpdateReviewTemplateAnswer ............................................................................................................. 274 Request Syntax .................................................................................................................................... 274 URI Request Parameters ................................................................................................................... 274 Request Body ....................................................................................................................................... 275 Response Syntax ................................................................................................................................. 276 Response Elements ............................................................................................................................ 278 Errors ..................................................................................................................................................... 279 See Also ................................................................................................................................................ 279 UpdateReviewTemplateLensReview ..................................................................................................... 281 Request Syntax .................................................................................................................................... 281 URI Request Parameters ................................................................................................................... 281 Request Body ....................................................................................................................................... 282 Response Syntax ................................................................................................................................. 282 Response Elements ............................................................................................................................ 283 Errors ..................................................................................................................................................... 284 See Also ................................................................................................................................................ 285 UpdateShareInvitation ............................................................................................................................ 286 Request Syntax .................................................................................................................................... 286 URI Request Parameters ................................................................................................................... 286 Request Body ....................................................................................................................................... 286 Response Syntax ................................................................................................................................. 287 Response Elements ............................................................................................................................ 287 Errors ..................................................................................................................................................... 287 See Also ................................................................................................................................................ 288 API Version 2020-03-31 xvii AWS Well-Architected Tool API Reference UpdateWorkload ...................................................................................................................................... 290 Request Syntax .................................................................................................................................... 290 URI Request Parameters ................................................................................................................... 290 Request Body ....................................................................................................................................... 291 Response Syntax ................................................................................................................................. 296 Response Elements ............................................................................................................................ 297 Errors ..................................................................................................................................................... 298 See Also ................................................................................................................................................ 298 UpdateWorkloadShare ............................................................................................................................ 300 Request Syntax .................................................................................................................................... 300 URI Request Parameters ................................................................................................................... 300 Request Body ....................................................................................................................................... 300 Response Syntax ................................................................................................................................. 301 Response Elements ............................................................................................................................ 301 Errors ..................................................................................................................................................... 302 See Also ................................................................................................................................................ 302 UpgradeLensReview ................................................................................................................................ 304 Request Syntax .................................................................................................................................... 304 URI Request Parameters ................................................................................................................... 304 Request Body ....................................................................................................................................... 305 Response Syntax ................................................................................................................................. 306 Response Elements ............................................................................................................................ 306 Errors ..................................................................................................................................................... 306 See Also ................................................................................................................................................ 307 UpgradeProfileVersion ............................................................................................................................ 308 Request Syntax .................................................................................................................................... 308 URI Request Parameters ................................................................................................................... 308 Request Body ....................................................................................................................................... 308 Response Syntax ................................................................................................................................. 309 Response Elements ............................................................................................................................ 310 Errors ..................................................................................................................................................... 310 See Also ................................................................................................................................................ 311 UpgradeReviewTemplateLensReview ................................................................................................... 312 Request Syntax .................................................................................................................................... 312 URI Request Parameters ................................................................................................................... 312 Request Body ....................................................................................................................................... 313 API Version 2020-03-31 xviii AWS Well-Architected Tool API Reference Response Syntax ................................................................................................................................. 313 Response Elements ............................................................................................................................ 313 Errors ..................................................................................................................................................... 314 See Also ................................................................................................................................................ 314 Data Types ................................................................................................................................... 316 AccountJiraConfigurationInput ............................................................................................................. 319 Contents ............................................................................................................................................... 319 See Also ................................................................................................................................................ 320 AccountJiraConfigurationOutput .......................................................................................................... 321 Contents ............................................................................................................................................... 321 See Also ................................................................................................................................................ 322 AdditionalResources ................................................................................................................................ 323 Contents ............................................................................................................................................... 323 See Also ................................................................................................................................................ 323 Answer ........................................................................................................................................................ 324 Contents ............................................................................................................................................... 324 See Also ................................................................................................................................................ 327 AnswerSummary ...................................................................................................................................... 328 Contents ............................................................................................................................................... 328 See Also ................................................................................................................................................ 330 BestPractice ............................................................................................................................................... 331 Contents ............................................................................................................................................... 331 See Also ................................................................................................................................................ 331 CheckDetail ................................................................................................................................................ 332 Contents ............................................................................................................................................... 332 See Also ................................................................................................................................................ 334 CheckSummary ......................................................................................................................................... 336 Contents ............................................................................................................................................... 336 See Also ................................................................................................................................................ 338 Choice ......................................................................................................................................................... 339 Contents ............................................................................................................................................... 339 See Also ................................................................................................................................................ 340 ChoiceAnswer ............................................................................................................................................ 341 Contents ............................................................................................................................................... 341 See Also ................................................................................................................................................ 342 ChoiceAnswerSummary .......................................................................................................................... 343 API Version 2020-03-31 xix AWS Well-Architected Tool API Reference Contents ............................................................................................................................................... 343 See Also ................................................................................................................................................ 343 ChoiceContent .......................................................................................................................................... 345 Contents ............................................................................................................................................... 345 See Also ................................................................................................................................................ 345 ChoiceImprovementPlan ......................................................................................................................... 346 Contents ............................................................................................................................................... 346 See Also ................................................................................................................................................ 346 ChoiceUpdate ............................................................................................................................................ 348 Contents ............................................................................................................................................... 348 See Also ................................................................................................................................................ 348 ConsolidatedReportMetric ...................................................................................................................... 350 Contents ............................................................................................................................................... 350 See Also ................................................................................................................................................ 351 ImprovementSummary ........................................................................................................................... 353 Contents ............................................................................................................................................... 353 See Also ................................................................................................................................................ 354 JiraConfiguration ...................................................................................................................................... 355 Contents ............................................................................................................................................... 355 See Also ................................................................................................................................................ 355 JiraSelectedQuestionConfiguration ...................................................................................................... 356 Contents ............................................................................................................................................... 356 See Also ................................................................................................................................................ 356 Lens ............................................................................................................................................................. 357 Contents ............................................................................................................................................... 357 See Also ................................................................................................................................................ 358 LensMetric ................................................................................................................................................. 359 Contents ............................................................................................................................................... 359 See Also ................................................................................................................................................ 359 LensReview ................................................................................................................................................ 361 Contents ............................................................................................................................................... 361 See Also ................................................................................................................................................ 364 LensReviewReport .................................................................................................................................... 365 Contents ............................................................................................................................................... 365 See Also ................................................................................................................................................ 366 LensReviewSummary ............................................................................................................................... 367 API Version 2020-03-31 xx AWS Well-Architected Tool API Reference Contents ............................................................................................................................................... 367 See Also ................................................................................................................................................ 369 LensShareSummary ................................................................................................................................. 370 Contents ............................................................................................................................................... 370 See Also ................................................................................................................................................ 371 LensSummary ........................................................................................................................................... 372 Contents ............................................................................................................................................... 372 See Also ................................................................................................................................................ 374 LensUpgradeSummary ............................................................................................................................ 375 Contents ............................................................................................................................................... 375 See Also ................................................................................................................................................ 377 Milestone ................................................................................................................................................... 378 Contents ............................................................................................................................................... 378 See Also ................................................................................................................................................ 379 MilestoneSummary .................................................................................................................................. 380 Contents ............................................................................................................................................... 380 See Also ................................................................................................................................................ 381 NotificationSummary .............................................................................................................................. 382 Contents ............................................................................................................................................... 382 See Also ................................................................................................................................................ 382 PillarDifference ......................................................................................................................................... 383 Contents ............................................................................................................................................... 383 See Also ................................................................................................................................................ 384 PillarMetric ................................................................................................................................................ 385 Contents ............................................................................................................................................... 385 See Also ................................................................................................................................................ 385 PillarReviewSummary .............................................................................................................................. 387 Contents ............................................................................................................................................... 387 See Also ................................................................................................................................................ 388 Profile ......................................................................................................................................................... 389 Contents ............................................................................................................................................... 389 See Also ................................................................................................................................................ 391 ProfileChoice ............................................................................................................................................. 392 Contents ............................................................................................................................................... 392 See Also ................................................................................................................................................ 392 ProfileNotificationSummary .................................................................................................................. 394 API Version 2020-03-31 xxi AWS Well-Architected Tool API Reference Contents ............................................................................................................................................... 394 See Also ................................................................................................................................................ 395 ProfileQuestion ......................................................................................................................................... 397 Contents ............................................................................................................................................... 397 See Also ................................................................................................................................................ 398 ProfileQuestionUpdate ........................................................................................................................... 399 Contents ............................................................................................................................................... 399 See |
wellarchitected-api-005 | wellarchitected-api.pdf | 5 | See Also ................................................................................................................................................ 381 NotificationSummary .............................................................................................................................. 382 Contents ............................................................................................................................................... 382 See Also ................................................................................................................................................ 382 PillarDifference ......................................................................................................................................... 383 Contents ............................................................................................................................................... 383 See Also ................................................................................................................................................ 384 PillarMetric ................................................................................................................................................ 385 Contents ............................................................................................................................................... 385 See Also ................................................................................................................................................ 385 PillarReviewSummary .............................................................................................................................. 387 Contents ............................................................................................................................................... 387 See Also ................................................................................................................................................ 388 Profile ......................................................................................................................................................... 389 Contents ............................................................................................................................................... 389 See Also ................................................................................................................................................ 391 ProfileChoice ............................................................................................................................................. 392 Contents ............................................................................................................................................... 392 See Also ................................................................................................................................................ 392 ProfileNotificationSummary .................................................................................................................. 394 API Version 2020-03-31 xxi AWS Well-Architected Tool API Reference Contents ............................................................................................................................................... 394 See Also ................................................................................................................................................ 395 ProfileQuestion ......................................................................................................................................... 397 Contents ............................................................................................................................................... 397 See Also ................................................................................................................................................ 398 ProfileQuestionUpdate ........................................................................................................................... 399 Contents ............................................................................................................................................... 399 See Also ................................................................................................................................................ 399 ProfileShareSummary ............................................................................................................................. 400 Contents ............................................................................................................................................... 400 See Also ................................................................................................................................................ 401 ProfileSummary ........................................................................................................................................ 402 Contents ............................................................................................................................................... 402 See Also ................................................................................................................................................ 403 ProfileTemplate ........................................................................................................................................ 404 Contents ............................................................................................................................................... 404 See Also ................................................................................................................................................ 404 ProfileTemplateChoice ............................................................................................................................ 406 Contents ............................................................................................................................................... 406 See Also ................................................................................................................................................ 406 ProfileTemplateQuestion ........................................................................................................................ 408 Contents ............................................................................................................................................... 408 See Also ................................................................................................................................................ 409 QuestionDifference .................................................................................................................................. 410 Contents ............................................................................................................................................... 410 See Also ................................................................................................................................................ 410 QuestionMetric ......................................................................................................................................... 412 Contents ............................................................................................................................................... 412 See Also ................................................................................................................................................ 412 ReviewTemplate ....................................................................................................................................... 414 Contents ............................................................................................................................................... 414 See Also ................................................................................................................................................ 416 ReviewTemplateAnswer .......................................................................................................................... 418 Contents ............................................................................................................................................... 418 See Also ................................................................................................................................................ 421 ReviewTemplateAnswerSummary ......................................................................................................... 422 API Version 2020-03-31 xxii AWS Well-Architected Tool API Reference Contents ............................................................................................................................................... 422 See Also ................................................................................................................................................ 424 ReviewTemplateLensReview .................................................................................................................. 425 Contents ............................................................................................................................................... 425 See Also ................................................................................................................................................ 427 ReviewTemplatePillarReviewSummary ................................................................................................ 428 Contents ............................................................................................................................................... 428 See Also ................................................................................................................................................ 429 ReviewTemplateSummary ...................................................................................................................... 430 Contents ............................................................................................................................................... 430 See Also ................................................................................................................................................ 431 SelectedPillar ............................................................................................................................................ 433 Contents ............................................................................................................................................... 433 See Also ................................................................................................................................................ 433 ShareInvitation ......................................................................................................................................... 434 Contents ............................................................................................................................................... 434 See Also ................................................................................................................................................ 436 ShareInvitationSummary ........................................................................................................................ 437 Contents ............................................................................................................................................... 437 See Also ................................................................................................................................................ 440 TemplateShareSummary ........................................................................................................................ 441 Contents ............................................................................................................................................... 441 See Also ................................................................................................................................................ 442 ValidationExceptionField ........................................................................................................................ 443 Contents ............................................................................................................................................... 443 See Also ................................................................................................................................................ 443 VersionDifferences ................................................................................................................................... 444 Contents ............................................................................................................................................... 444 See Also ................................................................................................................................................ 444 Workload .................................................................................................................................................... 445 Contents ............................................................................................................................................... 445 See Also ................................................................................................................................................ 452 WorkloadDiscoveryConfig ...................................................................................................................... 453 Contents ............................................................................................................................................... 453 See Also ................................................................................................................................................ 453 WorkloadJiraConfigurationInput ........................................................................................................... 454 API Version 2020-03-31 xxiii AWS Well-Architected Tool API Reference Contents ............................................................................................................................................... 454 See Also ................................................................................................................................................ 454 WorkloadJiraConfigurationOutput ....................................................................................................... 456 Contents ............................................................................................................................................... 456 See Also ................................................................................................................................................ 457 WorkloadProfile ........................................................................................................................................ 458 Contents ............................................................................................................................................... 458 See Also ................................................................................................................................................ 458 WorkloadShare ......................................................................................................................................... 459 Contents ............................................................................................................................................... 459 See Also ................................................................................................................................................ 460 WorkloadShareSummary ........................................................................................................................ 462 Contents ............................................................................................................................................... 462 See Also ................................................................................................................................................ 463 WorkloadSummary .................................................................................................................................. 464 Contents ............................................................................................................................................... 464 See Also ................................................................................................................................................ 466 Common Parameters ................................................................................................................... 467 Common Errors ............................................................................................................................ 470 API Version 2020-03-31 xxiv AWS Well-Architected Tool Welcome API Reference This is the AWS Well-Architected Tool API Reference. The AWS WA Tool API provides programmatic access to the AWS Well-Architected Tool in the AWS Management Console. For information about the AWS Well-Architected Tool, see the AWS Well-Architected Tool User Guide. This document was last published on May 21, 2025. API Version 2020-03-31 1 AWS Well-Architected Tool Actions The following actions are supported: API Reference • AssociateLenses • AssociateProfiles • CreateLensShare • CreateLensVersion • CreateMilestone • CreateProfile • CreateProfileShare • CreateReviewTemplate • CreateTemplateShare • CreateWorkload • CreateWorkloadShare • DeleteLens • DeleteLensShare • DeleteProfile • DeleteProfileShare • DeleteReviewTemplate • DeleteTemplateShare • DeleteWorkload • DeleteWorkloadShare • DisassociateLenses • DisassociateProfiles • ExportLens • GetAnswer • GetConsolidatedReport • GetGlobalSettings • GetLens • GetLensReview API Version 2020-03-31 2 AWS Well-Architected Tool • GetLensReviewReport • GetLensVersionDifference • GetMilestone • GetProfile • GetProfileTemplate • GetReviewTemplate • GetReviewTemplateAnswer • GetReviewTemplateLensReview • GetWorkload • ImportLens • ListAnswers • ListCheckDetails • ListCheckSummaries • ListLenses • ListLensReviewImprovements • ListLensReviews • ListLensShares • ListMilestones • ListNotifications • ListProfileNotifications • ListProfiles • ListProfileShares • ListReviewTemplateAnswers • ListReviewTemplates • ListShareInvitations • ListTagsForResource • ListTemplateShares • ListWorkloads • ListWorkloadShares • TagResource API Reference API Version 2020-03-31 3 AWS Well-Architected Tool • UntagResource • UpdateAnswer • UpdateGlobalSettings • UpdateIntegration • UpdateLensReview • UpdateProfile • UpdateReviewTemplate • UpdateReviewTemplateAnswer • UpdateReviewTemplateLensReview • UpdateShareInvitation • UpdateWorkload • UpdateWorkloadShare • UpgradeLensReview • UpgradeProfileVersion • UpgradeReviewTemplateLensReview API Reference API Version 2020-03-31 4 AWS Well-Architected Tool AssociateLenses Associate a lens to a workload. API Reference 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 AWS user or account, you acknowledge that custom lenses created by other users and shared with you are Third Party Content as defined in the AWS Customer Agreement. Request Syntax PATCH /workloads/WorkloadId/associateLenses HTTP/1.1 Content-type: application/json { "LensAliases": [ "string" ] } URI Request Parameters The request uses the following URI parameters. WorkloadId The ID assigned to the workload. This ID is unique within an AWS Region. Length Constraints: Fixed length of 32. Pattern: [0-9a-f]{32} Required: Yes AssociateLenses API Version 2020-03-31 5 AWS Well-Architected Tool Request Body The request accepts the following data in JSON format. LensAliases API Reference List of lens aliases to associate or disassociate with a workload. Up to 10 |
wellarchitected-api-006 | wellarchitected-api.pdf | 6 | users and shared with you are Third Party Content as defined in the AWS Customer Agreement. Request Syntax PATCH /workloads/WorkloadId/associateLenses HTTP/1.1 Content-type: application/json { "LensAliases": [ "string" ] } URI Request Parameters The request uses the following URI parameters. WorkloadId The ID assigned to the workload. This ID is unique within an AWS Region. Length Constraints: Fixed length of 32. Pattern: [0-9a-f]{32} Required: Yes AssociateLenses API Version 2020-03-31 5 AWS Well-Architected Tool Request Body The request accepts the following data in JSON format. LensAliases API Reference List of lens aliases to associate or disassociate with a workload. Up to 10 lenses can be specified. Identify a lens using its LensSummary:LensAlias. Type: Array of strings Array Members: Minimum number of 1 item. Length Constraints: Minimum length of 1. Maximum length of 128. Required: Yes Response Syntax HTTP/1.1 200 Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException User does not have sufficient access to perform this action. HTTP Status Code: 403 ConflictException The resource has already been processed, was deleted, or is too large. HTTP Status Code: 409 Request Body API Version 2020-03-31 6 AWS Well-Architected Tool InternalServerException API Reference There is a problem with the AWS Well-Architected Tool API service. HTTP Status Code: 500 ResourceNotFoundException The requested resource was not found. HTTP Status Code: 404 ThrottlingException Request was denied due to request throttling. HTTP Status Code: 429 ValidationException The user input is not valid. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2020-03-31 7 API Reference AWS Well-Architected Tool AssociateProfiles Associate a profile with a workload. Request Syntax PATCH /workloads/WorkloadId/associateProfiles HTTP/1.1 Content-type: application/json { "ProfileArns": [ "string" ] } URI Request Parameters The request uses the following URI parameters. WorkloadId The ID assigned to the workload. This ID is unique within an AWS Region. Length Constraints: Fixed length of 32. Pattern: [0-9a-f]{32} Required: Yes Request Body The request accepts the following data in JSON format. ProfileArns The list of profile ARNs to associate with the workload. Type: Array of strings Array Members: Minimum number of 1 item. Length Constraints: Maximum length of 2084. AssociateProfiles API Version 2020-03-31 8 AWS Well-Architected Tool API Reference Pattern: arn:aws[-a-z]*:wellarchitected:[a-z]{2}(-gov)?-[a-z]+-\d: \d{12}:profile/[a-z0-9]+ Required: Yes Response Syntax HTTP/1.1 200 Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException User does not have sufficient access to perform this action. HTTP Status Code: 403 ConflictException The resource has already been processed, was deleted, or is too large. HTTP Status Code: 409 InternalServerException There is a problem with the AWS Well-Architected Tool API service. HTTP Status Code: 500 ResourceNotFoundException The requested resource was not found. HTTP Status Code: 404 ThrottlingException Request was denied due to request throttling. Response Syntax API Version 2020-03-31 9 AWS Well-Architected Tool HTTP Status Code: 429 ValidationException The user input is not valid. HTTP Status Code: 400 See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2020-03-31 10 AWS Well-Architected Tool CreateLensShare Create a lens share. API Reference The owner of a lens can share it with other AWS accounts, users, an organization, and organizational units (OUs) in the same AWS Region. Lenses provided by AWS (AWS 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 AWS Well-Architected Tool User Guide. Note Disclaimer By sharing your custom lenses with other AWS accounts, you acknowledge that AWS will make your custom lenses available to those other accounts. Those other accounts may continue to access and |
wellarchitected-api-007 | wellarchitected-api.pdf | 7 | in the same AWS Region. Lenses provided by AWS (AWS 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 AWS Well-Architected Tool User Guide. Note Disclaimer By sharing your custom lenses with other AWS accounts, you acknowledge that AWS 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 AWS account or terminate your AWS account. Request Syntax POST /lenses/LensAlias/shares HTTP/1.1 Content-type: application/json { "ClientRequestToken": "string", "SharedWith": "string" } URI Request Parameters The request uses the following URI parameters. LensAlias The alias of the lens. CreateLensShare API Version 2020-03-31 11 AWS Well-Architected Tool API Reference For AWS official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on AWS official lenses. For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us- west-2:123456789012:lens/0123456789abcdef01234567890abcdef. Each lens is identified by its LensSummary:LensAlias. Length Constraints: Minimum length of 1. Maximum length of 128. Required: Yes Request Body The request accepts the following data in JSON format. ClientRequestToken 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 AWS SDKs automatically generate one for you. If you are not using the AWS SDK or the AWS CLI, you must provide this token or the request will fail. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: ^[\x00-\x7F]*$ Required: Yes Request Body API Version 2020-03-31 12 AWS Well-Architected Tool SharedWith API Reference The AWS account ID, organization ID, or organizational unit (OU) ID with which the workload, lens, profile, or review template is shared. Type: String Length Constraints: Minimum length of 12. Maximum length of 2048. Required: Yes Response Syntax HTTP/1.1 200 Content-type: application/json { "ShareId": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ShareId The ID associated with the share. Type: String Pattern: [0-9a-f]{32} Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException User does not have sufficient access to perform this action. Response Syntax API Version 2020-03-31 13 AWS Well-Architected Tool HTTP Status Code: 403 ConflictException The resource has already been processed, was deleted, or is too large. HTTP Status Code: 409 InternalServerException There is a problem with the AWS Well-Architected Tool API service. API Reference HTTP Status Code: 500 ResourceNotFoundException The requested resource was not found. HTTP Status Code: 404 ServiceQuotaExceededException The user has reached their resource quota. HTTP Status Code: 402 ThrottlingException Request was denied due to request throttling. HTTP Status Code: 429 ValidationException The user input is not valid. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET See Also API Version 2020-03-31 14 API Reference AWS Well-Architected Tool • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2020-03-31 15 AWS Well-Architected Tool CreateLensVersion Create a new lens version. A lens can have up to 100 versions. API Reference 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 AWS accounts and users in the same AWS Region. Only the owner of a lens can delete it. Request Syntax POST /lenses/LensAlias/versions HTTP/1.1 Content-type: application/json { "ClientRequestToken": "string", "IsMajorVersion": boolean, "LensVersion": "string" } URI Request Parameters The request uses the following URI parameters. LensAlias The alias of the lens. For AWS official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on AWS |
wellarchitected-api-008 | wellarchitected-api.pdf | 8 | identify the lens to be published. The owner of a lens can share the lens with other AWS accounts and users in the same AWS Region. Only the owner of a lens can delete it. Request Syntax POST /lenses/LensAlias/versions HTTP/1.1 Content-type: application/json { "ClientRequestToken": "string", "IsMajorVersion": boolean, "LensVersion": "string" } URI Request Parameters The request uses the following URI parameters. LensAlias The alias of the lens. For AWS official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on AWS official lenses. For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us- west-2:123456789012:lens/0123456789abcdef01234567890abcdef. Each lens is identified by its LensSummary:LensAlias. Length Constraints: Minimum length of 1. Maximum length of 128. Required: Yes CreateLensVersion API Version 2020-03-31 16 AWS Well-Architected Tool Request Body The request accepts the following data in JSON format. ClientRequestToken API Reference 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 AWS SDKs automatically generate one for you. If you are not using the AWS SDK or the AWS CLI, you must provide this token or the request will fail. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: ^[\x00-\x7F]*$ Required: Yes IsMajorVersion Set to true if this new major lens version. Type: Boolean Required: No LensVersion The version of the lens being created. Type: String Length Constraints: Minimum length of 1. Maximum length of 32. Request Body API Version 2020-03-31 17 API Reference AWS Well-Architected Tool Required: Yes Response Syntax HTTP/1.1 200 Content-type: application/json { "LensArn": "string", "LensVersion": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. LensArn The ARN for the lens. Type: String LensVersion The version of the lens. Type: String Length Constraints: Minimum length of 1. Maximum length of 32. Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException User does not have sufficient access to perform this action. HTTP Status Code: 403 Response Syntax API Version 2020-03-31 18 AWS Well-Architected Tool ConflictException API Reference The resource has already been processed, was deleted, or is too large. HTTP Status Code: 409 InternalServerException There is a problem with the AWS Well-Architected Tool API service. HTTP Status Code: 500 ResourceNotFoundException The requested resource was not found. HTTP Status Code: 404 ServiceQuotaExceededException The user has reached their resource quota. HTTP Status Code: 402 ThrottlingException Request was denied due to request throttling. HTTP Status Code: 429 ValidationException The user input is not valid. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ See Also API Version 2020-03-31 19 AWS Well-Architected Tool • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2020-03-31 20 API Reference AWS Well-Architected Tool CreateMilestone Create a milestone for an existing workload. Request Syntax POST /workloads/WorkloadId/milestones HTTP/1.1 Content-type: application/json { "ClientRequestToken": "string", "MilestoneName": "string" } URI Request Parameters The request uses the following URI parameters. WorkloadId The ID assigned to the workload. This ID is unique within an AWS Region. Length Constraints: Fixed length of 32. Pattern: [0-9a-f]{32} Required: Yes Request Body The request accepts the following data in JSON format. ClientRequestToken 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. CreateMilestone API Version 2020-03-31 21 AWS Well-Architected Tool API Reference Important This token is listed as required, however, if you do not specify it, the AWS SDKs automatically generate one for you. If you are not using the AWS SDK or the AWS CLI, you must provide this token or the request will fail. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: ^[\x00-\x7F]*$ Required: Yes MilestoneName The name of the milestone in a workload. Milestone |
wellarchitected-api-009 | wellarchitected-api.pdf | 9 | token and the same parameters after the original request has completed successfully, the result of the original request is returned. CreateMilestone API Version 2020-03-31 21 AWS Well-Architected Tool API Reference Important This token is listed as required, however, if you do not specify it, the AWS SDKs automatically generate one for you. If you are not using the AWS SDK or the AWS CLI, you must provide this token or the request will fail. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: ^[\x00-\x7F]*$ Required: Yes MilestoneName The name of the milestone in a workload. Milestone names must be unique within a workload. Type: String Length Constraints: Minimum length of 3. Maximum length of 100. Required: Yes Response Syntax HTTP/1.1 200 Content-type: application/json { "MilestoneNumber": number, "WorkloadId": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. Response Syntax API Version 2020-03-31 22 API Reference AWS Well-Architected Tool MilestoneNumber The milestone number. A workload can have a maximum of 100 milestones. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. WorkloadId The ID assigned to the workload. This ID is unique within an AWS Region. Type: String Length Constraints: Fixed length of 32. Pattern: [0-9a-f]{32} Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException User does not have sufficient access to perform this action. HTTP Status Code: 403 ConflictException The resource has already been processed, was deleted, or is too large. HTTP Status Code: 409 InternalServerException There is a problem with the AWS Well-Architected Tool API service. HTTP Status Code: 500 ResourceNotFoundException The requested resource was not found. Errors API Version 2020-03-31 23 AWS Well-Architected Tool API Reference HTTP Status Code: 404 ServiceQuotaExceededException The user has reached their resource quota. HTTP Status Code: 402 ThrottlingException Request was denied due to request throttling. HTTP Status Code: 429 ValidationException The user input is not valid. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2020-03-31 24 API Reference AWS Well-Architected Tool CreateProfile Create a profile. Request Syntax POST /profiles HTTP/1.1 Content-type: application/json { "ClientRequestToken": "string", "ProfileDescription": "string", "ProfileName": "string", "ProfileQuestions": [ { "QuestionId": "string", "SelectedChoiceIds": [ "string" ] } ], "Tags": { "string" : "string" } } URI Request Parameters The request does not use any URI parameters. Request Body The request accepts the following data in JSON format. ClientRequestToken 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. CreateProfile API Version 2020-03-31 25 AWS Well-Architected Tool API Reference Important This token is listed as required, however, if you do not specify it, the AWS SDKs automatically generate one for you. If you are not using the AWS SDK or the AWS CLI, you must provide this token or the request will fail. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: ^[\x00-\x7F]*$ Required: Yes ProfileDescription The profile description. Type: String Length Constraints: Minimum length of 3. Maximum length of 100. Required: Yes ProfileName Name of the profile. Type: String Length Constraints: Minimum length of 3. Maximum length of 100. Required: Yes ProfileQuestions The profile questions. Type: Array of ProfileQuestionUpdate objects Required: Yes Tags The tags assigned to the profile. Request Body API Version 2020-03-31 26 AWS Well-Architected Tool Type: String to string map Map Entries: Maximum number of 50 items. API Reference Key Length Constraints: Minimum length of 1. Maximum length of 128. Value Length Constraints: Minimum length of 0. Maximum length of 256. Required: No Response Syntax HTTP/1.1 200 Content-type: application/json { "ProfileArn": "string", "ProfileVersion": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ProfileArn The profile ARN. Type: String Length Constraints: Maximum length of 2084. Pattern: arn:aws[-a-z]*:wellarchitected:[a-z]{2}(-gov)?-[a-z]+-\d: \d{12}:profile/[a-z0-9]+ ProfileVersion Version of the profile. Type: String Length Constraints: Minimum length of 1. Maximum length of 32. Response Syntax API Version 2020-03-31 27 AWS Well-Architected Tool API Reference Pattern: ^[A-Za-z0-9-]+$ Errors For information about the errors that |
wellarchitected-api-010 | wellarchitected-api.pdf | 10 | Minimum length of 0. Maximum length of 256. Required: No Response Syntax HTTP/1.1 200 Content-type: application/json { "ProfileArn": "string", "ProfileVersion": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ProfileArn The profile ARN. Type: String Length Constraints: Maximum length of 2084. Pattern: arn:aws[-a-z]*:wellarchitected:[a-z]{2}(-gov)?-[a-z]+-\d: \d{12}:profile/[a-z0-9]+ ProfileVersion Version of the profile. Type: String Length Constraints: Minimum length of 1. Maximum length of 32. Response Syntax API Version 2020-03-31 27 AWS Well-Architected Tool API Reference Pattern: ^[A-Za-z0-9-]+$ Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException User does not have sufficient access to perform this action. HTTP Status Code: 403 ConflictException The resource has already been processed, was deleted, or is too large. HTTP Status Code: 409 InternalServerException There is a problem with the AWS Well-Architected Tool API service. HTTP Status Code: 500 ServiceQuotaExceededException The user has reached their resource quota. HTTP Status Code: 402 ThrottlingException Request was denied due to request throttling. HTTP Status Code: 429 ValidationException The user input is not valid. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: Errors API Version 2020-03-31 28 API Reference AWS Well-Architected Tool • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2020-03-31 29 API Reference AWS Well-Architected Tool CreateProfileShare Create a profile share. Request Syntax POST /profiles/ProfileArn/shares HTTP/1.1 Content-type: application/json { "ClientRequestToken": "string", "SharedWith": "string" } URI Request Parameters The request uses the following URI parameters. ProfileArn The profile ARN. Length Constraints: Maximum length of 2084. Pattern: arn:aws[-a-z]*:wellarchitected:[a-z]{2}(-gov)?-[a-z]+-\d: \d{12}:profile/[a-z0-9]+ Required: Yes Request Body The request accepts the following data in JSON format. ClientRequestToken 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. CreateProfileShare API Version 2020-03-31 30 AWS Well-Architected Tool API Reference Important This token is listed as required, however, if you do not specify it, the AWS SDKs automatically generate one for you. If you are not using the AWS SDK or the AWS CLI, you must provide this token or the request will fail. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: ^[\x00-\x7F]*$ Required: Yes SharedWith The AWS account ID, organization ID, or organizational unit (OU) ID with which the workload, lens, profile, or review template is shared. Type: String Length Constraints: Minimum length of 12. Maximum length of 2048. Required: Yes Response Syntax HTTP/1.1 200 Content-type: application/json { "ProfileArn": "string", "ShareId": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. Response Syntax API Version 2020-03-31 31 AWS Well-Architected Tool ProfileArn The profile ARN. Type: String API Reference Length Constraints: Maximum length of 2084. Pattern: arn:aws[-a-z]*:wellarchitected:[a-z]{2}(-gov)?-[a-z]+-\d: \d{12}:profile/[a-z0-9]+ ShareId The ID associated with the share. Type: String Pattern: [0-9a-f]{32} Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException User does not have sufficient access to perform this action. HTTP Status Code: 403 ConflictException The resource has already been processed, was deleted, or is too large. HTTP Status Code: 409 InternalServerException There is a problem with the AWS Well-Architected Tool API service. HTTP Status Code: 500 ResourceNotFoundException The requested resource was not found. Errors API Version 2020-03-31 32 AWS Well-Architected Tool API Reference HTTP Status Code: 404 ServiceQuotaExceededException The user has reached their resource quota. HTTP Status Code: 402 ThrottlingException Request was denied due to request throttling. HTTP Status Code: 429 ValidationException The user input is not valid. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2020-03-31 33 AWS Well-Architected Tool API Reference CreateReviewTemplate Create a review template. Note Disclaimer Do not include or gather personal identifiable information (PII) of end |
wellarchitected-api-011 | wellarchitected-api.pdf | 11 | more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2020-03-31 33 AWS Well-Architected Tool API Reference CreateReviewTemplate Create a review template. Note Disclaimer Do not include or gather personal identifiable information (PII) of end users or other identifiable individuals in or via your review templates. If your review template 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. Request Syntax POST /reviewTemplates HTTP/1.1 Content-type: application/json { "ClientRequestToken": "string", "Description": "string", "Lenses": [ "string" ], "Notes": "string", "Tags": { "string" : "string" }, "TemplateName": "string" } URI Request Parameters The request does not use any URI parameters. Request Body The request accepts the following data in JSON format. CreateReviewTemplate API Version 2020-03-31 34 AWS Well-Architected Tool ClientRequestToken API Reference 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 AWS SDKs automatically generate one for you. If you are not using the AWS SDK or the AWS CLI, you must provide this token or the request will fail. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: ^[\x00-\x7F]*$ Required: Yes Description The review template description. Type: String Length Constraints: Minimum length of 3. Maximum length of 250. Pattern: ^[A-Za-z0-9-_.,:/()@!&?#+'’\s]+$ Required: Yes Lenses Lenses applied to the review template. Type: Array of strings Length Constraints: Minimum length of 1. Maximum length of 128. Request Body API Version 2020-03-31 35 AWS Well-Architected Tool Required: Yes Notes The notes associated with the workload. API Reference For a review template, these are the notes that will be associated with the workload when the template is applied. Type: String Length Constraints: Maximum length of 2084. Required: No Tags The tags assigned to the review template. Type: String to string map Map Entries: Maximum number of 50 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Value Length Constraints: Minimum length of 0. Maximum length of 256. Required: No TemplateName Name of the review template. Type: String Length Constraints: Minimum length of 3. Maximum length of 100. Pattern: ^[A-Za-z0-9-_.,:/()@!&?#+'’\s]+$ Required: Yes Response Syntax HTTP/1.1 200 Content-type: application/json Response Syntax API Version 2020-03-31 36 AWS Well-Architected Tool API Reference { "TemplateArn": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. TemplateArn The review template ARN. Type: String Length Constraints: Minimum length of 50. Maximum length of 250. Pattern: arn:aws(-us-gov|-iso(-[a-z])?|-cn)?:wellarchitected:[a-z]{2}(- gov|-iso([a-z])?)?-[a-z]+-\d:\d{12}:(review-template)/[a-f0-9]{32} Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException User does not have sufficient access to perform this action. HTTP Status Code: 403 ConflictException The resource has already been processed, was deleted, or is too large. HTTP Status Code: 409 InternalServerException There is a problem with the AWS Well-Architected Tool API service. HTTP Status Code: 500 Response Elements API Version 2020-03-31 37 API Reference AWS Well-Architected Tool ResourceNotFoundException The requested resource was not found. HTTP Status Code: 404 ServiceQuotaExceededException The user has reached their resource quota. HTTP Status Code: 402 ThrottlingException Request was denied due to request throttling. HTTP Status Code: 429 ValidationException The user input is not valid. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2020-03-31 38 AWS Well-Architected Tool API Reference CreateTemplateShare Create a review template share. The owner of a review template can share it with other AWS accounts, users, an organization, and organizational units (OUs) in the same AWS Region. Shared access to a review template |
wellarchitected-api-012 | wellarchitected-api.pdf | 12 | Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2020-03-31 38 AWS Well-Architected Tool API Reference CreateTemplateShare Create a review template share. The owner of a review template can share it with other AWS accounts, users, an organization, and organizational units (OUs) in the same AWS Region. Shared access to a review template is not removed until the review template share invitation is deleted. If you share a review template with an organization or OU, all accounts in the organization or OU are granted access to the review template. Note Disclaimer By sharing your review template with other AWS accounts, you acknowledge that AWS will make your review template available to those other accounts. Request Syntax POST /templates/shares/TemplateArn HTTP/1.1 Content-type: application/json { "ClientRequestToken": "string", "SharedWith": "string" } URI Request Parameters The request uses the following URI parameters. TemplateArn The review template ARN. Length Constraints: Minimum length of 50. Maximum length of 250. CreateTemplateShare API Version 2020-03-31 39 AWS Well-Architected Tool API Reference Pattern: arn:aws(-us-gov|-iso(-[a-z])?|-cn)?:wellarchitected:[a-z]{2}(- gov|-iso([a-z])?)?-[a-z]+-\d:\d{12}:(review-template)/[a-f0-9]{32} Required: Yes Request Body The request accepts the following data in JSON format. ClientRequestToken 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 AWS SDKs automatically generate one for you. If you are not using the AWS SDK or the AWS CLI, you must provide this token or the request will fail. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: ^[\x00-\x7F]*$ Required: Yes SharedWith The AWS account ID, organization ID, or organizational unit (OU) ID with which the workload, lens, profile, or review template is shared. Type: String Length Constraints: Minimum length of 12. Maximum length of 2048. Request Body API Version 2020-03-31 40 API Reference AWS Well-Architected Tool Required: Yes Response Syntax HTTP/1.1 200 Content-type: application/json { "ShareId": "string", "TemplateArn": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ShareId The ID associated with the share. Type: String Pattern: [0-9a-f]{32} TemplateArn The review template ARN. Type: String Length Constraints: Minimum length of 50. Maximum length of 250. Pattern: arn:aws(-us-gov|-iso(-[a-z])?|-cn)?:wellarchitected:[a-z]{2}(- gov|-iso([a-z])?)?-[a-z]+-\d:\d{12}:(review-template)/[a-f0-9]{32} Errors For information about the errors that are common to all actions, see Common Errors. Response Syntax API Version 2020-03-31 41 AWS Well-Architected Tool AccessDeniedException API Reference User does not have sufficient access to perform this action. HTTP Status Code: 403 ConflictException The resource has already been processed, was deleted, or is too large. HTTP Status Code: 409 InternalServerException There is a problem with the AWS Well-Architected Tool API service. HTTP Status Code: 500 ResourceNotFoundException The requested resource was not found. HTTP Status Code: 404 ServiceQuotaExceededException The user has reached their resource quota. HTTP Status Code: 402 ThrottlingException Request was denied due to request throttling. HTTP Status Code: 429 ValidationException The user input is not valid. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: See Also API Version 2020-03-31 42 API Reference AWS Well-Architected Tool • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2020-03-31 43 AWS Well-Architected Tool CreateWorkload Create a new workload. API Reference The owner of a workload can share the workload with other AWS accounts, users, an organization, and organizational units (OUs) in the same AWS Region. Only the owner of a workload can delete it. For more information, see Defining a Workload in the AWS Well-Architected Tool User Guide. Important Either AwsRegions, NonAwsRegions, or both must be specified when creating a workload. You also must specify ReviewOwner, even though the parameter is listed as not being required in the following section. When creating a workload using a review template, you must have the following IAM permissions: • wellarchitected:GetReviewTemplate • wellarchitected:GetReviewTemplateAnswer • wellarchitected:ListReviewTemplateAnswers • wellarchitected:GetReviewTemplateLensReview Request Syntax POST /workloads HTTP/1.1 Content-type: application/json { "AccountIds": [ "string" ], "Applications": [ "string" ], "ArchitecturalDesign": "string", |
wellarchitected-api-013 | wellarchitected-api.pdf | 13 | the same AWS Region. Only the owner of a workload can delete it. For more information, see Defining a Workload in the AWS Well-Architected Tool User Guide. Important Either AwsRegions, NonAwsRegions, or both must be specified when creating a workload. You also must specify ReviewOwner, even though the parameter is listed as not being required in the following section. When creating a workload using a review template, you must have the following IAM permissions: • wellarchitected:GetReviewTemplate • wellarchitected:GetReviewTemplateAnswer • wellarchitected:ListReviewTemplateAnswers • wellarchitected:GetReviewTemplateLensReview Request Syntax POST /workloads HTTP/1.1 Content-type: application/json { "AccountIds": [ "string" ], "Applications": [ "string" ], "ArchitecturalDesign": "string", "AwsRegions": [ "string" ], "ClientRequestToken": "string", "Description": "string", "DiscoveryConfig": { CreateWorkload API Version 2020-03-31 44 AWS Well-Architected Tool API Reference "TrustedAdvisorIntegrationStatus": "string", "WorkloadResourceDefinition": [ "string" ] }, "Environment": "string", "Industry": "string", "IndustryType": "string", "JiraConfiguration": { "IssueManagementStatus": "string", "IssueManagementType": "string", "JiraProjectKey": "string" }, "Lenses": [ "string" ], "NonAwsRegions": [ "string" ], "Notes": "string", "PillarPriorities": [ "string" ], "ProfileArns": [ "string" ], "ReviewOwner": "string", "ReviewTemplateArns": [ "string" ], "Tags": { "string" : "string" }, "WorkloadName": "string" } URI Request Parameters The request does not use any URI parameters. Request Body The request accepts the following data in JSON format. AccountIds The list of AWS account IDs associated with the workload. Type: Array of strings Array Members: Maximum number of 100 items. Length Constraints: Fixed length of 12. Pattern: [0-9]{12} URI Request Parameters API Version 2020-03-31 45 API Reference AWS Well-Architected Tool Required: No Applications List of AppRegistry application ARNs associated to the workload. Type: Array of strings Array Members: Maximum number of 1 item. Length Constraints: Maximum length of 2084. Pattern: arn:aws[-a-z]*:servicecatalog:[a-z]{2}(-gov)?-[a-z]+-\d:\d{12}:/ applications/[a-z0-9]+ Required: No ArchitecturalDesign The URL of the architectural design for the workload. Type: String Length Constraints: Maximum length of 2048. Pattern: ^(|(https?|ftp):\/\/[^\s/$.?#].[^\s]*)$ Required: No AwsRegions The list of AWS Regions associated with the workload, for example, us-east-2, or ca- central-1. Type: Array of strings Array Members: Maximum number of 50 items. Length Constraints: Maximum length of 100. Required: No ClientRequestToken A unique case-sensitive string used to ensure that this request is idempotent (executes only once). Request Body API Version 2020-03-31 46 AWS Well-Architected Tool API Reference 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 AWS SDKs automatically generate one for you. If you are not using the AWS SDK or the AWS CLI, you must provide this token or the request will fail. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: ^[\x00-\x7F]*$ Required: Yes Description The description for the workload. Type: String Length Constraints: Minimum length of 3. Maximum length of 250. Required: Yes DiscoveryConfig Well-Architected discovery configuration settings associated to the workload. Type: WorkloadDiscoveryConfig object Required: No Environment The environment for the workload. Type: String Valid Values: PRODUCTION | PREPRODUCTION Request Body API Version 2020-03-31 47 API Reference AWS Well-Architected Tool Required: Yes Industry The industry for the workload. Type: String Length Constraints: Maximum length of 100. Required: No IndustryType The industry type for the workload. If specified, must be one of the following: • Agriculture • Automobile • Defense • Design and Engineering • Digital Advertising • Education • Environmental Protection • Financial Services • Gaming • General Public Services • Healthcare • Hospitality • InfoTech • Justice and Public Safety • Life Sciences • Manufacturing • Media & Entertainment • Mining & Resources • Oil & Gas Request Body API Version 2020-03-31 48 AWS Well-Architected Tool API Reference • Power & Utilities • Professional Services • Real Estate & Construction • Retail & Wholesale • Social Protection • Telecommunications • Travel, Transportation & Logistics • Other Type: String Length Constraints: Maximum length of 100. Required: No JiraConfiguration Jira configuration settings when creating a workload. Type: WorkloadJiraConfigurationInput object Required: No Lenses The list of lenses associated with the workload. Each lens is identified by its LensSummary:LensAlias. If a review template that specifies lenses is applied to the workload, those lenses are applied to the workload in addition to these lenses. Type: Array of strings Length Constraints: Minimum length of 1. Maximum length of 128. Required: Yes NonAwsRegions The list of non-AWS Regions associated with the workload. Type: Array of strings Request Body API Version 2020-03-31 49 AWS Well-Architected Tool API Reference Array Members: Maximum number of 5 items. Length Constraints: Minimum length of 3. Maximum length of 25. Required: No Notes The notes associated with the workload. For a review template, these are the notes that will be associated with the workload when the template is applied. Type: String Length Constraints: Maximum length of 2084. |
wellarchitected-api-014 | wellarchitected-api.pdf | 14 | in addition to these lenses. Type: Array of strings Length Constraints: Minimum length of 1. Maximum length of 128. Required: Yes NonAwsRegions The list of non-AWS Regions associated with the workload. Type: Array of strings Request Body API Version 2020-03-31 49 AWS Well-Architected Tool API Reference Array Members: Maximum number of 5 items. Length Constraints: Minimum length of 3. Maximum length of 25. Required: No Notes The notes associated with the workload. For a review template, these are the notes that will be associated with the workload when the template is applied. Type: String Length Constraints: Maximum length of 2084. Required: No PillarPriorities The priorities of the pillars, which are used to order items in the improvement plan. Each pillar is represented by its PillarReviewSummary:PillarId. Type: Array of strings Length Constraints: Minimum length of 1. Maximum length of 64. Required: No ProfileArns The list of profile ARNs associated with the workload. Type: Array of strings Array Members: Maximum number of 1 item. Length Constraints: Maximum length of 2084. Pattern: arn:aws[-a-z]*:wellarchitected:[a-z]{2}(-gov)?-[a-z]+-\d: \d{12}:profile/[a-z0-9]+ Required: No Request Body API Version 2020-03-31 50 AWS Well-Architected Tool ReviewOwner API Reference 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 Length Constraints: Minimum length of 3. Maximum length of 255. Required: No ReviewTemplateArns The list of review template ARNs to associate with the workload. Type: Array of strings Array Members: Maximum number of 1 item. Length Constraints: Minimum length of 50. Maximum length of 250. Pattern: arn:aws(-us-gov|-iso(-[a-z])?|-cn)?:wellarchitected:[a-z]{2}(- gov|-iso([a-z])?)?-[a-z]+-\d:\d{12}:(review-template)/[a-f0-9]{32} Required: No Tags The tags to be associated with the workload. Type: String to string map Map Entries: Maximum number of 50 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Value Length Constraints: Minimum length of 0. Maximum length of 256. Required: No WorkloadName The name of the workload. The name must be unique within an account within an AWS Region. Spaces and capitalization are ignored when checking for uniqueness. Request Body API Version 2020-03-31 51 AWS Well-Architected Tool Type: String API Reference Length Constraints: Minimum length of 3. Maximum length of 100. Required: Yes Response Syntax HTTP/1.1 200 Content-type: application/json { "WorkloadArn": "string", "WorkloadId": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. WorkloadArn The ARN for the workload. Type: String WorkloadId The ID assigned to the workload. This ID is unique within an AWS Region. Type: String Length Constraints: Fixed length of 32. Pattern: [0-9a-f]{32} Errors For information about the errors that are common to all actions, see Common Errors. Response Syntax API Version 2020-03-31 52 AWS Well-Architected Tool AccessDeniedException API Reference User does not have sufficient access to perform this action. HTTP Status Code: 403 ConflictException The resource has already been processed, was deleted, or is too large. HTTP Status Code: 409 InternalServerException There is a problem with the AWS Well-Architected Tool API service. HTTP Status Code: 500 ResourceNotFoundException The requested resource was not found. HTTP Status Code: 404 ServiceQuotaExceededException The user has reached their resource quota. HTTP Status Code: 402 ThrottlingException Request was denied due to request throttling. HTTP Status Code: 429 ValidationException The user input is not valid. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: See Also API Version 2020-03-31 53 API Reference AWS Well-Architected Tool • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2020-03-31 54 AWS Well-Architected Tool API Reference CreateWorkloadShare Create a workload share. The owner of a workload can share it with other AWS accounts and users in the same AWS 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 AWS Well-Architected Tool User Guide. Request Syntax POST /workloads/WorkloadId/shares HTTP/1.1 Content-type: application/json { "ClientRequestToken": "string", "PermissionType": "string", "SharedWith": "string" } URI Request Parameters The request uses the following URI parameters. WorkloadId The ID assigned to the workload. This ID is unique within an AWS Region. Length Constraints: Fixed length of 32. Pattern: [0-9a-f]{32} Required: Yes Request Body The request accepts the following data in JSON format. CreateWorkloadShare API Version 2020-03-31 55 AWS Well-Architected Tool ClientRequestToken API Reference A unique case-sensitive string used to ensure that |
wellarchitected-api-015 | wellarchitected-api.pdf | 15 | are granted access to the workload. For more information, see Sharing a workload in the AWS Well-Architected Tool User Guide. Request Syntax POST /workloads/WorkloadId/shares HTTP/1.1 Content-type: application/json { "ClientRequestToken": "string", "PermissionType": "string", "SharedWith": "string" } URI Request Parameters The request uses the following URI parameters. WorkloadId The ID assigned to the workload. This ID is unique within an AWS Region. Length Constraints: Fixed length of 32. Pattern: [0-9a-f]{32} Required: Yes Request Body The request accepts the following data in JSON format. CreateWorkloadShare API Version 2020-03-31 55 AWS Well-Architected Tool ClientRequestToken API Reference 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 AWS SDKs automatically generate one for you. If you are not using the AWS SDK or the AWS CLI, you must provide this token or the request will fail. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: ^[\x00-\x7F]*$ Required: Yes PermissionType Permission granted on a share request. Type: String Valid Values: READONLY | CONTRIBUTOR Required: Yes SharedWith The AWS account ID, organization ID, or organizational unit (OU) ID with which the workload, lens, profile, or review template is shared. Type: String Length Constraints: Minimum length of 12. Maximum length of 2048. Required: Yes Request Body API Version 2020-03-31 56 API Reference AWS Well-Architected Tool Response Syntax HTTP/1.1 200 Content-type: application/json { "ShareId": "string", "WorkloadId": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ShareId The ID associated with the share. Type: String Pattern: [0-9a-f]{32} WorkloadId The ID assigned to the workload. This ID is unique within an AWS Region. Type: String Length Constraints: Fixed length of 32. Pattern: [0-9a-f]{32} Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException User does not have sufficient access to perform this action. Response Syntax API Version 2020-03-31 57 AWS Well-Architected Tool HTTP Status Code: 403 ConflictException The resource has already been processed, was deleted, or is too large. HTTP Status Code: 409 InternalServerException There is a problem with the AWS Well-Architected Tool API service. API Reference HTTP Status Code: 500 ResourceNotFoundException The requested resource was not found. HTTP Status Code: 404 ServiceQuotaExceededException The user has reached their resource quota. HTTP Status Code: 402 ThrottlingException Request was denied due to request throttling. HTTP Status Code: 429 ValidationException The user input is not valid. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET See Also API Version 2020-03-31 58 API Reference AWS Well-Architected Tool • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2020-03-31 59 AWS Well-Architected Tool DeleteLens Delete an existing lens. API Reference Only the owner of a lens can delete it. After the lens is deleted, AWS 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 AWS accounts, you acknowledge that AWS 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 AWS account or terminate your AWS account. Request Syntax DELETE /lenses/LensAlias?ClientRequestToken=ClientRequestToken&LensStatus=LensStatus HTTP/1.1 URI Request Parameters The request uses the following URI parameters. ClientRequestToken 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. DeleteLens API Version 2020-03-31 60 AWS Well-Architected Tool API Reference Important This token is listed as required, however, if you do not specify it, the AWS SDKs automatically generate one for you. If you are not using the AWS SDK or the AWS CLI, you must provide this token or the request will fail. Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: ^[\x00-\x7F]*$ |
wellarchitected-api-016 | wellarchitected-api.pdf | 16 | 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. DeleteLens API Version 2020-03-31 60 AWS Well-Architected Tool API Reference Important This token is listed as required, however, if you do not specify it, the AWS SDKs automatically generate one for you. If you are not using the AWS SDK or the AWS CLI, you must provide this token or the request will fail. Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: ^[\x00-\x7F]*$ Required: Yes LensAlias The alias of the lens. For AWS official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on AWS official lenses. For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us- west-2:123456789012:lens/0123456789abcdef01234567890abcdef. Each lens is identified by its LensSummary:LensAlias. Length Constraints: Minimum length of 1. Maximum length of 128. Required: Yes LensStatus The status of the lens to be deleted. Valid Values: ALL | DRAFT | PUBLISHED Required: Yes Request Body The request does not have a request body. Request Body API Version 2020-03-31 61 AWS Well-Architected Tool Response Syntax HTTP/1.1 200 Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException User does not have sufficient access to perform this action. HTTP Status Code: 403 ConflictException The resource has already been processed, was deleted, or is too large. HTTP Status Code: 409 InternalServerException There is a problem with the AWS Well-Architected Tool API service. HTTP Status Code: 500 ResourceNotFoundException The requested resource was not found. HTTP Status Code: 404 ThrottlingException Request was denied due to request throttling. HTTP Status Code: 429 ValidationException The user input is not valid. Response Syntax API Version 2020-03-31 62 AWS Well-Architected Tool HTTP Status Code: 400 See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2020-03-31 63 AWS Well-Architected Tool DeleteLensShare Delete a lens share. API Reference After the lens share is deleted, AWS 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 AWS accounts, you acknowledge that AWS 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 AWS account or terminate your AWS account. Request Syntax DELETE /lenses/LensAlias/shares/ShareId?ClientRequestToken=ClientRequestToken HTTP/1.1 URI Request Parameters The request uses the following URI parameters. ClientRequestToken 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 AWS SDKs automatically generate one for you. If you are not using the AWS SDK or the AWS CLI, you must provide this token or the request will fail. DeleteLensShare API Version 2020-03-31 64 AWS Well-Architected Tool API Reference Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: ^[\x00-\x7F]*$ Required: Yes LensAlias The alias of the lens. For AWS official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on AWS official lenses. For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us- west-2:123456789012:lens/0123456789abcdef01234567890abcdef. Each lens is identified by its LensSummary:LensAlias. Length Constraints: Minimum length of 1. Maximum length of 128. Required: Yes ShareId The ID associated with the share. Pattern: [0-9a-f]{32} Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Request Body API Version 2020-03-31 65 AWS Well-Architected Tool Errors API Reference For information |
wellarchitected-api-017 | wellarchitected-api.pdf | 17 | ExportLens and CreateLensShare) are not permitted on AWS official lenses. For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us- west-2:123456789012:lens/0123456789abcdef01234567890abcdef. Each lens is identified by its LensSummary:LensAlias. Length Constraints: Minimum length of 1. Maximum length of 128. Required: Yes ShareId The ID associated with the share. Pattern: [0-9a-f]{32} Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Request Body API Version 2020-03-31 65 AWS Well-Architected Tool Errors API Reference For information about the errors that are common to all actions, see Common Errors. AccessDeniedException User does not have sufficient access to perform this action. HTTP Status Code: 403 ConflictException The resource has already been processed, was deleted, or is too large. HTTP Status Code: 409 InternalServerException There is a problem with the AWS Well-Architected Tool API service. HTTP Status Code: 500 ResourceNotFoundException The requested resource was not found. HTTP Status Code: 404 ThrottlingException Request was denied due to request throttling. HTTP Status Code: 429 ValidationException The user input is not valid. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface Errors API Version 2020-03-31 66 API Reference AWS Well-Architected Tool • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2020-03-31 67 AWS Well-Architected Tool DeleteProfile Delete a profile. Note API Reference Disclaimer By sharing your profile with other AWS accounts, you acknowledge that AWS 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 AWS account or terminate your AWS account. Request Syntax DELETE /profiles/ProfileArn?ClientRequestToken=ClientRequestToken HTTP/1.1 URI Request Parameters The request uses the following URI parameters. ClientRequestToken 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 AWS SDKs automatically generate one for you. If you are not using the AWS SDK or the AWS CLI, you must provide this token or the request will fail. Length Constraints: Minimum length of 1. Maximum length of 2048. DeleteProfile API Version 2020-03-31 68 AWS Well-Architected Tool Pattern: ^[\x00-\x7F]*$ Required: Yes ProfileArn The profile ARN. API Reference Length Constraints: Maximum length of 2084. Pattern: arn:aws[-a-z]*:wellarchitected:[a-z]{2}(-gov)?-[a-z]+-\d: \d{12}:profile/[a-z0-9]+ Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException User does not have sufficient access to perform this action. HTTP Status Code: 403 ConflictException The resource has already been processed, was deleted, or is too large. HTTP Status Code: 409 Request Body API Version 2020-03-31 69 AWS Well-Architected Tool InternalServerException API Reference There is a problem with the AWS Well-Architected Tool API service. HTTP Status Code: 500 ResourceNotFoundException The requested resource was not found. HTTP Status Code: 404 ThrottlingException Request was denied due to request throttling. HTTP Status Code: 429 ValidationException The user input is not valid. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2020-03-31 70 AWS Well-Architected Tool DeleteProfileShare Delete a profile share. Request Syntax API Reference DELETE /profiles/ProfileArn/shares/ShareId?ClientRequestToken=ClientRequestToken HTTP/1.1 URI Request Parameters The request uses the following URI parameters. ClientRequestToken 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 |
wellarchitected-api-018 | wellarchitected-api.pdf | 18 | for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2020-03-31 70 AWS Well-Architected Tool DeleteProfileShare Delete a profile share. Request Syntax API Reference DELETE /profiles/ProfileArn/shares/ShareId?ClientRequestToken=ClientRequestToken HTTP/1.1 URI Request Parameters The request uses the following URI parameters. ClientRequestToken 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 AWS SDKs automatically generate one for you. If you are not using the AWS SDK or the AWS CLI, you must provide this token or the request will fail. Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: ^[\x00-\x7F]*$ Required: Yes ProfileArn The profile ARN. Length Constraints: Maximum length of 2084. DeleteProfileShare API Version 2020-03-31 71 AWS Well-Architected Tool API Reference Pattern: arn:aws[-a-z]*:wellarchitected:[a-z]{2}(-gov)?-[a-z]+-\d: \d{12}:profile/[a-z0-9]+ Required: Yes ShareId The ID associated with the share. Pattern: [0-9a-f]{32} Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException User does not have sufficient access to perform this action. HTTP Status Code: 403 ConflictException The resource has already been processed, was deleted, or is too large. HTTP Status Code: 409 InternalServerException There is a problem with the AWS Well-Architected Tool API service. Request Body API Version 2020-03-31 72 API Reference AWS Well-Architected Tool HTTP Status Code: 500 ResourceNotFoundException The requested resource was not found. HTTP Status Code: 404 ThrottlingException Request was denied due to request throttling. HTTP Status Code: 429 ValidationException The user input is not valid. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2020-03-31 73 AWS Well-Architected Tool API Reference DeleteReviewTemplate Delete a review template. Only the owner of a review template can delete it. After the review template is deleted, AWS accounts, users, organizations, and organizational units (OUs) that you shared the review template with will no longer be able to apply it to new workloads. Request Syntax DELETE /reviewTemplates/TemplateArn?ClientRequestToken=ClientRequestToken HTTP/1.1 URI Request Parameters The request uses the following URI parameters. ClientRequestToken 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 AWS SDKs automatically generate one for you. If you are not using the AWS SDK or the AWS CLI, you must provide this token or the request will fail. Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: ^[\x00-\x7F]*$ Required: Yes TemplateArn The review template ARN. DeleteReviewTemplate API Version 2020-03-31 74 AWS Well-Architected Tool API Reference Length Constraints: Minimum length of 50. Maximum length of 250. Pattern: arn:aws(-us-gov|-iso(-[a-z])?|-cn)?:wellarchitected:[a-z]{2}(- gov|-iso([a-z])?)?-[a-z]+-\d:\d{12}:(review-template)/[a-f0-9]{32} Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException User does not have sufficient access to perform this action. HTTP Status Code: 403 ConflictException The resource has already been processed, was deleted, or is too large. HTTP Status Code: 409 InternalServerException There is a problem with the AWS Well-Architected Tool API service. HTTP Status Code: 500 ResourceNotFoundException The requested resource was not found. Request Body API Version 2020-03-31 75 API Reference AWS Well-Architected Tool HTTP Status Code: 404 ThrottlingException Request was denied due to request throttling. HTTP Status Code: 429 ValidationException The user input is not valid. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • |
wellarchitected-api-019 | wellarchitected-api.pdf | 19 | deleted, or is too large. HTTP Status Code: 409 InternalServerException There is a problem with the AWS Well-Architected Tool API service. HTTP Status Code: 500 ResourceNotFoundException The requested resource was not found. Request Body API Version 2020-03-31 75 API Reference AWS Well-Architected Tool HTTP Status Code: 404 ThrottlingException Request was denied due to request throttling. HTTP Status Code: 429 ValidationException The user input is not valid. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2020-03-31 76 AWS Well-Architected Tool API Reference DeleteTemplateShare Delete a review template share. After the review template share is deleted, AWS accounts, users, organizations, and organizational units (OUs) that you shared the review template with will no longer be able to apply it to new workloads. Request Syntax DELETE /templates/shares/TemplateArn/ShareId?ClientRequestToken=ClientRequestToken HTTP/1.1 URI Request Parameters The request uses the following URI parameters. ClientRequestToken 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 AWS SDKs automatically generate one for you. If you are not using the AWS SDK or the AWS CLI, you must provide this token or the request will fail. Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: ^[\x00-\x7F]*$ Required: Yes DeleteTemplateShare API Version 2020-03-31 77 API Reference AWS Well-Architected Tool ShareId The ID associated with the share. Pattern: [0-9a-f]{32} Required: Yes TemplateArn The review template ARN. Length Constraints: Minimum length of 50. Maximum length of 250. Pattern: arn:aws(-us-gov|-iso(-[a-z])?|-cn)?:wellarchitected:[a-z]{2}(- gov|-iso([a-z])?)?-[a-z]+-\d:\d{12}:(review-template)/[a-f0-9]{32} Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException User does not have sufficient access to perform this action. HTTP Status Code: 403 Request Body API Version 2020-03-31 78 AWS Well-Architected Tool ConflictException API Reference The resource has already been processed, was deleted, or is too large. HTTP Status Code: 409 InternalServerException There is a problem with the AWS Well-Architected Tool API service. HTTP Status Code: 500 ResourceNotFoundException The requested resource was not found. HTTP Status Code: 404 ThrottlingException Request was denied due to request throttling. HTTP Status Code: 429 ValidationException The user input is not valid. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin See Also API Version 2020-03-31 79 AWS Well-Architected Tool • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2020-03-31 80 AWS Well-Architected Tool DeleteWorkload Delete an existing workload. Request Syntax API Reference DELETE /workloads/WorkloadId?ClientRequestToken=ClientRequestToken HTTP/1.1 URI Request Parameters The request uses the following URI parameters. ClientRequestToken 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 AWS SDKs automatically generate one for you. If you are not using the AWS SDK or the AWS CLI, you must provide this token or the request will fail. Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: ^[\x00-\x7F]*$ Required: Yes WorkloadId The ID assigned to the workload. This ID is unique within an AWS Region. Length Constraints: Fixed length of 32. Pattern: [0-9a-f]{32} DeleteWorkload API Version 2020-03-31 81 API Reference AWS Well-Architected Tool Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Response Elements If the action is successful, the service sends back an HTTP 200 response |
wellarchitected-api-020 | wellarchitected-api.pdf | 20 | If you are not using the AWS SDK or the AWS CLI, you must provide this token or the request will fail. Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: ^[\x00-\x7F]*$ Required: Yes WorkloadId The ID assigned to the workload. This ID is unique within an AWS Region. Length Constraints: Fixed length of 32. Pattern: [0-9a-f]{32} DeleteWorkload API Version 2020-03-31 81 API Reference AWS Well-Architected Tool Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException User does not have sufficient access to perform this action. HTTP Status Code: 403 ConflictException The resource has already been processed, was deleted, or is too large. HTTP Status Code: 409 InternalServerException There is a problem with the AWS Well-Architected Tool API service. HTTP Status Code: 500 ResourceNotFoundException The requested resource was not found. HTTP Status Code: 404 Request Body API Version 2020-03-31 82 AWS Well-Architected Tool ThrottlingException Request was denied due to request throttling. API Reference HTTP Status Code: 429 ValidationException The user input is not valid. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2020-03-31 83 AWS Well-Architected Tool API Reference DeleteWorkloadShare Delete a workload share. Request Syntax DELETE /workloads/WorkloadId/shares/ShareId?ClientRequestToken=ClientRequestToken HTTP/1.1 URI Request Parameters The request uses the following URI parameters. ClientRequestToken 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 AWS SDKs automatically generate one for you. If you are not using the AWS SDK or the AWS CLI, you must provide this token or the request will fail. Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: ^[\x00-\x7F]*$ Required: Yes ShareId The ID associated with the share. Pattern: [0-9a-f]{32} DeleteWorkloadShare API Version 2020-03-31 84 AWS Well-Architected Tool Required: Yes WorkloadId API Reference The ID assigned to the workload. This ID is unique within an AWS Region. Length Constraints: Fixed length of 32. Pattern: [0-9a-f]{32} Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException User does not have sufficient access to perform this action. HTTP Status Code: 403 ConflictException The resource has already been processed, was deleted, or is too large. HTTP Status Code: 409 InternalServerException There is a problem with the AWS Well-Architected Tool API service. Request Body API Version 2020-03-31 85 API Reference AWS Well-Architected Tool HTTP Status Code: 500 ResourceNotFoundException The requested resource was not found. HTTP Status Code: 404 ThrottlingException Request was denied due to request throttling. HTTP Status Code: 429 ValidationException The user input is not valid. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2020-03-31 86 AWS Well-Architected Tool DisassociateLenses Disassociate a lens from a workload. API Reference Up to 10 lenses can be disassociated from a workload in a single API operation. Note The AWS Well-Architected Framework lens (wellarchitected) cannot be removed from a workload. Request Syntax PATCH /workloads/WorkloadId/disassociateLenses HTTP/1.1 Content-type: application/json { "LensAliases": [ "string" ] } URI Request Parameters The request uses the following URI parameters. WorkloadId The ID assigned to the workload. This ID is unique within an AWS Region. Length Constraints: Fixed length of 32. Pattern: [0-9a-f]{32} Required: Yes Request Body The request accepts the following data in JSON format. DisassociateLenses |
wellarchitected-api-021 | wellarchitected-api.pdf | 21 | AWS Well-Architected Tool DisassociateLenses Disassociate a lens from a workload. API Reference Up to 10 lenses can be disassociated from a workload in a single API operation. Note The AWS Well-Architected Framework lens (wellarchitected) cannot be removed from a workload. Request Syntax PATCH /workloads/WorkloadId/disassociateLenses HTTP/1.1 Content-type: application/json { "LensAliases": [ "string" ] } URI Request Parameters The request uses the following URI parameters. WorkloadId The ID assigned to the workload. This ID is unique within an AWS Region. Length Constraints: Fixed length of 32. Pattern: [0-9a-f]{32} Required: Yes Request Body The request accepts the following data in JSON format. DisassociateLenses API Version 2020-03-31 87 AWS Well-Architected Tool LensAliases API Reference List of lens aliases to associate or disassociate with a workload. Up to 10 lenses can be specified. Identify a lens using its LensSummary:LensAlias. Type: Array of strings Array Members: Minimum number of 1 item. Length Constraints: Minimum length of 1. Maximum length of 128. Required: Yes Response Syntax HTTP/1.1 200 Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException User does not have sufficient access to perform this action. HTTP Status Code: 403 ConflictException The resource has already been processed, was deleted, or is too large. HTTP Status Code: 409 InternalServerException There is a problem with the AWS Well-Architected Tool API service. HTTP Status Code: 500 Response Syntax API Version 2020-03-31 88 API Reference AWS Well-Architected Tool ResourceNotFoundException The requested resource was not found. HTTP Status Code: 404 ThrottlingException Request was denied due to request throttling. HTTP Status Code: 429 ValidationException The user input is not valid. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2020-03-31 89 API Reference AWS Well-Architected Tool DisassociateProfiles Disassociate a profile from a workload. Request Syntax PATCH /workloads/WorkloadId/disassociateProfiles HTTP/1.1 Content-type: application/json { "ProfileArns": [ "string" ] } URI Request Parameters The request uses the following URI parameters. WorkloadId The ID assigned to the workload. This ID is unique within an AWS Region. Length Constraints: Fixed length of 32. Pattern: [0-9a-f]{32} Required: Yes Request Body The request accepts the following data in JSON format. ProfileArns The list of profile ARNs to disassociate from the workload. Type: Array of strings Array Members: Minimum number of 1 item. Length Constraints: Maximum length of 2084. DisassociateProfiles API Version 2020-03-31 90 AWS Well-Architected Tool API Reference Pattern: arn:aws[-a-z]*:wellarchitected:[a-z]{2}(-gov)?-[a-z]+-\d: \d{12}:profile/[a-z0-9]+ Required: Yes Response Syntax HTTP/1.1 200 Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException User does not have sufficient access to perform this action. HTTP Status Code: 403 ConflictException The resource has already been processed, was deleted, or is too large. HTTP Status Code: 409 InternalServerException There is a problem with the AWS Well-Architected Tool API service. HTTP Status Code: 500 ResourceNotFoundException The requested resource was not found. HTTP Status Code: 404 ThrottlingException Request was denied due to request throttling. Response Syntax API Version 2020-03-31 91 AWS Well-Architected Tool HTTP Status Code: 429 ValidationException The user input is not valid. HTTP Status Code: 400 See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2020-03-31 92 AWS Well-Architected Tool ExportLens Export an existing lens. API Reference Only the owner of a lens can export it. Lenses provided by AWS (AWS Official Content) cannot be exported. Lenses are defined in JSON. For more information, see JSON format specification in the AWS Well- Architected Tool User Guide. Note 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 |
wellarchitected-api-022 | wellarchitected-api.pdf | 22 | an existing lens. API Reference Only the owner of a lens can export it. Lenses provided by AWS (AWS Official Content) cannot be exported. Lenses are defined in JSON. For more information, see JSON format specification in the AWS Well- Architected Tool User Guide. Note 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. Request Syntax GET /lenses/LensAlias/export?LensVersion=LensVersion HTTP/1.1 URI Request Parameters The request uses the following URI parameters. LensAlias The alias of the lens. For AWS official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on AWS official lenses. For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us- west-2:123456789012:lens/0123456789abcdef01234567890abcdef. Each lens is identified by its LensSummary:LensAlias. ExportLens API Version 2020-03-31 93 AWS Well-Architected Tool API Reference Length Constraints: Minimum length of 1. Maximum length of 128. Required: Yes LensVersion The lens version to be exported. Length Constraints: Minimum length of 1. Maximum length of 32. Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "LensJSON": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. LensJSON The JSON representation of a lens. Type: String Length Constraints: Minimum length of 2. Maximum length of 500000. Errors For information about the errors that are common to all actions, see Common Errors. Request Body API Version 2020-03-31 94 AWS Well-Architected Tool AccessDeniedException API Reference User does not have sufficient access to perform this action. HTTP Status Code: 403 InternalServerException There is a problem with the AWS Well-Architected Tool API service. HTTP Status Code: 500 ResourceNotFoundException The requested resource was not found. HTTP Status Code: 404 ThrottlingException Request was denied due to request throttling. HTTP Status Code: 429 ValidationException The user input is not valid. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin See Also API Version 2020-03-31 95 AWS Well-Architected Tool • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2020-03-31 96 AWS Well-Architected Tool GetAnswer API Reference Get the answer to a specific question in a workload review. Request Syntax GET /workloads/WorkloadId/lensReviews/LensAlias/answers/QuestionId? MilestoneNumber=MilestoneNumber HTTP/1.1 URI Request Parameters The request uses the following URI parameters. LensAlias The alias of the lens. For AWS official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on AWS official lenses. For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us- west-2:123456789012:lens/0123456789abcdef01234567890abcdef. Each lens is identified by its LensSummary:LensAlias. Length Constraints: Minimum length of 1. Maximum length of 128. Required: Yes MilestoneNumber The milestone number. A workload can have a maximum of 100 milestones. Valid Range: Minimum value of 1. Maximum value of 100. QuestionId The ID of the question. Length Constraints: Minimum length of 1. Maximum length of 128. GetAnswer API Version 2020-03-31 97 AWS Well-Architected Tool Required: Yes WorkloadId API Reference The ID assigned to the workload. This ID is unique within an AWS Region. Length Constraints: Fixed length of 32. Pattern: [0-9a-f]{32} Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "Answer": { "ChoiceAnswers": [ { "ChoiceId": "string", "Notes": "string", "Reason": "string", "Status": "string" } ], "Choices": [ { "AdditionalResources": [ { "Content": [ { "DisplayText": "string", "Url": "string" } ], "Type": "string" Request Body API Version 2020-03-31 98 API Reference AWS Well-Architected Tool } ], "ChoiceId": "string", "Description": "string", "HelpfulResource": { "DisplayText": "string", "Url": "string" }, "ImprovementPlan": { "DisplayText": "string", "Url": "string" }, "Title": "string" } ], "HelpfulResourceDisplayText": "string", "HelpfulResourceUrl": "string", "ImprovementPlanUrl": "string", "IsApplicable": boolean, "JiraConfiguration": { "JiraIssueUrl": "string", "LastSyncedTime": number }, "Notes": "string", "PillarId": "string", "QuestionDescription": "string", "QuestionId": "string", "QuestionTitle": "string", "Reason": "string", "Risk": "string", "SelectedChoices": [ "string" ] }, "LensAlias": "string", "LensArn": "string", "MilestoneNumber": number, "WorkloadId": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 |
wellarchitected-api-023 | wellarchitected-api.pdf | 23 | "DisplayText": "string", "Url": "string" } ], "Type": "string" Request Body API Version 2020-03-31 98 API Reference AWS Well-Architected Tool } ], "ChoiceId": "string", "Description": "string", "HelpfulResource": { "DisplayText": "string", "Url": "string" }, "ImprovementPlan": { "DisplayText": "string", "Url": "string" }, "Title": "string" } ], "HelpfulResourceDisplayText": "string", "HelpfulResourceUrl": "string", "ImprovementPlanUrl": "string", "IsApplicable": boolean, "JiraConfiguration": { "JiraIssueUrl": "string", "LastSyncedTime": number }, "Notes": "string", "PillarId": "string", "QuestionDescription": "string", "QuestionId": "string", "QuestionTitle": "string", "Reason": "string", "Risk": "string", "SelectedChoices": [ "string" ] }, "LensAlias": "string", "LensArn": "string", "MilestoneNumber": number, "WorkloadId": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. Response Elements API Version 2020-03-31 99 AWS Well-Architected Tool Answer An answer of the question. Type: Answer object LensAlias The alias of the lens. API Reference For AWS official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on AWS official lenses. For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us- west-2:123456789012:lens/0123456789abcdef01234567890abcdef. Each lens is identified by its LensSummary:LensAlias. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. LensArn The ARN for the lens. Type: String MilestoneNumber The milestone number. A workload can have a maximum of 100 milestones. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. WorkloadId The ID assigned to the workload. This ID is unique within an AWS Region. Type: String Length Constraints: Fixed length of 32. Response Elements API Version 2020-03-31 100 AWS Well-Architected Tool Pattern: [0-9a-f]{32} Errors API Reference For information about the errors that are common to all actions, see Common Errors. AccessDeniedException User does not have sufficient access to perform this action. HTTP Status Code: 403 InternalServerException There is a problem with the AWS Well-Architected Tool API service. HTTP Status Code: 500 ResourceNotFoundException The requested resource was not found. HTTP Status Code: 404 ThrottlingException Request was denied due to request throttling. HTTP Status Code: 429 ValidationException The user input is not valid. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET Errors API Version 2020-03-31 101 API Reference AWS Well-Architected Tool • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2020-03-31 102 AWS Well-Architected Tool API Reference GetConsolidatedReport Get a consolidated report of your workloads. You can optionally choose to include workloads that have been shared with you. Request Syntax GET /consolidatedReport? Format=Format&IncludeSharedResources=IncludeSharedResources&MaxResults=MaxResults&NextToken=NextToken HTTP/1.1 URI Request Parameters The request uses the following URI parameters. Format The format of the consolidated report. For PDF, Base64String is returned. For JSON, Metrics is returned. Valid Values: PDF | JSON Required: Yes IncludeSharedResources Set to true to have shared resources included in the report. MaxResults The maximum number of results to return for this request. Valid Range: Minimum value of 1. Maximum value of 15. NextToken The token to use to retrieve the next set of results. Request Body The request does not have a request body. GetConsolidatedReport API Version 2020-03-31 103 API Reference AWS Well-Architected Tool Response Syntax HTTP/1.1 200 Content-type: application/json { "Base64String": "string", "Metrics": [ { "Lenses": [ { "LensArn": "string", "Pillars": [ { "PillarId": "string", "Questions": [ { "BestPractices": [ { "ChoiceId": "string", "ChoiceTitle": "string" } ], "QuestionId": "string", "Risk": "string" } ], "RiskCounts": { "string" : number } } ], "RiskCounts": { "string" : number } } ], "LensesAppliedCount": number, "MetricType": "string", "RiskCounts": { "string" : number }, "UpdatedAt": number, Response Syntax API Version 2020-03-31 104 AWS Well-Architected Tool API Reference "WorkloadArn": "string", "WorkloadId": "string", "WorkloadName": "string" } ], "NextToken": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. Base64String The Base64-encoded string representation of a lens review report. This data can be used to create a PDF file. Only returned by GetConsolidatedReport when PDF format is requested. Type: String Metrics The metrics that make up the consolidated report. Only returned when JSON format is requested. Type: Array of ConsolidatedReportMetric objects NextToken The token to use to retrieve the next set of results. Type: String Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException User does not have sufficient access to perform this action. Response Elements API Version 2020-03-31 105 API Reference AWS Well-Architected Tool HTTP Status Code: 403 ConflictException The |
wellarchitected-api-024 | wellarchitected-api.pdf | 24 | report. This data can be used to create a PDF file. Only returned by GetConsolidatedReport when PDF format is requested. Type: String Metrics The metrics that make up the consolidated report. Only returned when JSON format is requested. Type: Array of ConsolidatedReportMetric objects NextToken The token to use to retrieve the next set of results. Type: String Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException User does not have sufficient access to perform this action. Response Elements API Version 2020-03-31 105 API Reference AWS Well-Architected Tool HTTP Status Code: 403 ConflictException The resource has already been processed, was deleted, or is too large. HTTP Status Code: 409 InternalServerException There is a problem with the AWS Well-Architected Tool API service. HTTP Status Code: 500 ThrottlingException Request was denied due to request throttling. HTTP Status Code: 429 ValidationException The user input is not valid. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2020-03-31 106 AWS Well-Architected Tool API Reference See Also API Version 2020-03-31 107 API Reference AWS Well-Architected Tool GetGlobalSettings Global settings for all workloads. Request Syntax GET /global-settings HTTP/1.1 URI Request Parameters The request does not use any URI parameters. Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "DiscoveryIntegrationStatus": "string", "JiraConfiguration": { "IntegrationStatus": "string", "IssueManagementStatus": "string", "IssueManagementType": "string", "JiraProjectKey": "string", "StatusMessage": "string", "Subdomain": "string" }, "OrganizationSharingStatus": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. GetGlobalSettings API Version 2020-03-31 108 API Reference AWS Well-Architected Tool DiscoveryIntegrationStatus Discovery integration status. Type: String Valid Values: ENABLED | DISABLED JiraConfiguration Jira configuration status. Type: AccountJiraConfigurationOutput object OrganizationSharingStatus AWS Organizations sharing status. Type: String Valid Values: ENABLED | DISABLED Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException User does not have sufficient access to perform this action. HTTP Status Code: 403 InternalServerException There is a problem with the AWS Well-Architected Tool API service. HTTP Status Code: 500 ThrottlingException Request was denied due to request throttling. HTTP Status Code: 429 ValidationException The user input is not valid. Errors API Version 2020-03-31 109 AWS Well-Architected Tool HTTP Status Code: 400 See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2020-03-31 110 API Reference AWS Well-Architected Tool GetLens Get an existing lens. Request Syntax GET /lenses/LensAlias?LensVersion=LensVersion HTTP/1.1 URI Request Parameters The request uses the following URI parameters. LensAlias The alias of the lens. For AWS official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on AWS official lenses. For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us- west-2:123456789012:lens/0123456789abcdef01234567890abcdef. Each lens is identified by its LensSummary:LensAlias. Length Constraints: Minimum length of 1. Maximum length of 128. Required: Yes LensVersion The lens version to be retrieved. Length Constraints: Minimum length of 1. Maximum length of 32. Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 GetLens API Version 2020-03-31 111 AWS Well-Architected Tool API Reference Content-type: application/json { "Lens": { "Description": "string", "LensArn": "string", "LensVersion": "string", "Name": "string", "Owner": "string", "ShareInvitationId": "string", "Tags": { "string" : "string" } } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. Lens A lens return object. Type: Lens object Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException User does not have sufficient access to perform this action. HTTP Status Code: 403 InternalServerException There is a problem with the AWS Well-Architected Tool API service. HTTP Status Code: 500 Response Elements API Version 2020-03-31 112 API Reference AWS Well-Architected Tool ResourceNotFoundException The requested resource was not found. HTTP Status Code: 404 |
wellarchitected-api-025 | wellarchitected-api.pdf | 25 | If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. Lens A lens return object. Type: Lens object Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException User does not have sufficient access to perform this action. HTTP Status Code: 403 InternalServerException There is a problem with the AWS Well-Architected Tool API service. HTTP Status Code: 500 Response Elements API Version 2020-03-31 112 API Reference AWS Well-Architected Tool ResourceNotFoundException The requested resource was not found. HTTP Status Code: 404 ThrottlingException Request was denied due to request throttling. HTTP Status Code: 429 ValidationException The user input is not valid. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2020-03-31 113 AWS Well-Architected Tool GetLensReview Get lens review. Request Syntax API Reference GET /workloads/WorkloadId/lensReviews/LensAlias?MilestoneNumber=MilestoneNumber HTTP/1.1 URI Request Parameters The request uses the following URI parameters. LensAlias The alias of the lens. For AWS official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on AWS official lenses. For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us- west-2:123456789012:lens/0123456789abcdef01234567890abcdef. Each lens is identified by its LensSummary:LensAlias. Length Constraints: Minimum length of 1. Maximum length of 128. Required: Yes MilestoneNumber The milestone number. A workload can have a maximum of 100 milestones. Valid Range: Minimum value of 1. Maximum value of 100. WorkloadId The ID assigned to the workload. This ID is unique within an AWS Region. Length Constraints: Fixed length of 32. GetLensReview API Version 2020-03-31 114 AWS Well-Architected Tool Pattern: [0-9a-f]{32} Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "LensReview": { "JiraConfiguration": { "SelectedPillars": [ { "PillarId": "string", "SelectedQuestionIds": [ "string" ] } ] }, "LensAlias": "string", "LensArn": "string", "LensName": "string", "LensStatus": "string", "LensVersion": "string", "NextToken": "string", "Notes": "string", "PillarReviewSummaries": [ { "Notes": "string", "PillarId": "string", "PillarName": "string", "PrioritizedRiskCounts": { "string" : number }, "RiskCounts": { "string" : number } } Request Body API Reference API Version 2020-03-31 115 API Reference AWS Well-Architected Tool ], "PrioritizedRiskCounts": { "string" : number }, "Profiles": [ { "ProfileArn": "string", "ProfileVersion": "string" } ], "RiskCounts": { "string" : number }, "UpdatedAt": number }, "MilestoneNumber": number, "WorkloadId": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. LensReview A lens review of a question. Type: LensReview object MilestoneNumber The milestone number. A workload can have a maximum of 100 milestones. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. WorkloadId The ID assigned to the workload. This ID is unique within an AWS Region. Response Elements API Version 2020-03-31 116 API Reference AWS Well-Architected Tool Type: String Length Constraints: Fixed length of 32. Pattern: [0-9a-f]{32} Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException User does not have sufficient access to perform this action. HTTP Status Code: 403 InternalServerException There is a problem with the AWS Well-Architected Tool API service. HTTP Status Code: 500 ResourceNotFoundException The requested resource was not found. HTTP Status Code: 404 ThrottlingException Request was denied due to request throttling. HTTP Status Code: 429 ValidationException The user input is not valid. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: Errors API Version 2020-03-31 117 API Reference AWS Well-Architected Tool • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2020-03-31 118 AWS Well-Architected Tool API Reference GetLensReviewReport Get lens review report. Request Syntax GET /workloads/WorkloadId/lensReviews/LensAlias/report?MilestoneNumber=MilestoneNumber HTTP/1.1 URI Request Parameters The request uses the following URI parameters. LensAlias The alias of the lens. For AWS official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on AWS |
wellarchitected-api-026 | wellarchitected-api.pdf | 26 | V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2020-03-31 118 AWS Well-Architected Tool API Reference GetLensReviewReport Get lens review report. Request Syntax GET /workloads/WorkloadId/lensReviews/LensAlias/report?MilestoneNumber=MilestoneNumber HTTP/1.1 URI Request Parameters The request uses the following URI parameters. LensAlias The alias of the lens. For AWS official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on AWS official lenses. For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us- west-2:123456789012:lens/0123456789abcdef01234567890abcdef. Each lens is identified by its LensSummary:LensAlias. Length Constraints: Minimum length of 1. Maximum length of 128. Required: Yes MilestoneNumber The milestone number. A workload can have a maximum of 100 milestones. Valid Range: Minimum value of 1. Maximum value of 100. WorkloadId The ID assigned to the workload. This ID is unique within an AWS Region. Length Constraints: Fixed length of 32. GetLensReviewReport API Version 2020-03-31 119 API Reference AWS Well-Architected Tool Pattern: [0-9a-f]{32} Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "LensReviewReport": { "Base64String": "string", "LensAlias": "string", "LensArn": "string" }, "MilestoneNumber": number, "WorkloadId": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. LensReviewReport A report of a lens review. Type: LensReviewReport object MilestoneNumber The milestone number. A workload can have a maximum of 100 milestones. Type: Integer Request Body API Version 2020-03-31 120 AWS Well-Architected Tool API Reference Valid Range: Minimum value of 1. Maximum value of 100. WorkloadId The ID assigned to the workload. This ID is unique within an AWS Region. Type: String Length Constraints: Fixed length of 32. Pattern: [0-9a-f]{32} Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException User does not have sufficient access to perform this action. HTTP Status Code: 403 InternalServerException There is a problem with the AWS Well-Architected Tool API service. HTTP Status Code: 500 ResourceNotFoundException The requested resource was not found. HTTP Status Code: 404 ThrottlingException Request was denied due to request throttling. HTTP Status Code: 429 ValidationException The user input is not valid. HTTP Status Code: 400 Errors API Version 2020-03-31 121 AWS Well-Architected Tool See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2020-03-31 122 AWS Well-Architected Tool API Reference GetLensVersionDifference Get lens version differences. Request Syntax GET /lenses/LensAlias/versionDifference? BaseLensVersion=BaseLensVersion&TargetLensVersion=TargetLensVersion HTTP/1.1 URI Request Parameters The request uses the following URI parameters. BaseLensVersion The base version of the lens. Length Constraints: Minimum length of 1. Maximum length of 32. LensAlias The alias of the lens. For AWS official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on AWS official lenses. For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us- west-2:123456789012:lens/0123456789abcdef01234567890abcdef. Each lens is identified by its LensSummary:LensAlias. Length Constraints: Minimum length of 1. Maximum length of 128. Required: Yes TargetLensVersion The lens version to target a difference for. Length Constraints: Minimum length of 1. Maximum length of 32. GetLensVersionDifference API Version 2020-03-31 123 API Reference AWS Well-Architected Tool Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "BaseLensVersion": "string", "LatestLensVersion": "string", "LensAlias": "string", "LensArn": "string", "TargetLensVersion": "string", "VersionDifferences": { "PillarDifferences": [ { "DifferenceStatus": "string", "PillarId": "string", "PillarName": "string", "QuestionDifferences": [ { "DifferenceStatus": "string", "QuestionId": "string", "QuestionTitle": "string" } ] } ] } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. BaseLensVersion The base version of the lens. Request Body API Version 2020-03-31 124 AWS Well-Architected Tool Type: String API Reference Length Constraints: Minimum length of 1. Maximum length of 32. LatestLensVersion The latest version of the lens. Type: String Length Constraints: Minimum length of 1. Maximum length of 32. LensAlias The alias of the lens. For AWS official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted |
wellarchitected-api-027 | wellarchitected-api.pdf | 27 | 200 response. The following data is returned in JSON format by the service. BaseLensVersion The base version of the lens. Request Body API Version 2020-03-31 124 AWS Well-Architected Tool Type: String API Reference Length Constraints: Minimum length of 1. Maximum length of 32. LatestLensVersion The latest version of the lens. Type: String Length Constraints: Minimum length of 1. Maximum length of 32. LensAlias The alias of the lens. For AWS official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on AWS official lenses. For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us- west-2:123456789012:lens/0123456789abcdef01234567890abcdef. Each lens is identified by its LensSummary:LensAlias. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. LensArn The ARN for the lens. Type: String TargetLensVersion The target lens version for the lens. Type: String Length Constraints: Minimum length of 1. Maximum length of 32. VersionDifferences The differences between the base and latest versions of the lens. Response Elements API Version 2020-03-31 125 AWS Well-Architected Tool API Reference Type: VersionDifferences object Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException User does not have sufficient access to perform this action. HTTP Status Code: 403 InternalServerException There is a problem with the AWS Well-Architected Tool API service. HTTP Status Code: 500 ResourceNotFoundException The requested resource was not found. HTTP Status Code: 404 ThrottlingException Request was denied due to request throttling. HTTP Status Code: 429 ValidationException The user input is not valid. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET Errors API Version 2020-03-31 126 API Reference AWS Well-Architected Tool • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2020-03-31 127 API Reference AWS Well-Architected Tool GetMilestone Get a milestone for an existing workload. Request Syntax GET /workloads/WorkloadId/milestones/MilestoneNumber HTTP/1.1 URI Request Parameters The request uses the following URI parameters. MilestoneNumber The milestone number. A workload can have a maximum of 100 milestones. Valid Range: Minimum value of 1. Maximum value of 100. Required: Yes WorkloadId The ID assigned to the workload. This ID is unique within an AWS Region. Length Constraints: Fixed length of 32. Pattern: [0-9a-f]{32} Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "Milestone": { GetMilestone API Version 2020-03-31 128 AWS Well-Architected Tool API Reference "MilestoneName": "string", "MilestoneNumber": number, "RecordedAt": number, "Workload": { "AccountIds": [ "string" ], "Applications": [ "string" ], "ArchitecturalDesign": "string", "AwsRegions": [ "string" ], "Description": "string", "DiscoveryConfig": { "TrustedAdvisorIntegrationStatus": "string", "WorkloadResourceDefinition": [ "string" ] }, "Environment": "string", "ImprovementStatus": "string", "Industry": "string", "IndustryType": "string", "IsReviewOwnerUpdateAcknowledged": boolean, "JiraConfiguration": { "IssueManagementStatus": "string", "IssueManagementType": "string", "JiraProjectKey": "string", "StatusMessage": "string" }, "Lenses": [ "string" ], "NonAwsRegions": [ "string" ], "Notes": "string", "Owner": "string", "PillarPriorities": [ "string" ], "PrioritizedRiskCounts": { "string" : number }, "Profiles": [ { "ProfileArn": "string", "ProfileVersion": "string" } ], "ReviewOwner": "string", "ReviewRestrictionDate": number, "RiskCounts": { "string" : number }, "ShareInvitationId": "string", Response Syntax API Version 2020-03-31 129 AWS Well-Architected Tool API Reference "Tags": { "string" : "string" }, "UpdatedAt": number, "WorkloadArn": "string", "WorkloadId": "string", "WorkloadName": "string" } }, "WorkloadId": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. Milestone A milestone return object. Type: Milestone object WorkloadId The ID assigned to the workload. This ID is unique within an AWS Region. Type: String Length Constraints: Fixed length of 32. Pattern: [0-9a-f]{32} Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException User does not have sufficient access to perform this action. HTTP Status Code: 403 Response Elements API Version 2020-03-31 130 AWS Well-Architected Tool InternalServerException API Reference There is a problem with the AWS Well-Architected Tool API service. HTTP Status Code: 500 ResourceNotFoundException The requested resource was not found. HTTP Status Code: 404 ThrottlingException Request was denied due to request throttling. HTTP Status Code: 429 ValidationException The user input is not valid. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin |
wellarchitected-api-028 | wellarchitected-api.pdf | 28 | AWS Well-Architected Tool API service. HTTP Status Code: 500 ResourceNotFoundException The requested resource was not found. HTTP Status Code: 404 ThrottlingException Request was denied due to request throttling. HTTP Status Code: 429 ValidationException The user input is not valid. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2020-03-31 131 AWS Well-Architected Tool GetProfile Get profile information. Request Syntax API Reference GET /profiles/ProfileArn?ProfileVersion=ProfileVersion HTTP/1.1 URI Request Parameters The request uses the following URI parameters. ProfileArn The profile ARN. Length Constraints: Maximum length of 2084. Pattern: arn:aws[-a-z]*:wellarchitected:[a-z]{2}(-gov)?-[a-z]+-\d: \d{12}:profile/[a-z0-9]+ Required: Yes ProfileVersion The profile version. Length Constraints: Minimum length of 1. Maximum length of 32. Pattern: ^[A-Za-z0-9-]+$ Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { GetProfile API Version 2020-03-31 132 AWS Well-Architected Tool API Reference "Profile": { "CreatedAt": number, "Owner": "string", "ProfileArn": "string", "ProfileDescription": "string", "ProfileName": "string", "ProfileQuestions": [ { "MaxSelectedChoices": number, "MinSelectedChoices": number, "QuestionChoices": [ { "ChoiceDescription": "string", "ChoiceId": "string", "ChoiceTitle": "string" } ], "QuestionDescription": "string", "QuestionId": "string", "QuestionTitle": "string", "SelectedChoiceIds": [ "string" ] } ], "ProfileVersion": "string", "ShareInvitationId": "string", "Tags": { "string" : "string" }, "UpdatedAt": number } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. Profile The profile. Type: Profile object Response Elements API Version 2020-03-31 133 AWS Well-Architected Tool Errors API Reference For information about the errors that are common to all actions, see Common Errors. AccessDeniedException User does not have sufficient access to perform this action. HTTP Status Code: 403 InternalServerException There is a problem with the AWS Well-Architected Tool API service. HTTP Status Code: 500 ResourceNotFoundException The requested resource was not found. HTTP Status Code: 404 ThrottlingException Request was denied due to request throttling. HTTP Status Code: 429 ValidationException The user input is not valid. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 Errors API Version 2020-03-31 134 AWS Well-Architected Tool • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2020-03-31 135 AWS Well-Architected Tool GetProfileTemplate Get profile template. Request Syntax GET /profileTemplate HTTP/1.1 URI Request Parameters The request does not use any URI parameters. Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "ProfileTemplate": { "CreatedAt": number, "TemplateName": "string", "TemplateQuestions": [ { "MaxSelectedChoices": number, "MinSelectedChoices": number, "QuestionChoices": [ { "ChoiceDescription": "string", "ChoiceId": "string", "ChoiceTitle": "string" } ], "QuestionDescription": "string", "QuestionId": "string", "QuestionTitle": "string" } ], GetProfileTemplate API Reference API Version 2020-03-31 136 AWS Well-Architected Tool "UpdatedAt": number } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. API Reference ProfileTemplate The profile template. Type: ProfileTemplate object Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException User does not have sufficient access to perform this action. HTTP Status Code: 403 InternalServerException There is a problem with the AWS Well-Architected Tool API service. HTTP Status Code: 500 ResourceNotFoundException The requested resource was not found. HTTP Status Code: 404 ThrottlingException Request was denied due to request throttling. HTTP Status Code: 429 Response Elements API Version 2020-03-31 137 AWS Well-Architected Tool ValidationException The user input is not valid. HTTP Status Code: 400 See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2020-03-31 138 AWS Well-Architected Tool API Reference GetReviewTemplate Get review template. Request Syntax GET /reviewTemplates/TemplateArn HTTP/1.1 URI Request Parameters The request uses the following URI parameters. TemplateArn The review template ARN. Length Constraints: Minimum length of |
wellarchitected-api-029 | wellarchitected-api.pdf | 29 | AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2020-03-31 138 AWS Well-Architected Tool API Reference GetReviewTemplate Get review template. Request Syntax GET /reviewTemplates/TemplateArn HTTP/1.1 URI Request Parameters The request uses the following URI parameters. TemplateArn The review template ARN. Length Constraints: Minimum length of 50. Maximum length of 250. Pattern: arn:aws(-us-gov|-iso(-[a-z])?|-cn)?:wellarchitected:[a-z]{2}(- gov|-iso([a-z])?)?-[a-z]+-\d:\d{12}:(review-template)/[a-f0-9]{32} Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "ReviewTemplate": { "Description": "string", "Lenses": [ "string" ], "Notes": "string", "Owner": "string", "QuestionCounts": { "string" : number GetReviewTemplate API Version 2020-03-31 139 AWS Well-Architected Tool API Reference }, "ShareInvitationId": "string", "Tags": { "string" : "string" }, "TemplateArn": "string", "TemplateName": "string", "UpdatedAt": number, "UpdateStatus": "string" } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ReviewTemplate The review template. Type: ReviewTemplate object Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException User does not have sufficient access to perform this action. HTTP Status Code: 403 InternalServerException There is a problem with the AWS Well-Architected Tool API service. HTTP Status Code: 500 ResourceNotFoundException The requested resource was not found. Response Elements API Version 2020-03-31 140 API Reference AWS Well-Architected Tool HTTP Status Code: 404 ThrottlingException Request was denied due to request throttling. HTTP Status Code: 429 ValidationException The user input is not valid. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2020-03-31 141 AWS Well-Architected Tool API Reference GetReviewTemplateAnswer Get review template answer. Request Syntax GET /reviewTemplates/TemplateArn/lensReviews/LensAlias/answers/QuestionId HTTP/1.1 URI Request Parameters The request uses the following URI parameters. LensAlias The alias of the lens. For AWS official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on AWS official lenses. For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us- west-2:123456789012:lens/0123456789abcdef01234567890abcdef. Each lens is identified by its LensSummary:LensAlias. Length Constraints: Minimum length of 1. Maximum length of 128. Required: Yes QuestionId The ID of the question. Length Constraints: Minimum length of 1. Maximum length of 128. Required: Yes TemplateArn The review template ARN. Length Constraints: Minimum length of 50. Maximum length of 250. GetReviewTemplateAnswer API Version 2020-03-31 142 AWS Well-Architected Tool API Reference Pattern: arn:aws(-us-gov|-iso(-[a-z])?|-cn)?:wellarchitected:[a-z]{2}(- gov|-iso([a-z])?)?-[a-z]+-\d:\d{12}:(review-template)/[a-f0-9]{32} Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "Answer": { "AnswerStatus": "string", "ChoiceAnswers": [ { "ChoiceId": "string", "Notes": "string", "Reason": "string", "Status": "string" } ], "Choices": [ { "AdditionalResources": [ { "Content": [ { "DisplayText": "string", "Url": "string" } ], "Type": "string" } ], "ChoiceId": "string", "Description": "string", "HelpfulResource": { "DisplayText": "string", Request Body API Version 2020-03-31 143 AWS Well-Architected Tool API Reference "Url": "string" }, "ImprovementPlan": { "DisplayText": "string", "Url": "string" }, "Title": "string" } ], "HelpfulResourceDisplayText": "string", "HelpfulResourceUrl": "string", "ImprovementPlanUrl": "string", "IsApplicable": boolean, "Notes": "string", "PillarId": "string", "QuestionDescription": "string", "QuestionId": "string", "QuestionTitle": "string", "Reason": "string", "SelectedChoices": [ "string" ] }, "LensAlias": "string", "TemplateArn": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. Answer An answer of the question. Type: ReviewTemplateAnswer object LensAlias The alias of the lens. For AWS official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on AWS official lenses. Response Elements API Version 2020-03-31 144 AWS Well-Architected Tool API Reference For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us- west-2:123456789012:lens/0123456789abcdef01234567890abcdef. Each lens is identified by its LensSummary:LensAlias. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. TemplateArn The review template ARN. Type: String Length Constraints: Minimum length of 50. Maximum length of 250. Pattern: arn:aws(-us-gov|-iso(-[a-z])?|-cn)?:wellarchitected:[a-z]{2}(- gov|-iso([a-z])?)?-[a-z]+-\d:\d{12}:(review-template)/[a-f0-9]{32} Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException User does not have sufficient access |
wellarchitected-api-030 | wellarchitected-api.pdf | 30 | Note that some operations (such as ExportLens and CreateLensShare) are not permitted on AWS official lenses. Response Elements API Version 2020-03-31 144 AWS Well-Architected Tool API Reference For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us- west-2:123456789012:lens/0123456789abcdef01234567890abcdef. Each lens is identified by its LensSummary:LensAlias. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. TemplateArn The review template ARN. Type: String Length Constraints: Minimum length of 50. Maximum length of 250. Pattern: arn:aws(-us-gov|-iso(-[a-z])?|-cn)?:wellarchitected:[a-z]{2}(- gov|-iso([a-z])?)?-[a-z]+-\d:\d{12}:(review-template)/[a-f0-9]{32} Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException User does not have sufficient access to perform this action. HTTP Status Code: 403 InternalServerException There is a problem with the AWS Well-Architected Tool API service. HTTP Status Code: 500 ResourceNotFoundException The requested resource was not found. HTTP Status Code: 404 ThrottlingException Request was denied due to request throttling. Errors API Version 2020-03-31 145 AWS Well-Architected Tool HTTP Status Code: 429 ValidationException The user input is not valid. HTTP Status Code: 400 See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2020-03-31 146 AWS Well-Architected Tool API Reference GetReviewTemplateLensReview Get a lens review associated with a review template. Request Syntax GET /reviewTemplates/TemplateArn/lensReviews/LensAlias HTTP/1.1 URI Request Parameters The request uses the following URI parameters. LensAlias The alias of the lens. For AWS official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on AWS official lenses. For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us- west-2:123456789012:lens/0123456789abcdef01234567890abcdef. Each lens is identified by its LensSummary:LensAlias. Length Constraints: Minimum length of 1. Maximum length of 128. Required: Yes TemplateArn The review template ARN. Length Constraints: Minimum length of 50. Maximum length of 250. Pattern: arn:aws(-us-gov|-iso(-[a-z])?|-cn)?:wellarchitected:[a-z]{2}(- gov|-iso([a-z])?)?-[a-z]+-\d:\d{12}:(review-template)/[a-f0-9]{32} Required: Yes Request Body The request does not have a request body. GetReviewTemplateLensReview API Version 2020-03-31 147 API Reference AWS Well-Architected Tool Response Syntax HTTP/1.1 200 Content-type: application/json { "LensReview": { "LensAlias": "string", "LensArn": "string", "LensName": "string", "LensStatus": "string", "LensVersion": "string", "NextToken": "string", "Notes": "string", "PillarReviewSummaries": [ { "Notes": "string", "PillarId": "string", "PillarName": "string", "QuestionCounts": { "string" : number } } ], "QuestionCounts": { "string" : number }, "UpdatedAt": number }, "TemplateArn": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. LensReview A lens review of a question. Type: ReviewTemplateLensReview object Response Syntax API Version 2020-03-31 148 AWS Well-Architected Tool TemplateArn The review template ARN. Type: String API Reference Length Constraints: Minimum length of 50. Maximum length of 250. Pattern: arn:aws(-us-gov|-iso(-[a-z])?|-cn)?:wellarchitected:[a-z]{2}(- gov|-iso([a-z])?)?-[a-z]+-\d:\d{12}:(review-template)/[a-f0-9]{32} Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException User does not have sufficient access to perform this action. HTTP Status Code: 403 InternalServerException There is a problem with the AWS Well-Architected Tool API service. HTTP Status Code: 500 ResourceNotFoundException The requested resource was not found. HTTP Status Code: 404 ThrottlingException Request was denied due to request throttling. HTTP Status Code: 429 ValidationException The user input is not valid. HTTP Status Code: 400 Errors API Version 2020-03-31 149 AWS Well-Architected Tool See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2020-03-31 150 API Reference AWS Well-Architected Tool GetWorkload Get an existing workload. Request Syntax GET /workloads/WorkloadId HTTP/1.1 URI Request Parameters The request uses the following URI parameters. WorkloadId The ID assigned to the workload. This ID is unique within an AWS Region. Length Constraints: Fixed length of 32. Pattern: [0-9a-f]{32} Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "Workload": { "AccountIds": [ "string" ], "Applications": [ "string" ], "ArchitecturalDesign": "string", "AwsRegions": [ "string" ], "Description": "string", "DiscoveryConfig": { "TrustedAdvisorIntegrationStatus": "string", "WorkloadResourceDefinition": [ "string" ] }, GetWorkload API Version 2020-03-31 151 AWS Well-Architected Tool API Reference "Environment": "string", "ImprovementStatus": "string", "Industry": "string", "IndustryType": "string", "IsReviewOwnerUpdateAcknowledged": boolean, "JiraConfiguration": { "IssueManagementStatus": "string", "IssueManagementType": "string", |
wellarchitected-api-031 | wellarchitected-api.pdf | 31 | uses the following URI parameters. WorkloadId The ID assigned to the workload. This ID is unique within an AWS Region. Length Constraints: Fixed length of 32. Pattern: [0-9a-f]{32} Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "Workload": { "AccountIds": [ "string" ], "Applications": [ "string" ], "ArchitecturalDesign": "string", "AwsRegions": [ "string" ], "Description": "string", "DiscoveryConfig": { "TrustedAdvisorIntegrationStatus": "string", "WorkloadResourceDefinition": [ "string" ] }, GetWorkload API Version 2020-03-31 151 AWS Well-Architected Tool API Reference "Environment": "string", "ImprovementStatus": "string", "Industry": "string", "IndustryType": "string", "IsReviewOwnerUpdateAcknowledged": boolean, "JiraConfiguration": { "IssueManagementStatus": "string", "IssueManagementType": "string", "JiraProjectKey": "string", "StatusMessage": "string" }, "Lenses": [ "string" ], "NonAwsRegions": [ "string" ], "Notes": "string", "Owner": "string", "PillarPriorities": [ "string" ], "PrioritizedRiskCounts": { "string" : number }, "Profiles": [ { "ProfileArn": "string", "ProfileVersion": "string" } ], "ReviewOwner": "string", "ReviewRestrictionDate": number, "RiskCounts": { "string" : number }, "ShareInvitationId": "string", "Tags": { "string" : "string" }, "UpdatedAt": number, "WorkloadArn": "string", "WorkloadId": "string", "WorkloadName": "string" } } Response Syntax API Version 2020-03-31 152 AWS Well-Architected Tool Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. Workload A workload return object. Type: Workload object Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException User does not have sufficient access to perform this action. HTTP Status Code: 403 InternalServerException There is a problem with the AWS Well-Architected Tool API service. HTTP Status Code: 500 ResourceNotFoundException The requested resource was not found. HTTP Status Code: 404 ThrottlingException Request was denied due to request throttling. HTTP Status Code: 429 ValidationException The user input is not valid. HTTP Status Code: 400 Response Elements API Version 2020-03-31 153 AWS Well-Architected Tool See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2020-03-31 154 AWS Well-Architected Tool ImportLens API Reference 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 AWS accounts until it's published with CreateLensVersion. Lenses are defined in JSON. For more information, see JSON format specification in the AWS Well- Architected Tool User Guide. A custom lens cannot exceed 500 KB in size. Note 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. Request Syntax PUT /importLens HTTP/1.1 Content-type: application/json { "ClientRequestToken": "string", "JSONString": "string", "LensAlias": "string", "Tags": { "string" : "string" } } ImportLens API Version 2020-03-31 155 AWS Well-Architected Tool API Reference URI Request Parameters The request does not use any URI parameters. Request Body The request accepts the following data in JSON format. ClientRequestToken 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 AWS SDKs automatically generate one for you. If you are not using the AWS SDK or the AWS CLI, you must provide this token or the request will fail. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: ^[\x00-\x7F]*$ Required: Yes JSONString The JSON representation of a lens. Type: String Length Constraints: Minimum length of 2. Maximum length of 500000. Required: Yes URI Request Parameters API Version 2020-03-31 156 AWS Well-Architected Tool LensAlias The alias of the lens. API Reference For AWS official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on AWS official lenses. For custom lenses, this is the lens |
wellarchitected-api-032 | wellarchitected-api.pdf | 32 | will fail. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: ^[\x00-\x7F]*$ Required: Yes JSONString The JSON representation of a lens. Type: String Length Constraints: Minimum length of 2. Maximum length of 500000. Required: Yes URI Request Parameters API Version 2020-03-31 156 AWS Well-Architected Tool LensAlias The alias of the lens. API Reference For AWS official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on AWS official lenses. For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us- west-2:123456789012:lens/0123456789abcdef01234567890abcdef. Each lens is identified by its LensSummary:LensAlias. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Required: No Tags Tags to associate to a lens. Type: String to string map Map Entries: Maximum number of 50 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Value Length Constraints: Minimum length of 0. Maximum length of 256. Required: No Response Syntax HTTP/1.1 200 Content-type: application/json { "LensArn": "string", "Status": "string" } Response Syntax API Version 2020-03-31 157 AWS Well-Architected Tool Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. LensArn The ARN for the lens that was created or updated. Type: String Status The status of the imported lens. Type: String Valid Values: IN_PROGRESS | COMPLETE | ERROR Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException User does not have sufficient access to perform this action. HTTP Status Code: 403 ConflictException The resource has already been processed, was deleted, or is too large. HTTP Status Code: 409 InternalServerException There is a problem with the AWS Well-Architected Tool API service. HTTP Status Code: 500 ResourceNotFoundException The requested resource was not found. Response Elements API Version 2020-03-31 158 AWS Well-Architected Tool API Reference HTTP Status Code: 404 ServiceQuotaExceededException The user has reached their resource quota. HTTP Status Code: 402 ThrottlingException Request was denied due to request throttling. HTTP Status Code: 429 ValidationException The user input is not valid. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2020-03-31 159 AWS Well-Architected Tool ListAnswers List of answers for a particular workload and lens. Request Syntax API Reference GET /workloads/WorkloadId/lensReviews/LensAlias/answers? MaxResults=MaxResults&MilestoneNumber=MilestoneNumber&NextToken=NextToken&PillarId=PillarId&QuestionPriority=QuestionPriority HTTP/1.1 URI Request Parameters The request uses the following URI parameters. LensAlias The alias of the lens. For AWS official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on AWS official lenses. For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us- west-2:123456789012:lens/0123456789abcdef01234567890abcdef. Each lens is identified by its LensSummary:LensAlias. Length Constraints: Minimum length of 1. Maximum length of 128. Required: Yes MaxResults The maximum number of results to return for this request. Valid Range: Minimum value of 1. Maximum value of 50. MilestoneNumber The milestone number. A workload can have a maximum of 100 milestones. Valid Range: Minimum value of 1. Maximum value of 100. ListAnswers API Version 2020-03-31 160 AWS Well-Architected Tool NextToken API Reference The token to use to retrieve the next set of results. PillarId The ID used to identify a pillar, for example, security. A pillar is identified by its PillarReviewSummary:PillarId. Length Constraints: Minimum length of 1. Maximum length of 64. QuestionPriority The priority of the question. Valid Values: PRIORITIZED | NONE WorkloadId The ID assigned to the workload. This ID is unique within an AWS Region. Length Constraints: Fixed length of 32. Pattern: [0-9a-f]{32} Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "AnswerSummaries": [ { "ChoiceAnswerSummaries": [ { "ChoiceId": "string", "Reason": "string", "Status": "string" } Request Body API Version 2020-03-31 161 API Reference AWS Well-Architected Tool ], "Choices": [ { "AdditionalResources": [ { "Content": [ { "DisplayText": "string", "Url": "string" } ], "Type": "string" } ], "ChoiceId": "string", "Description": "string", "HelpfulResource": { "DisplayText": "string", "Url": "string" }, "ImprovementPlan": { "DisplayText": "string", "Url": "string" }, "Title": "string" } ], "IsApplicable": boolean, "JiraConfiguration": { "JiraIssueUrl": "string", "LastSyncedTime": number }, "PillarId": "string", "QuestionId": "string", "QuestionTitle": "string", "QuestionType": "string", "Reason": "string", "Risk": "string", "SelectedChoices": [ "string" ] } ], "LensAlias": "string", "LensArn": "string", "MilestoneNumber": number, Response Syntax API |
wellarchitected-api-033 | wellarchitected-api.pdf | 33 | { "ChoiceAnswerSummaries": [ { "ChoiceId": "string", "Reason": "string", "Status": "string" } Request Body API Version 2020-03-31 161 API Reference AWS Well-Architected Tool ], "Choices": [ { "AdditionalResources": [ { "Content": [ { "DisplayText": "string", "Url": "string" } ], "Type": "string" } ], "ChoiceId": "string", "Description": "string", "HelpfulResource": { "DisplayText": "string", "Url": "string" }, "ImprovementPlan": { "DisplayText": "string", "Url": "string" }, "Title": "string" } ], "IsApplicable": boolean, "JiraConfiguration": { "JiraIssueUrl": "string", "LastSyncedTime": number }, "PillarId": "string", "QuestionId": "string", "QuestionTitle": "string", "QuestionType": "string", "Reason": "string", "Risk": "string", "SelectedChoices": [ "string" ] } ], "LensAlias": "string", "LensArn": "string", "MilestoneNumber": number, Response Syntax API Version 2020-03-31 162 API Reference AWS Well-Architected Tool "NextToken": "string", "WorkloadId": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. AnswerSummaries List of answer summaries of lens review in a workload. Type: Array of AnswerSummary objects LensAlias The alias of the lens. For AWS official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on AWS official lenses. For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us- west-2:123456789012:lens/0123456789abcdef01234567890abcdef. Each lens is identified by its LensSummary:LensAlias. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. LensArn The ARN for the lens. Type: String MilestoneNumber The milestone number. A workload can have a maximum of 100 milestones. Response Elements API Version 2020-03-31 163 API Reference AWS Well-Architected Tool Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. NextToken The token to use to retrieve the next set of results. Type: String WorkloadId The ID assigned to the workload. This ID is unique within an AWS Region. Type: String Length Constraints: Fixed length of 32. Pattern: [0-9a-f]{32} Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException User does not have sufficient access to perform this action. HTTP Status Code: 403 InternalServerException There is a problem with the AWS Well-Architected Tool API service. HTTP Status Code: 500 ResourceNotFoundException The requested resource was not found. HTTP Status Code: 404 ThrottlingException Request was denied due to request throttling. Errors API Version 2020-03-31 164 AWS Well-Architected Tool HTTP Status Code: 429 ValidationException The user input is not valid. HTTP Status Code: 400 See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2020-03-31 165 AWS Well-Architected Tool ListCheckDetails API Reference List of Trusted Advisor check details by account related to the workload. Request Syntax POST /workloads/WorkloadId/checks HTTP/1.1 Content-type: application/json { "ChoiceId": "string", "LensArn": "string", "MaxResults": number, "NextToken": "string", "PillarId": "string", "QuestionId": "string" } URI Request Parameters The request uses the following URI parameters. WorkloadId The ID assigned to the workload. This ID is unique within an AWS Region. Length Constraints: Fixed length of 32. Pattern: [0-9a-f]{32} Required: Yes Request Body The request accepts the following data in JSON format. ChoiceId The ID of a choice. Type: String ListCheckDetails API Version 2020-03-31 166 AWS Well-Architected Tool API Reference Length Constraints: Minimum length of 1. Maximum length of 64. Required: Yes LensArn Well-Architected Lens ARN. Type: String Required: Yes MaxResults The maximum number of results to return for this request. Type: Integer Valid Range: Minimum value of 1. Maximum value of 50. Required: No NextToken The token to use to retrieve the next set of results. Type: String Required: No PillarId The ID used to identify a pillar, for example, security. A pillar is identified by its PillarReviewSummary:PillarId. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Required: Yes QuestionId The ID of the question. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Request Body API Version 2020-03-31 167 API Reference AWS Well-Architected Tool Required: Yes Response Syntax HTTP/1.1 200 Content-type: application/json { "CheckDetails": [ { "AccountId": "string", "ChoiceId": "string", "Description": "string", "FlaggedResources": number, "Id": "string", "LensArn": "string", "Name": "string", "PillarId": "string", "Provider": "string", "QuestionId": "string", "Reason": "string", "Status": "string", "UpdatedAt": number } ], "NextToken": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. CheckDetails The details about the Trusted Advisor checks related to the Well-Architected best practice. Type: Array of CheckDetail objects NextToken The token to use to |
wellarchitected-api-034 | wellarchitected-api.pdf | 34 | 167 API Reference AWS Well-Architected Tool Required: Yes Response Syntax HTTP/1.1 200 Content-type: application/json { "CheckDetails": [ { "AccountId": "string", "ChoiceId": "string", "Description": "string", "FlaggedResources": number, "Id": "string", "LensArn": "string", "Name": "string", "PillarId": "string", "Provider": "string", "QuestionId": "string", "Reason": "string", "Status": "string", "UpdatedAt": number } ], "NextToken": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. CheckDetails The details about the Trusted Advisor checks related to the Well-Architected best practice. Type: Array of CheckDetail objects NextToken The token to use to retrieve the next set of results. Response Syntax API Version 2020-03-31 168 AWS Well-Architected Tool Type: String Errors API Reference For information about the errors that are common to all actions, see Common Errors. AccessDeniedException User does not have sufficient access to perform this action. HTTP Status Code: 403 InternalServerException There is a problem with the AWS Well-Architected Tool API service. HTTP Status Code: 500 ResourceNotFoundException The requested resource was not found. HTTP Status Code: 404 ThrottlingException Request was denied due to request throttling. HTTP Status Code: 429 ValidationException The user input is not valid. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET Errors API Version 2020-03-31 169 API Reference AWS Well-Architected Tool • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2020-03-31 170 AWS Well-Architected Tool API Reference ListCheckSummaries List of Trusted Advisor checks summarized for all accounts related to the workload. Request Syntax POST /workloads/WorkloadId/checkSummaries HTTP/1.1 Content-type: application/json { "ChoiceId": "string", "LensArn": "string", "MaxResults": number, "NextToken": "string", "PillarId": "string", "QuestionId": "string" } URI Request Parameters The request uses the following URI parameters. WorkloadId The ID assigned to the workload. This ID is unique within an AWS Region. Length Constraints: Fixed length of 32. Pattern: [0-9a-f]{32} Required: Yes Request Body The request accepts the following data in JSON format. ChoiceId The ID of a choice. Type: String ListCheckSummaries API Version 2020-03-31 171 AWS Well-Architected Tool API Reference Length Constraints: Minimum length of 1. Maximum length of 64. Required: Yes LensArn Well-Architected Lens ARN. Type: String Required: Yes MaxResults The maximum number of results to return for this request. Type: Integer Valid Range: Minimum value of 1. Maximum value of 50. Required: No NextToken The token to use to retrieve the next set of results. Type: String Required: No PillarId The ID used to identify a pillar, for example, security. A pillar is identified by its PillarReviewSummary:PillarId. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Required: Yes QuestionId The ID of the question. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Request Body API Version 2020-03-31 172 API Reference AWS Well-Architected Tool Required: Yes Response Syntax HTTP/1.1 200 Content-type: application/json { "CheckSummaries": [ { "AccountSummary": { "string" : number }, "ChoiceId": "string", "Description": "string", "Id": "string", "LensArn": "string", "Name": "string", "PillarId": "string", "Provider": "string", "QuestionId": "string", "Status": "string", "UpdatedAt": number } ], "NextToken": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. CheckSummaries List of Trusted Advisor summaries related to the Well-Architected best practice. Type: Array of CheckSummary objects NextToken The token to use to retrieve the next set of results. Response Syntax API Version 2020-03-31 173 AWS Well-Architected Tool Type: String Errors API Reference For information about the errors that are common to all actions, see Common Errors. AccessDeniedException User does not have sufficient access to perform this action. HTTP Status Code: 403 InternalServerException There is a problem with the AWS Well-Architected Tool API service. HTTP Status Code: 500 ResourceNotFoundException The requested resource was not found. HTTP Status Code: 404 ThrottlingException Request was denied due to request throttling. HTTP Status Code: 429 ValidationException The user input is not valid. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET Errors API Version 2020-03-31 174 API Reference AWS Well-Architected Tool • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2020-03-31 175 AWS Well-Architected Tool ListLenses |
wellarchitected-api-035 | wellarchitected-api.pdf | 35 | not valid. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET Errors API Version 2020-03-31 174 API Reference AWS Well-Architected Tool • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2020-03-31 175 AWS Well-Architected Tool ListLenses List the available lenses. Request Syntax GET /lenses? API Reference LensName=LensName&LensStatus=LensStatus&LensType=LensType&MaxResults=MaxResults&NextToken=NextToken HTTP/1.1 URI Request Parameters The request uses the following URI parameters. LensName The full name of the lens. Length Constraints: Minimum length of 1. Maximum length of 128. LensStatus The status of lenses to be returned. Valid Values: ALL | DRAFT | PUBLISHED LensType The type of lenses to be returned. Valid Values: AWS_OFFICIAL | CUSTOM_SHARED | CUSTOM_SELF MaxResults The maximum number of results to return for this request. Valid Range: Minimum value of 1. Maximum value of 50. NextToken The token to use to retrieve the next set of results. Request Body The request does not have a request body. ListLenses API Version 2020-03-31 176 API Reference AWS Well-Architected Tool Response Syntax HTTP/1.1 200 Content-type: application/json { "LensSummaries": [ { "CreatedAt": number, "Description": "string", "LensAlias": "string", "LensArn": "string", "LensName": "string", "LensStatus": "string", "LensType": "string", "LensVersion": "string", "Owner": "string", "UpdatedAt": number } ], "NextToken": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. LensSummaries List of lens summaries of available lenses. Type: Array of LensSummary objects NextToken The token to use to retrieve the next set of results. Type: String Response Syntax API Version 2020-03-31 177 AWS Well-Architected Tool Errors API Reference For information about the errors that are common to all actions, see Common Errors. AccessDeniedException User does not have sufficient access to perform this action. HTTP Status Code: 403 InternalServerException There is a problem with the AWS Well-Architected Tool API service. HTTP Status Code: 500 ThrottlingException Request was denied due to request throttling. HTTP Status Code: 429 ValidationException The user input is not valid. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 Errors API Version 2020-03-31 178 AWS Well-Architected Tool • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2020-03-31 179 AWS Well-Architected Tool API Reference ListLensReviewImprovements List the improvements of a particular lens review. Request Syntax GET /workloads/WorkloadId/lensReviews/LensAlias/improvements? MaxResults=MaxResults&MilestoneNumber=MilestoneNumber&NextToken=NextToken&PillarId=PillarId&QuestionPriority=QuestionPriority HTTP/1.1 URI Request Parameters The request uses the following URI parameters. LensAlias The alias of the lens. For AWS official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on AWS official lenses. For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us- west-2:123456789012:lens/0123456789abcdef01234567890abcdef. Each lens is identified by its LensSummary:LensAlias. Length Constraints: Minimum length of 1. Maximum length of 128. Required: Yes MaxResults The maximum number of results to return for this request. Valid Range: Minimum value of 1. Maximum value of 100. MilestoneNumber The milestone number. A workload can have a maximum of 100 milestones. ListLensReviewImprovements API Version 2020-03-31 180 AWS Well-Architected Tool API Reference Valid Range: Minimum value of 1. Maximum value of 100. NextToken The token to use to retrieve the next set of results. PillarId The ID used to identify a pillar, for example, security. A pillar is identified by its PillarReviewSummary:PillarId. Length Constraints: Minimum length of 1. Maximum length of 64. QuestionPriority The priority of the question. Valid Values: PRIORITIZED | NONE WorkloadId The ID assigned to the workload. This ID is unique within an AWS Region. Length Constraints: Fixed length of 32. Pattern: [0-9a-f]{32} Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "ImprovementSummaries": [ { "ImprovementPlans": [ { "ChoiceId": "string", Request Body API Version 2020-03-31 181 AWS Well-Architected Tool API Reference "DisplayText": "string", "ImprovementPlanUrl": "string" } ], "ImprovementPlanUrl": "string", "JiraConfiguration": { "JiraIssueUrl": "string", "LastSyncedTime": number }, "PillarId": "string", "QuestionId": "string", "QuestionTitle": "string", "Risk": "string" } ], "LensAlias": "string", "LensArn": "string", "MilestoneNumber": number, "NextToken": "string", "WorkloadId": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. |
wellarchitected-api-036 | wellarchitected-api.pdf | 36 | an AWS Region. Length Constraints: Fixed length of 32. Pattern: [0-9a-f]{32} Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "ImprovementSummaries": [ { "ImprovementPlans": [ { "ChoiceId": "string", Request Body API Version 2020-03-31 181 AWS Well-Architected Tool API Reference "DisplayText": "string", "ImprovementPlanUrl": "string" } ], "ImprovementPlanUrl": "string", "JiraConfiguration": { "JiraIssueUrl": "string", "LastSyncedTime": number }, "PillarId": "string", "QuestionId": "string", "QuestionTitle": "string", "Risk": "string" } ], "LensAlias": "string", "LensArn": "string", "MilestoneNumber": number, "NextToken": "string", "WorkloadId": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ImprovementSummaries List of improvement summaries of lens review in a workload. Type: Array of ImprovementSummary objects LensAlias The alias of the lens. For AWS official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on AWS official lenses. For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us- west-2:123456789012:lens/0123456789abcdef01234567890abcdef. Response Elements API Version 2020-03-31 182 AWS Well-Architected Tool API Reference Each lens is identified by its LensSummary:LensAlias. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. LensArn The ARN for the lens. Type: String MilestoneNumber The milestone number. A workload can have a maximum of 100 milestones. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. NextToken The token to use to retrieve the next set of results. Type: String WorkloadId The ID assigned to the workload. This ID is unique within an AWS Region. Type: String Length Constraints: Fixed length of 32. Pattern: [0-9a-f]{32} Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException User does not have sufficient access to perform this action. Errors API Version 2020-03-31 183 AWS Well-Architected Tool HTTP Status Code: 403 InternalServerException There is a problem with the AWS Well-Architected Tool API service. API Reference HTTP Status Code: 500 ResourceNotFoundException The requested resource was not found. HTTP Status Code: 404 ThrottlingException Request was denied due to request throttling. HTTP Status Code: 429 ValidationException The user input is not valid. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2020-03-31 184 AWS Well-Architected Tool API Reference See Also API Version 2020-03-31 185 AWS Well-Architected Tool ListLensReviews List lens reviews for a particular workload. Request Syntax API Reference GET /workloads/WorkloadId/lensReviews? MaxResults=MaxResults&MilestoneNumber=MilestoneNumber&NextToken=NextToken HTTP/1.1 URI Request Parameters The request uses the following URI parameters. MaxResults The maximum number of results to return for this request. Valid Range: Minimum value of 1. Maximum value of 50. MilestoneNumber The milestone number. A workload can have a maximum of 100 milestones. Valid Range: Minimum value of 1. Maximum value of 100. NextToken The token to use to retrieve the next set of results. WorkloadId The ID assigned to the workload. This ID is unique within an AWS Region. Length Constraints: Fixed length of 32. Pattern: [0-9a-f]{32} Required: Yes Request Body The request does not have a request body. ListLensReviews API Version 2020-03-31 186 API Reference AWS Well-Architected Tool Response Syntax HTTP/1.1 200 Content-type: application/json { "LensReviewSummaries": [ { "LensAlias": "string", "LensArn": "string", "LensName": "string", "LensStatus": "string", "LensVersion": "string", "PrioritizedRiskCounts": { "string" : number }, "Profiles": [ { "ProfileArn": "string", "ProfileVersion": "string" } ], "RiskCounts": { "string" : number }, "UpdatedAt": number } ], "MilestoneNumber": number, "NextToken": "string", "WorkloadId": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. LensReviewSummaries List of lens summaries of lens reviews of a workload. Response Syntax API Version 2020-03-31 187 AWS Well-Architected Tool API Reference Type: Array of LensReviewSummary objects MilestoneNumber The milestone number. A workload can have a maximum of 100 milestones. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. NextToken The token to use to retrieve the next set of results. Type: String WorkloadId The ID assigned to the workload. This ID is unique within an AWS Region. Type: String Length Constraints: Fixed length of 32. Pattern: [0-9a-f]{32} Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException User does not have sufficient access to perform this action. HTTP Status Code: 403 InternalServerException There is a problem with the |
wellarchitected-api-037 | wellarchitected-api.pdf | 37 | The milestone number. A workload can have a maximum of 100 milestones. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. NextToken The token to use to retrieve the next set of results. Type: String WorkloadId The ID assigned to the workload. This ID is unique within an AWS Region. Type: String Length Constraints: Fixed length of 32. Pattern: [0-9a-f]{32} Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException User does not have sufficient access to perform this action. HTTP Status Code: 403 InternalServerException There is a problem with the AWS Well-Architected Tool API service. HTTP Status Code: 500 ResourceNotFoundException The requested resource was not found. Errors API Version 2020-03-31 188 API Reference AWS Well-Architected Tool HTTP Status Code: 404 ThrottlingException Request was denied due to request throttling. HTTP Status Code: 429 ValidationException The user input is not valid. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2020-03-31 189 AWS Well-Architected Tool ListLensShares List the lens shares associated with the lens. Request Syntax GET /lenses/LensAlias/shares? API Reference MaxResults=MaxResults&NextToken=NextToken&SharedWithPrefix=SharedWithPrefix&Status=Status HTTP/1.1 URI Request Parameters The request uses the following URI parameters. LensAlias The alias of the lens. For AWS official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on AWS official lenses. For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us- west-2:123456789012:lens/0123456789abcdef01234567890abcdef. Each lens is identified by its LensSummary:LensAlias. Length Constraints: Minimum length of 1. Maximum length of 128. Required: Yes MaxResults The maximum number of results to return for this request. Valid Range: Minimum value of 1. Maximum value of 50. NextToken The token to use to retrieve the next set of results. SharedWithPrefix The AWS account ID, organization ID, or organizational unit (OU) ID with which the lens is shared. ListLensShares API Version 2020-03-31 190 AWS Well-Architected Tool API Reference Length Constraints: Maximum length of 100. Status The status of the share request. Valid Values: ACCEPTED | REJECTED | PENDING | REVOKED | EXPIRED | ASSOCIATING | ASSOCIATED | FAILED Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "LensShareSummaries": [ { "SharedWith": "string", "ShareId": "string", "Status": "string", "StatusMessage": "string" } ], "NextToken": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. LensShareSummaries A list of lens share summaries. Type: Array of LensShareSummary objects Request Body API Version 2020-03-31 191 AWS Well-Architected Tool NextToken The token to use to retrieve the next set of results. API Reference Type: String Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException User does not have sufficient access to perform this action. HTTP Status Code: 403 InternalServerException There is a problem with the AWS Well-Architected Tool API service. HTTP Status Code: 500 ResourceNotFoundException The requested resource was not found. HTTP Status Code: 404 ThrottlingException Request was denied due to request throttling. HTTP Status Code: 429 ValidationException The user input is not valid. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: Errors API Version 2020-03-31 192 API Reference AWS Well-Architected Tool • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2020-03-31 193 AWS Well-Architected Tool ListMilestones List all milestones for an existing workload. Request Syntax POST /workloads/WorkloadId/milestonesSummaries HTTP/1.1 Content-type: application/json { "MaxResults": number, "NextToken": "string" } URI Request Parameters The request uses the following URI parameters. WorkloadId The ID assigned to the workload. This ID is unique within an AWS Region. Length Constraints: Fixed length of 32. Pattern: [0-9a-f]{32} Required: Yes Request Body The request accepts the following data in JSON format. MaxResults The maximum number of results to return for this request. Type: Integer Valid Range: Minimum value of 1. Maximum value of 50. Required: No ListMilestones API Reference API Version 2020-03-31 194 AWS Well-Architected Tool NextToken The |
wellarchitected-api-038 | wellarchitected-api.pdf | 38 | for an existing workload. Request Syntax POST /workloads/WorkloadId/milestonesSummaries HTTP/1.1 Content-type: application/json { "MaxResults": number, "NextToken": "string" } URI Request Parameters The request uses the following URI parameters. WorkloadId The ID assigned to the workload. This ID is unique within an AWS Region. Length Constraints: Fixed length of 32. Pattern: [0-9a-f]{32} Required: Yes Request Body The request accepts the following data in JSON format. MaxResults The maximum number of results to return for this request. Type: Integer Valid Range: Minimum value of 1. Maximum value of 50. Required: No ListMilestones API Reference API Version 2020-03-31 194 AWS Well-Architected Tool NextToken The token to use to retrieve the next set of results. API Reference Type: String Required: No Response Syntax HTTP/1.1 200 Content-type: application/json { "MilestoneSummaries": [ { "MilestoneName": "string", "MilestoneNumber": number, "RecordedAt": number, "WorkloadSummary": { "ImprovementStatus": "string", "Lenses": [ "string" ], "Owner": "string", "PrioritizedRiskCounts": { "string" : number }, "Profiles": [ { "ProfileArn": "string", "ProfileVersion": "string" } ], "RiskCounts": { "string" : number }, "UpdatedAt": number, "WorkloadArn": "string", "WorkloadId": "string", "WorkloadName": "string" } } ], "NextToken": "string", Response Syntax API Version 2020-03-31 195 API Reference AWS Well-Architected Tool "WorkloadId": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. MilestoneSummaries A list of milestone summaries. Type: Array of MilestoneSummary objects NextToken The token to use to retrieve the next set of results. Type: String WorkloadId The ID assigned to the workload. This ID is unique within an AWS Region. Type: String Length Constraints: Fixed length of 32. Pattern: [0-9a-f]{32} Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException User does not have sufficient access to perform this action. HTTP Status Code: 403 InternalServerException There is a problem with the AWS Well-Architected Tool API service. Response Elements API Version 2020-03-31 196 API Reference AWS Well-Architected Tool HTTP Status Code: 500 ResourceNotFoundException The requested resource was not found. HTTP Status Code: 404 ThrottlingException Request was denied due to request throttling. HTTP Status Code: 429 ValidationException The user input is not valid. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2020-03-31 197 API Reference AWS Well-Architected Tool ListNotifications List lens notifications. Request Syntax POST /notifications HTTP/1.1 Content-type: application/json { "MaxResults": number, "NextToken": "string", "ResourceArn": "string", "WorkloadId": "string" } URI Request Parameters The request does not use any URI parameters. Request Body The request accepts the following data in JSON format. MaxResults The maximum number of results to return for this request. Type: Integer Valid Range: Minimum value of 1. Maximum value of 50. Required: No NextToken The token to use to retrieve the next set of results. Type: String Required: No ListNotifications API Version 2020-03-31 198 AWS Well-Architected Tool ResourceArn The ARN for the related resource for the notification. API Reference Note Only one of WorkloadID or ResourceARN should be specified. Type: String Length Constraints: Minimum length of 50. Maximum length of 250. Pattern: arn:aws(-us-gov|-iso(-[a-z])?|-cn)?:wellarchitected:[a-z]{2}(- gov|-iso([a-z])?)?-[a-z]+-\d:\d{12}:(review-template)/[a-f0-9]{32} Required: No WorkloadId The ID assigned to the workload. This ID is unique within an AWS Region. Type: String Length Constraints: Fixed length of 32. Pattern: [0-9a-f]{32} Required: No Response Syntax HTTP/1.1 200 Content-type: application/json { "NextToken": "string", "NotificationSummaries": [ { "LensUpgradeSummary": { "CurrentLensVersion": "string", "LatestLensVersion": "string", Response Syntax API Version 2020-03-31 199 AWS Well-Architected Tool API Reference "LensAlias": "string", "LensArn": "string", "ResourceArn": "string", "ResourceName": "string", "WorkloadId": "string", "WorkloadName": "string" }, "Type": "string" } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. NextToken The token to use to retrieve the next set of results. Type: String NotificationSummaries List of lens notification summaries in a workload. Type: Array of NotificationSummary objects Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException User does not have sufficient access to perform this action. HTTP Status Code: 403 InternalServerException There is a problem with the AWS Well-Architected Tool API service. Response Elements API Version 2020-03-31 200 API Reference AWS Well-Architected Tool HTTP Status Code: 500 ThrottlingException Request was denied due to request throttling. HTTP Status Code: 429 ValidationException The user input is not valid. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: |
wellarchitected-api-039 | wellarchitected-api.pdf | 39 | objects Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException User does not have sufficient access to perform this action. HTTP Status Code: 403 InternalServerException There is a problem with the AWS Well-Architected Tool API service. Response Elements API Version 2020-03-31 200 API Reference AWS Well-Architected Tool HTTP Status Code: 500 ThrottlingException Request was denied due to request throttling. HTTP Status Code: 429 ValidationException The user input is not valid. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2020-03-31 201 AWS Well-Architected Tool API Reference ListProfileNotifications List profile notifications. Request Syntax GET /profileNotifications/? MaxResults=MaxResults&NextToken=NextToken&WorkloadId=WorkloadId HTTP/1.1 URI Request Parameters The request uses the following URI parameters. MaxResults The maximum number of results to return for this request. Valid Range: Minimum value of 1. Maximum value of 50. NextToken The token to use to retrieve the next set of results. WorkloadId The ID assigned to the workload. This ID is unique within an AWS Region. Length Constraints: Fixed length of 32. Pattern: [0-9a-f]{32} Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "NextToken": "string", ListProfileNotifications API Version 2020-03-31 202 AWS Well-Architected Tool API Reference "NotificationSummaries": [ { "CurrentProfileVersion": "string", "LatestProfileVersion": "string", "ProfileArn": "string", "ProfileName": "string", "Type": "string", "WorkloadId": "string", "WorkloadName": "string" } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. NextToken The token to use to retrieve the next set of results. Type: String NotificationSummaries Notification summaries. Type: Array of ProfileNotificationSummary objects Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException User does not have sufficient access to perform this action. HTTP Status Code: 403 InternalServerException There is a problem with the AWS Well-Architected Tool API service. Response Elements API Version 2020-03-31 203 API Reference AWS Well-Architected Tool HTTP Status Code: 500 ThrottlingException Request was denied due to request throttling. HTTP Status Code: 429 ValidationException The user input is not valid. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2020-03-31 204 AWS Well-Architected Tool ListProfiles List profiles. Request Syntax API Reference GET /profileSummaries? MaxResults=MaxResults&NextToken=NextToken&ProfileNamePrefix=ProfileNamePrefix&ProfileOwnerType=ProfileOwnerType HTTP/1.1 URI Request Parameters The request uses the following URI parameters. MaxResults The maximum number of results to return for this request. Valid Range: Minimum value of 1. Maximum value of 50. NextToken The token to use to retrieve the next set of results. ProfileNamePrefix An optional string added to the beginning of each profile name returned in the results. Length Constraints: Maximum length of 100. ProfileOwnerType Profile owner type. Valid Values: SELF | SHARED Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 ListProfiles API Version 2020-03-31 205 AWS Well-Architected Tool API Reference Content-type: application/json { "NextToken": "string", "ProfileSummaries": [ { "CreatedAt": number, "Owner": "string", "ProfileArn": "string", "ProfileDescription": "string", "ProfileName": "string", "ProfileVersion": "string", "UpdatedAt": number } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. NextToken The token to use to retrieve the next set of results. Type: String ProfileSummaries Profile summaries. Type: Array of ProfileSummary objects Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException User does not have sufficient access to perform this action. Response Elements API Version 2020-03-31 206 AWS Well-Architected Tool HTTP Status Code: 403 InternalServerException There is a problem with the AWS Well-Architected Tool API service. HTTP Status Code: 500 ThrottlingException Request was denied due to request throttling. API Reference HTTP Status Code: 429 ValidationException The user input is not valid. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS |
wellarchitected-api-040 | wellarchitected-api.pdf | 40 | User does not have sufficient access to perform this action. Response Elements API Version 2020-03-31 206 AWS Well-Architected Tool HTTP Status Code: 403 InternalServerException There is a problem with the AWS Well-Architected Tool API service. HTTP Status Code: 500 ThrottlingException Request was denied due to request throttling. API Reference HTTP Status Code: 429 ValidationException The user input is not valid. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2020-03-31 207 AWS Well-Architected Tool ListProfileShares List profile shares. Request Syntax API Reference GET /profiles/ProfileArn/shares? MaxResults=MaxResults&NextToken=NextToken&SharedWithPrefix=SharedWithPrefix&Status=Status HTTP/1.1 URI Request Parameters The request uses the following URI parameters. MaxResults The maximum number of results to return for this request. Valid Range: Minimum value of 1. Maximum value of 50. NextToken The token to use to retrieve the next set of results. ProfileArn The profile ARN. Length Constraints: Maximum length of 2084. Pattern: arn:aws[-a-z]*:wellarchitected:[a-z]{2}(-gov)?-[a-z]+-\d: \d{12}:profile/[a-z0-9]+ Required: Yes SharedWithPrefix The AWS account ID, organization ID, or organizational unit (OU) ID with which the profile is shared. Length Constraints: Maximum length of 100. Status The status of the share request. ListProfileShares API Version 2020-03-31 208 AWS Well-Architected Tool API Reference Valid Values: ACCEPTED | REJECTED | PENDING | REVOKED | EXPIRED | ASSOCIATING | ASSOCIATED | FAILED Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "NextToken": "string", "ProfileShareSummaries": [ { "SharedWith": "string", "ShareId": "string", "Status": "string", "StatusMessage": "string" } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. NextToken The token to use to retrieve the next set of results. Type: String ProfileShareSummaries Profile share summaries. Type: Array of ProfileShareSummary objects Request Body API Version 2020-03-31 209 AWS Well-Architected Tool Errors API Reference For information about the errors that are common to all actions, see Common Errors. AccessDeniedException User does not have sufficient access to perform this action. HTTP Status Code: 403 InternalServerException There is a problem with the AWS Well-Architected Tool API service. HTTP Status Code: 500 ResourceNotFoundException The requested resource was not found. HTTP Status Code: 404 ThrottlingException Request was denied due to request throttling. HTTP Status Code: 429 ValidationException The user input is not valid. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 Errors API Version 2020-03-31 210 AWS Well-Architected Tool • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2020-03-31 211 AWS Well-Architected Tool API Reference ListReviewTemplateAnswers List the answers of a review template. Request Syntax GET /reviewTemplates/TemplateArn/lensReviews/LensAlias/answers? MaxResults=MaxResults&NextToken=NextToken&PillarId=PillarId HTTP/1.1 URI Request Parameters The request uses the following URI parameters. LensAlias The alias of the lens. For AWS official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on AWS official lenses. For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us- west-2:123456789012:lens/0123456789abcdef01234567890abcdef. Each lens is identified by its LensSummary:LensAlias. Length Constraints: Minimum length of 1. Maximum length of 128. Required: Yes MaxResults The maximum number of results to return for this request. Valid Range: Minimum value of 1. Maximum value of 50. NextToken The token to use to retrieve the next set of results. PillarId The ID used to identify a pillar, for example, security. ListReviewTemplateAnswers API Version 2020-03-31 212 AWS Well-Architected Tool API Reference A pillar is identified by its PillarReviewSummary:PillarId. Length Constraints: Minimum length of 1. Maximum length of 64. TemplateArn The ARN of the review template. Length Constraints: Minimum length of 50. Maximum length of 250. Pattern: arn:aws(-us-gov|-iso(-[a-z])?|-cn)?:wellarchitected:[a-z]{2}(- gov|-iso([a-z])?)?-[a-z]+-\d:\d{12}:(review-template)/[a-f0-9]{32} Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "AnswerSummaries": [ { "AnswerStatus": "string", "ChoiceAnswerSummaries": [ { "ChoiceId": "string", "Reason": "string", "Status": "string" } ], "Choices": [ { "AdditionalResources": [ { "Content": [ { "DisplayText": "string", "Url": "string" Request Body API Version 2020-03-31 213 AWS Well-Architected Tool API Reference } ], "Type": "string" } ], "ChoiceId": "string", "Description": "string", |
wellarchitected-api-041 | wellarchitected-api.pdf | 41 | PillarReviewSummary:PillarId. Length Constraints: Minimum length of 1. Maximum length of 64. TemplateArn The ARN of the review template. Length Constraints: Minimum length of 50. Maximum length of 250. Pattern: arn:aws(-us-gov|-iso(-[a-z])?|-cn)?:wellarchitected:[a-z]{2}(- gov|-iso([a-z])?)?-[a-z]+-\d:\d{12}:(review-template)/[a-f0-9]{32} Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "AnswerSummaries": [ { "AnswerStatus": "string", "ChoiceAnswerSummaries": [ { "ChoiceId": "string", "Reason": "string", "Status": "string" } ], "Choices": [ { "AdditionalResources": [ { "Content": [ { "DisplayText": "string", "Url": "string" Request Body API Version 2020-03-31 213 AWS Well-Architected Tool API Reference } ], "Type": "string" } ], "ChoiceId": "string", "Description": "string", "HelpfulResource": { "DisplayText": "string", "Url": "string" }, "ImprovementPlan": { "DisplayText": "string", "Url": "string" }, "Title": "string" } ], "IsApplicable": boolean, "PillarId": "string", "QuestionId": "string", "QuestionTitle": "string", "QuestionType": "string", "Reason": "string", "SelectedChoices": [ "string" ] } ], "LensAlias": "string", "NextToken": "string", "TemplateArn": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. AnswerSummaries List of answer summaries of a lens review in a review template. Type: Array of ReviewTemplateAnswerSummary objects Response Elements API Version 2020-03-31 214 AWS Well-Architected Tool LensAlias The alias of the lens. API Reference For AWS official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on AWS official lenses. For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us- west-2:123456789012:lens/0123456789abcdef01234567890abcdef. Each lens is identified by its LensSummary:LensAlias. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. NextToken The token to use to retrieve the next set of results. Type: String TemplateArn The ARN of the review template. Type: String Length Constraints: Minimum length of 50. Maximum length of 250. Pattern: arn:aws(-us-gov|-iso(-[a-z])?|-cn)?:wellarchitected:[a-z]{2}(- gov|-iso([a-z])?)?-[a-z]+-\d:\d{12}:(review-template)/[a-f0-9]{32} Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException User does not have sufficient access to perform this action. HTTP Status Code: 403 Errors API Version 2020-03-31 215 AWS Well-Architected Tool InternalServerException API Reference There is a problem with the AWS Well-Architected Tool API service. HTTP Status Code: 500 ResourceNotFoundException The requested resource was not found. HTTP Status Code: 404 ThrottlingException Request was denied due to request throttling. HTTP Status Code: 429 ValidationException The user input is not valid. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2020-03-31 216 AWS Well-Architected Tool API Reference ListReviewTemplates List review templates. Request Syntax GET /reviewTemplates?MaxResults=MaxResults&NextToken=NextToken HTTP/1.1 URI Request Parameters The request uses the following URI parameters. MaxResults The maximum number of results to return for this request. Valid Range: Minimum value of 1. Maximum value of 50. NextToken The token to use to retrieve the next set of results. Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "NextToken": "string", "ReviewTemplates": [ { "Description": "string", "Lenses": [ "string" ], "Owner": "string", "TemplateArn": "string", "TemplateName": "string", "UpdatedAt": number, ListReviewTemplates API Version 2020-03-31 217 AWS Well-Architected Tool API Reference "UpdateStatus": "string" } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. NextToken The token to use to retrieve the next set of results. Type: String ReviewTemplates List of review templates. Type: Array of ReviewTemplateSummary objects Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException User does not have sufficient access to perform this action. HTTP Status Code: 403 InternalServerException There is a problem with the AWS Well-Architected Tool API service. HTTP Status Code: 500 ThrottlingException Request was denied due to request throttling. HTTP Status Code: 429 Response Elements API Version 2020-03-31 218 AWS Well-Architected Tool ValidationException The user input is not valid. HTTP Status Code: 400 See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2020-03-31 219 AWS Well-Architected Tool API Reference |
wellarchitected-api-042 | wellarchitected-api.pdf | 42 | Well-Architected Tool ValidationException The user input is not valid. HTTP Status Code: 400 See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2020-03-31 219 AWS Well-Architected Tool API Reference ListShareInvitations List the share invitations. WorkloadNamePrefix, LensNamePrefix, ProfileNamePrefix, and TemplateNamePrefix are mutually exclusive. Use the parameter that matches your ShareResourceType. Request Syntax GET /shareInvitations? LensNamePrefix=LensNamePrefix&MaxResults=MaxResults&NextToken=NextToken&ProfileNamePrefix=ProfileNamePrefix&ShareResourceType=ShareResourceType&TemplateNamePrefix=TemplateNamePrefix&WorkloadNamePrefix=WorkloadNamePrefix HTTP/1.1 URI Request Parameters The request uses the following URI parameters. LensNamePrefix An optional string added to the beginning of each lens name returned in the results. Length Constraints: Maximum length of 100. MaxResults The maximum number of results to return for this request. Valid Range: Minimum value of 1. Maximum value of 50. NextToken The token to use to retrieve the next set of results. ProfileNamePrefix An optional string added to the beginning of each profile name returned in the results. Length Constraints: Maximum length of 100. ShareResourceType The type of share invitations to be returned. Valid Values: WORKLOAD | LENS | PROFILE | TEMPLATE ListShareInvitations API Version 2020-03-31 220 AWS Well-Architected Tool TemplateNamePrefix API Reference An optional string added to the beginning of each review template name returned in the results. Length Constraints: Maximum length of 100. Pattern: ^[A-Za-z0-9-_.,:/()@!&?#+'’\s]+$ WorkloadNamePrefix An optional string added to the beginning of each workload name returned in the results. Length Constraints: Maximum length of 100. Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "NextToken": "string", "ShareInvitationSummaries": [ { "LensArn": "string", "LensName": "string", "PermissionType": "string", "ProfileArn": "string", "ProfileName": "string", "SharedBy": "string", "SharedWith": "string", "ShareInvitationId": "string", "ShareResourceType": "string", "TemplateArn": "string", "TemplateName": "string", "WorkloadId": "string", "WorkloadName": "string" } ] Request Body API Version 2020-03-31 221 AWS Well-Architected Tool } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. API Reference NextToken The token to use to retrieve the next set of results. Type: String ShareInvitationSummaries List of share invitation summaries in a workload. Type: Array of ShareInvitationSummary objects Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException User does not have sufficient access to perform this action. HTTP Status Code: 403 InternalServerException There is a problem with the AWS Well-Architected Tool API service. HTTP Status Code: 500 ThrottlingException Request was denied due to request throttling. HTTP Status Code: 429 ValidationException The user input is not valid. Response Elements API Version 2020-03-31 222 AWS Well-Architected Tool HTTP Status Code: 400 See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2020-03-31 223 AWS Well-Architected Tool API Reference ListTagsForResource List the tags for a resource. Note The WorkloadArn parameter can be a workload ARN, a custom lens ARN, a profile ARN, or review template ARN. Request Syntax GET /tags/WorkloadArn HTTP/1.1 URI Request Parameters The request uses the following URI parameters. WorkloadArn The ARN for the workload. Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "Tags": { "string" : "string" } } ListTagsForResource API Version 2020-03-31 224 AWS Well-Architected Tool Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. Tags The tags for the resource. Type: String to string map Map Entries: Maximum number of 50 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Value Length Constraints: Minimum length of 0. Maximum length of 256. Errors For information about the errors that are common to all actions, see Common Errors. InternalServerException There is a problem with the AWS Well-Architected Tool API service. HTTP Status Code: 500 ResourceNotFoundException The requested resource was not found. HTTP Status Code: 404 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET Response Elements API Version 2020-03-31 225 API Reference AWS Well-Architected |
wellarchitected-api-043 | wellarchitected-api.pdf | 43 | Minimum length of 1. Maximum length of 128. Value Length Constraints: Minimum length of 0. Maximum length of 256. Errors For information about the errors that are common to all actions, see Common Errors. InternalServerException There is a problem with the AWS Well-Architected Tool API service. HTTP Status Code: 500 ResourceNotFoundException The requested resource was not found. HTTP Status Code: 404 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET Response Elements API Version 2020-03-31 225 API Reference AWS Well-Architected Tool • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2020-03-31 226 AWS Well-Architected Tool ListTemplateShares List review template shares. Request Syntax API Reference GET /templates/shares/TemplateArn? MaxResults=MaxResults&NextToken=NextToken&SharedWithPrefix=SharedWithPrefix&Status=Status HTTP/1.1 URI Request Parameters The request uses the following URI parameters. MaxResults The maximum number of results to return for this request. Valid Range: Minimum value of 1. Maximum value of 50. NextToken The token to use to retrieve the next set of results. SharedWithPrefix The AWS account ID, organization ID, or organizational unit (OU) ID with which the profile is shared. Length Constraints: Maximum length of 100. Status The status of the share request. Valid Values: ACCEPTED | REJECTED | PENDING | REVOKED | EXPIRED | ASSOCIATING | ASSOCIATED | FAILED TemplateArn The review template ARN. Length Constraints: Minimum length of 50. Maximum length of 250. ListTemplateShares API Version 2020-03-31 227 AWS Well-Architected Tool API Reference Pattern: arn:aws(-us-gov|-iso(-[a-z])?|-cn)?:wellarchitected:[a-z]{2}(- gov|-iso([a-z])?)?-[a-z]+-\d:\d{12}:(review-template)/[a-f0-9]{32} Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "NextToken": "string", "TemplateArn": "string", "TemplateShareSummaries": [ { "SharedWith": "string", "ShareId": "string", "Status": "string", "StatusMessage": "string" } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. NextToken The token to use to retrieve the next set of results. Type: String TemplateArn The review template ARN. Request Body API Version 2020-03-31 228 AWS Well-Architected Tool Type: String API Reference Length Constraints: Minimum length of 50. Maximum length of 250. Pattern: arn:aws(-us-gov|-iso(-[a-z])?|-cn)?:wellarchitected:[a-z]{2}(- gov|-iso([a-z])?)?-[a-z]+-\d:\d{12}:(review-template)/[a-f0-9]{32} TemplateShareSummaries A review template share summary return object. Type: Array of TemplateShareSummary objects Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException User does not have sufficient access to perform this action. HTTP Status Code: 403 InternalServerException There is a problem with the AWS Well-Architected Tool API service. HTTP Status Code: 500 ResourceNotFoundException The requested resource was not found. HTTP Status Code: 404 ThrottlingException Request was denied due to request throttling. HTTP Status Code: 429 ValidationException The user input is not valid. HTTP Status Code: 400 Errors API Version 2020-03-31 229 AWS Well-Architected Tool See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2020-03-31 230 API Reference AWS Well-Architected Tool ListWorkloads Paginated list of workloads. Request Syntax POST /workloadsSummaries HTTP/1.1 Content-type: application/json { "MaxResults": number, "NextToken": "string", "WorkloadNamePrefix": "string" } URI Request Parameters The request does not use any URI parameters. Request Body The request accepts the following data in JSON format. MaxResults The maximum number of results to return for this request. Type: Integer Valid Range: Minimum value of 1. Maximum value of 50. Required: No NextToken The token to use to retrieve the next set of results. Type: String Required: No WorkloadNamePrefix An optional string added to the beginning of each workload name returned in the results. ListWorkloads API Version 2020-03-31 231 API Reference AWS Well-Architected Tool Type: String Length Constraints: Maximum length of 100. Required: No Response Syntax HTTP/1.1 200 Content-type: application/json { "NextToken": "string", "WorkloadSummaries": [ { "ImprovementStatus": "string", "Lenses": [ "string" ], "Owner": "string", "PrioritizedRiskCounts": { "string" : number }, "Profiles": [ { "ProfileArn": "string", "ProfileVersion": "string" } ], "RiskCounts": { "string" : number }, "UpdatedAt": number, "WorkloadArn": "string", "WorkloadId": "string", "WorkloadName": "string" } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. Response Syntax API Version 2020-03-31 232 AWS Well-Architected Tool API Reference The following data is returned in JSON format by the service. NextToken The token to use to retrieve the next |
wellarchitected-api-044 | wellarchitected-api.pdf | 44 | Required: No Response Syntax HTTP/1.1 200 Content-type: application/json { "NextToken": "string", "WorkloadSummaries": [ { "ImprovementStatus": "string", "Lenses": [ "string" ], "Owner": "string", "PrioritizedRiskCounts": { "string" : number }, "Profiles": [ { "ProfileArn": "string", "ProfileVersion": "string" } ], "RiskCounts": { "string" : number }, "UpdatedAt": number, "WorkloadArn": "string", "WorkloadId": "string", "WorkloadName": "string" } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. Response Syntax API Version 2020-03-31 232 AWS Well-Architected Tool API Reference The following data is returned in JSON format by the service. NextToken The token to use to retrieve the next set of results. Type: String WorkloadSummaries A list of workload summaries. Type: Array of WorkloadSummary objects Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException User does not have sufficient access to perform this action. HTTP Status Code: 403 InternalServerException There is a problem with the AWS Well-Architected Tool API service. HTTP Status Code: 500 ThrottlingException Request was denied due to request throttling. HTTP Status Code: 429 ValidationException The user input is not valid. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: Errors API Version 2020-03-31 233 API Reference AWS Well-Architected Tool • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2020-03-31 234 AWS Well-Architected Tool API Reference ListWorkloadShares List the workload shares associated with the workload. Request Syntax GET /workloads/WorkloadId/shares? MaxResults=MaxResults&NextToken=NextToken&SharedWithPrefix=SharedWithPrefix&Status=Status HTTP/1.1 URI Request Parameters The request uses the following URI parameters. MaxResults The maximum number of results to return for this request. Valid Range: Minimum value of 1. Maximum value of 50. NextToken The token to use to retrieve the next set of results. SharedWithPrefix The AWS account ID, organization ID, or organizational unit (OU) ID with which the workload is shared. Length Constraints: Maximum length of 100. Status The status of the share request. Valid Values: ACCEPTED | REJECTED | PENDING | REVOKED | EXPIRED | ASSOCIATING | ASSOCIATED | FAILED WorkloadId The ID assigned to the workload. This ID is unique within an AWS Region. Length Constraints: Fixed length of 32. ListWorkloadShares API Version 2020-03-31 235 API Reference AWS Well-Architected Tool Pattern: [0-9a-f]{32} Required: Yes Request Body The request does not have a request body. Response Syntax HTTP/1.1 200 Content-type: application/json { "NextToken": "string", "WorkloadId": "string", "WorkloadShareSummaries": [ { "PermissionType": "string", "SharedWith": "string", "ShareId": "string", "Status": "string", "StatusMessage": "string" } ] } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. NextToken The token to use to retrieve the next set of results. Type: String WorkloadId The ID assigned to the workload. This ID is unique within an AWS Region. Request Body API Version 2020-03-31 236 API Reference AWS Well-Architected Tool Type: String Length Constraints: Fixed length of 32. Pattern: [0-9a-f]{32} WorkloadShareSummaries A list of workload share summaries. Type: Array of WorkloadShareSummary objects Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException User does not have sufficient access to perform this action. HTTP Status Code: 403 InternalServerException There is a problem with the AWS Well-Architected Tool API service. HTTP Status Code: 500 ResourceNotFoundException The requested resource was not found. HTTP Status Code: 404 ThrottlingException Request was denied due to request throttling. HTTP Status Code: 429 ValidationException The user input is not valid. HTTP Status Code: 400 Errors API Version 2020-03-31 237 AWS Well-Architected Tool See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2020-03-31 238 AWS Well-Architected Tool TagResource Adds one or more tags to the specified resource. API Reference Note The WorkloadArn parameter can be a workload ARN, a custom lens ARN, a profile ARN, or review template ARN. Request Syntax POST /tags/WorkloadArn HTTP/1.1 Content-type: application/json { "Tags": { "string" : "string" } } URI Request Parameters The request uses the following URI parameters. WorkloadArn The ARN for the workload. Required: Yes Request Body The request accepts the following data in JSON format. Tags The tags for the |
wellarchitected-api-045 | wellarchitected-api.pdf | 45 | AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2020-03-31 238 AWS Well-Architected Tool TagResource Adds one or more tags to the specified resource. API Reference Note The WorkloadArn parameter can be a workload ARN, a custom lens ARN, a profile ARN, or review template ARN. Request Syntax POST /tags/WorkloadArn HTTP/1.1 Content-type: application/json { "Tags": { "string" : "string" } } URI Request Parameters The request uses the following URI parameters. WorkloadArn The ARN for the workload. Required: Yes Request Body The request accepts the following data in JSON format. Tags The tags for the resource. Type: String to string map TagResource API Version 2020-03-31 239 AWS Well-Architected Tool API Reference Map Entries: Maximum number of 50 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Value Length Constraints: Minimum length of 0. Maximum length of 256. Required: Yes Response Syntax HTTP/1.1 200 Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. InternalServerException There is a problem with the AWS Well-Architected Tool API service. HTTP Status Code: 500 ResourceNotFoundException The requested resource was not found. HTTP Status Code: 404 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ Response Syntax API Version 2020-03-31 240 AWS Well-Architected Tool • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2020-03-31 241 AWS Well-Architected Tool UntagResource Deletes specified tags from a resource. Note API Reference The WorkloadArn parameter can be a workload ARN, a custom lens ARN, a profile ARN, or review template ARN. To specify multiple tags, use separate tagKeys parameters, for example: DELETE /tags/WorkloadArn?tagKeys=key1&tagKeys=key2 Request Syntax DELETE /tags/WorkloadArn?tagKeys=TagKeys HTTP/1.1 URI Request Parameters The request uses the following URI parameters. TagKeys A list of tag keys. Existing tags of the resource whose keys are members of this list are removed from the resource. Array Members: Minimum number of 1 item. Maximum number of 50 items. Length Constraints: Minimum length of 1. Maximum length of 128. Required: Yes WorkloadArn The ARN for the workload. Required: Yes Request Body The request does not have a request body. UntagResource API Version 2020-03-31 242 AWS Well-Architected Tool Response Syntax HTTP/1.1 200 Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. InternalServerException There is a problem with the AWS Well-Architected Tool API service. HTTP Status Code: 500 ResourceNotFoundException The requested resource was not found. HTTP Status Code: 404 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python Response Syntax API Version 2020-03-31 243 AWS Well-Architected Tool • AWS SDK for Ruby V3 API Reference See Also API Version 2020-03-31 244 AWS Well-Architected Tool UpdateAnswer Update the answer to a specific question in a workload review. Request Syntax API Reference PATCH /workloads/WorkloadId/lensReviews/LensAlias/answers/QuestionId HTTP/1.1 Content-type: application/json { "ChoiceUpdates": { "string" : { "Notes": "string", "Reason": "string", "Status": "string" } }, "IsApplicable": boolean, "Notes": "string", "Reason": "string", "SelectedChoices": [ "string" ] } URI Request Parameters The request uses the following URI parameters. LensAlias The alias of the lens. For AWS official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on AWS official lenses. For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us- west-2:123456789012:lens/0123456789abcdef01234567890abcdef. Each lens is identified by its LensSummary:LensAlias. Length Constraints: Minimum length of 1. Maximum length of 128. UpdateAnswer API Version 2020-03-31 245 API Reference AWS Well-Architected Tool Required: Yes QuestionId The ID of the question. Length Constraints: Minimum length of 1. Maximum length of 128. Required: Yes WorkloadId The ID assigned to the workload. This ID is unique within an AWS Region. Length Constraints: Fixed length of 32. Pattern: [0-9a-f]{32} Required: Yes Request Body The request accepts the following data in JSON format. ChoiceUpdates A list of choices to update on a |
wellarchitected-api-046 | wellarchitected-api.pdf | 46 | is the lens ARN, such as arn:aws:wellarchitected:us- west-2:123456789012:lens/0123456789abcdef01234567890abcdef. Each lens is identified by its LensSummary:LensAlias. Length Constraints: Minimum length of 1. Maximum length of 128. UpdateAnswer API Version 2020-03-31 245 API Reference AWS Well-Architected Tool Required: Yes QuestionId The ID of the question. Length Constraints: Minimum length of 1. Maximum length of 128. Required: Yes WorkloadId The ID assigned to the workload. This ID is unique within an AWS Region. Length Constraints: Fixed length of 32. Pattern: [0-9a-f]{32} Required: Yes Request Body The request accepts the following data in JSON format. ChoiceUpdates A list of choices to update on a question in your workload. The String key corresponds to the choice ID to be updated. Type: String to ChoiceUpdate object map Key Length Constraints: Minimum length of 1. Maximum length of 64. Required: No IsApplicable Defines whether this question is applicable to a lens review. Type: Boolean Required: No Notes The notes associated with the workload. Request Body API Version 2020-03-31 246 AWS Well-Architected Tool API Reference For a review template, these are the notes that will be associated with the workload when the template is applied. Type: String Length Constraints: Maximum length of 2084. Required: No Reason The reason why a question is not applicable to your workload. Type: String Valid Values: OUT_OF_SCOPE | BUSINESS_PRIORITIES | ARCHITECTURE_CONSTRAINTS | OTHER | NONE Required: No SelectedChoices List of selected choice IDs in a question answer. The values entered replace the previously selected choices. Type: Array of strings Length Constraints: Minimum length of 1. Maximum length of 64. Required: No Response Syntax HTTP/1.1 200 Content-type: application/json { "Answer": { "ChoiceAnswers": [ { "ChoiceId": "string", "Notes": "string", "Reason": "string", "Status": "string" Response Syntax API Version 2020-03-31 247 API Reference AWS Well-Architected Tool } ], "Choices": [ { "AdditionalResources": [ { "Content": [ { "DisplayText": "string", "Url": "string" } ], "Type": "string" } ], "ChoiceId": "string", "Description": "string", "HelpfulResource": { "DisplayText": "string", "Url": "string" }, "ImprovementPlan": { "DisplayText": "string", "Url": "string" }, "Title": "string" } ], "HelpfulResourceDisplayText": "string", "HelpfulResourceUrl": "string", "ImprovementPlanUrl": "string", "IsApplicable": boolean, "JiraConfiguration": { "JiraIssueUrl": "string", "LastSyncedTime": number }, "Notes": "string", "PillarId": "string", "QuestionDescription": "string", "QuestionId": "string", "QuestionTitle": "string", "Reason": "string", "Risk": "string", "SelectedChoices": [ "string" ] Response Syntax API Version 2020-03-31 248 AWS Well-Architected Tool API Reference }, "LensAlias": "string", "LensArn": "string", "WorkloadId": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. Answer An answer of the question. Type: Answer object LensAlias The alias of the lens. For AWS official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on AWS official lenses. For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us- west-2:123456789012:lens/0123456789abcdef01234567890abcdef. Each lens is identified by its LensSummary:LensAlias. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. LensArn The ARN for the lens. Type: String WorkloadId The ID assigned to the workload. This ID is unique within an AWS Region. Response Elements API Version 2020-03-31 249 API Reference AWS Well-Architected Tool Type: String Length Constraints: Fixed length of 32. Pattern: [0-9a-f]{32} Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException User does not have sufficient access to perform this action. HTTP Status Code: 403 ConflictException The resource has already been processed, was deleted, or is too large. HTTP Status Code: 409 InternalServerException There is a problem with the AWS Well-Architected Tool API service. HTTP Status Code: 500 ResourceNotFoundException The requested resource was not found. HTTP Status Code: 404 ThrottlingException Request was denied due to request throttling. HTTP Status Code: 429 ValidationException The user input is not valid. HTTP Status Code: 400 Errors API Version 2020-03-31 250 AWS Well-Architected Tool See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2020-03-31 251 AWS Well-Architected Tool API Reference UpdateGlobalSettings Update whether the AWS account is opted into organization sharing and discovery integration features. Request Syntax PATCH /global-settings HTTP/1.1 Content-type: application/json { "DiscoveryIntegrationStatus": "string", "JiraConfiguration": { "IntegrationStatus": "string", "IssueManagementStatus": "string", "IssueManagementType": "string", "JiraProjectKey": "string" }, "OrganizationSharingStatus": "string" } URI Request Parameters The request does not use any URI parameters. Request Body The request accepts the following data in JSON format. DiscoveryIntegrationStatus The status of discovery support settings. Type: String Valid Values: |
wellarchitected-api-047 | wellarchitected-api.pdf | 47 | • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2020-03-31 251 AWS Well-Architected Tool API Reference UpdateGlobalSettings Update whether the AWS account is opted into organization sharing and discovery integration features. Request Syntax PATCH /global-settings HTTP/1.1 Content-type: application/json { "DiscoveryIntegrationStatus": "string", "JiraConfiguration": { "IntegrationStatus": "string", "IssueManagementStatus": "string", "IssueManagementType": "string", "JiraProjectKey": "string" }, "OrganizationSharingStatus": "string" } URI Request Parameters The request does not use any URI parameters. Request Body The request accepts the following data in JSON format. DiscoveryIntegrationStatus The status of discovery support settings. Type: String Valid Values: ENABLED | DISABLED Required: No JiraConfiguration The status of Jira integration settings. UpdateGlobalSettings API Version 2020-03-31 252 AWS Well-Architected Tool API Reference Type: AccountJiraConfigurationInput object Required: No OrganizationSharingStatus The status of organization sharing settings. Type: String Valid Values: ENABLED | DISABLED Required: No Response Syntax HTTP/1.1 200 Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException User does not have sufficient access to perform this action. HTTP Status Code: 403 ConflictException The resource has already been processed, was deleted, or is too large. HTTP Status Code: 409 InternalServerException There is a problem with the AWS Well-Architected Tool API service. HTTP Status Code: 500 Response Syntax API Version 2020-03-31 253 AWS Well-Architected Tool ThrottlingException Request was denied due to request throttling. API Reference HTTP Status Code: 429 ValidationException The user input is not valid. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2020-03-31 254 API Reference AWS Well-Architected Tool UpdateIntegration Update integration features. Request Syntax POST /workloads/WorkloadId/updateIntegration HTTP/1.1 Content-type: application/json { "ClientRequestToken": "string", "IntegratingService": "string" } URI Request Parameters The request uses the following URI parameters. WorkloadId The ID assigned to the workload. This ID is unique within an AWS Region. Length Constraints: Fixed length of 32. Pattern: [0-9a-f]{32} Required: Yes Request Body The request accepts the following data in JSON format. ClientRequestToken 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. UpdateIntegration API Version 2020-03-31 255 AWS Well-Architected Tool API Reference Important This token is listed as required, however, if you do not specify it, the AWS SDKs automatically generate one for you. If you are not using the AWS SDK or the AWS CLI, you must provide this token or the request will fail. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: ^[\x00-\x7F]*$ Required: Yes IntegratingService Which integrated service to update. Type: String Valid Values: JIRA Required: Yes Response Syntax HTTP/1.1 200 Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException User does not have sufficient access to perform this action. Response Syntax API Version 2020-03-31 256 AWS Well-Architected Tool HTTP Status Code: 403 ConflictException The resource has already been processed, was deleted, or is too large. HTTP Status Code: 409 InternalServerException There is a problem with the AWS Well-Architected Tool API service. API Reference HTTP Status Code: 500 ResourceNotFoundException The requested resource was not found. HTTP Status Code: 404 ThrottlingException Request was denied due to request throttling. HTTP Status Code: 429 ValidationException The user input is not valid. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 See Also API Version 2020-03-31 257 AWS Well-Architected Tool • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2020-03-31 258 API Reference AWS Well-Architected Tool UpdateLensReview Update lens review for a particular workload. Request Syntax PATCH /workloads/WorkloadId/lensReviews/LensAlias HTTP/1.1 Content-type: application/json { "JiraConfiguration": { "SelectedPillars": [ { |
wellarchitected-api-048 | wellarchitected-api.pdf | 48 | the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 See Also API Version 2020-03-31 257 AWS Well-Architected Tool • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2020-03-31 258 API Reference AWS Well-Architected Tool UpdateLensReview Update lens review for a particular workload. Request Syntax PATCH /workloads/WorkloadId/lensReviews/LensAlias HTTP/1.1 Content-type: application/json { "JiraConfiguration": { "SelectedPillars": [ { "PillarId": "string", "SelectedQuestionIds": [ "string" ] } ] }, "LensNotes": "string", "PillarNotes": { "string" : "string" } } URI Request Parameters The request uses the following URI parameters. LensAlias The alias of the lens. For AWS official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on AWS official lenses. For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us- west-2:123456789012:lens/0123456789abcdef01234567890abcdef. Each lens is identified by its LensSummary:LensAlias. Length Constraints: Minimum length of 1. Maximum length of 128. UpdateLensReview API Version 2020-03-31 259 AWS Well-Architected Tool Required: Yes WorkloadId API Reference The ID assigned to the workload. This ID is unique within an AWS Region. Length Constraints: Fixed length of 32. Pattern: [0-9a-f]{32} Required: Yes Request Body The request accepts the following data in JSON format. JiraConfiguration Configuration of the Jira integration. Type: JiraSelectedQuestionConfiguration object Required: No LensNotes The notes associated with the workload. For a review template, these are the notes that will be associated with the workload when the template is applied. Type: String Length Constraints: Maximum length of 2084. Required: No PillarNotes List of pillar notes of a lens review in a workload. For a review template, these are the notes that will be associated with the workload when the template is applied. Request Body API Version 2020-03-31 260 AWS Well-Architected Tool Type: String to string map API Reference Key Length Constraints: Minimum length of 1. Maximum length of 64. Value Length Constraints: Maximum length of 2084. Required: No Response Syntax HTTP/1.1 200 Content-type: application/json { "LensReview": { "JiraConfiguration": { "SelectedPillars": [ { "PillarId": "string", "SelectedQuestionIds": [ "string" ] } ] }, "LensAlias": "string", "LensArn": "string", "LensName": "string", "LensStatus": "string", "LensVersion": "string", "NextToken": "string", "Notes": "string", "PillarReviewSummaries": [ { "Notes": "string", "PillarId": "string", "PillarName": "string", "PrioritizedRiskCounts": { "string" : number }, "RiskCounts": { "string" : number } } ], Response Syntax API Version 2020-03-31 261 AWS Well-Architected Tool API Reference "PrioritizedRiskCounts": { "string" : number }, "Profiles": [ { "ProfileArn": "string", "ProfileVersion": "string" } ], "RiskCounts": { "string" : number }, "UpdatedAt": number }, "WorkloadId": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. LensReview A lens review of a question. Type: LensReview object WorkloadId The ID assigned to the workload. This ID is unique within an AWS Region. Type: String Length Constraints: Fixed length of 32. Pattern: [0-9a-f]{32} Errors For information about the errors that are common to all actions, see Common Errors. Response Elements API Version 2020-03-31 262 AWS Well-Architected Tool AccessDeniedException API Reference User does not have sufficient access to perform this action. HTTP Status Code: 403 ConflictException The resource has already been processed, was deleted, or is too large. HTTP Status Code: 409 InternalServerException There is a problem with the AWS Well-Architected Tool API service. HTTP Status Code: 500 ResourceNotFoundException The requested resource was not found. HTTP Status Code: 404 ThrottlingException Request was denied due to request throttling. HTTP Status Code: 429 ValidationException The user input is not valid. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ See Also API Version 2020-03-31 263 AWS Well-Architected Tool • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2020-03-31 264 API Reference AWS Well-Architected Tool UpdateProfile Update a profile. Request Syntax PATCH /profiles/ProfileArn HTTP/1.1 Content-type: application/json { "ProfileDescription": "string", "ProfileQuestions": [ { "QuestionId": "string", "SelectedChoiceIds": [ "string" ] } ] } URI Request Parameters The request uses the following URI parameters. ProfileArn The profile ARN. Length Constraints: Maximum length of 2084. Pattern: arn:aws[-a-z]*:wellarchitected:[a-z]{2}(-gov)?-[a-z]+-\d: \d{12}:profile/[a-z0-9]+ Required: Yes Request Body The request accepts the following data in JSON format. ProfileDescription The profile description. UpdateProfile API Version 2020-03-31 265 AWS Well-Architected Tool |
wellarchitected-api-049 | wellarchitected-api.pdf | 49 | PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2020-03-31 264 API Reference AWS Well-Architected Tool UpdateProfile Update a profile. Request Syntax PATCH /profiles/ProfileArn HTTP/1.1 Content-type: application/json { "ProfileDescription": "string", "ProfileQuestions": [ { "QuestionId": "string", "SelectedChoiceIds": [ "string" ] } ] } URI Request Parameters The request uses the following URI parameters. ProfileArn The profile ARN. Length Constraints: Maximum length of 2084. Pattern: arn:aws[-a-z]*:wellarchitected:[a-z]{2}(-gov)?-[a-z]+-\d: \d{12}:profile/[a-z0-9]+ Required: Yes Request Body The request accepts the following data in JSON format. ProfileDescription The profile description. UpdateProfile API Version 2020-03-31 265 AWS Well-Architected Tool Type: String API Reference Length Constraints: Minimum length of 3. Maximum length of 100. Required: No ProfileQuestions Profile questions. Type: Array of ProfileQuestionUpdate objects Required: No Response Syntax HTTP/1.1 200 Content-type: application/json { "Profile": { "CreatedAt": number, "Owner": "string", "ProfileArn": "string", "ProfileDescription": "string", "ProfileName": "string", "ProfileQuestions": [ { "MaxSelectedChoices": number, "MinSelectedChoices": number, "QuestionChoices": [ { "ChoiceDescription": "string", "ChoiceId": "string", "ChoiceTitle": "string" } ], "QuestionDescription": "string", "QuestionId": "string", "QuestionTitle": "string", "SelectedChoiceIds": [ "string" ] } ], Response Syntax API Version 2020-03-31 266 AWS Well-Architected Tool API Reference "ProfileVersion": "string", "ShareInvitationId": "string", "Tags": { "string" : "string" }, "UpdatedAt": number } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. Profile The profile. Type: Profile object Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException User does not have sufficient access to perform this action. HTTP Status Code: 403 ConflictException The resource has already been processed, was deleted, or is too large. HTTP Status Code: 409 InternalServerException There is a problem with the AWS Well-Architected Tool API service. HTTP Status Code: 500 Response Elements API Version 2020-03-31 267 API Reference AWS Well-Architected Tool ResourceNotFoundException The requested resource was not found. HTTP Status Code: 404 ThrottlingException Request was denied due to request throttling. HTTP Status Code: 429 ValidationException The user input is not valid. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2020-03-31 268 AWS Well-Architected Tool API Reference UpdateReviewTemplate Update a review template. Request Syntax PATCH /reviewTemplates/TemplateArn HTTP/1.1 Content-type: application/json { "Description": "string", "LensesToAssociate": [ "string" ], "LensesToDisassociate": [ "string" ], "Notes": "string", "TemplateName": "string" } URI Request Parameters The request uses the following URI parameters. TemplateArn The review template ARN. Length Constraints: Minimum length of 50. Maximum length of 250. Pattern: arn:aws(-us-gov|-iso(-[a-z])?|-cn)?:wellarchitected:[a-z]{2}(- gov|-iso([a-z])?)?-[a-z]+-\d:\d{12}:(review-template)/[a-f0-9]{32} Required: Yes Request Body The request accepts the following data in JSON format. Description The review template description. Type: String UpdateReviewTemplate API Version 2020-03-31 269 AWS Well-Architected Tool API Reference Length Constraints: Minimum length of 3. Maximum length of 250. Pattern: ^[A-Za-z0-9-_.,:/()@!&?#+'’\s]+$ Required: No LensesToAssociate A list of lens aliases or ARNs to apply to the review template. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 10 items. Length Constraints: Minimum length of 1. Maximum length of 128. Required: No LensesToDisassociate A list of lens aliases or ARNs to unapply to the review template. The wellarchitected lens cannot be unapplied. Type: Array of strings Array Members: Minimum number of 1 item. Maximum number of 10 items. Length Constraints: Minimum length of 1. Maximum length of 128. Required: No Notes The notes associated with the workload. For a review template, these are the notes that will be associated with the workload when the template is applied. Type: String Length Constraints: Maximum length of 2084. Required: No TemplateName The review template name. Request Body API Version 2020-03-31 270 AWS Well-Architected Tool Type: String API Reference Length Constraints: Minimum length of 3. Maximum length of 100. Pattern: ^[A-Za-z0-9-_.,:/()@!&?#+'’\s]+$ Required: No Response Syntax HTTP/1.1 200 Content-type: application/json { "ReviewTemplate": { "Description": "string", "Lenses": [ "string" ], "Notes": "string", "Owner": "string", "QuestionCounts": { "string" : number }, "ShareInvitationId": "string", "Tags": { "string" : "string" }, "TemplateArn": "string", "TemplateName": "string", "UpdatedAt": number, "UpdateStatus": "string" } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ReviewTemplate A review template. Response Syntax API Version 2020-03-31 271 AWS Well-Architected Tool API Reference Type: ReviewTemplate object Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException User does not have sufficient access to perform this action. HTTP Status Code: |
wellarchitected-api-050 | wellarchitected-api.pdf | 50 | "string", "Owner": "string", "QuestionCounts": { "string" : number }, "ShareInvitationId": "string", "Tags": { "string" : "string" }, "TemplateArn": "string", "TemplateName": "string", "UpdatedAt": number, "UpdateStatus": "string" } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ReviewTemplate A review template. Response Syntax API Version 2020-03-31 271 AWS Well-Architected Tool API Reference Type: ReviewTemplate object Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException User does not have sufficient access to perform this action. HTTP Status Code: 403 ConflictException The resource has already been processed, was deleted, or is too large. HTTP Status Code: 409 InternalServerException There is a problem with the AWS Well-Architected Tool API service. HTTP Status Code: 500 ResourceNotFoundException The requested resource was not found. HTTP Status Code: 404 ThrottlingException Request was denied due to request throttling. HTTP Status Code: 429 ValidationException The user input is not valid. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: Errors API Version 2020-03-31 272 API Reference AWS Well-Architected Tool • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2020-03-31 273 AWS Well-Architected Tool API Reference UpdateReviewTemplateAnswer Update a review template answer. Request Syntax PATCH /reviewTemplates/TemplateArn/lensReviews/LensAlias/answers/QuestionId HTTP/1.1 Content-type: application/json { "ChoiceUpdates": { "string" : { "Notes": "string", "Reason": "string", "Status": "string" } }, "IsApplicable": boolean, "Notes": "string", "Reason": "string", "SelectedChoices": [ "string" ] } URI Request Parameters The request uses the following URI parameters. LensAlias The alias of the lens. For AWS official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on AWS official lenses. For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us- west-2:123456789012:lens/0123456789abcdef01234567890abcdef. Each lens is identified by its LensSummary:LensAlias. Length Constraints: Minimum length of 1. Maximum length of 128. UpdateReviewTemplateAnswer API Version 2020-03-31 274 AWS Well-Architected Tool Required: Yes QuestionId The ID of the question. API Reference Length Constraints: Minimum length of 1. Maximum length of 128. Required: Yes TemplateArn The review template ARN. Length Constraints: Minimum length of 50. Maximum length of 250. Pattern: arn:aws(-us-gov|-iso(-[a-z])?|-cn)?:wellarchitected:[a-z]{2}(- gov|-iso([a-z])?)?-[a-z]+-\d:\d{12}:(review-template)/[a-f0-9]{32} Required: Yes Request Body The request accepts the following data in JSON format. ChoiceUpdates A list of choices to be updated. Type: String to ChoiceUpdate object map Key Length Constraints: Minimum length of 1. Maximum length of 64. Required: No IsApplicable Defines whether this question is applicable to a lens review. Type: Boolean Required: No Notes The notes associated with the workload. Request Body API Version 2020-03-31 275 AWS Well-Architected Tool API Reference For a review template, these are the notes that will be associated with the workload when the template is applied. Type: String Length Constraints: Maximum length of 2084. Required: No Reason The update reason. Type: String Valid Values: OUT_OF_SCOPE | BUSINESS_PRIORITIES | ARCHITECTURE_CONSTRAINTS | OTHER | NONE Required: No SelectedChoices List of selected choice IDs in a question answer. The values entered replace the previously selected choices. Type: Array of strings Length Constraints: Minimum length of 1. Maximum length of 64. Required: No Response Syntax HTTP/1.1 200 Content-type: application/json { "Answer": { "AnswerStatus": "string", "ChoiceAnswers": [ { "ChoiceId": "string", "Notes": "string", "Reason": "string", Response Syntax API Version 2020-03-31 276 AWS Well-Architected Tool API Reference "Status": "string" } ], "Choices": [ { "AdditionalResources": [ { "Content": [ { "DisplayText": "string", "Url": "string" } ], "Type": "string" } ], "ChoiceId": "string", "Description": "string", "HelpfulResource": { "DisplayText": "string", "Url": "string" }, "ImprovementPlan": { "DisplayText": "string", "Url": "string" }, "Title": "string" } ], "HelpfulResourceDisplayText": "string", "HelpfulResourceUrl": "string", "ImprovementPlanUrl": "string", "IsApplicable": boolean, "Notes": "string", "PillarId": "string", "QuestionDescription": "string", "QuestionId": "string", "QuestionTitle": "string", "Reason": "string", "SelectedChoices": [ "string" ] }, "LensAlias": "string", "TemplateArn": "string" Response Syntax API Version 2020-03-31 277 AWS Well-Architected Tool } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. API Reference Answer An answer of the question. Type: ReviewTemplateAnswer object LensAlias The alias of the lens. For AWS official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on AWS official lenses. For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us- west-2:123456789012:lens/0123456789abcdef01234567890abcdef. Each lens is identified by its LensSummary:LensAlias. Type: |
wellarchitected-api-051 | wellarchitected-api.pdf | 51 | } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. API Reference Answer An answer of the question. Type: ReviewTemplateAnswer object LensAlias The alias of the lens. For AWS official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on AWS official lenses. For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us- west-2:123456789012:lens/0123456789abcdef01234567890abcdef. Each lens is identified by its LensSummary:LensAlias. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. TemplateArn The review template ARN. Type: String Length Constraints: Minimum length of 50. Maximum length of 250. Pattern: arn:aws(-us-gov|-iso(-[a-z])?|-cn)?:wellarchitected:[a-z]{2}(- gov|-iso([a-z])?)?-[a-z]+-\d:\d{12}:(review-template)/[a-f0-9]{32} Response Elements API Version 2020-03-31 278 AWS Well-Architected Tool Errors API Reference For information about the errors that are common to all actions, see Common Errors. AccessDeniedException User does not have sufficient access to perform this action. HTTP Status Code: 403 ConflictException The resource has already been processed, was deleted, or is too large. HTTP Status Code: 409 InternalServerException There is a problem with the AWS Well-Architected Tool API service. HTTP Status Code: 500 ResourceNotFoundException The requested resource was not found. HTTP Status Code: 404 ThrottlingException Request was denied due to request throttling. HTTP Status Code: 429 ValidationException The user input is not valid. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface Errors API Version 2020-03-31 279 API Reference AWS Well-Architected Tool • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2020-03-31 280 AWS Well-Architected Tool API Reference UpdateReviewTemplateLensReview Update a lens review associated with a review template. Request Syntax PATCH /reviewTemplates/TemplateArn/lensReviews/LensAlias HTTP/1.1 Content-type: application/json { "LensNotes": "string", "PillarNotes": { "string" : "string" } } URI Request Parameters The request uses the following URI parameters. LensAlias The alias of the lens. For AWS official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on AWS official lenses. For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us- west-2:123456789012:lens/0123456789abcdef01234567890abcdef. Each lens is identified by its LensSummary:LensAlias. Length Constraints: Minimum length of 1. Maximum length of 128. Required: Yes TemplateArn The review template ARN. Length Constraints: Minimum length of 50. Maximum length of 250. UpdateReviewTemplateLensReview API Version 2020-03-31 281 AWS Well-Architected Tool API Reference Pattern: arn:aws(-us-gov|-iso(-[a-z])?|-cn)?:wellarchitected:[a-z]{2}(- gov|-iso([a-z])?)?-[a-z]+-\d:\d{12}:(review-template)/[a-f0-9]{32} Required: Yes Request Body The request accepts the following data in JSON format. LensNotes The notes associated with the workload. For a review template, these are the notes that will be associated with the workload when the template is applied. Type: String Length Constraints: Maximum length of 2084. Required: No PillarNotes List of pillar notes of a lens review in a workload. For a review template, these are the notes that will be associated with the workload when the template is applied. Type: String to string map Key Length Constraints: Minimum length of 1. Maximum length of 64. Value Length Constraints: Maximum length of 2084. Required: No Response Syntax HTTP/1.1 200 Content-type: application/json Request Body API Version 2020-03-31 282 API Reference AWS Well-Architected Tool { "LensReview": { "LensAlias": "string", "LensArn": "string", "LensName": "string", "LensStatus": "string", "LensVersion": "string", "NextToken": "string", "Notes": "string", "PillarReviewSummaries": [ { "Notes": "string", "PillarId": "string", "PillarName": "string", "QuestionCounts": { "string" : number } } ], "QuestionCounts": { "string" : number }, "UpdatedAt": number }, "TemplateArn": "string" } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. LensReview A lens review of a question. Type: ReviewTemplateLensReview object TemplateArn The review template ARN. Type: String Response Elements API Version 2020-03-31 283 AWS Well-Architected Tool API Reference Length Constraints: Minimum length of 50. Maximum length of 250. Pattern: arn:aws(-us-gov|-iso(-[a-z])?|-cn)?:wellarchitected:[a-z]{2}(- gov|-iso([a-z])?)?-[a-z]+-\d:\d{12}:(review-template)/[a-f0-9]{32} Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException User does not have sufficient access to perform this action. HTTP Status Code: 403 ConflictException The resource has already been processed, was deleted, or is too large. HTTP Status Code: 409 InternalServerException There is a problem with the AWS Well-Architected Tool API service. HTTP Status Code: 500 ResourceNotFoundException The requested resource was not found. HTTP Status Code: 404 ThrottlingException Request was denied due to request throttling. HTTP Status Code: 429 ValidationException The user input is |
wellarchitected-api-052 | wellarchitected-api.pdf | 52 | of 50. Maximum length of 250. Pattern: arn:aws(-us-gov|-iso(-[a-z])?|-cn)?:wellarchitected:[a-z]{2}(- gov|-iso([a-z])?)?-[a-z]+-\d:\d{12}:(review-template)/[a-f0-9]{32} Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException User does not have sufficient access to perform this action. HTTP Status Code: 403 ConflictException The resource has already been processed, was deleted, or is too large. HTTP Status Code: 409 InternalServerException There is a problem with the AWS Well-Architected Tool API service. HTTP Status Code: 500 ResourceNotFoundException The requested resource was not found. HTTP Status Code: 404 ThrottlingException Request was denied due to request throttling. HTTP Status Code: 429 ValidationException The user input is not valid. HTTP Status Code: 400 Errors API Version 2020-03-31 284 AWS Well-Architected Tool See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2020-03-31 285 AWS Well-Architected Tool API Reference UpdateShareInvitation Update a workload or custom lens share invitation. Note This API operation can be called independently of any resource. Previous documentation implied that a workload ARN must be specified. Request Syntax PATCH /shareInvitations/ShareInvitationId HTTP/1.1 Content-type: application/json { "ShareInvitationAction": "string" } URI Request Parameters The request uses the following URI parameters. ShareInvitationId The ID assigned to the share invitation. Pattern: [0-9a-f]{32} Required: Yes Request Body The request accepts the following data in JSON format. ShareInvitationAction Share invitation action taken by contributor. Type: String UpdateShareInvitation API Version 2020-03-31 286 AWS Well-Architected Tool API Reference Valid Values: ACCEPT | REJECT Required: Yes Response Syntax HTTP/1.1 200 Content-type: application/json { "ShareInvitation": { "LensAlias": "string", "LensArn": "string", "ProfileArn": "string", "ShareInvitationId": "string", "ShareResourceType": "string", "TemplateArn": "string", "WorkloadId": "string" } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. ShareInvitation The updated workload or custom lens share invitation. Type: ShareInvitation object Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException User does not have sufficient access to perform this action. Response Syntax API Version 2020-03-31 287 AWS Well-Architected Tool HTTP Status Code: 403 ConflictException The resource has already been processed, was deleted, or is too large. HTTP Status Code: 409 InternalServerException There is a problem with the AWS Well-Architected Tool API service. API Reference HTTP Status Code: 500 ResourceNotFoundException The requested resource was not found. HTTP Status Code: 404 ThrottlingException Request was denied due to request throttling. HTTP Status Code: 429 ValidationException The user input is not valid. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 See Also API Version 2020-03-31 288 AWS Well-Architected Tool • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 API Reference See Also API Version 2020-03-31 289 API Reference AWS Well-Architected Tool UpdateWorkload Update an existing workload. Request Syntax PATCH /workloads/WorkloadId HTTP/1.1 Content-type: application/json { "AccountIds": [ "string" ], "Applications": [ "string" ], "ArchitecturalDesign": "string", "AwsRegions": [ "string" ], "Description": "string", "DiscoveryConfig": { "TrustedAdvisorIntegrationStatus": "string", "WorkloadResourceDefinition": [ "string" ] }, "Environment": "string", "ImprovementStatus": "string", "Industry": "string", "IndustryType": "string", "IsReviewOwnerUpdateAcknowledged": boolean, "JiraConfiguration": { "IssueManagementStatus": "string", "IssueManagementType": "string", "JiraProjectKey": "string" }, "NonAwsRegions": [ "string" ], "Notes": "string", "PillarPriorities": [ "string" ], "ReviewOwner": "string", "WorkloadName": "string" } URI Request Parameters The request uses the following URI parameters. UpdateWorkload API Version 2020-03-31 290 AWS Well-Architected Tool WorkloadId API Reference The ID assigned to the workload. This ID is unique within an AWS Region. Length Constraints: Fixed length of 32. Pattern: [0-9a-f]{32} Required: Yes Request Body The request accepts the following data in JSON format. AccountIds The list of AWS account IDs associated with the workload. Type: Array of strings Array Members: Maximum number of 100 items. Length Constraints: Fixed length of 12. Pattern: [0-9]{12} Required: No Applications List of AppRegistry application ARNs to associate to the workload. Type: Array of strings Array Members: Maximum number of 1 item. Length Constraints: Maximum length of 2084. Pattern: arn:aws[-a-z]*:servicecatalog:[a-z]{2}(-gov)?-[a-z]+-\d:\d{12}:/ applications/[a-z0-9]+ Required: No Request Body API Version 2020-03-31 291 AWS Well-Architected Tool ArchitecturalDesign API Reference The URL of the architectural design for the workload. Type: String Length Constraints: Maximum length of 2048. Pattern: ^(|(https?|ftp):\/\/[^\s/$.?#].[^\s]*)$ Required: No AwsRegions The list of AWS Regions |
wellarchitected-api-053 | wellarchitected-api.pdf | 53 | AWS account IDs associated with the workload. Type: Array of strings Array Members: Maximum number of 100 items. Length Constraints: Fixed length of 12. Pattern: [0-9]{12} Required: No Applications List of AppRegistry application ARNs to associate to the workload. Type: Array of strings Array Members: Maximum number of 1 item. Length Constraints: Maximum length of 2084. Pattern: arn:aws[-a-z]*:servicecatalog:[a-z]{2}(-gov)?-[a-z]+-\d:\d{12}:/ applications/[a-z0-9]+ Required: No Request Body API Version 2020-03-31 291 AWS Well-Architected Tool ArchitecturalDesign API Reference The URL of the architectural design for the workload. Type: String Length Constraints: Maximum length of 2048. Pattern: ^(|(https?|ftp):\/\/[^\s/$.?#].[^\s]*)$ Required: No AwsRegions The list of AWS Regions associated with the workload, for example, us-east-2, or ca- central-1. Type: Array of strings Array Members: Maximum number of 50 items. Length Constraints: Maximum length of 100. Required: No Description The description for the workload. Type: String Length Constraints: Minimum length of 3. Maximum length of 250. Required: No DiscoveryConfig Well-Architected discovery configuration settings to associate to the workload. Type: WorkloadDiscoveryConfig object Required: No Environment The environment for the workload. Type: String Request Body API Version 2020-03-31 292 AWS Well-Architected Tool API Reference Valid Values: PRODUCTION | PREPRODUCTION Required: No ImprovementStatus The improvement status for a workload. Type: String Valid Values: NOT_APPLICABLE | NOT_STARTED | IN_PROGRESS | COMPLETE | RISK_ACKNOWLEDGED Required: No Industry The industry for the workload. Type: String Length Constraints: Maximum length of 100. Required: No IndustryType The industry type for the workload. If specified, must be one of the following: • Agriculture • Automobile • Defense • Design and Engineering • Digital Advertising • Education • Environmental Protection • Financial Services • Gaming • General Public Services • Healthcare Request Body API Version 2020-03-31 293 API Reference AWS Well-Architected Tool • Hospitality • InfoTech • Justice and Public Safety • Life Sciences • Manufacturing • Media & Entertainment • Mining & Resources • Oil & Gas • Power & Utilities • Professional Services • Real Estate & Construction • Retail & Wholesale • Social Protection • Telecommunications • Travel, Transportation & Logistics • Other Type: String Length Constraints: Maximum length of 100. Required: No IsReviewOwnerUpdateAcknowledged Flag indicating whether the workload owner has acknowledged that the Review owner field is required. If a Review owner is not added to the workload within 60 days of acknowledgement, access to the workload is restricted until an owner is added. Type: Boolean Required: No JiraConfiguration Configuration of the Jira integration. Request Body API Version 2020-03-31 294 AWS Well-Architected Tool API Reference Type: WorkloadJiraConfigurationInput object Required: No NonAwsRegions The list of non-AWS Regions associated with the workload. Type: Array of strings Array Members: Maximum number of 5 items. Length Constraints: Minimum length of 3. Maximum length of 25. Required: No Notes The notes associated with the workload. For a review template, these are the notes that will be associated with the workload when the template is applied. Type: String Length Constraints: Maximum length of 2084. Required: No PillarPriorities The priorities of the pillars, which are used to order items in the improvement plan. Each pillar is represented by its PillarReviewSummary:PillarId. Type: Array of strings Length Constraints: Minimum length of 1. Maximum length of 64. Required: No ReviewOwner The review owner of the workload. The name, email address, or identifier for the primary group or individual that owns the workload review process. Request Body API Version 2020-03-31 295 AWS Well-Architected Tool Type: String API Reference Length Constraints: Minimum length of 3. Maximum length of 255. Required: No WorkloadName The name of the workload. The name must be unique within an account within an AWS Region. Spaces and capitalization are ignored when checking for uniqueness. Type: String Length Constraints: Minimum length of 3. Maximum length of 100. Required: No Response Syntax HTTP/1.1 200 Content-type: application/json { "Workload": { "AccountIds": [ "string" ], "Applications": [ "string" ], "ArchitecturalDesign": "string", "AwsRegions": [ "string" ], "Description": "string", "DiscoveryConfig": { "TrustedAdvisorIntegrationStatus": "string", "WorkloadResourceDefinition": [ "string" ] }, "Environment": "string", "ImprovementStatus": "string", "Industry": "string", "IndustryType": "string", "IsReviewOwnerUpdateAcknowledged": boolean, "JiraConfiguration": { "IssueManagementStatus": "string", "IssueManagementType": "string", Response Syntax API Version 2020-03-31 296 AWS Well-Architected Tool API Reference "JiraProjectKey": "string", "StatusMessage": "string" }, "Lenses": [ "string" ], "NonAwsRegions": [ "string" ], "Notes": "string", "Owner": "string", "PillarPriorities": [ "string" ], "PrioritizedRiskCounts": { "string" : number }, "Profiles": [ { "ProfileArn": "string", "ProfileVersion": "string" } ], "ReviewOwner": "string", "ReviewRestrictionDate": number, "RiskCounts": { "string" : number }, "ShareInvitationId": "string", "Tags": { "string" : "string" }, "UpdatedAt": number, "WorkloadArn": "string", "WorkloadId": "string", "WorkloadName": "string" } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. Workload A workload return object. Type: Workload object Response Elements API Version 2020-03-31 297 AWS Well-Architected Tool Errors API Reference For information about the errors that are common to all actions, see Common Errors. |
wellarchitected-api-054 | wellarchitected-api.pdf | 54 | : number }, "Profiles": [ { "ProfileArn": "string", "ProfileVersion": "string" } ], "ReviewOwner": "string", "ReviewRestrictionDate": number, "RiskCounts": { "string" : number }, "ShareInvitationId": "string", "Tags": { "string" : "string" }, "UpdatedAt": number, "WorkloadArn": "string", "WorkloadId": "string", "WorkloadName": "string" } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. Workload A workload return object. Type: Workload object Response Elements API Version 2020-03-31 297 AWS Well-Architected Tool Errors API Reference For information about the errors that are common to all actions, see Common Errors. AccessDeniedException User does not have sufficient access to perform this action. HTTP Status Code: 403 ConflictException The resource has already been processed, was deleted, or is too large. HTTP Status Code: 409 InternalServerException There is a problem with the AWS Well-Architected Tool API service. HTTP Status Code: 500 ResourceNotFoundException The requested resource was not found. HTTP Status Code: 404 ThrottlingException Request was denied due to request throttling. HTTP Status Code: 429 ValidationException The user input is not valid. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface Errors API Version 2020-03-31 298 API Reference AWS Well-Architected Tool • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2020-03-31 299 AWS Well-Architected Tool API Reference UpdateWorkloadShare Update a workload share. Request Syntax PATCH /workloads/WorkloadId/shares/ShareId HTTP/1.1 Content-type: application/json { "PermissionType": "string" } URI Request Parameters The request uses the following URI parameters. ShareId The ID associated with the share. Pattern: [0-9a-f]{32} Required: Yes WorkloadId The ID assigned to the workload. This ID is unique within an AWS Region. Length Constraints: Fixed length of 32. Pattern: [0-9a-f]{32} Required: Yes Request Body The request accepts the following data in JSON format. PermissionType Permission granted on a share request. UpdateWorkloadShare API Version 2020-03-31 300 API Reference AWS Well-Architected Tool Type: String Valid Values: READONLY | CONTRIBUTOR Required: Yes Response Syntax HTTP/1.1 200 Content-type: application/json { "WorkloadId": "string", "WorkloadShare": { "PermissionType": "string", "SharedBy": "string", "SharedWith": "string", "ShareId": "string", "Status": "string", "WorkloadId": "string", "WorkloadName": "string" } } Response Elements If the action is successful, the service sends back an HTTP 200 response. The following data is returned in JSON format by the service. WorkloadId The ID assigned to the workload. This ID is unique within an AWS Region. Type: String Length Constraints: Fixed length of 32. Pattern: [0-9a-f]{32} WorkloadShare A workload share return object. Response Syntax API Version 2020-03-31 301 AWS Well-Architected Tool Type: WorkloadShare object Errors API Reference For information about the errors that are common to all actions, see Common Errors. AccessDeniedException User does not have sufficient access to perform this action. HTTP Status Code: 403 ConflictException The resource has already been processed, was deleted, or is too large. HTTP Status Code: 409 InternalServerException There is a problem with the AWS Well-Architected Tool API service. HTTP Status Code: 500 ResourceNotFoundException The requested resource was not found. HTTP Status Code: 404 ThrottlingException Request was denied due to request throttling. HTTP Status Code: 429 ValidationException The user input is not valid. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: Errors API Version 2020-03-31 302 API Reference AWS Well-Architected Tool • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2020-03-31 303 AWS Well-Architected Tool API Reference UpgradeLensReview Upgrade lens review for a particular workload. Request Syntax PUT /workloads/WorkloadId/lensReviews/LensAlias/upgrade HTTP/1.1 Content-type: application/json { "ClientRequestToken": "string", "MilestoneName": "string" } URI Request Parameters The request uses the following URI parameters. LensAlias The alias of the lens. For AWS official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on AWS official lenses. For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us- west-2:123456789012:lens/0123456789abcdef01234567890abcdef. Each lens is identified by its LensSummary:LensAlias. Length Constraints: Minimum length of 1. Maximum length of 128. Required: Yes WorkloadId The ID assigned to the workload. This ID is unique within an AWS Region. Length Constraints: Fixed length of 32. Pattern: [0-9a-f]{32} UpgradeLensReview API Version 2020-03-31 304 AWS Well-Architected |
wellarchitected-api-055 | wellarchitected-api.pdf | 55 | of the lens. For AWS official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on AWS official lenses. For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us- west-2:123456789012:lens/0123456789abcdef01234567890abcdef. Each lens is identified by its LensSummary:LensAlias. Length Constraints: Minimum length of 1. Maximum length of 128. Required: Yes WorkloadId The ID assigned to the workload. This ID is unique within an AWS Region. Length Constraints: Fixed length of 32. Pattern: [0-9a-f]{32} UpgradeLensReview API Version 2020-03-31 304 AWS Well-Architected Tool Required: Yes Request Body The request accepts the following data in JSON format. ClientRequestToken API Reference 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 AWS SDKs automatically generate one for you. If you are not using the AWS SDK or the AWS CLI, you must provide this token or the request will fail. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: ^[\x00-\x7F]*$ Required: No MilestoneName The name of the milestone in a workload. Milestone names must be unique within a workload. Type: String Length Constraints: Minimum length of 3. Maximum length of 100. Required: Yes Request Body API Version 2020-03-31 305 AWS Well-Architected Tool Response Syntax HTTP/1.1 200 Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException User does not have sufficient access to perform this action. HTTP Status Code: 403 ConflictException The resource has already been processed, was deleted, or is too large. HTTP Status Code: 409 InternalServerException There is a problem with the AWS Well-Architected Tool API service. HTTP Status Code: 500 ResourceNotFoundException The requested resource was not found. HTTP Status Code: 404 ServiceQuotaExceededException The user has reached their resource quota. HTTP Status Code: 402 ThrottlingException Request was denied due to request throttling. Response Syntax API Version 2020-03-31 306 AWS Well-Architected Tool HTTP Status Code: 429 ValidationException The user input is not valid. HTTP Status Code: 400 See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2020-03-31 307 AWS Well-Architected Tool API Reference UpgradeProfileVersion Upgrade a profile. Request Syntax PUT /workloads/WorkloadId/profiles/ProfileArn/upgrade HTTP/1.1 Content-type: application/json { "ClientRequestToken": "string", "MilestoneName": "string" } URI Request Parameters The request uses the following URI parameters. ProfileArn The profile ARN. Length Constraints: Maximum length of 2084. Pattern: arn:aws[-a-z]*:wellarchitected:[a-z]{2}(-gov)?-[a-z]+-\d: \d{12}:profile/[a-z0-9]+ Required: Yes WorkloadId The ID assigned to the workload. This ID is unique within an AWS Region. Length Constraints: Fixed length of 32. Pattern: [0-9a-f]{32} Required: Yes Request Body The request accepts the following data in JSON format. UpgradeProfileVersion API Version 2020-03-31 308 AWS Well-Architected Tool ClientRequestToken API Reference 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 AWS SDKs automatically generate one for you. If you are not using the AWS SDK or the AWS CLI, you must provide this token or the request will fail. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: ^[\x00-\x7F]*$ Required: No MilestoneName The name of the milestone in a workload. Milestone names must be unique within a workload. Type: String Length Constraints: Minimum length of 3. Maximum length of 100. Required: No Response Syntax HTTP/1.1 200 Response Syntax API Version 2020-03-31 309 AWS Well-Architected Tool Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException User does not have sufficient access to perform this action. HTTP |
wellarchitected-api-056 | wellarchitected-api.pdf | 56 | length of 2048. Pattern: ^[\x00-\x7F]*$ Required: No MilestoneName The name of the milestone in a workload. Milestone names must be unique within a workload. Type: String Length Constraints: Minimum length of 3. Maximum length of 100. Required: No Response Syntax HTTP/1.1 200 Response Syntax API Version 2020-03-31 309 AWS Well-Architected Tool Response Elements API Reference If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Errors For information about the errors that are common to all actions, see Common Errors. AccessDeniedException User does not have sufficient access to perform this action. HTTP Status Code: 403 ConflictException The resource has already been processed, was deleted, or is too large. HTTP Status Code: 409 InternalServerException There is a problem with the AWS Well-Architected Tool API service. HTTP Status Code: 500 ResourceNotFoundException The requested resource was not found. HTTP Status Code: 404 ServiceQuotaExceededException The user has reached their resource quota. HTTP Status Code: 402 ThrottlingException Request was denied due to request throttling. HTTP Status Code: 429 ValidationException The user input is not valid. Response Elements API Version 2020-03-31 310 AWS Well-Architected Tool HTTP Status Code: 400 See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2020-03-31 311 AWS Well-Architected Tool API Reference UpgradeReviewTemplateLensReview Upgrade the lens review of a review template. Request Syntax PUT /reviewTemplates/TemplateArn/lensReviews/LensAlias/upgrade HTTP/1.1 Content-type: application/json { "ClientRequestToken": "string" } URI Request Parameters The request uses the following URI parameters. LensAlias The alias of the lens. For AWS official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on AWS official lenses. For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us- west-2:123456789012:lens/0123456789abcdef01234567890abcdef. Each lens is identified by its LensSummary:LensAlias. Length Constraints: Minimum length of 1. Maximum length of 128. Required: Yes TemplateArn The ARN of the review template. Length Constraints: Minimum length of 50. Maximum length of 250. Pattern: arn:aws(-us-gov|-iso(-[a-z])?|-cn)?:wellarchitected:[a-z]{2}(- gov|-iso([a-z])?)?-[a-z]+-\d:\d{12}:(review-template)/[a-f0-9]{32} UpgradeReviewTemplateLensReview API Version 2020-03-31 312 AWS Well-Architected Tool Required: Yes Request Body The request accepts the following data in JSON format. ClientRequestToken API Reference 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 AWS SDKs automatically generate one for you. If you are not using the AWS SDK or the AWS CLI, you must provide this token or the request will fail. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Pattern: ^[\x00-\x7F]*$ Required: No Response Syntax HTTP/1.1 200 Response Elements If the action is successful, the service sends back an HTTP 200 response with an empty HTTP body. Request Body API Version 2020-03-31 313 AWS Well-Architected Tool Errors API Reference For information about the errors that are common to all actions, see Common Errors. AccessDeniedException User does not have sufficient access to perform this action. HTTP Status Code: 403 ConflictException The resource has already been processed, was deleted, or is too large. HTTP Status Code: 409 InternalServerException There is a problem with the AWS Well-Architected Tool API service. HTTP Status Code: 500 ResourceNotFoundException The requested resource was not found. HTTP Status Code: 404 ThrottlingException Request was denied due to request throttling. HTTP Status Code: 429 ValidationException The user input is not valid. HTTP Status Code: 400 See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS Command Line Interface Errors API Version 2020-03-31 314 API Reference AWS Well-Architected Tool • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2020-03-31 315 AWS Well-Architected Tool Data Types API Reference The AWS Well-Architected Tool API contains several data types that various actions use. This section describes each data type in detail. Note The order of each element in a data type |
wellarchitected-api-057 | wellarchitected-api.pdf | 57 | 314 API Reference AWS Well-Architected Tool • AWS SDK for .NET • AWS SDK for C++ • AWS SDK for Go v2 • AWS SDK for Java V2 • AWS SDK for JavaScript V3 • AWS SDK for Kotlin • AWS SDK for PHP V3 • AWS SDK for Python • AWS SDK for Ruby V3 See Also API Version 2020-03-31 315 AWS Well-Architected Tool Data Types API Reference The AWS Well-Architected Tool API contains several data types that various actions use. This section describes each data type in detail. Note The order of each element in a data type structure is not guaranteed. Applications should not assume a particular order. The following data types are supported: • AccountJiraConfigurationInput • AccountJiraConfigurationOutput • AdditionalResources • Answer • AnswerSummary • BestPractice • CheckDetail • CheckSummary • Choice • ChoiceAnswer • ChoiceAnswerSummary • ChoiceContent • ChoiceImprovementPlan • ChoiceUpdate • ConsolidatedReportMetric • ImprovementSummary • JiraConfiguration • JiraSelectedQuestionConfiguration • Lens • LensMetric API Version 2020-03-31 316 AWS Well-Architected Tool • LensReview • LensReviewReport • LensReviewSummary • LensShareSummary • LensSummary • LensUpgradeSummary • Milestone • MilestoneSummary • NotificationSummary • PillarDifference • PillarMetric • PillarReviewSummary • Profile • ProfileChoice • ProfileNotificationSummary • ProfileQuestion • ProfileQuestionUpdate • ProfileShareSummary • ProfileSummary • ProfileTemplate • ProfileTemplateChoice • ProfileTemplateQuestion • QuestionDifference • QuestionMetric • ReviewTemplate • ReviewTemplateAnswer • ReviewTemplateAnswerSummary • ReviewTemplateLensReview • ReviewTemplatePillarReviewSummary • ReviewTemplateSummary API Reference API Version 2020-03-31 317 AWS Well-Architected Tool • SelectedPillar • ShareInvitation • ShareInvitationSummary • TemplateShareSummary • ValidationExceptionField • VersionDifferences • Workload • WorkloadDiscoveryConfig • WorkloadJiraConfigurationInput • WorkloadJiraConfigurationOutput • WorkloadProfile • WorkloadShare • WorkloadShareSummary • WorkloadSummary API Reference API Version 2020-03-31 318 AWS Well-Architected Tool API Reference AccountJiraConfigurationInput Account-level: Input for the Jira configuration. Contents IntegrationStatus Account-level: Configuration status of the Jira integration. Type: String Valid Values: NOT_CONFIGURED Required: No IssueManagementStatus Account-level: Jira issue management status. Type: String Valid Values: ENABLED | DISABLED Required: No IssueManagementType Account-level: Jira issue management type. Type: String Valid Values: AUTO | MANUAL Required: No JiraProjectKey Account-level: Jira project key to sync workloads to. Type: String Length Constraints: Minimum length of 1. Maximum length of 100. Pattern: ^[A-Z][A-Z0-9_]*$ AccountJiraConfigurationInput API Version 2020-03-31 319 AWS Well-Architected Tool Required: No See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2020-03-31 320 AWS Well-Architected Tool API Reference AccountJiraConfigurationOutput Account-level: Output configuration of the Jira integration. Contents IntegrationStatus Account-level: Configuration status of the Jira integration. Type: String Valid Values: CONFIGURED | NOT_CONFIGURED Required: No IssueManagementStatus Account-level: Jira issue management status. Type: String Valid Values: ENABLED | DISABLED Required: No IssueManagementType Account-level: Jira issue management type. Type: String Valid Values: AUTO | MANUAL Required: No JiraProjectKey Account-level: Jira project key to sync workloads to. Type: String Length Constraints: Minimum length of 1. Maximum length of 100. Pattern: ^[A-Z][A-Z0-9_]*$ AccountJiraConfigurationOutput API Version 2020-03-31 321 API Reference AWS Well-Architected Tool Required: No StatusMessage Account-level: Status message on configuration of the Jira integration. Type: String Length Constraints: Minimum length of 1. Maximum length of 512. Required: No Subdomain Account-level: Jira subdomain URL. Type: String Length Constraints: Minimum length of 1. Maximum length of 100. Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2020-03-31 322 AWS Well-Architected Tool API Reference AdditionalResources The choice level additional resources for a custom lens. This field does not apply to AWS official lenses. Contents Content The URLs for additional resources, either helpful resources or improvement plans, for a custom lens. Up to five additional URLs can be specified. Type: Array of ChoiceContent objects Required: No Type Type of additional resource for a custom lens. Type: String Valid Values: HELPFUL_RESOURCE | IMPROVEMENT_PLAN Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 AdditionalResources API Version 2020-03-31 323 API Reference AWS Well-Architected Tool Answer An answer of the question. Contents ChoiceAnswers A list of selected choices to a question in your workload. Type: Array of ChoiceAnswer objects Required: No Choices List of choices available for a question. Type: Array of Choice objects Required: No HelpfulResourceDisplayText The helpful resource text to be displayed for a custom lens. This field does not apply to AWS official lenses. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Required: No HelpfulResourceUrl The helpful resource URL. For AWS official lenses, this is the helpful resource URL for a question or choice. For |
wellarchitected-api-058 | wellarchitected-api.pdf | 58 | AWS Well-Architected Tool Answer An answer of the question. Contents ChoiceAnswers A list of selected choices to a question in your workload. Type: Array of ChoiceAnswer objects Required: No Choices List of choices available for a question. Type: Array of Choice objects Required: No HelpfulResourceDisplayText The helpful resource text to be displayed for a custom lens. This field does not apply to AWS official lenses. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Required: No HelpfulResourceUrl The helpful resource URL. For AWS official lenses, this is the helpful resource URL for a question or choice. For custom lenses, this is the helpful resource URL for a question and is only provided if HelpfulResourceDisplayText was specified for the question. Type: String Answer API Version 2020-03-31 324 AWS Well-Architected Tool API Reference Length Constraints: Minimum length of 1. Maximum length of 2048. Required: No ImprovementPlanUrl The improvement plan URL for a question in an AWS official lenses. This value is only available if the question has been answered. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Required: No IsApplicable Defines whether this question is applicable to a lens review. Type: Boolean Required: No JiraConfiguration Configuration of the Jira integration. Type: JiraConfiguration object Required: No Notes The notes associated with the workload. For a review template, these are the notes that will be associated with the workload when the template is applied. Type: String Length Constraints: Maximum length of 2084. Required: No PillarId The ID used to identify a pillar, for example, security. Contents API Version 2020-03-31 325 AWS Well-Architected Tool API Reference A pillar is identified by its PillarReviewSummary:PillarId. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Required: No QuestionDescription The description of the question. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Required: No QuestionId The ID of the question. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Required: No QuestionTitle The title of the question. Type: String Length Constraints: Minimum length of 1. Maximum length of 512. Required: No Reason The reason why the question is not applicable to your workload. Type: String Valid Values: OUT_OF_SCOPE | BUSINESS_PRIORITIES | ARCHITECTURE_CONSTRAINTS | OTHER | NONE Contents API Version 2020-03-31 326 AWS Well-Architected Tool Required: No Risk API Reference The risk for a given workload, lens review, pillar, or question. Type: String Valid Values: UNANSWERED | HIGH | MEDIUM | NONE | NOT_APPLICABLE Required: No SelectedChoices List of selected choice IDs in a question answer. The values entered replace the previously selected choices. Type: Array of strings Length Constraints: Minimum length of 1. Maximum length of 64. Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2020-03-31 327 API Reference AWS Well-Architected Tool AnswerSummary An answer summary of a lens review in a workload. Contents ChoiceAnswerSummaries A list of selected choices to a question in your workload. Type: Array of ChoiceAnswerSummary objects Required: No Choices List of choices available for a question. Type: Array of Choice objects Required: No IsApplicable Defines whether this question is applicable to a lens review. Type: Boolean Required: No JiraConfiguration Configuration of the Jira integration. Type: JiraConfiguration object Required: No PillarId The ID used to identify a pillar, for example, security. A pillar is identified by its PillarReviewSummary:PillarId. Type: String AnswerSummary API Version 2020-03-31 328 AWS Well-Architected Tool API Reference Length Constraints: Minimum length of 1. Maximum length of 64. Required: No QuestionId The ID of the question. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Required: No QuestionTitle The title of the question. Type: String Length Constraints: Minimum length of 1. Maximum length of 512. Required: No QuestionType The type of the question. Type: String Valid Values: PRIORITIZED | NON_PRIORITIZED Required: No Reason The reason why a choice is non-applicable to a question in your workload. Type: String Valid Values: OUT_OF_SCOPE | BUSINESS_PRIORITIES | ARCHITECTURE_CONSTRAINTS | OTHER | NONE Required: No Risk The risk for a given workload, lens review, pillar, or question. Contents API Version 2020-03-31 329 AWS Well-Architected Tool Type: String API Reference Valid Values: UNANSWERED | HIGH | MEDIUM | NONE | NOT_APPLICABLE Required: No SelectedChoices List of selected choice IDs in a question answer. The values entered replace the previously selected choices. Type: Array of strings Length Constraints: Minimum length of 1. Maximum length of 64. Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See |
wellarchitected-api-059 | wellarchitected-api.pdf | 59 | review, pillar, or question. Contents API Version 2020-03-31 329 AWS Well-Architected Tool Type: String API Reference Valid Values: UNANSWERED | HIGH | MEDIUM | NONE | NOT_APPLICABLE Required: No SelectedChoices List of selected choice IDs in a question answer. The values entered replace the previously selected choices. Type: Array of strings Length Constraints: Minimum length of 1. Maximum length of 64. Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2020-03-31 330 AWS Well-Architected Tool BestPractice API Reference A best practice, or question choice, that has been identified as a risk in this question. Contents ChoiceId The ID of a choice. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Required: No ChoiceTitle The title of a choice. Type: String Length Constraints: Minimum length of 1. Maximum length of 512. Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 BestPractice API Version 2020-03-31 331 AWS Well-Architected Tool CheckDetail API Reference Account details for a Well-Architected best practice in relation to Trusted Advisor checks. Contents AccountId An AWS account ID. Type: String Length Constraints: Fixed length of 12. Pattern: [0-9]{12} Required: No ChoiceId The ID of a choice. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Required: No Description Trusted Advisor check description. Type: String Required: No FlaggedResources Count of flagged resources associated to the check. Type: Integer Valid Range: Minimum value of 1. Maximum value of 9999. Required: No CheckDetail API Version 2020-03-31 332 AWS Well-Architected Tool Id Trusted Advisor check ID. Type: String Required: No LensArn Well-Architected Lens ARN associated to the check. Type: String Required: No Name Trusted Advisor check name. Type: String Required: No PillarId The ID used to identify a pillar, for example, security. A pillar is identified by its PillarReviewSummary:PillarId. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Required: No Provider Provider of the check related to the best practice. Type: String Valid Values: TRUSTED_ADVISOR Required: No Contents API Reference API Version 2020-03-31 333 AWS Well-Architected Tool QuestionId The ID of the question. Type: String API Reference Length Constraints: Minimum length of 1. Maximum length of 128. Required: No Reason Reason associated to the check. Type: String Valid Values: ASSUME_ROLE_ERROR | ACCESS_DENIED | UNKNOWN_ERROR | PREMIUM_SUPPORT_REQUIRED Required: No Status Status associated to the check. Type: String Valid Values: OKAY | WARNING | ERROR | NOT_AVAILABLE | FETCH_FAILED Required: No UpdatedAt The date and time recorded in Unix format (seconds). Type: Timestamp Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ See Also API Version 2020-03-31 334 AWS Well-Architected Tool • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference See Also API Version 2020-03-31 335 API Reference AWS Well-Architected Tool CheckSummary Trusted Advisor check summary. Contents AccountSummary Account summary associated to the check. Type: String to integer map Valid Keys: OKAY | WARNING | ERROR | NOT_AVAILABLE | FETCH_FAILED Valid Range: Minimum value of 1. Maximum value of 101. Required: No ChoiceId The ID of a choice. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Required: No Description Trusted Advisor check description. Type: String Required: No Id Trusted Advisor check ID. Type: String Required: No LensArn Well-Architected Lens ARN associated to the check. CheckSummary API Version 2020-03-31 336 API Reference AWS Well-Architected Tool Type: String Required: No Name Trusted Advisor check name. Type: String Required: No PillarId The ID used to identify a pillar, for example, security. A pillar is identified by its PillarReviewSummary:PillarId. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Required: No Provider Provider of the check related to the best practice. Type: String Valid Values: TRUSTED_ADVISOR Required: No QuestionId The ID of the question. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Required: No Status Status associated to the check. Contents API Version 2020-03-31 337 AWS Well-Architected Tool Type: String API Reference Valid Values: OKAY | WARNING | ERROR | NOT_AVAILABLE | FETCH_FAILED Required: No UpdatedAt The date and time recorded in Unix format (seconds). Type: Timestamp Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2020-03-31 338 AWS Well-Architected Tool Choice A |
wellarchitected-api-060 | wellarchitected-api.pdf | 60 | of 1. Maximum length of 128. Required: No Status Status associated to the check. Contents API Version 2020-03-31 337 AWS Well-Architected Tool Type: String API Reference Valid Values: OKAY | WARNING | ERROR | NOT_AVAILABLE | FETCH_FAILED Required: No UpdatedAt The date and time recorded in Unix format (seconds). Type: Timestamp Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2020-03-31 338 AWS Well-Architected Tool Choice A choice available to answer question. Contents AdditionalResources API Reference 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. Type: Array of AdditionalResources objects Required: No ChoiceId The ID of a choice. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Required: No Description The description of a choice. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Required: No HelpfulResource 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. Type: ChoiceContent object Choice API Version 2020-03-31 339 AWS Well-Architected Tool Required: No ImprovementPlan API Reference 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. Type: ChoiceContent object Required: No Title The title of a choice. Type: String Length Constraints: Minimum length of 1. Maximum length of 512. Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2020-03-31 340 AWS Well-Architected Tool ChoiceAnswer A choice that has been answered on a question in your workload. API Reference Contents ChoiceId The ID of a choice. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Required: No Notes The notes associated with a choice. Type: String Length Constraints: Maximum length of 250. Required: No Reason The reason why a choice is non-applicable to a question in your workload. Type: String Valid Values: OUT_OF_SCOPE | BUSINESS_PRIORITIES | ARCHITECTURE_CONSTRAINTS | OTHER | NONE Required: No Status The status of a choice. Type: String Valid Values: SELECTED | NOT_APPLICABLE | UNSELECTED ChoiceAnswer API Version 2020-03-31 341 AWS Well-Architected Tool Required: No See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2020-03-31 342 AWS Well-Architected Tool API Reference ChoiceAnswerSummary A choice summary that has been answered on a question in your workload. Contents ChoiceId The ID of a choice. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Required: No Reason The reason why a choice is non-applicable to a question in your workload. Type: String Valid Values: OUT_OF_SCOPE | BUSINESS_PRIORITIES | ARCHITECTURE_CONSTRAINTS | OTHER | NONE Required: No Status The status of a choice. Type: String Valid Values: SELECTED | NOT_APPLICABLE | UNSELECTED Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ ChoiceAnswerSummary API Version 2020-03-31 343 AWS Well-Architected Tool • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference See Also API Version 2020-03-31 344 AWS Well-Architected Tool ChoiceContent The choice content. Contents DisplayText API Reference The display text for the choice content. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Required: No Url The URL for the choice content. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ChoiceContent API Version 2020-03-31 345 AWS Well-Architected Tool API Reference ChoiceImprovementPlan The choice level improvement plan. This value is only applicable to custom lenses. Contents ChoiceId The ID of a choice. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Required: No DisplayText The display text for the improvement plan. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Required: No ImprovementPlanUrl The improvement plan URL for a question in an AWS official lenses. This value is only available if the question has been answered. Type: String Length Constraints: Minimum length of |
wellarchitected-api-061 | wellarchitected-api.pdf | 61 | Ruby V3 ChoiceContent API Version 2020-03-31 345 AWS Well-Architected Tool API Reference ChoiceImprovementPlan The choice level improvement plan. This value is only applicable to custom lenses. Contents ChoiceId The ID of a choice. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Required: No DisplayText The display text for the improvement plan. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Required: No ImprovementPlanUrl The improvement plan URL for a question in an AWS official lenses. This value is only available if the question has been answered. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: ChoiceImprovementPlan API Version 2020-03-31 346 AWS Well-Architected Tool • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference See Also API Version 2020-03-31 347 API Reference AWS Well-Architected Tool ChoiceUpdate A list of choices to be updated. Contents Status The status of a choice. Type: String Valid Values: SELECTED | NOT_APPLICABLE | UNSELECTED Required: Yes Notes The notes associated with a choice. Type: String Length Constraints: Maximum length of 250. Required: No Reason The reason why a choice is non-applicable to a question in your workload. Type: String Valid Values: OUT_OF_SCOPE | BUSINESS_PRIORITIES | ARCHITECTURE_CONSTRAINTS | OTHER | NONE Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ ChoiceUpdate API Version 2020-03-31 348 AWS Well-Architected Tool • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference See Also API Version 2020-03-31 349 AWS Well-Architected Tool API Reference ConsolidatedReportMetric A metric that contributes to the consolidated report. Contents Lenses The metrics for the lenses in the workload. Type: Array of LensMetric objects Required: No LensesAppliedCount The total number of lenses applied to the workload. Type: Integer Valid Range: Minimum value of 0. Required: No MetricType The metric type of a metric in the consolidated report. Currently only WORKLOAD metric types are supported. Type: String Valid Values: WORKLOAD Required: No RiskCounts A map from risk names to the count of how many questions have that rating. Type: String to integer map Valid Keys: UNANSWERED | HIGH | MEDIUM | NONE | NOT_APPLICABLE Valid Range: Minimum value of 0. Required: No ConsolidatedReportMetric API Version 2020-03-31 350 AWS Well-Architected Tool UpdatedAt The date and time recorded in Unix format (seconds). API Reference Type: Timestamp Required: No WorkloadArn The ARN for the workload. Type: String Required: No WorkloadId The ID assigned to the workload. This ID is unique within an AWS Region. Type: String Length Constraints: Fixed length of 32. Pattern: [0-9a-f]{32} Required: No WorkloadName The name of the workload. The name must be unique within an account within an AWS Region. Spaces and capitalization are ignored when checking for uniqueness. Type: String Length Constraints: Minimum length of 3. Maximum length of 100. Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: See Also API Version 2020-03-31 351 AWS Well-Architected Tool • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference See Also API Version 2020-03-31 352 AWS Well-Architected Tool API Reference ImprovementSummary An improvement summary of a lens review in a workload. Contents ImprovementPlans The improvement plan details. This value is only applicable to custom lenses. Type: Array of ChoiceImprovementPlan objects Required: No ImprovementPlanUrl The improvement plan URL for a question in an AWS official lenses. This value is only available if the question has been answered. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Required: No JiraConfiguration Configuration of the Jira integration. Type: JiraConfiguration object Required: No PillarId The ID used to identify a pillar, for example, security. A pillar is identified by its PillarReviewSummary:PillarId. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. ImprovementSummary API Version 2020-03-31 353 AWS Well-Architected Tool Required: No QuestionId The ID of the question. Type: String API Reference Length Constraints: Minimum length of 1. Maximum length of 128. Required: No QuestionTitle The title of the question. Type: String Length Constraints: Minimum length of 1. Maximum length of 512. Required: No Risk The risk for a given workload, lens review, pillar, or question. Type: String Valid Values: UNANSWERED | HIGH | MEDIUM | NONE | NOT_APPLICABLE Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2020-03-31 354 API Reference AWS Well-Architected |
wellarchitected-api-062 | wellarchitected-api.pdf | 62 | 1. Maximum length of 128. Required: No QuestionTitle The title of the question. Type: String Length Constraints: Minimum length of 1. Maximum length of 512. Required: No Risk The risk for a given workload, lens review, pillar, or question. Type: String Valid Values: UNANSWERED | HIGH | MEDIUM | NONE | NOT_APPLICABLE Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2020-03-31 354 API Reference AWS Well-Architected Tool JiraConfiguration Configuration of the Jira integration. Contents JiraIssueUrl The URL of the associated Jira issue. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Required: No LastSyncedTime The date and time recorded in Unix format (seconds). Type: Timestamp Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 JiraConfiguration API Version 2020-03-31 355 AWS Well-Architected Tool API Reference JiraSelectedQuestionConfiguration Selected questions in the workload. Contents SelectedPillars Selected pillars in the workload. Type: Array of SelectedPillar objects Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 JiraSelectedQuestionConfiguration API Version 2020-03-31 356 API Reference AWS Well-Architected Tool Lens A lens return object. Contents Description The description of the lens. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Required: No LensArn The ARN of a lens. Type: String Required: No LensVersion The version of a lens. Type: String Length Constraints: Minimum length of 1. Maximum length of 32. Required: No Name The full name of the lens. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Required: No Owner The AWS account ID that owns the lens. Lens API Version 2020-03-31 357 API Reference AWS Well-Architected Tool Type: String Required: No ShareInvitationId The ID assigned to the share invitation. Type: String Pattern: [0-9a-f]{32} Required: No Tags The tags assigned to the lens. Type: String to string map Map Entries: Maximum number of 50 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Value Length Constraints: Minimum length of 0. Maximum length of 256. Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2020-03-31 358 AWS Well-Architected Tool LensMetric A metric for a particular lens in a workload. API Reference Contents LensArn The lens ARN. Type: String Required: No Pillars The metrics for the pillars in a lens. Type: Array of PillarMetric objects Required: No RiskCounts A map from risk names to the count of how many questions have that rating. Type: String to integer map Valid Keys: UNANSWERED | HIGH | MEDIUM | NONE | NOT_APPLICABLE Valid Range: Minimum value of 0. Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 LensMetric API Version 2020-03-31 359 AWS Well-Architected Tool API Reference See Also API Version 2020-03-31 360 API Reference AWS Well-Architected Tool LensReview A lens review of a question. Contents JiraConfiguration Jira configuration status of the Lens review. Type: JiraSelectedQuestionConfiguration object Required: No LensAlias The alias of the lens. For AWS official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on AWS official lenses. For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us- west-2:123456789012:lens/0123456789abcdef01234567890abcdef. Each lens is identified by its LensSummary:LensAlias. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Required: No LensArn The ARN for the lens. Type: String Required: No LensName The full name of the lens. LensReview API Version 2020-03-31 361 AWS Well-Architected Tool Type: String API Reference Length Constraints: Minimum length of 1. Maximum length of 128. Required: No LensStatus The status of the lens. Type: String Valid Values: CURRENT | NOT_CURRENT | DEPRECATED | DELETED | UNSHARED Required: No LensVersion The version of the lens. Type: String Length Constraints: Minimum length of 1. Maximum length of 32. Required: No NextToken The token to use to retrieve the next set of results. Type: String Required: No Notes The notes associated with the workload. For a review template, these are the |
wellarchitected-api-063 | wellarchitected-api.pdf | 63 | full name of the lens. LensReview API Version 2020-03-31 361 AWS Well-Architected Tool Type: String API Reference Length Constraints: Minimum length of 1. Maximum length of 128. Required: No LensStatus The status of the lens. Type: String Valid Values: CURRENT | NOT_CURRENT | DEPRECATED | DELETED | UNSHARED Required: No LensVersion The version of the lens. Type: String Length Constraints: Minimum length of 1. Maximum length of 32. Required: No NextToken The token to use to retrieve the next set of results. Type: String Required: No Notes The notes associated with the workload. For a review template, these are the notes that will be associated with the workload when the template is applied. Type: String Length Constraints: Maximum length of 2084. Required: No Contents API Version 2020-03-31 362 AWS Well-Architected Tool PillarReviewSummaries API Reference List of pillar review summaries of lens review in a workload. Type: Array of PillarReviewSummary objects Required: No PrioritizedRiskCounts A map from risk names to the count of how many questions have that rating. Type: String to integer map Valid Keys: UNANSWERED | HIGH | MEDIUM | NONE | NOT_APPLICABLE Valid Range: Minimum value of 0. Required: No Profiles The profiles associated with the workload. Type: Array of WorkloadProfile objects Array Members: Maximum number of 1 item. Required: No RiskCounts A map from risk names to the count of how many questions have that rating. Type: String to integer map Valid Keys: UNANSWERED | HIGH | MEDIUM | NONE | NOT_APPLICABLE Valid Range: Minimum value of 0. Required: No UpdatedAt The date and time recorded in Unix format (seconds). Type: Timestamp Contents API Version 2020-03-31 363 AWS Well-Architected Tool Required: No See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2020-03-31 364 AWS Well-Architected Tool LensReviewReport A report of a lens review. Contents Base64String API Reference The Base64-encoded string representation of a lens review report. This data can be used to create a PDF file. Only returned by GetConsolidatedReport when PDF format is requested. Type: String Required: No LensAlias The alias of the lens. For AWS official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on AWS official lenses. For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us- west-2:123456789012:lens/0123456789abcdef01234567890abcdef. Each lens is identified by its LensSummary:LensAlias. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Required: No LensArn The ARN for the lens. Type: String Required: No LensReviewReport API Version 2020-03-31 365 AWS Well-Architected Tool See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2020-03-31 366 AWS Well-Architected Tool API Reference LensReviewSummary A lens review summary of a workload. Contents LensAlias The alias of the lens. For AWS official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on AWS official lenses. For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us- west-2:123456789012:lens/0123456789abcdef01234567890abcdef. Each lens is identified by its LensSummary:LensAlias. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Required: No LensArn The ARN for the lens. Type: String Required: No LensName The full name of the lens. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Required: No LensReviewSummary API Version 2020-03-31 367 AWS Well-Architected Tool LensStatus The status of the lens. Type: String API Reference Valid Values: CURRENT | NOT_CURRENT | DEPRECATED | DELETED | UNSHARED Required: No LensVersion The version of the lens. Type: String Length Constraints: Minimum length of 1. Maximum length of 32. Required: No PrioritizedRiskCounts A map from risk names to the count of how many questions have that rating. Type: String to integer map Valid Keys: UNANSWERED | HIGH | MEDIUM | NONE | NOT_APPLICABLE Valid Range: Minimum value of 0. Required: No Profiles The profiles associated with the workload. Type: Array of WorkloadProfile objects Array Members: Maximum number of 1 item. Required: No RiskCounts A map from risk names to the count of how many questions have that rating. Type: String to integer map Contents API Version 2020-03-31 368 AWS Well-Architected Tool API Reference Valid Keys: UNANSWERED | HIGH | MEDIUM | NONE | NOT_APPLICABLE Valid Range: Minimum value of 0. Required: No UpdatedAt The date and time recorded in Unix format (seconds). Type: Timestamp Required: No See Also |
wellarchitected-api-064 | wellarchitected-api.pdf | 64 | MEDIUM | NONE | NOT_APPLICABLE Valid Range: Minimum value of 0. Required: No Profiles The profiles associated with the workload. Type: Array of WorkloadProfile objects Array Members: Maximum number of 1 item. Required: No RiskCounts A map from risk names to the count of how many questions have that rating. Type: String to integer map Contents API Version 2020-03-31 368 AWS Well-Architected Tool API Reference Valid Keys: UNANSWERED | HIGH | MEDIUM | NONE | NOT_APPLICABLE Valid Range: Minimum value of 0. Required: No UpdatedAt The date and time recorded in Unix format (seconds). Type: Timestamp Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2020-03-31 369 AWS Well-Architected Tool LensShareSummary A lens share summary return object. Contents SharedWith API Reference The AWS account ID, organization ID, or organizational unit (OU) ID with which the workload, lens, profile, or review template is shared. Type: String Length Constraints: Minimum length of 12. Maximum length of 2048. Required: No ShareId The ID associated with the share. Type: String Pattern: [0-9a-f]{32} Required: No Status The status of the share request. Type: String Valid Values: ACCEPTED | REJECTED | PENDING | REVOKED | EXPIRED | ASSOCIATING | ASSOCIATED | FAILED Required: No StatusMessage Optional message to compliment the Status field. Type: String Length Constraints: Minimum length of 1. Maximum length of 512. LensShareSummary API Version 2020-03-31 370 AWS Well-Architected Tool Required: No See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2020-03-31 371 API Reference AWS Well-Architected Tool LensSummary A lens summary of a lens. Contents CreatedAt The date and time recorded in Unix format (seconds). Type: Timestamp Required: No Description The description of the lens. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Required: No LensAlias The alias of the lens. For AWS official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on AWS official lenses. For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us- west-2:123456789012:lens/0123456789abcdef01234567890abcdef. Each lens is identified by its LensSummary:LensAlias. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Required: No LensSummary API Version 2020-03-31 372 API Reference AWS Well-Architected Tool LensArn The ARN of the lens. Type: String Required: No LensName The full name of the lens. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Required: No LensStatus The status of the lens. Type: String Valid Values: CURRENT | NOT_CURRENT | DEPRECATED | DELETED | UNSHARED Required: No LensType The type of the lens. Type: String Valid Values: AWS_OFFICIAL | CUSTOM_SHARED | CUSTOM_SELF Required: No LensVersion The version of the lens. Type: String Length Constraints: Minimum length of 1. Maximum length of 32. Required: No Contents API Version 2020-03-31 373 API Reference AWS Well-Architected Tool Owner An AWS account ID. Type: String Length Constraints: Fixed length of 12. Pattern: [0-9]{12} Required: No UpdatedAt The date and time recorded in Unix format (seconds). Type: Timestamp Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2020-03-31 374 AWS Well-Architected Tool API Reference LensUpgradeSummary Lens upgrade summary return object. Contents CurrentLensVersion The current version of the lens. Type: String Length Constraints: Minimum length of 1. Maximum length of 32. Required: No LatestLensVersion The latest version of the lens. Type: String Length Constraints: Minimum length of 1. Maximum length of 32. Required: No LensAlias The alias of the lens. For AWS official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on AWS official lenses. For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us- west-2:123456789012:lens/0123456789abcdef01234567890abcdef. Each lens is identified by its LensSummary:LensAlias. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Required: No LensUpgradeSummary API Version 2020-03-31 375 AWS Well-Architected Tool LensArn The ARN for the lens. Type: String Required: No ResourceArn API Reference ResourceArn of the lens being upgraded Type: String Length Constraints: Minimum length of 50. Maximum length of 250. Pattern: arn:aws(-us-gov|-iso(-[a-z])?|-cn)?:wellarchitected:[a-z]{2}(- gov|-iso([a-z])?)?-[a-z]+-\d:\d{12}:(review-template)/[a-f0-9]{32} Required: No ResourceName The name of the workload. The name must be unique within an account within an AWS Region. |
wellarchitected-api-065 | wellarchitected-api.pdf | 65 | permitted on AWS official lenses. For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us- west-2:123456789012:lens/0123456789abcdef01234567890abcdef. Each lens is identified by its LensSummary:LensAlias. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Required: No LensUpgradeSummary API Version 2020-03-31 375 AWS Well-Architected Tool LensArn The ARN for the lens. Type: String Required: No ResourceArn API Reference ResourceArn of the lens being upgraded Type: String Length Constraints: Minimum length of 50. Maximum length of 250. Pattern: arn:aws(-us-gov|-iso(-[a-z])?|-cn)?:wellarchitected:[a-z]{2}(- gov|-iso([a-z])?)?-[a-z]+-\d:\d{12}:(review-template)/[a-f0-9]{32} Required: No ResourceName The name of the workload. The name must be unique within an account within an AWS Region. Spaces and capitalization are ignored when checking for uniqueness. Type: String Length Constraints: Minimum length of 3. Maximum length of 100. Required: No WorkloadId The ID assigned to the workload. This ID is unique within an AWS Region. Type: String Length Constraints: Fixed length of 32. Pattern: [0-9a-f]{32} Required: No Contents API Version 2020-03-31 376 AWS Well-Architected Tool WorkloadName The name of the workload. API Reference The name must be unique within an account within an AWS Region. Spaces and capitalization are ignored when checking for uniqueness. Type: String Length Constraints: Minimum length of 3. Maximum length of 100. Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2020-03-31 377 AWS Well-Architected Tool Milestone A milestone return object. Contents MilestoneName The name of the milestone in a workload. Milestone names must be unique within a workload. Type: String Length Constraints: Minimum length of 3. Maximum length of 100. Required: No MilestoneNumber The milestone number. A workload can have a maximum of 100 milestones. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No RecordedAt The date and time recorded in Unix format (seconds). Type: Timestamp Required: No Workload A workload return object. Type: Workload object Required: No Milestone API Reference API Version 2020-03-31 378 AWS Well-Architected Tool See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2020-03-31 379 AWS Well-Architected Tool MilestoneSummary A milestone summary return object. Contents MilestoneName The name of the milestone in a workload. Milestone names must be unique within a workload. Type: String Length Constraints: Minimum length of 3. Maximum length of 100. Required: No MilestoneNumber The milestone number. A workload can have a maximum of 100 milestones. Type: Integer Valid Range: Minimum value of 1. Maximum value of 100. Required: No RecordedAt The date and time recorded in Unix format (seconds). Type: Timestamp Required: No WorkloadSummary A workload summary return object. Type: WorkloadSummary object Required: No MilestoneSummary API Reference API Version 2020-03-31 380 AWS Well-Architected Tool See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2020-03-31 381 AWS Well-Architected Tool API Reference NotificationSummary A notification summary return object. Contents LensUpgradeSummary Summary of lens upgrade. Type: LensUpgradeSummary object Required: No Type The type of notification. Type: String Valid Values: LENS_VERSION_UPGRADED | LENS_VERSION_DEPRECATED Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 NotificationSummary API Version 2020-03-31 382 API Reference AWS Well-Architected Tool PillarDifference A pillar difference return object. Contents DifferenceStatus Indicates the type of change to the pillar. Type: String Valid Values: UPDATED | NEW | DELETED Required: No PillarId The ID used to identify a pillar, for example, security. A pillar is identified by its PillarReviewSummary:PillarId. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Required: No PillarName The name of the pillar. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Required: No QuestionDifferences List of question differences. Type: Array of QuestionDifference objects Required: No PillarDifference API Version 2020-03-31 383 AWS Well-Architected Tool See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2020-03-31 384 API Reference AWS Well-Architected Tool PillarMetric A metric for a particular pillar in a lens. Contents PillarId The ID used to identify a pillar, for example, security. A pillar is identified by its PillarReviewSummary:PillarId. Type: String Length Constraints: Minimum length |
wellarchitected-api-066 | wellarchitected-api.pdf | 66 | differences. Type: Array of QuestionDifference objects Required: No PillarDifference API Version 2020-03-31 383 AWS Well-Architected Tool See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2020-03-31 384 API Reference AWS Well-Architected Tool PillarMetric A metric for a particular pillar in a lens. Contents PillarId The ID used to identify a pillar, for example, security. A pillar is identified by its PillarReviewSummary:PillarId. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Required: No Questions The questions that have been identified as risks in the pillar. Type: Array of QuestionMetric objects Required: No RiskCounts A map from risk names to the count of how many questions have that rating. Type: String to integer map Valid Keys: UNANSWERED | HIGH | MEDIUM | NONE | NOT_APPLICABLE Valid Range: Minimum value of 0. Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: PillarMetric API Version 2020-03-31 385 AWS Well-Architected Tool • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference See Also API Version 2020-03-31 386 AWS Well-Architected Tool API Reference PillarReviewSummary A pillar review summary of a lens review. Contents Notes The notes associated with the workload. For a review template, these are the notes that will be associated with the workload when the template is applied. Type: String Length Constraints: Maximum length of 2084. Required: No PillarId The ID used to identify a pillar, for example, security. A pillar is identified by its PillarReviewSummary:PillarId. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Required: No PillarName The name of the pillar. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Required: No PrioritizedRiskCounts A map from risk names to the count of how many questions have that rating. PillarReviewSummary API Version 2020-03-31 387 AWS Well-Architected Tool Type: String to integer map API Reference Valid Keys: UNANSWERED | HIGH | MEDIUM | NONE | NOT_APPLICABLE Valid Range: Minimum value of 0. Required: No RiskCounts A map from risk names to the count of how many questions have that rating. Type: String to integer map Valid Keys: UNANSWERED | HIGH | MEDIUM | NONE | NOT_APPLICABLE Valid Range: Minimum value of 0. Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2020-03-31 388 AWS Well-Architected Tool API Reference Profile A profile. Contents CreatedAt The date and time recorded in Unix format (seconds). Type: Timestamp Required: No Owner An AWS account ID. Type: String Length Constraints: Fixed length of 12. Pattern: [0-9]{12} Required: No ProfileArn The profile ARN. Type: String Length Constraints: Maximum length of 2084. Pattern: arn:aws[-a-z]*:wellarchitected:[a-z]{2}(-gov)?-[a-z]+-\d: \d{12}:profile/[a-z0-9]+ Required: No ProfileDescription The profile description. Type: String Profile API Version 2020-03-31 389 AWS Well-Architected Tool API Reference Length Constraints: Minimum length of 3. Maximum length of 100. Required: No ProfileName The profile name. Type: String Length Constraints: Minimum length of 3. Maximum length of 100. Required: No ProfileQuestions Profile questions. Type: Array of ProfileQuestion objects Required: No ProfileVersion The profile version. Type: String Length Constraints: Minimum length of 1. Maximum length of 32. Pattern: ^[A-Za-z0-9-]+$ Required: No ShareInvitationId The ID assigned to the share invitation. Type: String Pattern: [0-9a-f]{32} Required: No Tags The tags assigned to the profile. Contents API Version 2020-03-31 390 AWS Well-Architected Tool Type: String to string map Map Entries: Maximum number of 50 items. API Reference Key Length Constraints: Minimum length of 1. Maximum length of 128. Value Length Constraints: Minimum length of 0. Maximum length of 256. Required: No UpdatedAt The date and time recorded in Unix format (seconds). Type: Timestamp Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2020-03-31 391 API Reference AWS Well-Architected Tool ProfileChoice The profile choice. Contents ChoiceDescription The description of a choice. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Required: No ChoiceId The ID of a choice. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Required: No ChoiceTitle The title of a choice. Type: String Length Constraints: Minimum length of 1. Maximum length of 512. Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: |
wellarchitected-api-067 | wellarchitected-api.pdf | 67 | AWS SDK for Ruby V3 See Also API Version 2020-03-31 391 API Reference AWS Well-Architected Tool ProfileChoice The profile choice. Contents ChoiceDescription The description of a choice. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Required: No ChoiceId The ID of a choice. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Required: No ChoiceTitle The title of a choice. Type: String Length Constraints: Minimum length of 1. Maximum length of 512. Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 ProfileChoice API Version 2020-03-31 392 AWS Well-Architected Tool • AWS SDK for Ruby V3 API Reference See Also API Version 2020-03-31 393 AWS Well-Architected Tool API Reference ProfileNotificationSummary The profile notification summary. Contents CurrentProfileVersion The current profile version. Type: String Length Constraints: Minimum length of 1. Maximum length of 32. Pattern: ^[A-Za-z0-9-]+$ Required: No LatestProfileVersion The latest profile version. Type: String Length Constraints: Minimum length of 1. Maximum length of 32. Pattern: ^[A-Za-z0-9-]+$ Required: No ProfileArn The profile ARN. Type: String Length Constraints: Maximum length of 2084. Pattern: arn:aws[-a-z]*:wellarchitected:[a-z]{2}(-gov)?-[a-z]+-\d: \d{12}:profile/[a-z0-9]+ Required: No ProfileName The profile name. ProfileNotificationSummary API Version 2020-03-31 394 AWS Well-Architected Tool Type: String API Reference Length Constraints: Minimum length of 3. Maximum length of 100. Required: No Type Type of notification. Type: String Valid Values: PROFILE_ANSWERS_UPDATED | PROFILE_DELETED Required: No WorkloadId The ID assigned to the workload. This ID is unique within an AWS Region. Type: String Length Constraints: Fixed length of 32. Pattern: [0-9a-f]{32} Required: No WorkloadName The name of the workload. The name must be unique within an account within an AWS Region. Spaces and capitalization are ignored when checking for uniqueness. Type: String Length Constraints: Minimum length of 3. Maximum length of 100. Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: See Also API Version 2020-03-31 395 AWS Well-Architected Tool • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference See Also API Version 2020-03-31 396 API Reference AWS Well-Architected Tool ProfileQuestion A profile question. Contents MaxSelectedChoices The maximum number of selected choices. Type: Integer Valid Range: Minimum value of 0. Required: No MinSelectedChoices The minimum number of selected choices. Type: Integer Valid Range: Minimum value of 0. Required: No QuestionChoices The question choices. Type: Array of ProfileChoice objects Required: No QuestionDescription The description of the question. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Required: No QuestionId The ID of the question. ProfileQuestion API Version 2020-03-31 397 AWS Well-Architected Tool Type: String API Reference Length Constraints: Minimum length of 1. Maximum length of 128. Required: No QuestionTitle The title of the question. Type: String Length Constraints: Minimum length of 1. Maximum length of 512. Required: No SelectedChoiceIds The selected choices. Type: Array of strings Length Constraints: Minimum length of 1. Maximum length of 64. Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2020-03-31 398 AWS Well-Architected Tool API Reference ProfileQuestionUpdate An update to a profile question. Contents QuestionId The ID of the question. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Required: No SelectedChoiceIds The selected choices. Type: Array of strings Length Constraints: Minimum length of 1. Maximum length of 64. Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ProfileQuestionUpdate API Version 2020-03-31 399 AWS Well-Architected Tool API Reference ProfileShareSummary Summary of a profile share. Contents SharedWith The AWS account ID, organization ID, or organizational unit (OU) ID with which the workload, lens, profile, or review template is shared. Type: String Length Constraints: Minimum length of 12. Maximum length of 2048. Required: No ShareId The ID associated with the share. Type: String Pattern: [0-9a-f]{32} Required: No Status The status of the share request. Type: String Valid Values: ACCEPTED | REJECTED | PENDING | REVOKED | EXPIRED | ASSOCIATING | ASSOCIATED | FAILED Required: No StatusMessage Profile share invitation status message. Type: String Length Constraints: Minimum length of 1. Maximum length of 512. ProfileShareSummary API Version 2020-03-31 400 AWS Well-Architected Tool Required: No See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for |
wellarchitected-api-068 | wellarchitected-api.pdf | 68 | the share. Type: String Pattern: [0-9a-f]{32} Required: No Status The status of the share request. Type: String Valid Values: ACCEPTED | REJECTED | PENDING | REVOKED | EXPIRED | ASSOCIATING | ASSOCIATED | FAILED Required: No StatusMessage Profile share invitation status message. Type: String Length Constraints: Minimum length of 1. Maximum length of 512. ProfileShareSummary API Version 2020-03-31 400 AWS Well-Architected Tool Required: No See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2020-03-31 401 API Reference AWS Well-Architected Tool ProfileSummary Summary of a profile. Contents CreatedAt The date and time recorded in Unix format (seconds). Type: Timestamp Required: No Owner An AWS account ID. Type: String Length Constraints: Fixed length of 12. Pattern: [0-9]{12} Required: No ProfileArn The profile ARN. Type: String Length Constraints: Maximum length of 2084. Pattern: arn:aws[-a-z]*:wellarchitected:[a-z]{2}(-gov)?-[a-z]+-\d: \d{12}:profile/[a-z0-9]+ Required: No ProfileDescription The profile description. Type: String ProfileSummary API Version 2020-03-31 402 AWS Well-Architected Tool API Reference Length Constraints: Minimum length of 3. Maximum length of 100. Required: No ProfileName The profile name. Type: String Length Constraints: Minimum length of 3. Maximum length of 100. Required: No ProfileVersion The profile version. Type: String Length Constraints: Minimum length of 1. Maximum length of 32. Pattern: ^[A-Za-z0-9-]+$ Required: No UpdatedAt The date and time recorded in Unix format (seconds). Type: Timestamp Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2020-03-31 403 API Reference AWS Well-Architected Tool ProfileTemplate The profile template. Contents CreatedAt The date and time recorded in Unix format (seconds). Type: Timestamp Required: No TemplateName The name of the profile template. Type: String Length Constraints: Minimum length of 3. Maximum length of 100. Required: No TemplateQuestions Profile template questions. Type: Array of ProfileTemplateQuestion objects Required: No UpdatedAt The date and time recorded in Unix format (seconds). Type: Timestamp Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: ProfileTemplate API Version 2020-03-31 404 AWS Well-Architected Tool • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference See Also API Version 2020-03-31 405 AWS Well-Architected Tool API Reference ProfileTemplateChoice A profile template choice. Contents ChoiceDescription The description of a choice. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Required: No ChoiceId The ID of a choice. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Required: No ChoiceTitle The title of a choice. Type: String Length Constraints: Minimum length of 1. Maximum length of 512. Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 ProfileTemplateChoice API Version 2020-03-31 406 AWS Well-Architected Tool • AWS SDK for Ruby V3 API Reference See Also API Version 2020-03-31 407 AWS Well-Architected Tool API Reference ProfileTemplateQuestion A profile template question. Contents MaxSelectedChoices The maximum number of choices selected. Type: Integer Valid Range: Minimum value of 0. Required: No MinSelectedChoices The minimum number of choices selected. Type: Integer Valid Range: Minimum value of 0. Required: No QuestionChoices The question choices. Type: Array of ProfileTemplateChoice objects Required: No QuestionDescription The description of the question. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Required: No QuestionId The ID of the question. ProfileTemplateQuestion API Version 2020-03-31 408 AWS Well-Architected Tool Type: String API Reference Length Constraints: Minimum length of 1. Maximum length of 128. Required: No QuestionTitle The title of the question. Type: String Length Constraints: Minimum length of 1. Maximum length of 512. Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2020-03-31 409 API Reference AWS Well-Architected Tool QuestionDifference A question difference return object. Contents DifferenceStatus Indicates the type of change to the question. Type: String Valid Values: UPDATED | NEW | DELETED Required: No QuestionId The ID of the question. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Required: No QuestionTitle The title of the question. Type: String Length Constraints: Minimum length of 1. Maximum length of 512. Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS |
wellarchitected-api-069 | wellarchitected-api.pdf | 69 | 2020-03-31 409 API Reference AWS Well-Architected Tool QuestionDifference A question difference return object. Contents DifferenceStatus Indicates the type of change to the question. Type: String Valid Values: UPDATED | NEW | DELETED Required: No QuestionId The ID of the question. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Required: No QuestionTitle The title of the question. Type: String Length Constraints: Minimum length of 1. Maximum length of 512. Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 QuestionDifference API Version 2020-03-31 410 AWS Well-Architected Tool • AWS SDK for Ruby V3 API Reference See Also API Version 2020-03-31 411 AWS Well-Architected Tool QuestionMetric A metric for a particular question in the pillar. Contents BestPractices API Reference The best practices, or choices, that have been identified as contributing to risk in a question. Type: Array of BestPractice objects Required: No QuestionId The ID of the question. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Required: No Risk The risk for a given workload, lens review, pillar, or question. Type: String Valid Values: UNANSWERED | HIGH | MEDIUM | NONE | NOT_APPLICABLE Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 QuestionMetric API Version 2020-03-31 412 AWS Well-Architected Tool API Reference See Also API Version 2020-03-31 413 API Reference AWS Well-Architected Tool ReviewTemplate A review template. Contents Description The review template description. Type: String Length Constraints: Minimum length of 3. Maximum length of 250. Pattern: ^[A-Za-z0-9-_.,:/()@!&?#+'’\s]+$ Required: No Lenses The lenses applied to the review template. Type: Array of strings Length Constraints: Minimum length of 1. Maximum length of 128. Required: No Notes The notes associated with the workload. For a review template, these are the notes that will be associated with the workload when the template is applied. Type: String Length Constraints: Maximum length of 2084. Required: No Owner An AWS account ID. ReviewTemplate API Version 2020-03-31 414 AWS Well-Architected Tool Type: String Length Constraints: Fixed length of 12. Pattern: [0-9]{12} Required: No QuestionCounts API Reference A count of how many total questions are answered and unanswered in the review template. Type: String to integer map Valid Keys: UNANSWERED | ANSWERED Valid Range: Minimum value of 0. Required: No ShareInvitationId The ID assigned to the template share invitation. Type: String Pattern: [0-9a-f]{32} Required: No Tags The tags assigned to the review template. Type: String to string map Map Entries: Maximum number of 50 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Value Length Constraints: Minimum length of 0. Maximum length of 256. Required: No TemplateArn The review template ARN. Contents API Version 2020-03-31 415 AWS Well-Architected Tool Type: String API Reference Length Constraints: Minimum length of 50. Maximum length of 250. Pattern: arn:aws(-us-gov|-iso(-[a-z])?|-cn)?:wellarchitected:[a-z]{2}(- gov|-iso([a-z])?)?-[a-z]+-\d:\d{12}:(review-template)/[a-f0-9]{32} Required: No TemplateName The name of the review template. Type: String Length Constraints: Minimum length of 3. Maximum length of 100. Pattern: ^[A-Za-z0-9-_.,:/()@!&?#+'’\s]+$ Required: No UpdatedAt The date and time recorded in Unix format (seconds). Type: Timestamp Required: No UpdateStatus The latest status of a review template. Type: String Valid Values: CURRENT | LENS_NOT_CURRENT Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ See Also API Version 2020-03-31 416 AWS Well-Architected Tool • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference See Also API Version 2020-03-31 417 AWS Well-Architected Tool API Reference ReviewTemplateAnswer An answer of the question. Contents AnswerStatus The status of whether or not this question has been answered. Type: String Valid Values: UNANSWERED | ANSWERED Required: No ChoiceAnswers A list of selected choices to a question in your review template. Type: Array of ChoiceAnswer objects Required: No Choices List of choices available for a question. Type: Array of Choice objects Required: No HelpfulResourceDisplayText The helpful resource text to be displayed for a custom lens. Note This field does not apply to AWS official lenses. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. ReviewTemplateAnswer API Version 2020-03-31 418 AWS Well-Architected Tool Required: No HelpfulResourceUrl The helpful resource URL. API Reference For AWS official lenses, this is the helpful resource URL for a question or choice. For custom lenses, this is the helpful resource URL for a question and is only provided if HelpfulResourceDisplayText was specified for the question. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Required: No ImprovementPlanUrl The improvement plan URL for a question in an AWS official lenses. |
wellarchitected-api-070 | wellarchitected-api.pdf | 70 | not apply to AWS official lenses. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. ReviewTemplateAnswer API Version 2020-03-31 418 AWS Well-Architected Tool Required: No HelpfulResourceUrl The helpful resource URL. API Reference For AWS official lenses, this is the helpful resource URL for a question or choice. For custom lenses, this is the helpful resource URL for a question and is only provided if HelpfulResourceDisplayText was specified for the question. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Required: No ImprovementPlanUrl The improvement plan URL for a question in an AWS official lenses. This value is only available if the question has been answered. Type: String Length Constraints: Minimum length of 1. Maximum length of 2048. Required: No IsApplicable Defines whether this question is applicable to a lens review. Type: Boolean Required: No Notes The notes associated with the workload. For a review template, these are the notes that will be associated with the workload when the template is applied. Type: String Length Constraints: Maximum length of 2084. Contents API Version 2020-03-31 419 API Reference AWS Well-Architected Tool Required: No PillarId The ID used to identify a pillar, for example, security. A pillar is identified by its PillarReviewSummary:PillarId. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Required: No QuestionDescription The description of the question. Type: String Length Constraints: Minimum length of 1. Maximum length of 1024. Required: No QuestionId The ID of the question. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Required: No QuestionTitle The title of the question. Type: String Length Constraints: Minimum length of 1. Maximum length of 512. Required: No Reason The reason why the question is not applicable to your review template. Contents API Version 2020-03-31 420 AWS Well-Architected Tool Type: String API Reference Valid Values: OUT_OF_SCOPE | BUSINESS_PRIORITIES | ARCHITECTURE_CONSTRAINTS | OTHER | NONE Required: No SelectedChoices List of selected choice IDs in a question answer. The values entered replace the previously selected choices. Type: Array of strings Length Constraints: Minimum length of 1. Maximum length of 64. Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2020-03-31 421 AWS Well-Architected Tool API Reference ReviewTemplateAnswerSummary The summary of review template answers. Contents AnswerStatus The status of whether or not this question has been answered. Type: String Valid Values: UNANSWERED | ANSWERED Required: No ChoiceAnswerSummaries A list of selected choices to a question in the review template. Type: Array of ChoiceAnswerSummary objects Required: No Choices List of choices available for a question. Type: Array of Choice objects Required: No IsApplicable Defines whether this question is applicable to a lens review. Type: Boolean Required: No PillarId The ID used to identify a pillar, for example, security. A pillar is identified by its PillarReviewSummary:PillarId. ReviewTemplateAnswerSummary API Version 2020-03-31 422 AWS Well-Architected Tool Type: String API Reference Length Constraints: Minimum length of 1. Maximum length of 64. Required: No QuestionId The ID of the question. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Required: No QuestionTitle The title of the question. Type: String Length Constraints: Minimum length of 1. Maximum length of 512. Required: No QuestionType The type of question. Type: String Valid Values: PRIORITIZED | NON_PRIORITIZED Required: No Reason The reason why a choice is not-applicable to a question in the review template. Type: String Valid Values: OUT_OF_SCOPE | BUSINESS_PRIORITIES | ARCHITECTURE_CONSTRAINTS | OTHER | NONE Required: No Contents API Version 2020-03-31 423 AWS Well-Architected Tool SelectedChoices API Reference List of selected choice IDs in a question answer. The values entered replace the previously selected choices. Type: Array of strings Length Constraints: Minimum length of 1. Maximum length of 64. Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2020-03-31 424 AWS Well-Architected Tool API Reference ReviewTemplateLensReview The lens review of a review template. Contents LensAlias The alias of the lens. For AWS official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on AWS official lenses. For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us- west-2:123456789012:lens/0123456789abcdef01234567890abcdef. Each lens is identified by its LensSummary:LensAlias. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Required: No LensArn The lens ARN. Type: String Required: No LensName The full name of the lens. Type: String Length Constraints: Minimum length of |
wellarchitected-api-071 | wellarchitected-api.pdf | 71 | review template. Contents LensAlias The alias of the lens. For AWS official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on AWS official lenses. For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us- west-2:123456789012:lens/0123456789abcdef01234567890abcdef. Each lens is identified by its LensSummary:LensAlias. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Required: No LensArn The lens ARN. Type: String Required: No LensName The full name of the lens. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Required: No ReviewTemplateLensReview API Version 2020-03-31 425 AWS Well-Architected Tool LensStatus The status of the lens. Type: String API Reference Valid Values: CURRENT | NOT_CURRENT | DEPRECATED | DELETED | UNSHARED Required: No LensVersion The version of the lens. Type: String Length Constraints: Minimum length of 1. Maximum length of 32. Required: No NextToken The token to use to retrieve the next set of results. Type: String Required: No Notes The notes associated with the workload. For a review template, these are the notes that will be associated with the workload when the template is applied. Type: String Length Constraints: Maximum length of 2084. Required: No PillarReviewSummaries Pillar review summaries of a lens review. Type: Array of ReviewTemplatePillarReviewSummary objects Contents API Version 2020-03-31 426 AWS Well-Architected Tool Required: No QuestionCounts API Reference A count of how many questions are answered and unanswered in the lens review. Type: String to integer map Valid Keys: UNANSWERED | ANSWERED Valid Range: Minimum value of 0. Required: No UpdatedAt The date and time recorded in Unix format (seconds). Type: Timestamp Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2020-03-31 427 AWS Well-Architected Tool API Reference ReviewTemplatePillarReviewSummary Summary of a review template. Contents Notes The notes associated with the workload. For a review template, these are the notes that will be associated with the workload when the template is applied. Type: String Length Constraints: Maximum length of 2084. Required: No PillarId The ID used to identify a pillar, for example, security. A pillar is identified by its PillarReviewSummary:PillarId. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Required: No PillarName The name of the pillar. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Required: No QuestionCounts A count of how many questions are answered and unanswered in the requested pillar of the lens review. ReviewTemplatePillarReviewSummary API Version 2020-03-31 428 AWS Well-Architected Tool Type: String to integer map Valid Keys: UNANSWERED | ANSWERED Valid Range: Minimum value of 0. Required: No See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2020-03-31 429 AWS Well-Architected Tool API Reference ReviewTemplateSummary Summary of a review template. Contents Description Description of the review template. Type: String Length Constraints: Minimum length of 3. Maximum length of 250. Pattern: ^[A-Za-z0-9-_.,:/()@!&?#+'’\s]+$ Required: No Lenses Lenses associated with the review template. Type: Array of strings Length Constraints: Minimum length of 1. Maximum length of 128. Required: No Owner An AWS account ID. Type: String Length Constraints: Fixed length of 12. Pattern: [0-9]{12} Required: No TemplateArn The review template ARN. Type: String ReviewTemplateSummary API Version 2020-03-31 430 AWS Well-Architected Tool API Reference Length Constraints: Minimum length of 50. Maximum length of 250. Pattern: arn:aws(-us-gov|-iso(-[a-z])?|-cn)?:wellarchitected:[a-z]{2}(- gov|-iso([a-z])?)?-[a-z]+-\d:\d{12}:(review-template)/[a-f0-9]{32} Required: No TemplateName The name of the review template. Type: String Length Constraints: Minimum length of 3. Maximum length of 100. Pattern: ^[A-Za-z0-9-_.,:/()@!&?#+'’\s]+$ Required: No UpdatedAt The date and time recorded in Unix format (seconds). Type: Timestamp Required: No UpdateStatus The latest status of a review template. Type: String Valid Values: CURRENT | LENS_NOT_CURRENT Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 See Also API Version 2020-03-31 431 AWS Well-Architected Tool • AWS SDK for Ruby V3 API Reference See Also API Version 2020-03-31 432 API Reference AWS Well-Architected Tool SelectedPillar The selected pillar. Contents PillarId The ID used to identify a pillar, for example, security. A pillar is identified by its PillarReviewSummary:PillarId. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Required: No SelectedQuestionIds Selected question IDs in the selected pillar. Type: Array of strings Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, |
wellarchitected-api-072 | wellarchitected-api.pdf | 72 | AWS SDK for Java V2 See Also API Version 2020-03-31 431 AWS Well-Architected Tool • AWS SDK for Ruby V3 API Reference See Also API Version 2020-03-31 432 API Reference AWS Well-Architected Tool SelectedPillar The selected pillar. Contents PillarId The ID used to identify a pillar, for example, security. A pillar is identified by its PillarReviewSummary:PillarId. Type: String Length Constraints: Minimum length of 1. Maximum length of 64. Required: No SelectedQuestionIds Selected question IDs in the selected pillar. Type: Array of strings Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 SelectedPillar API Version 2020-03-31 433 AWS Well-Architected Tool ShareInvitation The share invitation. Contents LensAlias The alias of the lens. API Reference For AWS official lenses, this is either the lens alias, such as serverless, or the lens ARN, such as arn:aws:wellarchitected:us-east-1::lens/serverless. Note that some operations (such as ExportLens and CreateLensShare) are not permitted on AWS official lenses. For custom lenses, this is the lens ARN, such as arn:aws:wellarchitected:us- west-2:123456789012:lens/0123456789abcdef01234567890abcdef. Each lens is identified by its LensSummary:LensAlias. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Required: No LensArn The ARN for the lens. Type: String Required: No ProfileArn The profile ARN. Type: String Length Constraints: Maximum length of 2084. Pattern: arn:aws[-a-z]*:wellarchitected:[a-z]{2}(-gov)?-[a-z]+-\d: \d{12}:profile/[a-z0-9]+ ShareInvitation API Version 2020-03-31 434 API Reference AWS Well-Architected Tool Required: No ShareInvitationId The ID assigned to the share invitation. Type: String Pattern: [0-9a-f]{32} Required: No ShareResourceType The resource type of the share invitation. Type: String Valid Values: WORKLOAD | LENS | PROFILE | TEMPLATE Required: No TemplateArn The review template ARN. Type: String Length Constraints: Minimum length of 50. Maximum length of 250. Pattern: arn:aws(-us-gov|-iso(-[a-z])?|-cn)?:wellarchitected:[a-z]{2}(- gov|-iso([a-z])?)?-[a-z]+-\d:\d{12}:(review-template)/[a-f0-9]{32} Required: No WorkloadId The ID assigned to the workload. This ID is unique within an AWS Region. Type: String Length Constraints: Fixed length of 32. Pattern: [0-9a-f]{32} Required: No Contents API Version 2020-03-31 435 AWS Well-Architected Tool See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2020-03-31 436 AWS Well-Architected Tool API Reference ShareInvitationSummary A share invitation summary return object. Contents LensArn The ARN for the lens. Type: String Required: No LensName The full name of the lens. Type: String Length Constraints: Minimum length of 1. Maximum length of 128. Required: No PermissionType Permission granted on a share request. Type: String Valid Values: READONLY | CONTRIBUTOR Required: No ProfileArn The profile ARN. Type: String Length Constraints: Maximum length of 2084. Pattern: arn:aws[-a-z]*:wellarchitected:[a-z]{2}(-gov)?-[a-z]+-\d: \d{12}:profile/[a-z0-9]+ ShareInvitationSummary API Version 2020-03-31 437 AWS Well-Architected Tool Required: No ProfileName The profile name. Type: String Length Constraints: Minimum length of 3. Maximum length of 100. API Reference Required: No SharedBy An AWS account ID. Type: String Length Constraints: Fixed length of 12. Pattern: [0-9]{12} Required: No SharedWith The AWS account ID, organization ID, or organizational unit (OU) ID with which the workload, lens, profile, or review template is shared. Type: String Length Constraints: Minimum length of 12. Maximum length of 2048. Required: No ShareInvitationId The ID assigned to the share invitation. Type: String Pattern: [0-9a-f]{32} Required: No ShareResourceType The resource type of the share invitation. Contents API Version 2020-03-31 438 AWS Well-Architected Tool Type: String API Reference Valid Values: WORKLOAD | LENS | PROFILE | TEMPLATE Required: No TemplateArn The review template ARN. Type: String Length Constraints: Minimum length of 50. Maximum length of 250. Pattern: arn:aws(-us-gov|-iso(-[a-z])?|-cn)?:wellarchitected:[a-z]{2}(- gov|-iso([a-z])?)?-[a-z]+-\d:\d{12}:(review-template)/[a-f0-9]{32} Required: No TemplateName The name of the review template. Type: String Length Constraints: Minimum length of 3. Maximum length of 100. Pattern: ^[A-Za-z0-9-_.,:/()@!&?#+'’\s]+$ Required: No WorkloadId The ID assigned to the workload. This ID is unique within an AWS Region. Type: String Length Constraints: Fixed length of 32. Pattern: [0-9a-f]{32} Required: No WorkloadName The name of the workload. Contents API Version 2020-03-31 439 AWS Well-Architected Tool API Reference The name must be unique within an account within an AWS Region. Spaces and capitalization are ignored when checking for uniqueness. Type: String Length Constraints: Minimum length of 3. Maximum length of 100. Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2020-03-31 440 AWS Well-Architected Tool API Reference TemplateShareSummary Summary of a review template share. Contents SharedWith The AWS account ID, organization ID, or organizational unit (OU) ID with which the workload, lens, profile, or review template is shared. Type: String Length Constraints: Minimum length of 12. Maximum length of 2048. |
wellarchitected-api-073 | wellarchitected-api.pdf | 73 | Minimum length of 3. Maximum length of 100. Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2020-03-31 440 AWS Well-Architected Tool API Reference TemplateShareSummary Summary of a review template share. Contents SharedWith The AWS account ID, organization ID, or organizational unit (OU) ID with which the workload, lens, profile, or review template is shared. Type: String Length Constraints: Minimum length of 12. Maximum length of 2048. Required: No ShareId The ID associated with the share. Type: String Pattern: [0-9a-f]{32} Required: No Status The status of the share request. Type: String Valid Values: ACCEPTED | REJECTED | PENDING | REVOKED | EXPIRED | ASSOCIATING | ASSOCIATED | FAILED Required: No StatusMessage Review template share invitation status message. Type: String Length Constraints: Minimum length of 1. Maximum length of 512. TemplateShareSummary API Version 2020-03-31 441 AWS Well-Architected Tool Required: No See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2020-03-31 442 AWS Well-Architected Tool API Reference ValidationExceptionField Stores information about a field passed inside a request that resulted in an exception. Contents Message Description of the error. Type: String Required: Yes Name The field name for which validation failed. Type: String Required: Yes See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 ValidationExceptionField API Version 2020-03-31 443 AWS Well-Architected Tool VersionDifferences The differences between the base and latest versions of the lens. API Reference Contents PillarDifferences The differences between the base and latest versions of the lens. Type: Array of PillarDifference objects Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 VersionDifferences API Version 2020-03-31 444 API Reference AWS Well-Architected Tool Workload A workload return object. Contents AccountIds The list of AWS account IDs associated with the workload. Type: Array of strings Array Members: Maximum number of 100 items. Length Constraints: Fixed length of 12. Pattern: [0-9]{12} Required: No Applications List of AppRegistry application ARNs associated to the workload. Type: Array of strings Array Members: Maximum number of 1 item. Length Constraints: Maximum length of 2084. Pattern: arn:aws[-a-z]*:servicecatalog:[a-z]{2}(-gov)?-[a-z]+-\d:\d{12}:/ applications/[a-z0-9]+ Required: No ArchitecturalDesign The URL of the architectural design for the workload. Type: String Length Constraints: Maximum length of 2048. Pattern: ^(|(https?|ftp):\/\/[^\s/$.?#].[^\s]*)$ Workload API Version 2020-03-31 445 AWS Well-Architected Tool Required: No AwsRegions API Reference The list of AWS Regions associated with the workload, for example, us-east-2, or ca- central-1. Type: Array of strings Array Members: Maximum number of 50 items. Length Constraints: Maximum length of 100. Required: No Description The description for the workload. Type: String Length Constraints: Minimum length of 3. Maximum length of 250. Required: No DiscoveryConfig Discovery configuration associated to the workload. Type: WorkloadDiscoveryConfig object Required: No Environment The environment for the workload. Type: String Valid Values: PRODUCTION | PREPRODUCTION Required: No ImprovementStatus The improvement status for a workload. Type: String Contents API Version 2020-03-31 446 AWS Well-Architected Tool API Reference Valid Values: NOT_APPLICABLE | NOT_STARTED | IN_PROGRESS | COMPLETE | RISK_ACKNOWLEDGED Required: No Industry The industry for the workload. Type: String Length Constraints: Maximum length of 100. Required: No IndustryType The industry type for the workload. If specified, must be one of the following: • Agriculture • Automobile • Defense • Design and Engineering • Digital Advertising • Education • Environmental Protection • Financial Services • Gaming • General Public Services • Healthcare • Hospitality • InfoTech • Justice and Public Safety • Life Sciences • Manufacturing • Media & Entertainment Contents API Version 2020-03-31 447 AWS Well-Architected Tool API Reference • Mining & Resources • Oil & Gas • Power & Utilities • Professional Services • Real Estate & Construction • Retail & Wholesale • Social Protection • Telecommunications • Travel, Transportation & Logistics • Other Type: String Length Constraints: Maximum length of 100. Required: No IsReviewOwnerUpdateAcknowledged Flag indicating whether the workload owner has acknowledged that the Review owner field is required. If a Review owner is not added to the workload within 60 days of acknowledgement, access to the workload is restricted until an owner is added. Type: Boolean Required: No JiraConfiguration Jira configuration for a specific workload. Type: WorkloadJiraConfigurationOutput object Required: No Lenses The list of lenses associated with the workload. Each |
wellarchitected-api-074 | wellarchitected-api.pdf | 74 | Services • Real Estate & Construction • Retail & Wholesale • Social Protection • Telecommunications • Travel, Transportation & Logistics • Other Type: String Length Constraints: Maximum length of 100. Required: No IsReviewOwnerUpdateAcknowledged Flag indicating whether the workload owner has acknowledged that the Review owner field is required. If a Review owner is not added to the workload within 60 days of acknowledgement, access to the workload is restricted until an owner is added. Type: Boolean Required: No JiraConfiguration Jira configuration for a specific workload. Type: WorkloadJiraConfigurationOutput object Required: No Lenses The list of lenses associated with the workload. Each lens is identified by its LensSummary:LensAlias. Contents API Version 2020-03-31 448 AWS Well-Architected Tool API Reference If a review template that specifies lenses is applied to the workload, those lenses are applied to the workload in addition to these lenses. Type: Array of strings Length Constraints: Minimum length of 1. Maximum length of 128. Required: No NonAwsRegions The list of non-AWS Regions associated with the workload. Type: Array of strings Array Members: Maximum number of 5 items. Length Constraints: Minimum length of 3. Maximum length of 25. Required: No Notes The notes associated with the workload. For a review template, these are the notes that will be associated with the workload when the template is applied. Type: String Length Constraints: Maximum length of 2084. Required: No Owner An AWS account ID. Type: String Length Constraints: Fixed length of 12. Pattern: [0-9]{12} Required: No Contents API Version 2020-03-31 449 AWS Well-Architected Tool PillarPriorities API Reference The priorities of the pillars, which are used to order items in the improvement plan. Each pillar is represented by its PillarReviewSummary:PillarId. Type: Array of strings Length Constraints: Minimum length of 1. Maximum length of 64. Required: No PrioritizedRiskCounts A map from risk names to the count of how many questions have that rating. Type: String to integer map Valid Keys: UNANSWERED | HIGH | MEDIUM | NONE | NOT_APPLICABLE Valid Range: Minimum value of 0. Required: No Profiles Profile associated with a workload. Type: Array of WorkloadProfile objects Array Members: Maximum number of 1 item. Required: No ReviewOwner 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 Length Constraints: Minimum length of 3. Maximum length of 255. Required: No ReviewRestrictionDate The date and time recorded in Unix format (seconds). Contents API Version 2020-03-31 450 AWS Well-Architected Tool Type: Timestamp Required: No RiskCounts API Reference A map from risk names to the count of how many questions have that rating. Type: String to integer map Valid Keys: UNANSWERED | HIGH | MEDIUM | NONE | NOT_APPLICABLE Valid Range: Minimum value of 0. Required: No ShareInvitationId The ID assigned to the share invitation. Type: String Pattern: [0-9a-f]{32} Required: No Tags The tags associated with the workload. Type: String to string map Map Entries: Maximum number of 50 items. Key Length Constraints: Minimum length of 1. Maximum length of 128. Value Length Constraints: Minimum length of 0. Maximum length of 256. Required: No UpdatedAt The date and time recorded in Unix format (seconds). Type: Timestamp Required: No Contents API Version 2020-03-31 451 AWS Well-Architected Tool WorkloadArn The ARN for the workload. Type: String Required: No WorkloadId API Reference The ID assigned to the workload. This ID is unique within an AWS Region. Type: String Length Constraints: Fixed length of 32. Pattern: [0-9a-f]{32} Required: No WorkloadName The name of the workload. The name must be unique within an account within an AWS Region. Spaces and capitalization are ignored when checking for uniqueness. Type: String Length Constraints: Minimum length of 3. Maximum length of 100. Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2020-03-31 452 AWS Well-Architected Tool API Reference WorkloadDiscoveryConfig Discovery configuration associated to the workload. Contents TrustedAdvisorIntegrationStatus Discovery integration status in respect to Trusted Advisor for the workload. Type: String Valid Values: ENABLED | DISABLED Required: No WorkloadResourceDefinition The mode to use for identifying resources associated with the workload. You can specify WORKLOAD_METADATA, APP_REGISTRY, or both. Type: Array of strings Valid Values: WORKLOAD_METADATA | APP_REGISTRY Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 WorkloadDiscoveryConfig API Version 2020-03-31 453 AWS Well-Architected Tool API Reference WorkloadJiraConfigurationInput Workload-level: Input for the Jira configuration. Contents IssueManagementStatus Workload-level: Jira issue management status. Type: String Valid Values: ENABLED | DISABLED | INHERIT Required: No IssueManagementType Workload-level: Jira issue management type. Type: String Valid |
wellarchitected-api-075 | wellarchitected-api.pdf | 75 | the workload. You can specify WORKLOAD_METADATA, APP_REGISTRY, or both. Type: Array of strings Valid Values: WORKLOAD_METADATA | APP_REGISTRY Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 WorkloadDiscoveryConfig API Version 2020-03-31 453 AWS Well-Architected Tool API Reference WorkloadJiraConfigurationInput Workload-level: Input for the Jira configuration. Contents IssueManagementStatus Workload-level: Jira issue management status. Type: String Valid Values: ENABLED | DISABLED | INHERIT Required: No IssueManagementType Workload-level: Jira issue management type. Type: String Valid Values: AUTO | MANUAL Required: No JiraProjectKey Workload-level: Jira project key to sync workloads to. Type: String Length Constraints: Minimum length of 1. Maximum length of 100. Pattern: ^[A-Z][A-Z0-9_]*$ Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: WorkloadJiraConfigurationInput API Version 2020-03-31 454 AWS Well-Architected Tool • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference See Also API Version 2020-03-31 455 AWS Well-Architected Tool API Reference WorkloadJiraConfigurationOutput Workload-level: Output configuration of the Jira integration. Contents IssueManagementStatus Workload-level: Jira issue management status. Type: String Valid Values: ENABLED | DISABLED | INHERIT Required: No IssueManagementType Workload-level: Jira issue management type. Type: String Valid Values: AUTO | MANUAL Required: No JiraProjectKey Workload-level: Jira project key to sync workloads to. Type: String Length Constraints: Minimum length of 1. Maximum length of 100. Pattern: ^[A-Z][A-Z0-9_]*$ Required: No StatusMessage Workload-level: Status message on configuration of the Jira integration. Type: String Length Constraints: Minimum length of 1. Maximum length of 512. WorkloadJiraConfigurationOutput API Version 2020-03-31 456 AWS Well-Architected Tool Required: No See Also API Reference For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2020-03-31 457 API Reference AWS Well-Architected Tool WorkloadProfile The profile associated with a workload. Contents ProfileArn The profile ARN. Type: String Length Constraints: Maximum length of 2084. Pattern: arn:aws[-a-z]*:wellarchitected:[a-z]{2}(-gov)?-[a-z]+-\d: \d{12}:profile/[a-z0-9]+ Required: No ProfileVersion The profile version. Type: String Length Constraints: Minimum length of 1. Maximum length of 32. Pattern: ^[A-Za-z0-9-]+$ Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 WorkloadProfile API Version 2020-03-31 458 API Reference AWS Well-Architected Tool WorkloadShare A workload share return object. Contents PermissionType Permission granted on a share request. Type: String Valid Values: READONLY | CONTRIBUTOR Required: No SharedBy An AWS account ID. Type: String Length Constraints: Fixed length of 12. Pattern: [0-9]{12} Required: No SharedWith The AWS account ID, organization ID, or organizational unit (OU) ID with which the workload, lens, profile, or review template is shared. Type: String Length Constraints: Minimum length of 12. Maximum length of 2048. Required: No ShareId The ID associated with the share. Type: String WorkloadShare API Version 2020-03-31 459 AWS Well-Architected Tool Pattern: [0-9a-f]{32} Required: No Status The status of the share request. Type: String API Reference Valid Values: ACCEPTED | REJECTED | PENDING | REVOKED | EXPIRED | ASSOCIATING | ASSOCIATED | FAILED Required: No WorkloadId The ID assigned to the workload. This ID is unique within an AWS Region. Type: String Length Constraints: Fixed length of 32. Pattern: [0-9a-f]{32} Required: No WorkloadName The name of the workload. The name must be unique within an account within an AWS Region. Spaces and capitalization are ignored when checking for uniqueness. Type: String Length Constraints: Minimum length of 3. Maximum length of 100. Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: See Also API Version 2020-03-31 460 AWS Well-Architected Tool • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 API Reference See Also API Version 2020-03-31 461 AWS Well-Architected Tool API Reference WorkloadShareSummary A workload share summary return object. Contents PermissionType Permission granted on a share request. Type: String Valid Values: READONLY | CONTRIBUTOR Required: No SharedWith The AWS account ID, organization ID, or organizational unit (OU) ID with which the workload, lens, profile, or review template is shared. Type: String Length Constraints: Minimum length of 12. Maximum length of 2048. Required: No ShareId The ID associated with the share. Type: String Pattern: [0-9a-f]{32} Required: No Status The status of the share request. Type: String Valid Values: ACCEPTED | REJECTED | PENDING | REVOKED | EXPIRED | ASSOCIATING | ASSOCIATED | FAILED WorkloadShareSummary API Version 2020-03-31 462 AWS Well-Architected Tool Required: No StatusMessage Optional message to compliment the Status field. Type: String |
wellarchitected-api-076 | wellarchitected-api.pdf | 76 | | CONTRIBUTOR Required: No SharedWith The AWS account ID, organization ID, or organizational unit (OU) ID with which the workload, lens, profile, or review template is shared. Type: String Length Constraints: Minimum length of 12. Maximum length of 2048. Required: No ShareId The ID associated with the share. Type: String Pattern: [0-9a-f]{32} Required: No Status The status of the share request. Type: String Valid Values: ACCEPTED | REJECTED | PENDING | REVOKED | EXPIRED | ASSOCIATING | ASSOCIATED | FAILED WorkloadShareSummary API Version 2020-03-31 462 AWS Well-Architected Tool Required: No StatusMessage Optional message to compliment the Status field. Type: String Length Constraints: Minimum length of 1. Maximum length of 512. API Reference Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2020-03-31 463 API Reference AWS Well-Architected Tool WorkloadSummary A workload summary return object. Contents ImprovementStatus The improvement status for a workload. Type: String Valid Values: NOT_APPLICABLE | NOT_STARTED | IN_PROGRESS | COMPLETE | RISK_ACKNOWLEDGED Required: No Lenses The list of lenses associated with the workload. Each lens is identified by its LensSummary:LensAlias. If a review template that specifies lenses is applied to the workload, those lenses are applied to the workload in addition to these lenses. Type: Array of strings Length Constraints: Minimum length of 1. Maximum length of 128. Required: No Owner An AWS account ID. Type: String Length Constraints: Fixed length of 12. Pattern: [0-9]{12} Required: No WorkloadSummary API Version 2020-03-31 464 AWS Well-Architected Tool PrioritizedRiskCounts API Reference A map from risk names to the count of how many questions have that rating. Type: String to integer map Valid Keys: UNANSWERED | HIGH | MEDIUM | NONE | NOT_APPLICABLE Valid Range: Minimum value of 0. Required: No Profiles Profile associated with a workload. Type: Array of WorkloadProfile objects Array Members: Maximum number of 1 item. Required: No RiskCounts A map from risk names to the count of how many questions have that rating. Type: String to integer map Valid Keys: UNANSWERED | HIGH | MEDIUM | NONE | NOT_APPLICABLE Valid Range: Minimum value of 0. Required: No UpdatedAt The date and time recorded in Unix format (seconds). Type: Timestamp Required: No WorkloadArn The ARN for the workload. Type: String Contents API Version 2020-03-31 465 AWS Well-Architected Tool Required: No WorkloadId API Reference The ID assigned to the workload. This ID is unique within an AWS Region. Type: String Length Constraints: Fixed length of 32. Pattern: [0-9a-f]{32} Required: No WorkloadName The name of the workload. The name must be unique within an account within an AWS Region. Spaces and capitalization are ignored when checking for uniqueness. Type: String Length Constraints: Minimum length of 3. Maximum length of 100. Required: No See Also For more information about using this API in one of the language-specific AWS SDKs, see the following: • AWS SDK for C++ • AWS SDK for Java V2 • AWS SDK for Ruby V3 See Also API Version 2020-03-31 466 AWS Well-Architected Tool API Reference Common Parameters The following list contains the parameters that all actions use for signing Signature Version 4 requests with a query string. Any action-specific parameters are listed in the topic for that action. For more information about Signature Version 4, see Signing AWS API requests in the IAM User Guide. Action The action to be performed. Type: string Required: Yes Version The API version that the request is written for, expressed in the format YYYY-MM-DD. Type: string Required: Yes X-Amz-Algorithm The hash algorithm that you used to create the request signature. Condition: Specify this parameter when you include authentication information in a query string instead of in the HTTP authorization header. Type: string Valid Values: AWS4-HMAC-SHA256 Required: Conditional X-Amz-Credential The credential scope value, which is a string that includes your access key, the date, the region you are targeting, the service you are requesting, and a termination string ("aws4_request"). The value is expressed in the following format: access_key/YYYYMMDD/region/service/ aws4_request. API Version 2020-03-31 467 AWS Well-Architected Tool API Reference For more information, see Create a signed AWS API request in the IAM User Guide. Condition: Specify this parameter when you include authentication information in a query string instead of in the HTTP authorization header. Type: string Required: Conditional X-Amz-Date The date that is used to create the signature. The format must be ISO 8601 basic format (YYYYMMDD'T'HHMMSS'Z'). For example, the following date time is a valid X-Amz-Date value: 20120325T120000Z. Condition: X-Amz-Date is optional for all requests; it can be used to override the date used for signing requests. If the Date header is specified in the ISO 8601 basic format, X-Amz-Date is not required. When X-Amz-Date is used, it |
wellarchitected-api-077 | wellarchitected-api.pdf | 77 | in the IAM User Guide. Condition: Specify this parameter when you include authentication information in a query string instead of in the HTTP authorization header. Type: string Required: Conditional X-Amz-Date The date that is used to create the signature. The format must be ISO 8601 basic format (YYYYMMDD'T'HHMMSS'Z'). For example, the following date time is a valid X-Amz-Date value: 20120325T120000Z. Condition: X-Amz-Date is optional for all requests; it can be used to override the date used for signing requests. If the Date header is specified in the ISO 8601 basic format, X-Amz-Date is not required. When X-Amz-Date is used, it always overrides the value of the Date header. For more information, see Elements of an AWS API request signature in the IAM User Guide. Type: string Required: Conditional X-Amz-Security-Token The temporary security token that was obtained through a call to AWS Security Token Service (AWS STS). For a list of services that support temporary security credentials from AWS STS, see AWS services that work with IAM in the IAM User Guide. Condition: If you're using temporary security credentials from AWS STS, you must include the security token. Type: string Required: Conditional X-Amz-Signature Specifies the hex-encoded signature that was calculated from the string to sign and the derived signing key. Condition: Specify this parameter when you include authentication information in a query string instead of in the HTTP authorization header. API Version 2020-03-31 468 AWS Well-Architected Tool Type: string Required: Conditional X-Amz-SignedHeaders API Reference Specifies all the HTTP headers that were included as part of the canonical request. For more information about specifying signed headers, see Create a signed AWS API request in the IAM User Guide. Condition: Specify this parameter when you include authentication information in a query string instead of in the HTTP authorization header. Type: string Required: Conditional API Version 2020-03-31 469 AWS Well-Architected Tool API Reference Common Errors This section lists the errors common to the API actions of all AWS services. For errors specific to an API action for this service, see the topic for that API action. AccessDeniedException You do not have sufficient access to perform this action. HTTP Status Code: 403 ExpiredTokenException The security token included in the request is expired HTTP Status Code: 403 IncompleteSignature The request signature does not conform to AWS standards. HTTP Status Code: 403 InternalFailure The request processing has failed because of an unknown error, exception or failure. HTTP Status Code: 500 MalformedHttpRequestException Problems with the request at the HTTP level, e.g. we can't decompress the body according to the decompression algorithm specified by the content-encoding. HTTP Status Code: 400 NotAuthorized You do not have permission to perform this action. HTTP Status Code: 401 OptInRequired The AWS access key ID needs a subscription for the service. API Version 2020-03-31 470 AWS Well-Architected Tool HTTP Status Code: 403 RequestAbortedException API Reference Convenient exception that can be used when a request is aborted before a reply is sent back (e.g. client closed connection). HTTP Status Code: 400 RequestEntityTooLargeException Problems with the request at the HTTP level. The request entity is too large. HTTP Status Code: 413 RequestExpired The request reached the service more than 15 minutes after the date stamp on the request or more than 15 minutes after the request expiration date (such as for pre-signed URLs), or the date stamp on the request is more than 15 minutes in the future. HTTP Status Code: 400 RequestTimeoutException Problems with the request at the HTTP level. Reading the Request timed out. HTTP Status Code: 408 ServiceUnavailable The request has failed due to a temporary failure of the server. HTTP Status Code: 503 ThrottlingException The request was denied due to request throttling. HTTP Status Code: 400 UnrecognizedClientException The X.509 certificate or AWS access key ID provided does not exist in our records. HTTP Status Code: 403 API Version 2020-03-31 471 AWS Well-Architected Tool UnknownOperationException API Reference The action or operation requested is invalid. Verify that the action is typed correctly. HTTP Status Code: 404 ValidationError The input fails to satisfy the constraints specified by an AWS service. HTTP Status Code: 400 API Version 2020-03-31 472 |
wellarchitected-ug-001 | wellarchitected-ug.pdf | 1 | User Guide AWS Well-Architected Tool Copyright © 2025 Amazon Web Services, Inc. and/or its affiliates. All rights reserved. AWS Well-Architected Tool User Guide AWS Well-Architected Tool: User Guide Copyright © 2025 Amazon Web Services, Inc. and/or its affiliates. All rights reserved. Amazon's trademarks and trade dress may not be used in connection with any product or service that is not Amazon's, in any manner that is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who may or may not be affiliated with, connected to, or sponsored by Amazon. AWS Well-Architected Tool Table of Contents User Guide ........................................................................................................................................................ vii What is AWS Well-Architected Tool? ............................................................................................. 1 What is AWS Well-Architected Framework? ........................................................................................... 2 AWS Well-Architected Tool glossary ........................................................................................................ 2 Getting started ................................................................................................................................ 4 Providing access to AWS WA Tool ............................................................................................................ 4 Activating integrations ................................................................................................................................ 5 Activating AppRegistry ........................................................................................................................... 6 Activating Trusted Advisor .................................................................................................................... 6 Defining a workload .................................................................................................................................. 14 Documenting a workload ......................................................................................................................... 17 Reviewing a workload ............................................................................................................................... 18 Viewing Trusted Advisor checks .............................................................................................................. 19 Saving a milestone .................................................................................................................................... 21 Tutorial: Document a workload .................................................................................................... 22 Step 1: Define a workload ....................................................................................................................... 22 Step 2: Document the workload state .................................................................................................. 23 Step 3: Review the improvement plan .................................................................................................. 26 Step 4: Make improvements and measure progress ........................................................................... 28 Workloads in AWS Well-Architected Tool .................................................................................... 30 High Risk Issues (HRIs) and Medium Risk Issues (MRIs) ..................................................................... 31 Define a workload ...................................................................................................................................... 32 View a workload ......................................................................................................................................... 32 Edit a workload .......................................................................................................................................... 33 Share a workload ....................................................................................................................................... 34 Sharing considerations ......................................................................................................................... 36 Delete shared access ............................................................................................................................ 37 Modify shared access ........................................................................................................................... 38 Accept and reject invitations .............................................................................................................. 38 Delete a workload ...................................................................................................................................... 39 Generate a workload report .................................................................................................................... 40 View workload details ............................................................................................................................... 40 Overview tab .......................................................................................................................................... 41 Milestones tab ....................................................................................................................................... 41 iii AWS Well-Architected Tool User Guide Properties tab ........................................................................................................................................ 42 Shares tab ............................................................................................................................................... 42 Lenses ............................................................................................................................................. 44 Adding a lens .............................................................................................................................................. 44 Removing a lens ......................................................................................................................................... 45 Viewing lens details ................................................................................................................................... 45 Overview tab .......................................................................................................................................... 46 Improvement plan tab ......................................................................................................................... 46 Shares tab ............................................................................................................................................... 46 Custom lenses ............................................................................................................................................. 46 Viewing custom lenses ........................................................................................................................ 47 Creating a custom lens ........................................................................................................................ 48 Previewing a custom lens ................................................................................................................... 49 Publishing a custom lens .................................................................................................................... 50 Publishing a lens update ..................................................................................................................... 50 Sharing a lens ........................................................................................................................................ 52 Adding tags to a lens .......................................................................................................................... 53 Deleting a lens ...................................................................................................................................... 54 Lens format specification .................................................................................................................... 54 Lens upgrades ............................................................................................................................................. 61 Determining lens to upgrade ............................................................................................................. 62 Upgrading a lens ................................................................................................................................... 63 Lens Catalog ................................................................................................................................................ 64 Review templates .......................................................................................................................... 67 Creating a review template ..................................................................................................................... 67 Editing a review template ........................................................................................................................ 68 Sharing a review template ....................................................................................................................... 69 Defining a workload from a template ................................................................................................... 69 Deleting a review template ..................................................................................................................... 71 Profiles ........................................................................................................................................... 72 Creating a profile ....................................................................................................................................... 72 Editing a profile .......................................................................................................................................... 72 Sharing a profile ......................................................................................................................................... 73 Adding a profile to a workload ............................................................................................................... 73 Removing a profile from a workload ..................................................................................................... 74 Deleting a profile ....................................................................................................................................... 75 iv AWS Well-Architected Tool User Guide Jira .................................................................................................................................................. 76 Setting up the connector ......................................................................................................................... 77 Configuring the connector ....................................................................................................................... 78 Syncing a workload ................................................................................................................................... 80 Uninstalling the connector ....................................................................................................................... 81 Milestones ...................................................................................................................................... 83 Saving a milestone .................................................................................................................................... 83 Viewing milestones .................................................................................................................................... 83 Generating a milestone report ................................................................................................................ 84 Share invitations ............................................................................................................................ 85 Accepting a share invitation .................................................................................................................... 86 Rejecting a share invitation ..................................................................................................................... 86 Notifications ................................................................................................................................... 88 Lens notifications ....................................................................................................................................... 88 Profile notifications ................................................................................................................................... 88 Dashboard ...................................................................................................................................... 90 Summary ...................................................................................................................................................... 90 Well-Architected Framework issues per pillar ...................................................................................... 90 Well-Architected Framework issues per workload .............................................................................. 91 Well-Architected Framework issues by improvement plan item ...................................................... 92 Security .......................................................................................................................................... 94 Data protection ........................................................................................................................................... 95 Encryption at rest ................................................................................................................................. 95 Encryption in transit ............................................................................................................................ 96 How AWS uses your data .................................................................................................................... 96 Identity and access management ........................................................................................................... 96 Audience .................................................................................................................................................. 97 Authenticating with identities ............................................................................................................ 97 Managing access using policies ....................................................................................................... 101 How AWS Well-Architected Tool works with IAM ........................................................................ 103 Identity-based policy examples ....................................................................................................... 110 AWS managed policies ...................................................................................................................... 116 Troubleshooting .................................................................................................................................. 122 Incident response ..................................................................................................................................... 123 Compliance validation ............................................................................................................................ 123 Resilience ................................................................................................................................................... 124 v AWS Well-Architected Tool User Guide Infrastructure security ............................................................................................................................. 124 Configuration and vulnerability analysis ............................................................................................ 125 Cross-service confused deputy prevention ......................................................................................... 125 Sharing your resources ................................................................................................................ 127 Activate resource sharing within AWS Organizations ...................................................................... 127 Tagging your resources ............................................................................................................... 130 Tag basics .................................................................................................................................................. 130 Tagging your resources ........................................................................................................................... 131 Tag restrictions ......................................................................................................................................... 132 Working with tags using the console .................................................................................................. 132 Adding tags on an individual resource on creation ..................................................................... 132 Adding and deleting tags on an individual resource .................................................................. 132 Working with tags using the API .......................................................................................................... 134 Logging ......................................................................................................................................... 136 AWS WA Tool information in CloudTrail ............................................................................................. 136 Understanding AWS WA Tool log file entries .................................................................................... 137 EventBridge .................................................................................................................................. 140 Sample events from |
wellarchitected-ug-002 | wellarchitected-ug.pdf | 2 | 125 Cross-service confused deputy prevention ......................................................................................... 125 Sharing your resources ................................................................................................................ 127 Activate resource sharing within AWS Organizations ...................................................................... 127 Tagging your resources ............................................................................................................... 130 Tag basics .................................................................................................................................................. 130 Tagging your resources ........................................................................................................................... 131 Tag restrictions ......................................................................................................................................... 132 Working with tags using the console .................................................................................................. 132 Adding tags on an individual resource on creation ..................................................................... 132 Adding and deleting tags on an individual resource .................................................................. 132 Working with tags using the API .......................................................................................................... 134 Logging ......................................................................................................................................... 136 AWS WA Tool information in CloudTrail ............................................................................................. 136 Understanding AWS WA Tool log file entries .................................................................................... 137 EventBridge .................................................................................................................................. 140 Sample events from AWS WA Tool ...................................................................................................... 141 Document history ........................................................................................................................ 145 AWS Glossary ............................................................................................................................... 151 vi AWS Well-Architected Tool User Guide We have released a new version of the Well-Architected Framework. We also added new and updated lenses to the Lens Catalog. Learn more about the changes. vii AWS Well-Architected Tool User Guide What is AWS Well-Architected Tool? AWS Well-Architected Tool (AWS WA Tool) is a service in the cloud that provides a consistent process for measuring your architecture using AWS best practices. AWS WA Tool helps you throughout the product lifecycle by doing the following: • Assisting with documenting the decisions that you make • Providing recommendations for improving your workload based on best practices • Guiding you in making your workloads more reliable, secure, efficient, and cost-effective You can use AWS WA Tool to document and measure your workload using the best practices from the AWS Well-Architected Framework. These best practices were developed by AWS Solutions Architects based on their years of experience building solutions across a wide variety of businesses. The framework provides a consistent approach for measuring architectures and provides guidance for implementing designs that scale with your needs over time. In addition to AWS best practices, you can use custom lenses to measure your workload using your own best practices. You can tailor the questions in a custom lens to be specific to a particular technology or to help you meet the governance needs within your organization. Custom lenses extend the guidance provided by the AWS lenses. Integrations with AWS Trusted Advisor and AWS Service Catalog AppRegistry helps you more easily discover the information needed to answer AWS Well-Architected Toolreview questions. This service is intended for those involved in technical product development, such as chief technology officers (CTOs), architects, developers, and operations team members. AWS customers use AWS WA Tool to document their architectures, provide product launch governance, and to understand and manage the risks in their technology portfolio. Topics • What is AWS Well-Architected Framework? • AWS Well-Architected Tool glossary 1 AWS Well-Architected Tool User Guide What is AWS Well-Architected Framework? The AWS Well-Architected Framework documents a set of foundational questions that enable you to understand how a specific architecture aligns with cloud best practices. The framework provides a consistent approach for evaluating systems against the qualities that are expected from modern cloud-based systems. Based on the state of your architecture, the framework suggests improvements that you can make to better achieve those qualities. By using the framework, you learn architectural best practices for designing and operating reliable, secure, efficient, and cost-effective systems in the cloud. It provides a way for you to consistently measure your architectures against best practices and identify areas for improvement. The framework is based on six pillars: operational excellence, security, reliability, performance efficiency, cost optimization, and sustainability. When designing a workload, you make trade-offs between these pillars based on your business needs. These business decisions help drive your engineering priorities. In development environments, you might optimize to reduce cost at the expense of reliability. In mission-critical solutions, you might optimize reliability and be willing to accept increased costs. In ecommerce solutions, you might prioritize performance, since customer satisfaction can drive increased revenue. Security and operational excellence are generally not traded off against the other pillars. For much more information on the framework, visit the AWS Well-Architected website. AWS Well-Architected Tool glossary The following defines common terms used in AWS WA Tool and the AWS Well-Architected Framework. • A workload identifies a set of components that deliver business value. The workload is usually the level of detail that business and technology leaders communicate about. Examples of workloads include marketing websites, ecommerce websites, the backend for a mobile app, and analytic platforms. Workloads vary in their level of architectural complexity. They can be simple, such as a static website, or complex, such as microservices architectures with multiple data stores and many components. • Milestones mark key changes in your architecture as it evolves throughout the product lifecycle — design, testing, go live, and production. • Lenses provide a way for you to consistently measure your architectures against best practices and identify areas for improvement. What is AWS Well-Architected Framework? 2 AWS Well-Architected Tool |
wellarchitected-ug-003 | wellarchitected-ug.pdf | 3 | communicate about. Examples of workloads include marketing websites, ecommerce websites, the backend for a mobile app, and analytic platforms. Workloads vary in their level of architectural complexity. They can be simple, such as a static website, or complex, such as microservices architectures with multiple data stores and many components. • Milestones mark key changes in your architecture as it evolves throughout the product lifecycle — design, testing, go live, and production. • Lenses provide a way for you to consistently measure your architectures against best practices and identify areas for improvement. What is AWS Well-Architected Framework? 2 AWS Well-Architected Tool User Guide In addition to the lenses provided by AWS, you also can create and use your own lenses, or use lenses that have been shared with you. • High risk issues (HRIs) are architectural and operational choices that AWS has found might result in significant negative impact to a business. These HRIs might affect organizational operations, assets, and individuals. • Medium risk issues (MRIs) are architectural and operational choices that AWS has found might negatively impact business, but to a lesser extent than HRIs. For additional information, see High Risk Issues (HRIs) and Medium Risk Issues (MRIs). AWS Well-Architected Tool glossary 3 AWS Well-Architected Tool User Guide Getting started with AWS Well-Architected Tool To get started using AWS Well-Architected Tool, you first provide the appropriate permissions to the your users, groups, and roles, and activate support for the AWS services you want use with AWS WA Tool. Next, you define and document a workload. You can also save a milestone of the current state of a workload. The following topics explain how to get started using AWS WA Tool. For a step-by-step tutorial showing how to use AWS Well-Architected Tool, see Tutorial: Document an AWS Well-Architected Tool workload. Topics • Providing users, groups, or roles access to AWS WA Tool • Activating support in AWS WA Tool for other AWS services • Defining a workload in AWS WA Tool • Documenting a workload in AWS WA Tool • Reviewing a workload with AWS Well-Architected Framework • Viewing Trusted Advisor checks for your workload • Saving a milestone for a workload in AWS WA Tool Providing users, groups, or roles access to AWS WA Tool You can grant users, groups, or roles full control or read-only access to AWS Well-Architected Tool. Provide access to AWS WA Tool 1. To provide access, add permissions to your users, groups, or roles: • Users and groups in AWS IAM Identity Center: Create a permission set. Follow the instructions in Create a permission set in the AWS IAM Identity Center User Guide. • Users managed in IAM through an identity provider: Create a role for identity federation. Follow the instructions in Create a role for a third-party identity provider (federation) in the IAM User Guide. Providing access to AWS WA Tool 4 AWS Well-Architected Tool • IAM users: User Guide • Create a role that your user can assume. Follow the instructions in Create a role for an IAM user in the IAM User Guide. • (Not recommended) Attach a policy directly to a user or add a user to a user group. Follow the instructions in Adding permissions to a user (console) in the IAM User Guide. 2. To grant full control, apply the WellArchitectedConsoleFullAccess managed policy to the permission set or role. Full access allows the principal to perform all actions in AWS WA Tool. This access is required to define workloads, delete workloads, view workloads, update workloads, share workloads, create custom lenses, and share custom lenses. 3. To grant read-only access, apply the WellArchitectedConsoleReadOnlyAccess managed policy to the permission set or role. Principals with this role can only view resources. For more information on these policies, see AWS managed policies for AWS Well-Architected Tool. Activating support in AWS WA Tool for other AWS services Activating Organization access permits AWS Well-Architected Tool to gather information about your organization's structure to share resources more easily (see the section called “Activate resource sharing within AWS Organizations” for more information). Activating Discovery support gathers information from AWS Trusted Advisor, AWS Service Catalog AppRegistry, and related resources (such as AWS CloudFormation stacks in AppRegistry resource collections) to help you more easily discover the information needed to answer Well-Architected review questions, and tailor the Trusted Advisor checks for a workload. Activating support for AWS Organizations, or activating Discovery support automatically creates a service-linked role for your account. To turn on support for other services that AWS WA Tool can interact with, navigate to Settings. 1. 2. 3. To gather information from AWS Organizations, turn on Activate AWS Organizations support. Turn on Activate Discovery support to gather information from other AWS services and resources. Select View role permissions to view the service-linked role permissions or trust relationship policies. |
wellarchitected-ug-004 | wellarchitected-ug.pdf | 4 | to help you more easily discover the information needed to answer Well-Architected review questions, and tailor the Trusted Advisor checks for a workload. Activating support for AWS Organizations, or activating Discovery support automatically creates a service-linked role for your account. To turn on support for other services that AWS WA Tool can interact with, navigate to Settings. 1. 2. 3. To gather information from AWS Organizations, turn on Activate AWS Organizations support. Turn on Activate Discovery support to gather information from other AWS services and resources. Select View role permissions to view the service-linked role permissions or trust relationship policies. Activating integrations 5 AWS Well-Architected Tool 4. Select Save settings. User Guide Activating AppRegistry for a workload Using AppRegistry is optional, and AWS Business and Enterprise Support customers can activate it on a per-workload basis. Whenever Discovery support is turned on and AppRegistry is associated with a new or existing workload, AWS Well-Architected Tool creates a service-managed attribute group. The attribute group Metadata in AppRegistry contains the workload ARN, the workload name, and the risks associated with the workload. • When Discovery support is turned on, any time there is a change to the workload, the attribute group is updated. • When Discovery support is turned off or the application is removed from the workload, the workload information is removed from AWS Service Catalog. If you want an AppRegistry application to drive the data fetched from Trusted Advisor, set your workload Resource definition as AppRegistry or All. Create roles for all accounts that own resources in your application following the guidelines in the section called “Activating Trusted Advisor in IAM”. Activating AWS Trusted Advisor for a workload You can optionally integrate AWS Trusted Advisor and activate it on a per-workload basis for AWS Business and Enterprise Support customers. There is no cost to integrate Trusted Advisor with AWS WA Tool, but for Trusted Advisor pricing details, see AWS Support Plans. Activating Trusted Advisor for workloads can provide you a more comprehensive, automated, and monitored approach to reviewing and optimizing your AWS workloads. This can help you improve the reliability, security, performance, and cost optimization for your workloads. To activate Trusted Advisor for a workload 1. 2. To activate Trusted Advisor, workload owners can use AWS WA Tool to update an existing workload, or create a new workload by choosing Define workload. Enter an account ID used by Trusted Advisor in the Account IDs field, select an application ARN in the Application field, or both to activate Trusted Advisor. Activating AppRegistry 6 AWS Well-Architected Tool User Guide 3. In the AWS Trusted Advisor section, select Activate Trusted Advisor. 4. A notification that the IAM service role will be created displays the first time Trusted Advisor is activated for a workload. Choosing View permissions displays the IAM role permissions. You can view the Role name, as well as the Permissions and Trust relationships JSON automatically created for you in IAM. After the role is created, for subsequent workloads activating Trusted Advisor, only the notification for Additional setup needed is shown. 5. In the Resource definition dropdown, you can select Workload Metadata, AppRegistry, or All. The Resource definition selection defines what data AWS WA Tool fetches from Trusted Advisor to provide the status checks in the workload review that map to Well-Architected best practices. Activating Trusted Advisor 7 AWS Well-Architected Tool User Guide Workload Metadata – the workload is defined by account IDs and AWS Regions specified in the workload. AppRegistry – the workload is defined by resources (such as AWS CloudFormation stacks) that are present in the AppRegistry application associated with the workload. All – the workload is defined by both the workload metadata and AppRegistry resources. 6. Choose Next. 7. Apply the AWS Well-Architected Framework to your workload, and choose Define workload. Trusted Advisor checks are only linked to the AWS Well-Architected Framework, and not other lenses. The AWS WA Tool periodically gets data from Trusted Advisor using the roles created in IAM. The IAM role is automatically created for the workload owner. However, to view Trusted Advisor information, the owners of any associated accounts on the workload must go to IAM and create a role, see ??? for more details. If this role does not exist, AWS WA Tool cannot obtain Trusted Advisor information for that account and displays an error. For more information about creating a role in AWS Identity and Access Management (IAM), see Creating a role for an AWS service (console) in the IAM User Guide. Activating Trusted Advisor for a workload in IAM Note Workload owners should Activate Discovery support for their account before creating a Trusted Advisor workload. Choosing to Activate Discovery support creates the role required for the workload owner. Use the following steps for all other associated accounts. The owners of associated accounts |
wellarchitected-ug-005 | wellarchitected-ug.pdf | 5 | If this role does not exist, AWS WA Tool cannot obtain Trusted Advisor information for that account and displays an error. For more information about creating a role in AWS Identity and Access Management (IAM), see Creating a role for an AWS service (console) in the IAM User Guide. Activating Trusted Advisor for a workload in IAM Note Workload owners should Activate Discovery support for their account before creating a Trusted Advisor workload. Choosing to Activate Discovery support creates the role required for the workload owner. Use the following steps for all other associated accounts. The owners of associated accounts for workloads that have activated Trusted Advisor must create a role in IAM to see Trusted Advisor information in AWS Well-Architected Tool. To create a role in IAM for AWS WA Tool to get information from Trusted Advisor 1. Sign in to the AWS Management Console and open the IAM console at https:// console.aws.amazon.com/iam/. Activating Trusted Advisor 8 AWS Well-Architected Tool User Guide 2. In the navigation pane of the IAM console, choose Roles, and then choose Create role. 3. Under Trusted entity type choose Custom trust policy. 4. Copy and paste the following Custom trust policy into the JSON field in the IAM console, as shown in the following image. Replace WORKLOAD_OWNER_ACCOUNT_ID with the workload owner's account ID, and choose Next. { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Principal": { "Service": "wellarchitected.amazonaws.com" }, "Action": "sts:AssumeRole", "Condition": { "StringEquals": { "aws:SourceAccount": "WORKLOAD_OWNER_ACCOUNT_ID" }, "ArnEquals": { "aws:SourceArn": "arn:aws:wellarchitected:*:WORKLOAD_OWNER_ACCOUNT_ID:workload/*" } } } ] } Activating Trusted Advisor 9 AWS Well-Architected Tool User Guide Note The aws:sourceArn in the condition block of the preceeding custom trust policy is "arn:aws:wellarchitected:*:WORKLOAD_OWNER_ACCOUNT_ID:workload/*", which is a generic condition stating this role can be used by AWS WA Tool for all of the workload owner's workloads. However, access can be narrowed to a specific workload ARN, or set of workload ARNs. To specify multiple ARNs, see the following example trust policy. { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Principal": { "Service": "wellarchitected.amazonaws.com" }, "Action": "sts:AssumeRole", "Condition": { "StringEquals": { Activating Trusted Advisor 10 AWS Well-Architected Tool User Guide "aws:SourceAccount": "WORKLOAD_OWNER_ACCOUNT_ID" }, "ArnEquals": { "aws:SourceArn": [ "arn:aws:wellarchitected:REGION:WORKLOAD_OWNER_ACCOUNT_ID:workload/ WORKLOAD_ID_1", "arn:aws:wellarchitected:REGION:WORKLOAD_OWNER_ACCOUNT_ID:workload/ WORKLOAD_ID_2" ] } } } ] } 5. On the Add permissions page, for Permissions policies choose Create policy to give AWS WA Tool access to read data from Trusted Advisor. Selecting Create policy opens a new window. Note Additionally, you have the option to skip creating the permissions during the role creation and create an inline policy after creating the role. Choose View role in the successful role creation message and select Create inline policy from the Add permissions dropdown in the Permissions tab. 6. Copy and paste the following Permissions policy into the JSON field. In the Resource ARN, replace YOUR_ACCOUNT_ID with your own account ID, specify the Region or an asterisk (*), and choose Next:Tags. For details about ARN formats, see Amazon Resource Name (ARN) in the AWS General Reference Guide. { "Version": "2012-10-17", "Statement": [ { "Effect": "Allow", "Action": [ "trustedadvisor:DescribeCheckRefreshStatuses", Activating Trusted Advisor 11 AWS Well-Architected Tool User Guide "trustedadvisor:DescribeCheckSummaries", "trustedadvisor:DescribeRiskResources", "trustedadvisor:DescribeAccount", "trustedadvisor:DescribeRisk", "trustedadvisor:DescribeAccountAccess", "trustedadvisor:DescribeRisks", "trustedadvisor:DescribeCheckItems" ], "Resource": [ "arn:aws:trustedadvisor:*:YOUR_ACCOUNT_ID:checks/*" ] } ] } 7. If Trusted Advisor is activated for a workload and the Resource definition is set to AppRegistry or All, all of the accounts that own a resource in the AppRegistry application attached to the workload must add the following permission to their Trusted Advisor role's Permissions policy. { "Version": "2012-10-17", "Statement": [ { "Sid": "DiscoveryPermissions", "Effect": "Allow", "Action": [ "servicecatalog:ListAssociatedResources", "tag:GetResources", "servicecatalog:GetApplication", "resource-groups:ListGroupResources", "cloudformation:DescribeStacks", "cloudformation:ListStackResources" ], "Resource": "*" } ] } 8. (Optional) Add tags. Choose Next: Review. 9. Review the policy, give it a name, and select Create policy. Activating Trusted Advisor 12 AWS Well-Architected Tool User Guide 10. On the Add permissions page for the role, select the policy name you just created, and select Next. 11. Enter the Role name, which must use the following syntax: WellArchitectedRoleForTrustedAdvisor-WORKLOAD_OWNER_ACCOUNT_ID and choose Create role. Replace WORKLOAD_OWNER_ACCOUNT_ID with the workload owner's account ID. You should get a success message at the top of the page notifying you that the role has been created. 12. To view the role and associated permissions policy, in the left navigation pane under Access management, choose Roles and search for the WellArchitectedRoleForTrustedAdvisor-WORKLOAD_OWNER_ACCOUNT_ID name. Select the name of the role to verify that the Permissions and Trust relationships are correct. Deactivating Trusted Advisor for a workload To deactivate Trusted Advisor for a workload You can deactivate Trusted Advisor for any workload from the AWS Well-Architected Tool by editing your workload and deselecting Activate Trusted Advisor. For more information on editing workloads, see the section called “Edit a workload”. Deactivating Trusted Advisor from the AWS WA Tool does not delete the roles created in IAM. Deleting roles |
wellarchitected-ug-006 | wellarchitected-ug.pdf | 6 | permissions policy, in the left navigation pane under Access management, choose Roles and search for the WellArchitectedRoleForTrustedAdvisor-WORKLOAD_OWNER_ACCOUNT_ID name. Select the name of the role to verify that the Permissions and Trust relationships are correct. Deactivating Trusted Advisor for a workload To deactivate Trusted Advisor for a workload You can deactivate Trusted Advisor for any workload from the AWS Well-Architected Tool by editing your workload and deselecting Activate Trusted Advisor. For more information on editing workloads, see the section called “Edit a workload”. Deactivating Trusted Advisor from the AWS WA Tool does not delete the roles created in IAM. Deleting roles from IAM requires a separate cleanup measure. Workload owners or owners of associated accounts should delete the IAM roles created when Trusted Advisor is deactivated in AWS WA Tool, or to stop AWS WA Tool from collecting Trusted Advisor data for the workload. To delete the WellArchitectedRoleForTrustedAdvisor in IAM 1. Sign in to the AWS Management Console and open the IAM console at https:// 2. 3. console.aws.amazon.com/iam/. In the navigation pane of the IAM console, choose Roles. Search for WellArchitectedRoleForTrustedAdvisor-WORKLOAD_OWNER_ACCOUNT_ID and select the role name. 4. Choose Delete. In the pop-up window, type the name of the role to confirm deletion, and select Delete again. Activating Trusted Advisor 13 AWS Well-Architected Tool User Guide For more information about deleting a role from IAM, see Deleting an IAM role (console) in the IAM User Guide. Defining a workload in AWS WA Tool A workload is a set of components that deliver business value. For example, workloads can be marketing websites, ecommerce websites, the backend for a mobile app, and analytic platforms. Accurately defining a workload helps ensure a comprehensive review against the AWS Well- Architected Framework pillars. To define a workload 1. Sign in to the AWS Management Console and open the AWS Well-Architected Tool console at https://console.aws.amazon.com/wellarchitected/. 2. If this is your first time using AWS WA Tool, you see a page that introduces you to the features of the service. In the Define a workload section, choose Define workload. Alternately, in the left navigation pane, choose Workloads and choose Define workload. For details on how AWS uses your workload data, choose Why does AWS need this data, and how will it be used? 3. In the Name box, enter a name for your workload. Note The name must be between 3 and 100 characters. At least three characters must not be spaces. Workload names must be unique. Spaces and capitalization are ignored when checking for uniqueness. 4. 5. In the Description box, enter a description of the workload. The description must be between 3 and 250 characters. In the Review owner box, enter the name, email address, or identifier for the primary group or individual that owns the workload review process. 6. In the Environment box, choose the environment for your workload: • • Production – Workload runs in a production environment. Pre-production – Workload runs in a pre-production environment. 7. In the Regions section, choose the Regions for your workload: Defining a workload 14 AWS Well-Architected Tool User Guide • • AWS Regions – Choose the AWS Regions where your workload runs, one at a time. Non-AWS regions – Enter the names of the Regions outside of AWS where your workload runs. You can specify up to five unique Regions, separated by commas. Use both options if appropriate for your workload. 8. (Optional) In the Account IDs box, enter the IDs of the AWS accounts associated with your workload. You can specify up to 100 unique account IDs, separated by commas. If Trusted Advisor is activated, any account IDs specified are used to get data from Trusted Advisor. See Activating AWS Trusted Advisor for a workload to grant AWS WA Tool permissions to get Trusted Advisor data on your behalf within IAM. 9. (Optional) In the Application box, enter the application ARN of an application from the AWS Service Catalog AppRegistry that you want to associate with this workload. Only one ARN can be specified per workload, and the application and workload must be in the same Region. 10. (Optional) In the Architectural design box, enter the URL for your architectural design. 11. (Optional) In the Industry type box, choose the type of industry associated with your workload. 12. (Optional) In the Industry box, choose the industry that best matches your workload. 13. (Optional) In the Trusted Advisor section, to turn on Trusted Advisor checks for your workload, select Activate Trusted Advisor. Additional setup might be needed for accounts associated with your workload. See the section called “Activating Trusted Advisor” to grant AWS WA Tool permissions to get Trusted Advisor data on your behalf. Select from Workload Metadata, AppRegistry, or All under Resource definition to define what resources AWS WA Tool uses to run Trusted Advisor checks. 14. |
wellarchitected-ug-007 | wellarchitected-ug.pdf | 7 | box, choose the type of industry associated with your workload. 12. (Optional) In the Industry box, choose the industry that best matches your workload. 13. (Optional) In the Trusted Advisor section, to turn on Trusted Advisor checks for your workload, select Activate Trusted Advisor. Additional setup might be needed for accounts associated with your workload. See the section called “Activating Trusted Advisor” to grant AWS WA Tool permissions to get Trusted Advisor data on your behalf. Select from Workload Metadata, AppRegistry, or All under Resource definition to define what resources AWS WA Tool uses to run Trusted Advisor checks. 14. (Optional) In the Jira section, to turn on workload-level Jira sync settings for the workload, select Override account level settings. Additional setup might be needed for accounts associated with your workload. See AWS Well-Architected Tool Connector for Jira to get started with setting up and configuring the connector. Select from Do not sync workload, Sync workload - Manual, and Sync workload - Automatic, and optionally enter a Jira project key to sync to. Note If you do not override account-level settings, workloads will default to the account- level Jira sync setting. Defining a workload 15 AWS Well-Architected Tool User Guide 15. (Optional) In the Tags section, add any tags you want to associate with the workload. For more information on tags, see Tagging your AWS WA Tool resources. 16. Choose Next. If a required box is blank or if a specified value is not valid, you must correct the issue before you can continue. 17. (Optional) In the Apply Profile step, associate a profile with the workload by selecting an existing profile, searching for the profile name, or choosing Create profile to create a profile. Choose Next. 18. Choose the lenses that apply to this workload. Up to 20 lenses can be added to a workload. For descriptions of official AWS lenses, see Lenses. Lenses can be selected from Custom lenses (lenses that you created or that were shared with your AWS account), Lens Catalog (AWS official lenses available to all users), or both. Note The Custom lenses section is empty if you have not created a custom lens or had a custom lens shared with you. Disclaimer By accessing and/or applying custom lenses created by another AWS user or account, you acknowledge that custom lenses created by other users and shared with you are Third Party Content as defined in the AWS Customer Agreement. 19. Choose Define workload. If a required box is blank or if a specified value is not valid, you must correct the issue before your workload is defined. Defining a workload 16 AWS Well-Architected Tool User Guide Documenting a workload in AWS WA Tool After you've defined a workload in AWS Well-Architected Tool, you can document its state by opening the Review workload page. This helps you assess your workload and track its progress over time. To document the state of a workload 1. After you initially define a workload, you see a page that shows the current details of your workload. Choose Start reviewing to begin. Otherwise, in the left navigation pane, choose Workloads and select the name of the workload to open the workload details page. Choose Continue reviewing. (Optional) If a profile is associated with your workload, then the left navigation pane contains a list of Prioritized workload review questions you can use to speed up the workload review process. 2. You are now presented with the first question. For each question: a. Read the question and determine if the question applies to your workload. For additional guidance, choose Info and view the information in the help pane. • • If the question does not apply to your workload, choose Question does not apply to this workload. Otherwise, select the best practices that you are currently following from the list. If you are currently not following any of the best practices, choose None of these. For additional guidance on any item, choose Info and view the information in the help pane. b. (Optional) If one or more best practices do not apply to your workload, choose Mark best practice(s) that don't apply to this workload and select them. For each selected best practice, you can optionally select a reason and provide additional details. c. (Optional) Use the Notes box to record information related to the question. For example, you might describe why the question does not apply or provide additional details about the best practices selected. d. Choose Next to continue to the next question. Documenting a workload 17 AWS Well-Architected Tool User Guide Repeat these steps for each question in each pillar. 3. Choose Save and exit at any time to save your changes and pause documenting your workload. After you've documented your workload, you can return to the questions to |
wellarchitected-ug-008 | wellarchitected-ug.pdf | 8 | practice, you can optionally select a reason and provide additional details. c. (Optional) Use the Notes box to record information related to the question. For example, you might describe why the question does not apply or provide additional details about the best practices selected. d. Choose Next to continue to the next question. Documenting a workload 17 AWS Well-Architected Tool User Guide Repeat these steps for each question in each pillar. 3. Choose Save and exit at any time to save your changes and pause documenting your workload. After you've documented your workload, you can return to the questions to continuing reviewing it at anytime. For more information, see Reviewing a workload with AWS Well-Architected Framework. Reviewing a workload with AWS Well-Architected Framework You can review your workload in the console on the Review workload page. This page provides best practices and helpful resources for your workload's performance. Reviewing a workload 18 AWS Well-Architected Tool User Guide 1. To open the Review workload page, from the workload details page, choose Continue reviewing. The left navigation pane shows the questions for each pillar. Questions that you have answered are marked Done. The number of questions answered in each pillar is shown next to the pillar name. You can navigate to questions in other pillars by choosing the pillar name and then choosing the question you want to answer. (Optional) If a profile is associated with your workload, then AWS WA Tool uses the information in the profile to determine which questions in the workload review are Prioritized and which questions are not applicable for your business. In the left navigation pane you can use the Prioritized questions to help speed up the workload review process. A notification icon appears next to questions that are newly added to the list of Prioritized questions. 2. The middle pane displays the current question. Select the best practices that you are following. Choose Info to get additional information about the question or a best practice. Choose Ask an expert to access the AWS re:Post community dedicated to AWS Well-Architected. AWS re:Post is a topic-based question-and-answer community replacement for AWS Forums. With re:Post, you can find answers, answer questions, join a group, follow popular topics, and vote on your favorite questions and answers. (Optional) To mark one or more best practices as not applicable, choose Mark best practice(s) that don't apply to this workload and select them. Use the buttons at the bottom of this pane to go to the next question, return to the previous question, or save your changes and exit. 3. The right help pane displays additional information and helpful resources. Choose Ask an expert to access the AWS re:Post community dedicated to AWS Well-Architected. In this community, you can ask questions related to designing, building, deploying, and operating workloads on AWS. Viewing Trusted Advisor checks for your workload If Trusted Advisor is activated for your workload, a Trusted Advisor checks tab is displayed next to Question. If there are any checks available for the best practice, a notification that there are Trusted Advisor checks available is displayed following the question selection. Selecting View checks takes you to the Trusted Advisor checks tab. Viewing Trusted Advisor checks 19 AWS Well-Architected Tool User Guide On the Trusted Advisor checks tab, you can view more detailed information about the best practice checks from Trusted Advisor, view links to the Trusted Advisor documentation in the Help resources pane, or Download check details, which provides a report of the Trusted Advisor checks and statuses for each best practice in a CSV file. Viewing Trusted Advisor checks 20 AWS Well-Architected Tool User Guide The check categories from Trusted Advisor are displayed as colored icons, and the number next to each icon shows the number of accounts in that status. • Action recommended (red) – Trusted Advisor recommends an action for the check. • Investigation recommended (yellow) – Trusted Advisor detects a possible issue for the check. • No problems detected (green) – Trusted Advisor doesn't detect an issue for the check. • Excluded items (gray) – The number of checks that have excluded items, such as resources that you want a check to ignore. For more information on the checks Trusted Advisor provides, see View check categories in the Support User Guide. Selecting the Info link next to each Trusted Advisor check displays information about the check in the Help resources pane. For more information, see AWS Trusted Advisor check reference in the Support User Guide. Saving a milestone for a workload in AWS WA Tool You can save a milestone for a workload at any time. A milestone records the current state of the workload. To save a milestone 1. 2. From the workload details page, choose Save milestone. In the Milestone name box, enter a name |
wellarchitected-ug-009 | wellarchitected-ug.pdf | 9 | the checks Trusted Advisor provides, see View check categories in the Support User Guide. Selecting the Info link next to each Trusted Advisor check displays information about the check in the Help resources pane. For more information, see AWS Trusted Advisor check reference in the Support User Guide. Saving a milestone for a workload in AWS WA Tool You can save a milestone for a workload at any time. A milestone records the current state of the workload. To save a milestone 1. 2. From the workload details page, choose Save milestone. In the Milestone name box, enter a name for your milestone. Note The name must be between 3 and 100 characters. At least three characters must not be spaces. Milestone names associated with a workload must be unique. Spaces and capitalization are ignored when checking for uniqueness. 3. Choose Save. After a milestone is saved, you can't change the workload data that was captured in that milestone. For more information, see Milestones. Saving a milestone 21 AWS Well-Architected Tool User Guide Tutorial: Document an AWS Well-Architected Tool workload This tutorial describes using AWS Well-Architected Tool to document and measure a workload. This example illustrates, step by step, how to define and document a workload for a retail ecommerce website. Topics • Step 1: Define a workload • Step 2: Document the workload state • Step 3: Review the improvement plan • Step 4: Make improvements and measure progress Step 1: Define a workload You begin by defining a workload. There are two ways to define a workload. In this tutorial, we are not defining a workload from a review template. For more details on defining a workload from a review template, see the section called “Define a workload”. To define a workload 1. Sign in to the AWS Management Console and open the AWS Well-Architected Tool console at https://console.aws.amazon.com/wellarchitected/. Note The user who documents the workload state must have full access permissions to AWS WA Tool. 2. 3. 4. 5. In the Define a workload section, choose Define workload. In the Name box, enter Retail Website - North America as the workload name. In the Description box, enter a description for the workload. In the Review owner box, enter the name of the person responsible for the workload review process. Step 1: Define a workload 22 AWS Well-Architected Tool User Guide 6. In the Environment box, indicate that the workload is in a production environment. 7. Our workload runs on both AWS and at our local data center: a. Select AWS Regions, and choose the two Regions in North America where the workload runs. b. Also select Non-AWS regions, and enter a name for the local data center. 8. 9. The Account IDs box is optional. Do not associate any AWS accounts with this workload. The Application box is optional. Do not enter an Application ARN for this workload. 10. The Architectural diagram box is optional. Do not associate an architectural diagram with this workload. 11. The Industry type and Industry boxes are optional and are not specified for this workload. 12. The Trusted Advisor section is optional. Do not Activate Trusted Advisor Support for this workload. 13. The Jira section is optional. Do not Override account level settings in the Jira section for this workload. 14. For this example, do not apply any tags to the workload. Choose Next. 15. The Apply profile step is optional. Do not apply a profile for this workload. Choose Next. 16. For this example, apply the AWS Well-Architected Framework lens, which is automatically selected. Choose Define workload to save these values and define the workload. 17. After the workload is defined, choose Start reviewing to begin documenting the state of the workload. Step 2: Document the workload state To document the state of the workload, you are presented with questions for the selected lens that span the pillars of the AWS Well-Architected Framework: operational excellence, security, reliability, performance efficiency, cost optimization, and sustainability. For each question, choose the best practices that you are following from the list provided. If you need details about a best practice, choose Info and view the additional information and resources in the right panel. Choose Ask an expert to access the AWS re:Post community dedicated to AWS Well-Architected. In this community, you can ask questions related to designing, building, deploying, and operating workloads on AWS. Step 2: Document the workload state 23 AWS Well-Architected Tool User Guide 1. Choose Next to proceed to the next question. You can use the left panel to navigate to a different question in the same pillar or to a question in a different pillar. 2. If you choose Question does not apply to this workload or None of these, AWS recommends that you include the reason in the Notes box. |
wellarchitected-ug-010 | wellarchitected-ug.pdf | 10 | an expert to access the AWS re:Post community dedicated to AWS Well-Architected. In this community, you can ask questions related to designing, building, deploying, and operating workloads on AWS. Step 2: Document the workload state 23 AWS Well-Architected Tool User Guide 1. Choose Next to proceed to the next question. You can use the left panel to navigate to a different question in the same pillar or to a question in a different pillar. 2. If you choose Question does not apply to this workload or None of these, AWS recommends that you include the reason in the Notes box. These notes are included as part of the workload report and can be helpful in the future as changes are made to the workload. Note Optionally, you can mark one or more individual best practices as not applicable. Choose Mark best practice(s) that don't apply to this workload and select the best practice that does not apply. You can optionally select a reason and provide additional details. Repeat for each best practice that does not apply. Step 2: Document the workload state 24 AWS Well-Architected Tool User Guide Note You can pause this process at any time by choosing Save and exit.To resume later, open the AWS WA Tool console and choose Workloads in the left navigation pane. 3. Select the name of the workload to open the workload details page. 4. Choose Continue reviewing and then navigate to where you left off. Step 2: Document the workload state 25 AWS Well-Architected Tool User Guide 5. After you complete all of the questions, an overview page for the workload appears. You can review these details now or navigate to them later by choosing Workloads in the left navigation pane and selecting the workload name. After documenting the state of your workload for the first time, you should save a milestone and generate a workload report. A milestone captures the current state of the workload and enables you to measure progress as you make changes based on your improvement plan. From the workload details page: 1. 2. In the Workload overview section, choose the Save milestone button. Enter Version 1.0 - initial review as the Milestone name. 3. Choose Save. 4. To generate a workload report, select the desired lens and choose Generate report and a PDF file is created. This file contains the state of the workload, the number of risks identified, and a list of suggested improvements. Step 3: Review the improvement plan Based on the best practices selected, AWS WA Tool identifies areas of high and medium risk as measured against the AWS Well-Architected Framework Lens. To review the improvement plan: 1. Choose AWS Well-Architected Framework from the Lenses section of the Overview page. 2. Then choose Improvement plan. For this particular example workload, three high risk issues and one medium risk issue were identified by the AWS Well-Architected Framework Lens. Step 3: Review the improvement plan 26 AWS Well-Architected Tool User Guide Update the Improvement status for the workload to indicate that improvements to the workload have not been started. To change the Improvement status: 1. From the Improvement plan, click on the name of the workload (Retail Website - North America) in the breadcrumbs at the top of the page. 2. Click on the Properties tab. 3. Navigate to the Workload status section and select Not Started from the dropdown list. Step 3: Review the improvement plan 27 AWS Well-Architected Tool User Guide 4. Navigate back to the Improvement plan from the Properties tab by clicking on the Overview tab and then clicking on the AWS Well-Architected Framework link in the Lenses section. Then click on the Improvement plan tab at the top of the page. The Improvement items section shows the recommended improvement items identified in the workload. The questions are ordered based on the pillar priority that is set, with any high risk issues listed first followed by any medium risk issues. Expand Recommended improvement items to show the best practices for a question. Each recommended improvement action links to detailed expert guidance to help you eliminate, or at least mitigate, the risks identified. If a profile is associated with the workload, a count of prioritized risks is displayed in the Improvement plan overview section, and you can filter the list of Improvement items by selecting Prioritized by profile. The list of improvement items display a Prioritized label. Step 4: Make improvements and measure progress As part of this improvement plan, one of the high risk issues was addressed by adding Amazon CloudWatch and AWS Auto Scaling support to the workload. From the Improvement items section: 1. Choose the pertinent question and update the selected best practices to reflect the changes. Notes are added to record the improvements. 2. Then choose Save and exit |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.