recommendations
Creates, updates, deletes, gets or lists a recommendations resource.
Overview
| Name | recommendations |
| Type | Resource |
| Id | aws.codeguruprofiler.recommendations |
Fields
The following fields are returned by SELECT queries:
- get_recommendations
| Name | Datatype | Description |
|---|---|---|
anomalies | array | The list of anomalies that the analysis has found for this profile. |
profile_end_time | string (date-time) | The end time of the profile the analysis data is about. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC. |
profile_start_time | string (date-time) | The start time of the profile the analysis data is about. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC. |
profiling_group_name | string | The name of the profiling group the analysis data is about. (pattern: <code>^[\w-]+$</code>) |
recommendations | array | The list of recommendations that the analysis found for this profile. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_recommendations | select | endTime, profiling_group_name, startTime, region | locale | Returns a list of Recommendation objects that contain recommendations for a profiling group for a given time period. A list of Anomaly objects that contains details about anomalies detected in the profiling group for the same time period is also returned. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
endTime | string (date-time) | The start time of the profile to get analysis data about. You must specify startTime and endTime. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC. |
profiling_group_name | string | The name of the profiling group to get analysis data about. |
region | string | AWS region (default: us-east-1) |
startTime | string (date-time) | The end time of the profile to get analysis data about. You must specify startTime and endTime. This is specified using the ISO 8601 format. For example, 2020-06-01T13:15:02.001Z represents 1 millisecond past June 1, 2020 1:15:02 PM UTC. |
locale | string | The language used to provide analysis. Specify using a string that is one of the following BCP 47 language codes. de-DE - German, Germany en-GB - English, United Kingdom en-US - English, United States es-ES - Spanish, Spain fr-FR - French, France it-IT - Italian, Italy ja-JP - Japanese, Japan ko-KR - Korean, Republic of Korea pt-BR - Portugese, Brazil zh-CN - Chinese, China zh-TW - Chinese, Taiwan |
SELECT examples
- get_recommendations
Returns a list of Recommendation objects that contain recommendations for a profiling group for a given time period. A list of Anomaly objects that contains details about anomalies detected in the profiling group for the same time period is also returned.
SELECT
anomalies,
profile_end_time,
profile_start_time,
profiling_group_name,
recommendations
FROM aws.codeguruprofiler.recommendations
WHERE endTime = '{{ endTime }}' -- required
AND profiling_group_name = '{{ profiling_group_name }}' -- required
AND startTime = '{{ startTime }}' -- required
AND region = '{{ region }}' -- required
AND locale = '{{ locale }}'
;