Amazonka.Forecast.StopResource

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
• Explainability Job
• Explainability Export Job

Creating a Request

data StopResource

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, ForecastExportJobArn, ExplainabilityArn, and ExplainabilityExportArn.

Instances

ToJSON StopResource

Defined in Amazonka.Forecast.StopResource

Methods

toJSON :: StopResource -> Value

toEncoding :: StopResource -> Encoding

toJSONList :: [StopResource] -> Value

toEncodingList :: [StopResource] -> Encoding

ToHeaders StopResource

Defined in Amazonka.Forecast.StopResource

Methods

toHeaders :: StopResource -> [Header]

ToPath StopResource

Defined in Amazonka.Forecast.StopResource

Methods

toPath :: StopResource -> ByteString

ToQuery StopResource

Defined in Amazonka.Forecast.StopResource

Methods

toQuery :: StopResource -> QueryString

AWSRequest StopResource

Defined in Amazonka.Forecast.StopResource

Associated Types

type AWSResponse StopResource

Methods

request :: (Service -> Service) -> StopResource -> Request StopResource

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy StopResource -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse StopResource)))

Generic StopResource

Defined in Amazonka.Forecast.StopResource

Associated Types

type Rep StopResource :: Type -> Type

Methods

from :: StopResource -> Rep StopResource x

to :: Rep StopResource x -> StopResource

Read StopResource

Defined in Amazonka.Forecast.StopResource

Methods

readsPrec :: Int -> ReadS StopResource

readList :: ReadS [StopResource]

readPrec :: ReadPrec StopResource

readListPrec :: ReadPrec [StopResource]

Show StopResource

Defined in Amazonka.Forecast.StopResource

Methods

showsPrec :: Int -> StopResource -> ShowS

show :: StopResource -> String

showList :: [StopResource] -> ShowS

NFData StopResource

Defined in Amazonka.Forecast.StopResource

Methods

rnf :: StopResource -> ()

Eq StopResource

Defined in Amazonka.Forecast.StopResource

Methods

(==) :: StopResource -> StopResource -> Bool

(/=) :: StopResource -> StopResource -> Bool

Hashable StopResource

Defined in Amazonka.Forecast.StopResource

Methods

hashWithSalt :: Int -> StopResource -> Int

hash :: StopResource -> Int

type AWSResponse StopResource

Defined in Amazonka.Forecast.StopResource

type AWSResponse StopResource = StopResourceResponse

type Rep StopResource

Defined in Amazonka.Forecast.StopResource

type Rep StopResource = D1 ('MetaData "StopResource" "Amazonka.Forecast.StopResource" "amazonka-forecast-2.0-HHvJwvxGrDPBJtUcnmLBqf" 'False) (C1 ('MetaCons "StopResource'" 'PrefixI 'True) (S1 ('MetaSel ('Just "resourceArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newStopResource

Arguments

:: Text

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:

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

Request Lenses

stopResource_resourceArn :: Lens' StopResource Text

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

Destructuring the Response

data StopResourceResponse

See: newStopResourceResponse smart constructor.

Constructors

StopResourceResponse'

Instances

Generic StopResourceResponse

Defined in Amazonka.Forecast.StopResource

Associated Types

type Rep StopResourceResponse :: Type -> Type

Methods

from :: StopResourceResponse -> Rep StopResourceResponse x

to :: Rep StopResourceResponse x -> StopResourceResponse

Read StopResourceResponse

Defined in Amazonka.Forecast.StopResource

Methods

readsPrec :: Int -> ReadS StopResourceResponse

readList :: ReadS [StopResourceResponse]

readPrec :: ReadPrec StopResourceResponse

readListPrec :: ReadPrec [StopResourceResponse]

Show StopResourceResponse

Defined in Amazonka.Forecast.StopResource

Methods

showsPrec :: Int -> StopResourceResponse -> ShowS

show :: StopResourceResponse -> String

showList :: [StopResourceResponse] -> ShowS

NFData StopResourceResponse

Defined in Amazonka.Forecast.StopResource

Methods

rnf :: StopResourceResponse -> ()

Eq StopResourceResponse

Defined in Amazonka.Forecast.StopResource

Methods

(==) :: StopResourceResponse -> StopResourceResponse -> Bool

(/=) :: StopResourceResponse -> StopResourceResponse -> Bool

type Rep StopResourceResponse

Defined in Amazonka.Forecast.StopResource

type Rep StopResourceResponse = D1 ('MetaData "StopResourceResponse" "Amazonka.Forecast.StopResource" "amazonka-forecast-2.0-HHvJwvxGrDPBJtUcnmLBqf" 'False) (C1 ('MetaCons "StopResourceResponse'" 'PrefixI 'False) (U1 :: Type -> Type))

newStopResourceResponse :: StopResourceResponse

Create a value of StopResourceResponse with all optional fields omitted.

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