Actions, resources, and condition keys for Amazon Forecast
Amazon Forecast (service prefix: forecast) provides the following
service-specific operations, resources, actions, and condition keys for use in IAM permission
policies.
References:
-
Learn how to configure this service.
-
View a list of the API operations available for this service.
-
Learn how to secure this service and its resources by using IAM permission policies.
-
View the programmatic service authorization reference
for this service.
Topics
API operations defined by Amazon Forecast
The following table maps API operations to the IAM actions they authorize. Only condition keys that have static values for the given API and action are listed; for the full set of condition keys supported by each action, see the Actions table.
| Operation | SDK client | IAM action | Condition key | Possible value(s) | Access level |
|---|---|---|---|---|---|
|
CreateAutoPredictor |
forecast |
Write |
|||
Tagging, Write |
|||||
iam:PassedToService |
forecast.amazonaws.com |
Write |
|||
|
CreateDataset |
forecast |
Write |
|||
Tagging, Write |
|||||
iam:PassedToService |
forecast.amazonaws.com |
Write |
|||
|
CreateDatasetGroup |
forecast |
Write |
|||
Tagging, Write |
|||||
|
CreateDatasetImportJob |
forecast |
Write |
|||
Tagging, Write |
|||||
iam:PassedToService |
forecast.amazonaws.com |
Write |
|||
|
CreateExplainability |
forecast |
Write |
|||
Tagging, Write |
|||||
|
CreateExplainabilityExport |
forecast |
Write |
|||
Tagging, Write |
|||||
iam:PassedToService |
forecast.amazonaws.com |
Write |
|||
|
CreateForecast |
forecast |
Write |
|||
Tagging, Write |
|||||
|
CreateForecastExportJob |
forecast |
Write |
|||
Tagging, Write |
|||||
iam:PassedToService |
forecast.amazonaws.com |
Write |
|||
|
CreateMonitor |
forecast |
Write |
|||
Tagging, Write |
|||||
|
CreatePredictor |
forecast |
Write |
|||
Tagging, Write |
|||||
iam:PassedToService |
forecast.amazonaws.com |
Write |
|||
|
CreatePredictorBacktestExportJob |
forecast |
Write |
|||
Tagging, Write |
|||||
iam:PassedToService |
forecast.amazonaws.com |
Write |
|||
|
CreateWhatIfAnalysis |
forecast |
Write |
|||
Tagging, Write |
|||||
|
DeleteDataset |
forecast |
Write |
|||
|
DeleteDatasetGroup |
forecast |
Write |
|||
|
DeleteDatasetImportJob |
forecast |
Write |
|||
|
DeleteExplainability |
forecast |
Write |
|||
|
DeleteExplainabilityExport |
forecast |
Write |
|||
|
DeleteForecast |
forecast |
Write |
|||
|
DeleteForecastExportJob |
forecast |
Write |
|||
|
DeleteMonitor |
forecast |
Write |
|||
|
DeletePredictor |
forecast |
Write |
|||
|
DeletePredictorBacktestExportJob |
forecast |
Write |
|||
|
DeleteResourceTree |
forecast |
Write |
|||
|
DeleteWhatIfAnalysis |
forecast |
Write |
|||
|
DescribeAutoPredictor |
forecast |
Read |
|||
|
DescribeDataset |
forecast |
Read |
|||
|
DescribeDatasetGroup |
forecast |
Read |
|||
|
DescribeDatasetImportJob |
forecast |
Read |
|||
|
DescribeExplainability |
forecast |
Read |
|||
|
DescribeExplainabilityExport |
forecast |
Read |
|||
|
DescribeForecast |
forecast |
Read |
|||
|
DescribeForecastExportJob |
forecast |
Read |
|||
|
DescribeMonitor |
forecast |
Read |
|||
|
DescribePredictor |
forecast |
Read |
|||
|
DescribePredictorBacktestExportJob |
forecast |
Read |
|||
|
DescribeWhatIfAnalysis |
forecast |
Read |
|||
|
GetAccuracyMetrics |
forecast |
Read |
|||
|
ListDatasetGroups |
forecast |
Read |
|||
|
ListDatasetImportJobs |
forecast |
Read |
|||
|
ListDatasets |
forecast |
Read |
|||
|
ListExplainabilities |
forecast |
Read |
|||
|
ListExplainabilityExports |
forecast |
Read |
|||
|
ListForecastExportJobs |
forecast |
Read |
|||
|
ListForecasts |
forecast |
Read |
|||
|
ListMonitorEvaluations |
forecast |
Read |
|||
|
ListMonitors |
forecast |
Read |
|||
|
ListPredictorBacktestExportJobs |
forecast |
Read |
|||
|
ListPredictors |
forecast |
Read |
|||
|
ListTagsForResource |
forecast |
Read |
|||
|
ListWhatIfAnalyses |
forecast |
Read |
|||
|
ListWhatIfForecastExports |
forecast |
Read |
|||
|
ListWhatIfForecasts |
forecast |
Read |
|||
|
ResumeResource |
forecast |
Write |
|||
|
StopResource |
forecast |
Write |
|||
|
TagResource |
forecast |
Tagging, Write |
|||
|
UntagResource |
forecast |
Tagging, Write |
|||
|
UpdateDatasetGroup |
forecast |
Write |
|||
|
QueryForecast |
forecastquery |
Read |
|||
|
QueryWhatIfForecast |
forecastquery |
Read |
Actions defined by Amazon Forecast
You can specify the following actions in the Action element of an IAM
policy statement. Use policies to grant permissions to perform an operation in AWS. When
you use an action in a policy, you usually allow or deny access to the API operation or CLI
command with the same name. However, in some cases, a single action controls access to more
than one operation. Alternatively, some operations require several different actions.
| Actions | Description | Resource types (*required) | Condition keys | Access level |
|---|---|---|---|---|
Grants permission to create an auto predictor |
Write |
|||
Grants permission to create a dataset |
Write |
|||
Grants permission to create a dataset group |
Write |
|||
Grants permission to create a dataset import job |
Write |
|||
Grants permission to create an explainability |
Write |
|||
Grants permission to create an explainability export using an explainability resource |
Write |
|||
Grants permission to create a forecast |
Write |
|||
Grants permission to create a forecast export job using a forecast resource |
Write |
|||
Grants permission to create an monitor using a Predictor resource |
Write |
|||
Grants permission to create a predictor |
Write |
|||
Grants permission to create a predictor backtest export job using a predictor |
Write |
|||
Grants permission to create a what-if analysis |
Write |
|||
Grants permission to create a what-if forecast |
Write |
|||
Grants permission to create a what-if forecast export using what-if forecast resources |
Write |
|||
Grants permission to delete a dataset |
Write |
|||
Grants permission to delete a dataset group |
Write |
|||
Grants permission to delete a dataset import job |
Write |
|||
Grants permission to delete an explainability |
Write |
|||
Grants permission to delete an explainability export |
Write |
|||
Grants permission to delete a forecast |
Write |
|||
Grants permission to delete a forecast export job |
Write |
|||
Grants permission to delete a monitor resource |
Write |
|||
Grants permission to delete a predictor |
Write |
|||
Grants permission to delete a predictor backtest export job |
Write |
|||
Grants permission to delete a resource and its child resources |
Write |
|||
Grants permission to delete a what-if analysis |
Write |
|||
Grants permission to delete a what-if forecast |
Write |
|||
Grants permission to delete a what-if forecast export |
Write |
|||
Grants permission to describe an auto predictor |
Read |
|||
Grants permission to describe a dataset |
Read |
|||
Grants permission to describe a dataset group |
Read |
|||
Grants permission to describe a dataset import job |
Read |
|||
Grants permission to describe an explainability |
Read |
|||
Grants permission to describe an explainability export |
Read |
|||
Grants permission to describe a forecast |
Read |
|||
Grants permission to describe a forecast export job |
Read |
|||
Grants permission to describe an monitor resource |
Read |
|||
Grants permission to describe a predictor |
Read |
|||
Grants permission to describe a predictor backtest export job |
Read |
|||
Grants permission to describe a what-if analysis |
Read |
|||
Grants permission to describe a what-if forecast |
Read |
|||
Grants permission to describe a what-if forecast export |
Read |
|||
Grants permission to get the Accuracy Metrics for a predictor |
Read |
|||
Grants permission to list all the dataset groups |
Read |
|||
Grants permission to list all the dataset import jobs |
Read |
|||
Grants permission to list all the datasets |
Read |
|||
Grants permission to list all the explainabilities |
Read |
|||
Grants permission to list all the explainability exports |
Read |
|||
Grants permission to list all the forecast export jobs |
Read |
|||
Grants permission to list all the forecasts |
Read |
|||
Grants permission to list all the monitor evaluation result for a monitor |
Read |
|||
Grants permission to list all the monitor resources |
Read |
|||
Grants permission to list all the predictor backtest export jobs |
Read |
|||
Grants permission to list all the predictors |
Read |
|||
Grants permission to list the tags for an Amazon Forecast resource |
Read |
|||
Grants permission to list all the what-if analyses |
Read |
|||
Grants permission to list all the what-if forecast exports |
Read |
|||
Grants permission to list all the what-if forecasts |
Read |
|||
Grants permission to retrieve a forecast for a single item |
Read |
|||
Grants permission to retrieve a what-if forecast for a single item |
Read |
|||
Grants permission to resume Amazon Forecast resource jobs |
Write |
|||
Grants permission to stop Amazon Forecast resource jobs |
Write |
|||
Grants permission to associate the specified tags to a resource |
Tagging, Write |
|||
Grants permission to delete the specified tags for a resource |
Tagging, Write |
|||
Grants permission to update a dataset group |
Write |
|||
Permission-only actions for Amazon Forecast
The following actions are defined by Amazon Forecast but are not directly invocable through any API operation. They can only be used in IAM policy statements to grant or deny permissions.
| Actions | Description | Resource types (*required) | Condition keys | Access level |
|---|---|---|---|---|
Grants permission to create an endpoint using a Predictor resource |
Write |
|||
Grants permission to delete an endpoint resource |
Write |
|||
Grants permission to describe an endpoint resource |
Read |
|||
Grants permission to get the forecast context of a timeseries for an endpoint |
Read |
|||
Grants permission to invoke the endpoint to get forecast for a timeseries |
Read |
Resource types defined by Amazon Forecast
The following resource types are defined by this service and can be used in the
Resource element of IAM permission policy statements.
| Resource types | ARN | Condition keys |
|---|---|---|
arn:${Partition}:forecast:::algorithm/${ResourceId} |
||
arn:${Partition}:forecast:${Region}:${Account}:dataset/${ResourceId} |
||
arn:${Partition}:forecast:${Region}:${Account}:dataset-group/${ResourceId} |
||
arn:${Partition}:forecast:${Region}:${Account}:dataset-import-job/${ResourceId} |
||
arn:${Partition}:forecast:${Region}:${Account}:forecast-endpoint/${ResourceId} |
||
arn:${Partition}:forecast:${Region}:${Account}:explainability/${ResourceId} |
||
arn:${Partition}:forecast:${Region}:${Account}:explainability-export/${ResourceId} |
||
arn:${Partition}:forecast:${Region}:${Account}:forecast/${ResourceId} |
||
arn:${Partition}:forecast:${Region}:${Account}:forecast-export-job/${ResourceId} |
||
arn:${Partition}:forecast:${Region}:${Account}:monitor/${ResourceId} |
||
arn:${Partition}:forecast:${Region}:${Account}:predictor/${ResourceId} |
||
arn:${Partition}:forecast:${Region}:${Account}:predictor-backtest-export-job/${ResourceId} |
||
arn:${Partition}:forecast:${Region}:${Account}:what-if-analysis/${ResourceId} |
||
arn:${Partition}:forecast:${Region}:${Account}:what-if-forecast/${ResourceId} |
||
arn:${Partition}:forecast:${Region}:${Account}:what-if-forecast-export/${ResourceId} |
Condition keys for Amazon Forecast
Amazon Forecast defines the following condition keys that can be used in the
Condition element of an IAM policy.
| Condition keys | Description | Type |
|---|---|---|
Filters access by the tags that are passed in the request |
String |
|
Filters access by the tags associated with the resource |
String |
|
Filters access by the tag keys that are passed in the request |
ArrayOfString |