Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.AppConfig.GetEnvironment

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Retrieves information about an environment. An environment is a deployment group of AppConfig applications, such as applications in a Production environment or in an EU_Region environment. Each configuration deployment targets an environment. You can enable one or more Amazon CloudWatch alarms for an environment. If an alarm is triggered during a deployment, AppConfig roles back the configuration.

Synopsis

data GetEnvironment = GetEnvironment' {
- applicationId :: Text
- environmentId :: Text
}
newGetEnvironment :: Text -> Text -> GetEnvironment
getEnvironment_applicationId :: Lens' GetEnvironment Text
getEnvironment_environmentId :: Lens' GetEnvironment Text
data Environment = Environment' {
- applicationId :: Maybe Text
- description :: Maybe Text
- id :: Maybe Text
- monitors :: Maybe [Monitor]
- name :: Maybe Text
- state :: Maybe EnvironmentState
}
newEnvironment :: Environment
environment_applicationId :: Lens' Environment (Maybe Text)
environment_description :: Lens' Environment (Maybe Text)
environment_id :: Lens' Environment (Maybe Text)
environment_monitors :: Lens' Environment (Maybe [Monitor])
environment_name :: Lens' Environment (Maybe Text)
environment_state :: Lens' Environment (Maybe EnvironmentState)

Creating a Request

data GetEnvironment Source #

See: newGetEnvironment smart constructor.

Constructors

GetEnvironment'
Fields applicationId :: Text The ID of the application that includes the environment you want to get. environmentId :: Text The ID of the environment that you want to get.

Instances

Instances details

