diff --git a/.changes/next-release/feature-AmazonForecastService-80dca48.json b/.changes/next-release/feature-AmazonForecastService-80dca48.json new file mode 100644 index 000000000000..173829f36f9b --- /dev/null +++ b/.changes/next-release/feature-AmazonForecastService-80dca48.json @@ -0,0 +1,6 @@ +{ + "type": "feature", + "category": "Amazon Forecast Service", + "contributor": "", + "description": "Added new StopResource operation that stops Amazon Forecast resource jobs that are in progress." +} diff --git a/services/forecast/src/main/resources/codegen-resources/service-2.json b/services/forecast/src/main/resources/codegen-resources/service-2.json index 737ddd3679a8..17b954930c54 100644 --- a/services/forecast/src/main/resources/codegen-resources/service-2.json +++ b/services/forecast/src/main/resources/codegen-resources/service-2.json @@ -473,6 +473,21 @@ ], "documentation":"
Lists the tags for an Amazon Forecast resource.
" }, + "StopResource":{ + "name":"StopResource", + "http":{ + "method":"POST", + "requestUri":"/" + }, + "input":{"shape":"StopResourceRequest"}, + "errors":[ + {"shape":"InvalidInputException"}, + {"shape":"LimitExceededException"}, + {"shape":"ResourceNotFoundException"} + ], + "documentation":"Stops a resource.
The resource undergoes the following states: CREATE_STOPPING
and CREATE_STOPPED
. You cannot resume a resource once it has been stopped.
This operation can be applied to the following resources (and their corresponding child resources):
Dataset Import Job
Predictor Job
Forecast Job
Forecast Export Job
Predictor Backtest Export Job
The status of the dataset import job. The status is reflected in the status of the dataset. For example, when the import job status is CREATE_IN_PROGRESS
, the status of the dataset is UPDATE_IN_PROGRESS
. States include:
ACTIVE
CREATE_PENDING
, CREATE_IN_PROGRESS
, CREATE_FAILED
DELETE_PENDING
, DELETE_IN_PROGRESS
, DELETE_FAILED
The status of the dataset import job. States include:
ACTIVE
CREATE_PENDING
, CREATE_IN_PROGRESS
, CREATE_FAILED
DELETE_PENDING
, DELETE_IN_PROGRESS
, DELETE_FAILED
CREATE_STOPPING
, CREATE_STOPPED
The last time that the dataset was modified. The time depends on the status of the job, as follows:
CREATE_PENDING
- The same time as CreationTime
.
CREATE_IN_PROGRESS
- The current timestamp.
ACTIVE
or CREATE_FAILED
- When the job finished or failed.
The last time the resource was modified. The timestamp depends on the status of the job:
CREATE_PENDING
- The CreationTime
.
CREATE_IN_PROGRESS
- The current timestamp.
CREATE_STOPPING
- The current timestamp.
CREATE_STOPPED
- When the job stopped.
ACTIVE
or CREATE_FAILED
- When the job finished or failed.
Provides a summary of the dataset import job properties used in the ListDatasetImportJobs operation. To get the complete set of properties, call the DescribeDatasetImportJob operation, and provide the DatasetImportJobArn
.
The status of the dataset import job. The status is reflected in the status of the dataset. For example, when the import job status is CREATE_IN_PROGRESS
, the status of the dataset is UPDATE_IN_PROGRESS
. States include:
ACTIVE
CREATE_PENDING
, CREATE_IN_PROGRESS
, CREATE_FAILED
DELETE_PENDING
, DELETE_IN_PROGRESS
, DELETE_FAILED
The status of the dataset import job. States include:
ACTIVE
CREATE_PENDING
, CREATE_IN_PROGRESS
, CREATE_FAILED
DELETE_PENDING
, DELETE_IN_PROGRESS
, DELETE_FAILED
CREATE_STOPPING
, CREATE_STOPPED
The last time that the dataset was modified. The time depends on the status of the job, as follows:
CREATE_PENDING
- The same time as CreationTime
.
CREATE_IN_PROGRESS
- The current timestamp.
ACTIVE
or CREATE_FAILED
- When the job finished or failed.
The last time the resource was modified. The timestamp depends on the status of the job:
CREATE_PENDING
- The CreationTime
.
CREATE_IN_PROGRESS
- The current timestamp.
CREATE_STOPPING
- The current timestamp.
CREATE_STOPPED
- When the job stopped.
ACTIVE
or CREATE_FAILED
- When the job finished or failed.
The status of the forecast export job. States include:
ACTIVE
CREATE_PENDING
, CREATE_IN_PROGRESS
, CREATE_FAILED
DELETE_PENDING
, DELETE_IN_PROGRESS
, DELETE_FAILED
The Status
of the forecast export job must be ACTIVE
before you can access the forecast in your S3 bucket.
The status of the forecast export job. States include:
ACTIVE
CREATE_PENDING
, CREATE_IN_PROGRESS
, CREATE_FAILED
CREATE_STOPPING
, CREATE_STOPPED
DELETE_PENDING
, DELETE_IN_PROGRESS
, DELETE_FAILED
The Status
of the forecast export job must be ACTIVE
before you can access the forecast in your S3 bucket.
When the last successful export job finished.
" + "documentation":"The last time the resource was modified. The timestamp depends on the status of the job:
CREATE_PENDING
- The CreationTime
.
CREATE_IN_PROGRESS
- The current timestamp.
CREATE_STOPPING
- The current timestamp.
CREATE_STOPPED
- When the job stopped.
ACTIVE
or CREATE_FAILED
- When the job finished or failed.
The status of the forecast. States include:
ACTIVE
CREATE_PENDING
, CREATE_IN_PROGRESS
, CREATE_FAILED
DELETE_PENDING
, DELETE_IN_PROGRESS
, DELETE_FAILED
The Status
of the forecast must be ACTIVE
before you can query or export the forecast.
The status of the forecast. States include:
ACTIVE
CREATE_PENDING
, CREATE_IN_PROGRESS
, CREATE_FAILED
CREATE_STOPPING
, CREATE_STOPPED
DELETE_PENDING
, DELETE_IN_PROGRESS
, DELETE_FAILED
The Status
of the forecast must be ACTIVE
before you can query or export the forecast.
Initially, the same as CreationTime
(status is CREATE_PENDING
). Updated when inference (creating the forecast) starts (status changed to CREATE_IN_PROGRESS
), and when inference is complete (status changed to ACTIVE
) or fails (status changed to CREATE_FAILED
).
The last time the resource was modified. The timestamp depends on the status of the job:
CREATE_PENDING
- The CreationTime
.
CREATE_IN_PROGRESS
- The current timestamp.
CREATE_STOPPING
- The current timestamp.
CREATE_STOPPED
- When the job stopped.
ACTIVE
or CREATE_FAILED
- When the job finished or failed.
The status of the predictor backtest export job. States include:
ACTIVE
CREATE_PENDING
CREATE_IN_PROGRESS
CREATE_FAILED
DELETE_PENDING
DELETE_IN_PROGRESS
DELETE_FAILED
The status of the predictor backtest export job. States include:
ACTIVE
CREATE_PENDING
, CREATE_IN_PROGRESS
, CREATE_FAILED
CREATE_STOPPING
, CREATE_STOPPED
DELETE_PENDING
, DELETE_IN_PROGRESS
, DELETE_FAILED
When the last successful export job finished.
" + "documentation":"The last time the resource was modified. The timestamp depends on the status of the job:
CREATE_PENDING
- The CreationTime
.
CREATE_IN_PROGRESS
- The current timestamp.
CREATE_STOPPING
- The current timestamp.
CREATE_STOPPED
- When the job stopped.
ACTIVE
or CREATE_FAILED
- When the job finished or failed.
The status of the predictor. States include:
ACTIVE
CREATE_PENDING
, CREATE_IN_PROGRESS
, CREATE_FAILED
DELETE_PENDING
, DELETE_IN_PROGRESS
, DELETE_FAILED
UPDATE_PENDING
, UPDATE_IN_PROGRESS
, UPDATE_FAILED
The Status
of the predictor must be ACTIVE
before you can use the predictor to create a forecast.
The status of the predictor. States include:
ACTIVE
CREATE_PENDING
, CREATE_IN_PROGRESS
, CREATE_FAILED
DELETE_PENDING
, DELETE_IN_PROGRESS
, DELETE_FAILED
CREATE_STOPPING
, CREATE_STOPPED
The Status
of the predictor must be ACTIVE
before you can use the predictor to create a forecast.
Initially, the same as CreationTime
(when the status is CREATE_PENDING
). This value is updated when training starts (when the status changes to CREATE_IN_PROGRESS
), and when training has completed (when the status changes to ACTIVE
) or fails (when the status changes to CREATE_FAILED
).
The last time the resource was modified. The timestamp depends on the status of the job:
CREATE_PENDING
- The CreationTime
.
CREATE_IN_PROGRESS
- The current timestamp.
CREATE_STOPPING
- The current timestamp.
CREATE_STOPPED
- When the job stopped.
ACTIVE
or CREATE_FAILED
- When the job finished or failed.
The status of the forecast export job. States include:
ACTIVE
CREATE_PENDING
, CREATE_IN_PROGRESS
, CREATE_FAILED
DELETE_PENDING
, DELETE_IN_PROGRESS
, DELETE_FAILED
The Status
of the forecast export job must be ACTIVE
before you can access the forecast in your S3 bucket.
The status of the forecast export job. States include:
ACTIVE
CREATE_PENDING
, CREATE_IN_PROGRESS
, CREATE_FAILED
CREATE_STOPPING
, CREATE_STOPPED
DELETE_PENDING
, DELETE_IN_PROGRESS
, DELETE_FAILED
The Status
of the forecast export job must be ACTIVE
before you can access the forecast in your S3 bucket.
When the last successful export job finished.
" + "documentation":"The last time the resource was modified. The timestamp depends on the status of the job:
CREATE_PENDING
- The CreationTime
.
CREATE_IN_PROGRESS
- The current timestamp.
CREATE_STOPPING
- The current timestamp.
CREATE_STOPPED
- When the job stopped.
ACTIVE
or CREATE_FAILED
- When the job finished or failed.
Provides a summary of the forecast export job properties used in the ListForecastExportJobs operation. To get the complete set of properties, call the DescribeForecastExportJob operation, and provide the listed ForecastExportJobArn
.
The status of the forecast. States include:
ACTIVE
CREATE_PENDING
, CREATE_IN_PROGRESS
, CREATE_FAILED
DELETE_PENDING
, DELETE_IN_PROGRESS
, DELETE_FAILED
The Status
of the forecast must be ACTIVE
before you can query or export the forecast.
The status of the forecast. States include:
ACTIVE
CREATE_PENDING
, CREATE_IN_PROGRESS
, CREATE_FAILED
CREATE_STOPPING
, CREATE_STOPPED
DELETE_PENDING
, DELETE_IN_PROGRESS
, DELETE_FAILED
The Status
of the forecast must be ACTIVE
before you can query or export the forecast.
Initially, the same as CreationTime
(status is CREATE_PENDING
). Updated when inference (creating the forecast) starts (status changed to CREATE_IN_PROGRESS
), and when inference is complete (status changed to ACTIVE
) or fails (status changed to CREATE_FAILED
).
The last time the resource was modified. The timestamp depends on the status of the job:
CREATE_PENDING
- The CreationTime
.
CREATE_IN_PROGRESS
- The current timestamp.
CREATE_STOPPING
- The current timestamp.
CREATE_STOPPED
- When the job stopped.
ACTIVE
or CREATE_FAILED
- When the job finished or failed.
Provides a summary of the forecast properties used in the ListForecasts operation. To get the complete set of properties, call the DescribeForecast operation, and provide the ForecastArn
that is listed in the summary.
An array of filters. For each filter, provide a condition and a match statement. The condition is either IS
or IS_NOT
, which specifies whether to include or exclude the predictor backtest export jobs that match the statement from the list. The match statement consists of a key and a value.
Filter properties
Condition
- The condition to apply. Valid values are IS
and IS_NOT
. To include the predictor backtest export jobs that match the statement, specify IS
. To exclude matching predictor backtest export jobs, specify IS_NOT
.
Key
- The name of the parameter to filter on. Valid values are PredictorBacktestExportJobArn
and Status
.
Value
- The value to match.
An array of filters. For each filter, provide a condition and a match statement. The condition is either IS
or IS_NOT
, which specifies whether to include or exclude the predictor backtest export jobs that match the statement from the list. The match statement consists of a key and a value.
Filter properties
Condition
- The condition to apply. Valid values are IS
and IS_NOT
. To include the predictor backtest export jobs that match the statement, specify IS
. To exclude matching predictor backtest export jobs, specify IS_NOT
.
Key
- The name of the parameter to filter on. Valid values are PredictorArn
and Status
.
Value
- The value to match.
The status of the predictor backtest export job. States include:
ACTIVE
CREATE_PENDING
CREATE_IN_PROGRESS
CREATE_FAILED
DELETE_PENDING
DELETE_IN_PROGRESS
DELETE_FAILED
The status of the predictor backtest export job. States include:
ACTIVE
CREATE_PENDING
, CREATE_IN_PROGRESS
, CREATE_FAILED
CREATE_STOPPING
, CREATE_STOPPED
DELETE_PENDING
, DELETE_IN_PROGRESS
, DELETE_FAILED
When the last successful export job finished.
" + "documentation":"The last time the resource was modified. The timestamp depends on the status of the job:
CREATE_PENDING
- The CreationTime
.
CREATE_IN_PROGRESS
- The current timestamp.
CREATE_STOPPING
- The current timestamp.
CREATE_STOPPED
- When the job stopped.
ACTIVE
or CREATE_FAILED
- When the job finished or failed.
Provides a summary of the predictor backtest export job properties used in the ListPredictorBacktestExportJobs operation. To get a complete set of properties, call the DescribePredictorBacktestExportJob operation, and provide the listed PredictorBacktestExportJobArn
.
The status of the predictor. States include:
ACTIVE
CREATE_PENDING
, CREATE_IN_PROGRESS
, CREATE_FAILED
DELETE_PENDING
, DELETE_IN_PROGRESS
, DELETE_FAILED
UPDATE_PENDING
, UPDATE_IN_PROGRESS
, UPDATE_FAILED
The Status
of the predictor must be ACTIVE
before you can use the predictor to create a forecast.
The status of the predictor. States include:
ACTIVE
CREATE_PENDING
, CREATE_IN_PROGRESS
, CREATE_FAILED
DELETE_PENDING
, DELETE_IN_PROGRESS
, DELETE_FAILED
CREATE_STOPPING
, CREATE_STOPPED
The Status
of the predictor must be ACTIVE
before you can use the predictor to create a forecast.
Initially, the same as CreationTime
(status is CREATE_PENDING
). Updated when training starts (status changed to CREATE_IN_PROGRESS
), and when training is complete (status changed to ACTIVE
) or fails (status changed to CREATE_FAILED
).
The last time the resource was modified. The timestamp depends on the status of the job:
CREATE_PENDING
- The CreationTime
.
CREATE_IN_PROGRESS
- The current timestamp.
CREATE_STOPPING
- The current timestamp.
CREATE_STOPPED
- When the job stopped.
ACTIVE
or CREATE_FAILED
- When the job finished or failed.
Provides a summary of the predictor properties that are used in the ListPredictors operation. To get the complete set of properties, call the DescribePredictor operation, and provide the listed PredictorArn
.
The Amazon Resource Name (ARN) that identifies the resource to stop. The supported ARNs are DatasetImportJobArn
, PredictorArn
, PredictorBacktestExportJobArn
, ForecastArn
, and ForecastExportJobArn
.