Copyright	(c) 2013-2021 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	None

Amazonka.Forecast.StopResource

Contents

Creating a Request
Request Lenses
Destructuring the Response

Description

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

Synopsis

data StopResource = StopResource' {
- resourceArn :: Text
}
newStopResource :: Text -> StopResource
stopResource_resourceArn :: Lens' StopResource Text
data StopResourceResponse = StopResourceResponse' {
}
newStopResourceResponse :: StopResourceResponse

Creating a Request

data StopResource Source #

See: newStopResource smart constructor.

Constructors

StopResource'
Fields resourceArn :: Text The Amazon Resource Name (ARN) that identifies the resource to stop. The supported ARNs are `DatasetImportJobArn`, `PredictorArn`, `PredictorBacktestExportJobArn`, `ForecastArn`, and `ForecastExportJobArn`.

Instances

Instances details

Eq StopResource Source #
Instance details Defined in Amazonka.Forecast.StopResource Methods (==) :: StopResource -> StopResource -> Bool # (/=) :: StopResource -> StopResource -> Bool #
Read StopResource Source #
Instance details Defined in Amazonka.Forecast.StopResource Methods readsPrec :: Int -> ReadS StopResource # readList :: ReadS [StopResource] # readPrec :: ReadPrec StopResource # readListPrec :: ReadPrec [StopResource] #
Show StopResource Source #
Instance details Defined in Amazonka.Forecast.StopResource Methods showsPrec :: Int -> StopResource -> ShowS # show :: StopResource -> String # showList :: [StopResource] -> ShowS #
Generic StopResource Source #
Instance details Defined in Amazonka.Forecast.StopResource Associated Types type Rep StopResource :: Type -> Type # Methods from :: StopResource -> Rep StopResource x # to :: Rep StopResource x -> StopResource #
NFData StopResource Source #
Instance details Defined in Amazonka.Forecast.StopResource Methods rnf :: StopResource -> () #
Hashable StopResource Source #
Instance details Defined in Amazonka.Forecast.StopResource Methods hashWithSalt :: Int -> StopResource -> Int # hash :: StopResource -> Int #
ToJSON StopResource Source #
Instance details Defined in Amazonka.Forecast.StopResource Methods toJSON :: StopResource -> Value # toEncoding :: StopResource -> Encoding # toJSONList :: [StopResource] -> Value # toEncodingList :: [StopResource] -> Encoding #
AWSRequest StopResource Source #
Instance details Defined in Amazonka.Forecast.StopResource Associated Types type AWSResponse StopResource # Methods request :: StopResource -> Request StopResource # response :: MonadResource m => Logger -> Service -> Proxy StopResource -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse StopResource))) #
ToHeaders StopResource Source #
Instance details Defined in Amazonka.Forecast.StopResource Methods toHeaders :: StopResource -> [Header] #
ToPath StopResource Source #
Instance details Defined in Amazonka.Forecast.StopResource Methods toPath :: StopResource -> ByteString #
ToQuery StopResource Source #
Instance details Defined in Amazonka.Forecast.StopResource Methods toQuery :: StopResource -> QueryString #
type Rep StopResource Source #
Instance details Defined in Amazonka.Forecast.StopResource type Rep StopResource = D1 ('MetaData "StopResource" "Amazonka.Forecast.StopResource" "libZSservicesZSamazonka-forecastZSamazonka-forecast" 'False) (C1 ('MetaCons "StopResource'" 'PrefixI 'True) (S1 ('MetaSel ('Just "resourceArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse StopResource Source #
Instance details Defined in Amazonka.Forecast.StopResource type AWSResponse StopResource = StopResourceResponse

newStopResource Source #

Arguments

:: Text	`$sel:resourceArn:StopResource'`
-> StopResource

Create a value of StopResource with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:resourceArn:StopResource', stopResource_resourceArn - The Amazon Resource Name (ARN) that identifies the resource to stop. The supported ARNs are DatasetImportJobArn, PredictorArn, PredictorBacktestExportJobArn, ForecastArn, and ForecastExportJobArn.

Request Lenses

stopResource_resourceArn :: Lens' StopResource Text Source #

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

Destructuring the Response

data StopResourceResponse Source #

See: newStopResourceResponse smart constructor.

Constructors

StopResourceResponse'

Instances

Instances details

Eq StopResourceResponse Source #
Instance details Defined in Amazonka.Forecast.StopResource Methods (==) :: StopResourceResponse -> StopResourceResponse -> Bool # (/=) :: StopResourceResponse -> StopResourceResponse -> Bool #
Read StopResourceResponse Source #
Instance details Defined in Amazonka.Forecast.StopResource Methods readsPrec :: Int -> ReadS StopResourceResponse # readList :: ReadS [StopResourceResponse] # readPrec :: ReadPrec StopResourceResponse # readListPrec :: ReadPrec [StopResourceResponse] #
Show StopResourceResponse Source #
Instance details Defined in Amazonka.Forecast.StopResource Methods showsPrec :: Int -> StopResourceResponse -> ShowS # show :: StopResourceResponse -> String # showList :: [StopResourceResponse] -> ShowS #
Generic StopResourceResponse Source #
Instance details Defined in Amazonka.Forecast.StopResource Associated Types type Rep StopResourceResponse :: Type -> Type # Methods from :: StopResourceResponse -> Rep StopResourceResponse x # to :: Rep StopResourceResponse x -> StopResourceResponse #
NFData StopResourceResponse Source #
Instance details Defined in Amazonka.Forecast.StopResource Methods rnf :: StopResourceResponse -> () #
type Rep StopResourceResponse Source #
Instance details Defined in Amazonka.Forecast.StopResource type Rep StopResourceResponse = D1 ('MetaData "StopResourceResponse" "Amazonka.Forecast.StopResource" "libZSservicesZSamazonka-forecastZSamazonka-forecast" 'False) (C1 ('MetaCons "StopResourceResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newStopResourceResponse :: StopResourceResponse Source #

Create a value of StopResourceResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.