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):

", + "idempotent":true + }, "TagResource":{ "name":"TagResource", "http":{ @@ -968,7 +983,7 @@ }, "Status":{ "shape":"Status", - "documentation":"

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:

" + "documentation":"

The status of the dataset import job. States include:

" }, "Message":{ "shape":"ErrorMessage", @@ -980,7 +995,7 @@ }, "LastModificationTime":{ "shape":"Timestamp", - "documentation":"

The last time that the dataset was modified. The time depends on the status of the job, as follows:

" + "documentation":"

The last time the resource was modified. The timestamp depends on the status of the job:

" } }, "documentation":"

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.

" @@ -1199,7 +1214,7 @@ }, "Status":{ "shape":"Status", - "documentation":"

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:

" + "documentation":"

The status of the dataset import job. States include:

" }, "Message":{ "shape":"Message", @@ -1211,7 +1226,7 @@ }, "LastModificationTime":{ "shape":"Timestamp", - "documentation":"

The last time that the dataset was modified. The time depends on the status of the job, as follows:

" + "documentation":"

The last time the resource was modified. The timestamp depends on the status of the job:

" } } }, @@ -1305,7 +1320,7 @@ }, "Status":{ "shape":"Status", - "documentation":"

The status of the forecast export job. States include:

The Status of the forecast export job must be ACTIVE before you can access the forecast in your S3 bucket.

" + "documentation":"

The status of the forecast export job. States include:

The Status of the forecast export job must be ACTIVE before you can access the forecast in your S3 bucket.

" }, "CreationTime":{ "shape":"Timestamp", @@ -1313,7 +1328,7 @@ }, "LastModificationTime":{ "shape":"Timestamp", - "documentation":"

When the last successful export job finished.

" + "documentation":"

The last time the resource was modified. The timestamp depends on the status of the job:

" } } }, @@ -1352,7 +1367,7 @@ }, "Status":{ "shape":"String", - "documentation":"

The status of the forecast. States include:

The Status of the forecast must be ACTIVE before you can query or export the forecast.

" + "documentation":"

The status of the forecast. States include:

The Status of the forecast must be ACTIVE before you can query or export the forecast.

" }, "Message":{ "shape":"ErrorMessage", @@ -1364,7 +1379,7 @@ }, "LastModificationTime":{ "shape":"Timestamp", - "documentation":"

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).

" + "documentation":"

The last time the resource was modified. The timestamp depends on the status of the job:

" } } }, @@ -1400,7 +1415,7 @@ }, "Status":{ "shape":"Status", - "documentation":"

The status of the predictor backtest export job. States include:

" + "documentation":"

The status of the predictor backtest export job. States include:

" }, "CreationTime":{ "shape":"Timestamp", @@ -1408,7 +1423,7 @@ }, "LastModificationTime":{ "shape":"Timestamp", - "documentation":"

When the last successful export job finished.

" + "documentation":"

The last time the resource was modified. The timestamp depends on the status of the job:

" } } }, @@ -1491,7 +1506,7 @@ }, "Status":{ "shape":"Status", - "documentation":"

The status of the predictor. States include:

The Status of the predictor must be ACTIVE before you can use the predictor to create a forecast.

" + "documentation":"

The status of the predictor. States include:

The Status of the predictor must be ACTIVE before you can use the predictor to create a forecast.

" }, "Message":{ "shape":"Message", @@ -1503,7 +1518,7 @@ }, "LastModificationTime":{ "shape":"Timestamp", - "documentation":"

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).

" + "documentation":"

The last time the resource was modified. The timestamp depends on the status of the job:

" } } }, @@ -1730,7 +1745,7 @@ }, "Status":{ "shape":"Status", - "documentation":"

The status of the forecast export job. States include:

The Status of the forecast export job must be ACTIVE before you can access the forecast in your S3 bucket.

" + "documentation":"

The status of the forecast export job. States include:

The Status of the forecast export job must be ACTIVE before you can access the forecast in your S3 bucket.

" }, "Message":{ "shape":"ErrorMessage", @@ -1742,7 +1757,7 @@ }, "LastModificationTime":{ "shape":"Timestamp", - "documentation":"

When the last successful export job finished.

" + "documentation":"

The last time the resource was modified. The timestamp depends on the status of the job:

" } }, "documentation":"

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.

" @@ -1772,7 +1787,7 @@ }, "Status":{ "shape":"Status", - "documentation":"

The status of the forecast. States include:

The Status of the forecast must be ACTIVE before you can query or export the forecast.

" + "documentation":"

The status of the forecast. States include:

The Status of the forecast must be ACTIVE before you can query or export the forecast.

" }, "Message":{ "shape":"ErrorMessage", @@ -1784,7 +1799,7 @@ }, "LastModificationTime":{ "shape":"Timestamp", - "documentation":"

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).

" + "documentation":"

The last time the resource was modified. The timestamp depends on the status of the job:

" } }, "documentation":"

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.

" @@ -2074,7 +2089,7 @@ }, "Filters":{ "shape":"Filters", - "documentation":"

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

" + "documentation":"

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

" } } }, @@ -2219,7 +2234,7 @@ "Destination":{"shape":"DataDestination"}, "Status":{ "shape":"Status", - "documentation":"

The status of the predictor backtest export job. States include:

" + "documentation":"

The status of the predictor backtest export job. States include:

" }, "Message":{ "shape":"ErrorMessage", @@ -2231,7 +2246,7 @@ }, "LastModificationTime":{ "shape":"Timestamp", - "documentation":"

When the last successful export job finished.

" + "documentation":"

The last time the resource was modified. The timestamp depends on the status of the job:

" } }, "documentation":"

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.

" @@ -2291,7 +2306,7 @@ }, "Status":{ "shape":"Status", - "documentation":"

The status of the predictor. States include:

The Status of the predictor must be ACTIVE before you can use the predictor to create a forecast.

" + "documentation":"

The status of the predictor. States include:

The Status of the predictor must be ACTIVE before you can use the predictor to create a forecast.

" }, "Message":{ "shape":"ErrorMessage", @@ -2303,7 +2318,7 @@ }, "LastModificationTime":{ "shape":"Timestamp", - "documentation":"

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).

" + "documentation":"

The last time the resource was modified. The timestamp depends on the status of the job:

" } }, "documentation":"

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.

" @@ -2443,6 +2458,16 @@ "type":"string", "max":256 }, + "StopResourceRequest":{ + "type":"structure", + "required":["ResourceArn"], + "members":{ + "ResourceArn":{ + "shape":"Arn", + "documentation":"

The Amazon Resource Name (ARN) that identifies the resource to stop. The supported ARNs are DatasetImportJobArn, PredictorArn, PredictorBacktestExportJobArn, ForecastArn, and ForecastExportJobArn.

" + } + } + }, "String":{ "type":"string", "max":256,