ToHeaders GetEnvironment Source #
Instance details Defined in Amazonka.AppConfig.GetEnvironment Methods toHeaders :: GetEnvironment -> [Header] #
ToPath GetEnvironment Source #
Instance details Defined in Amazonka.AppConfig.GetEnvironment Methods toPath :: GetEnvironment -> ByteString #
ToQuery GetEnvironment Source #
Instance details Defined in Amazonka.AppConfig.GetEnvironment Methods toQuery :: GetEnvironment -> QueryString #
AWSRequest GetEnvironment Source #
Instance details Defined in Amazonka.AppConfig.GetEnvironment Associated Types type AWSResponse GetEnvironment # Methods request :: (Service -> Service) -> GetEnvironment -> Request GetEnvironment # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy GetEnvironment -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse GetEnvironment))) #
Generic GetEnvironment Source #
Instance details Defined in Amazonka.AppConfig.GetEnvironment Associated Types type Rep GetEnvironment :: Type -> Type # Methods from :: GetEnvironment -> Rep GetEnvironment x # to :: Rep GetEnvironment x -> GetEnvironment #
Read GetEnvironment Source #
Instance details Defined in Amazonka.AppConfig.GetEnvironment Methods readsPrec :: Int -> ReadS GetEnvironment # readList :: ReadS [GetEnvironment] # readPrec :: ReadPrec GetEnvironment # readListPrec :: ReadPrec [GetEnvironment] #
Show GetEnvironment Source #
Instance details Defined in Amazonka.AppConfig.GetEnvironment Methods showsPrec :: Int -> GetEnvironment -> ShowS # show :: GetEnvironment -> String # showList :: [GetEnvironment] -> ShowS #
NFData GetEnvironment Source #
Instance details Defined in Amazonka.AppConfig.GetEnvironment Methods rnf :: GetEnvironment -> () #
Eq GetEnvironment Source #
Instance details Defined in Amazonka.AppConfig.GetEnvironment Methods (==) :: GetEnvironment -> GetEnvironment -> Bool # (/=) :: GetEnvironment -> GetEnvironment -> Bool #
Hashable GetEnvironment Source #
Instance details Defined in Amazonka.AppConfig.GetEnvironment Methods hashWithSalt :: Int -> GetEnvironment -> Int # hash :: GetEnvironment -> Int #
type AWSResponse GetEnvironment Source #
Instance details Defined in Amazonka.AppConfig.GetEnvironment type AWSResponse GetEnvironment = Environment
type Rep GetEnvironment Source #
Instance details Defined in Amazonka.AppConfig.GetEnvironment type Rep GetEnvironment = D1 ('MetaData "GetEnvironment" "Amazonka.AppConfig.GetEnvironment" "amazonka-appconfig-2.0-KxEFpSAUlWtLf1lFyPWujo" 'False) (C1 ('MetaCons "GetEnvironment'" 'PrefixI 'True) (S1 ('MetaSel ('Just "applicationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "environmentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newGetEnvironment Source #

Arguments

:: Text	`GetEnvironment`
-> Text	`GetEnvironment`
-> GetEnvironment

Create a value of GetEnvironment 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:

GetEnvironment, getEnvironment_applicationId - The ID of the application that includes the environment you want to get.

GetEnvironment, getEnvironment_environmentId - The ID of the environment that you want to get.

Request Lenses

getEnvironment_applicationId :: Lens' GetEnvironment Text Source #

The ID of the application that includes the environment you want to get.

getEnvironment_environmentId :: Lens' GetEnvironment Text Source #

The ID of the environment that you want to get.

Destructuring the Response

data Environment Source #

See: newEnvironment smart constructor.

Constructors

Environment'

Fields

applicationId :: Maybe Text
The application ID.
description :: Maybe Text
The description of the environment.
id :: Maybe Text
The environment ID.
monitors :: Maybe [Monitor]
Amazon CloudWatch alarms monitored during the deployment.
name :: Maybe Text
The name of the environment.
state :: Maybe EnvironmentState
The state of the environment. An environment can be in one of the following states: READY_FOR_DEPLOYMENT, DEPLOYING, ROLLING_BACK, or ROLLED_BACK

Instances

Instances details

FromJSON Environment Source #
Instance details Defined in Amazonka.AppConfig.Types.Environment Methods parseJSON :: Value -> Parser Environment # parseJSONList :: Value -> Parser [Environment] #
Generic Environment Source #
Instance details Defined in Amazonka.AppConfig.Types.Environment Associated Types type Rep Environment :: Type -> Type # Methods from :: Environment -> Rep Environment x # to :: Rep Environment x -> Environment #
Read Environment Source #
Instance details Defined in Amazonka.AppConfig.Types.Environment Methods readsPrec :: Int -> ReadS Environment # readList :: ReadS [Environment] # readPrec :: ReadPrec Environment # readListPrec :: ReadPrec [Environment] #
Show Environment Source #
Instance details Defined in Amazonka.AppConfig.Types.Environment Methods showsPrec :: Int -> Environment -> ShowS # show :: Environment -> String # showList :: [Environment] -> ShowS #
NFData Environment Source #
Instance details Defined in Amazonka.AppConfig.Types.Environment Methods rnf :: Environment -> () #
Eq Environment Source #
Instance details Defined in Amazonka.AppConfig.Types.Environment Methods (==) :: Environment -> Environment -> Bool # (/=) :: Environment -> Environment -> Bool #
Hashable Environment Source #
Instance details Defined in Amazonka.AppConfig.Types.Environment Methods hashWithSalt :: Int -> Environment -> Int # hash :: Environment -> Int #
type Rep Environment Source #
Instance details Defined in Amazonka.AppConfig.Types.Environment type Rep Environment = D1 ('MetaData "Environment" "Amazonka.AppConfig.Types.Environment" "amazonka-appconfig-2.0-KxEFpSAUlWtLf1lFyPWujo" 'False) (C1 ('MetaCons "Environment'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "applicationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "id") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "monitors") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Monitor])) :: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe EnvironmentState))))))

newEnvironment :: Environment Source #

Create a value of Environment 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:applicationId:Environment', environment_applicationId - The application ID.

$sel:description:Environment', environment_description - The description of the environment.

$sel:id:Environment', environment_id - The environment ID.

$sel:monitors:Environment', environment_monitors - Amazon CloudWatch alarms monitored during the deployment.

$sel:name:Environment', environment_name - The name of the environment.

$sel:state:Environment', environment_state - The state of the environment. An environment can be in one of the following states: READY_FOR_DEPLOYMENT, DEPLOYING, ROLLING_BACK, or ROLLED_BACK

Response Lenses

environment_applicationId :: Lens' Environment (Maybe Text) Source #

The application ID.

environment_description :: Lens' Environment (Maybe Text) Source #

The description of the environment.

environment_id :: Lens' Environment (Maybe Text) Source #

The environment ID.

environment_monitors :: Lens' Environment (Maybe [Monitor]) Source #

Amazon CloudWatch alarms monitored during the deployment.

environment_name :: Lens' Environment (Maybe Text) Source #

The name of the environment.

environment_state :: Lens' Environment (Maybe EnvironmentState) Source #

The state of the environment. An environment can be in one of the following states: READY_FOR_DEPLOYMENT, DEPLOYING, ROLLING_BACK, or ROLLED_BACK