{-# LANGUAGE DeriveGeneric #-} {-# LANGUAGE DuplicateRecordFields #-} {-# LANGUAGE NamedFieldPuns #-} {-# LANGUAGE OverloadedStrings #-} {-# LANGUAGE RecordWildCards #-} {-# LANGUAGE StrictData #-} {-# LANGUAGE TypeFamilies #-} {-# LANGUAGE NoImplicitPrelude #-} {-# OPTIONS_GHC -fno-warn-unused-binds #-} {-# OPTIONS_GHC -fno-warn-unused-imports #-} {-# OPTIONS_GHC -fno-warn-unused-matches #-} -- Derived from AWS service descriptions, licensed under Apache 2.0. -- | -- Module : Amazonka.KinesisAnalytics.StartApplication -- Copyright : (c) 2013-2023 Brendan Hay -- License : Mozilla Public License, v. 2.0. -- Maintainer : Brendan Hay -- Stability : auto-generated -- Portability : non-portable (GHC extensions) -- -- This documentation is for version 1 of the Amazon Kinesis Data Analytics -- API, which only supports SQL applications. Version 2 of the API supports -- SQL and Java applications. For more information about version 2, see -- . -- -- Starts the specified Amazon Kinesis Analytics application. After -- creating an application, you must exclusively call this operation to -- start your application. -- -- After the application starts, it begins consuming the input data, -- processes it, and writes the output to the configured destination. -- -- The application status must be @READY@ for you to start an application. -- You can get the application status in the console or using the -- -- operation. -- -- After you start the application, you can stop the application from -- processing the input by calling the -- -- operation. -- -- This operation requires permissions to perform the -- @kinesisanalytics:StartApplication@ action. module Amazonka.KinesisAnalytics.StartApplication ( -- * Creating a Request StartApplication (..), newStartApplication, -- * Request Lenses startApplication_applicationName, startApplication_inputConfigurations, -- * Destructuring the Response StartApplicationResponse (..), newStartApplicationResponse, -- * Response Lenses startApplicationResponse_httpStatus, ) where import qualified Amazonka.Core as Core import qualified Amazonka.Core.Lens.Internal as Lens import qualified Amazonka.Data as Data import Amazonka.KinesisAnalytics.Types import qualified Amazonka.Prelude as Prelude import qualified Amazonka.Request as Request import qualified Amazonka.Response as Response -- | -- -- /See:/ 'newStartApplication' smart constructor. data StartApplication = StartApplication' { -- | Name of the application. applicationName :: Prelude.Text, -- | Identifies the specific input, by ID, that the application starts -- consuming. Amazon Kinesis Analytics starts reading the streaming source -- associated with the input. You can also specify where in the streaming -- source you want Amazon Kinesis Analytics to start reading. inputConfigurations :: [InputConfiguration] } deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic) -- | -- Create a value of 'StartApplication' with all optional fields omitted. -- -- Use or to modify other optional fields. -- -- The following record fields are available, with the corresponding lenses provided -- for backwards compatibility: -- -- 'applicationName', 'startApplication_applicationName' - Name of the application. -- -- 'inputConfigurations', 'startApplication_inputConfigurations' - Identifies the specific input, by ID, that the application starts -- consuming. Amazon Kinesis Analytics starts reading the streaming source -- associated with the input. You can also specify where in the streaming -- source you want Amazon Kinesis Analytics to start reading. newStartApplication :: -- | 'applicationName' Prelude.Text -> StartApplication newStartApplication pApplicationName_ = StartApplication' { applicationName = pApplicationName_, inputConfigurations = Prelude.mempty } -- | Name of the application. startApplication_applicationName :: Lens.Lens' StartApplication Prelude.Text startApplication_applicationName = Lens.lens (\StartApplication' {applicationName} -> applicationName) (\s@StartApplication' {} a -> s {applicationName = a} :: StartApplication) -- | Identifies the specific input, by ID, that the application starts -- consuming. Amazon Kinesis Analytics starts reading the streaming source -- associated with the input. You can also specify where in the streaming -- source you want Amazon Kinesis Analytics to start reading. startApplication_inputConfigurations :: Lens.Lens' StartApplication [InputConfiguration] startApplication_inputConfigurations = Lens.lens (\StartApplication' {inputConfigurations} -> inputConfigurations) (\s@StartApplication' {} a -> s {inputConfigurations = a} :: StartApplication) Prelude.. Lens.coerced instance Core.AWSRequest StartApplication where type AWSResponse StartApplication = StartApplicationResponse request overrides = Request.postJSON (overrides defaultService) response = Response.receiveEmpty ( \s h x -> StartApplicationResponse' Prelude.<$> (Prelude.pure (Prelude.fromEnum s)) ) instance Prelude.Hashable StartApplication where hashWithSalt _salt StartApplication' {..} = _salt `Prelude.hashWithSalt` applicationName `Prelude.hashWithSalt` inputConfigurations instance Prelude.NFData StartApplication where rnf StartApplication' {..} = Prelude.rnf applicationName `Prelude.seq` Prelude.rnf inputConfigurations instance Data.ToHeaders StartApplication where toHeaders = Prelude.const ( Prelude.mconcat [ "X-Amz-Target" Data.=# ( "KinesisAnalytics_20150814.StartApplication" :: Prelude.ByteString ), "Content-Type" Data.=# ( "application/x-amz-json-1.1" :: Prelude.ByteString ) ] ) instance Data.ToJSON StartApplication where toJSON StartApplication' {..} = Data.object ( Prelude.catMaybes [ Prelude.Just ("ApplicationName" Data..= applicationName), Prelude.Just ("InputConfigurations" Data..= inputConfigurations) ] ) instance Data.ToPath StartApplication where toPath = Prelude.const "/" instance Data.ToQuery StartApplication where toQuery = Prelude.const Prelude.mempty -- | -- -- /See:/ 'newStartApplicationResponse' smart constructor. data StartApplicationResponse = StartApplicationResponse' { -- | The response's http status code. httpStatus :: Prelude.Int } deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic) -- | -- Create a value of 'StartApplicationResponse' with all optional fields omitted. -- -- Use or to modify other optional fields. -- -- The following record fields are available, with the corresponding lenses provided -- for backwards compatibility: -- -- 'httpStatus', 'startApplicationResponse_httpStatus' - The response's http status code. newStartApplicationResponse :: -- | 'httpStatus' Prelude.Int -> StartApplicationResponse newStartApplicationResponse pHttpStatus_ = StartApplicationResponse' { httpStatus = pHttpStatus_ } -- | The response's http status code. startApplicationResponse_httpStatus :: Lens.Lens' StartApplicationResponse Prelude.Int startApplicationResponse_httpStatus = Lens.lens (\StartApplicationResponse' {httpStatus} -> httpStatus) (\s@StartApplicationResponse' {} a -> s {httpStatus = a} :: StartApplicationResponse) instance Prelude.NFData StartApplicationResponse where rnf StartApplicationResponse' {..} = Prelude.rnf httpStatus