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.M2.GetEnvironment

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Describes a specific runtime environment.

Synopsis

data GetEnvironment = GetEnvironment' {
- environmentId :: Text
}
newGetEnvironment :: Text -> GetEnvironment
getEnvironment_environmentId :: Lens' GetEnvironment Text
data GetEnvironmentResponse = GetEnvironmentResponse' {
- actualCapacity :: Maybe Natural
- description :: Maybe Text
- highAvailabilityConfig :: Maybe HighAvailabilityConfig
- kmsKeyId :: Maybe Text
- loadBalancerArn :: Maybe Text
- pendingMaintenance :: Maybe PendingMaintenance
- preferredMaintenanceWindow :: Maybe Text
- publiclyAccessible :: Maybe Bool
- statusReason :: Maybe Text
- storageConfigurations :: Maybe [StorageConfiguration]
- tags :: Maybe (HashMap Text Text)
- httpStatus :: Int
- creationTime :: POSIX
- engineType :: EngineType
- engineVersion :: Text
- environmentArn :: Text
- environmentId :: Text
- instanceType :: Text
- name :: Text
- securityGroupIds :: [Text]
- status :: EnvironmentLifecycle
- subnetIds :: [Text]
- vpcId :: Text
}
newGetEnvironmentResponse :: Int -> UTCTime -> EngineType -> Text -> Text -> Text -> Text -> Text -> EnvironmentLifecycle -> Text -> GetEnvironmentResponse
getEnvironmentResponse_actualCapacity :: Lens' GetEnvironmentResponse (Maybe Natural)
getEnvironmentResponse_description :: Lens' GetEnvironmentResponse (Maybe Text)
getEnvironmentResponse_highAvailabilityConfig :: Lens' GetEnvironmentResponse (Maybe HighAvailabilityConfig)
getEnvironmentResponse_kmsKeyId :: Lens' GetEnvironmentResponse (Maybe Text)
getEnvironmentResponse_loadBalancerArn :: Lens' GetEnvironmentResponse (Maybe Text)
getEnvironmentResponse_pendingMaintenance :: Lens' GetEnvironmentResponse (Maybe PendingMaintenance)
getEnvironmentResponse_preferredMaintenanceWindow :: Lens' GetEnvironmentResponse (Maybe Text)
getEnvironmentResponse_publiclyAccessible :: Lens' GetEnvironmentResponse (Maybe Bool)
getEnvironmentResponse_statusReason :: Lens' GetEnvironmentResponse (Maybe Text)
getEnvironmentResponse_storageConfigurations :: Lens' GetEnvironmentResponse (Maybe [StorageConfiguration])
getEnvironmentResponse_tags :: Lens' GetEnvironmentResponse (Maybe (HashMap Text Text))
getEnvironmentResponse_httpStatus :: Lens' GetEnvironmentResponse Int
getEnvironmentResponse_creationTime :: Lens' GetEnvironmentResponse UTCTime
getEnvironmentResponse_engineType :: Lens' GetEnvironmentResponse EngineType
getEnvironmentResponse_engineVersion :: Lens' GetEnvironmentResponse Text
getEnvironmentResponse_environmentArn :: Lens' GetEnvironmentResponse Text
getEnvironmentResponse_environmentId :: Lens' GetEnvironmentResponse Text
getEnvironmentResponse_instanceType :: Lens' GetEnvironmentResponse Text
getEnvironmentResponse_name :: Lens' GetEnvironmentResponse Text
getEnvironmentResponse_securityGroupIds :: Lens' GetEnvironmentResponse [Text]
getEnvironmentResponse_status :: Lens' GetEnvironmentResponse EnvironmentLifecycle
getEnvironmentResponse_subnetIds :: Lens' GetEnvironmentResponse [Text]
getEnvironmentResponse_vpcId :: Lens' GetEnvironmentResponse Text

Creating a Request

data GetEnvironment Source #

See: newGetEnvironment smart constructor.

Constructors

GetEnvironment'
Fields environmentId :: Text The unique identifier of the runtime environment.

Instances

Instances details

ToHeaders GetEnvironment Source #
Instance details Defined in Amazonka.M2.GetEnvironment Methods toHeaders :: GetEnvironment -> [Header] #
ToPath GetEnvironment Source #
Instance details Defined in Amazonka.M2.GetEnvironment Methods toPath :: GetEnvironment -> ByteString #
ToQuery GetEnvironment Source #
Instance details Defined in Amazonka.M2.GetEnvironment Methods toQuery :: GetEnvironment -> QueryString #
AWSRequest GetEnvironment Source #
Instance details Defined in Amazonka.M2.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.M2.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.M2.GetEnvironment Methods readsPrec :: Int -> ReadS GetEnvironment # readList :: ReadS [GetEnvironment] # readPrec :: ReadPrec GetEnvironment # readListPrec :: ReadPrec [GetEnvironment] #
Show GetEnvironment Source #
Instance details Defined in Amazonka.M2.GetEnvironment Methods showsPrec :: Int -> GetEnvironment -> ShowS # show :: GetEnvironment -> String # showList :: [GetEnvironment] -> ShowS #
NFData GetEnvironment Source #
Instance details Defined in Amazonka.M2.GetEnvironment Methods rnf :: GetEnvironment -> () #
Eq GetEnvironment Source #
Instance details Defined in Amazonka.M2.GetEnvironment Methods (==) :: GetEnvironment -> GetEnvironment -> Bool # (/=) :: GetEnvironment -> GetEnvironment -> Bool #
Hashable GetEnvironment Source #
Instance details Defined in Amazonka.M2.GetEnvironment Methods hashWithSalt :: Int -> GetEnvironment -> Int # hash :: GetEnvironment -> Int #
type AWSResponse GetEnvironment Source #
Instance details Defined in Amazonka.M2.GetEnvironment type AWSResponse GetEnvironment = GetEnvironmentResponse
type Rep GetEnvironment Source #
Instance details Defined in Amazonka.M2.GetEnvironment type Rep GetEnvironment = D1 ('MetaData "GetEnvironment" "Amazonka.M2.GetEnvironment" "amazonka-m2-2.0-1kXEGTJs74f5RPbatSDeMH" 'False) (C1 ('MetaCons "GetEnvironment'" 'PrefixI 'True) (S1 ('MetaSel ('Just "environmentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newGetEnvironment Source #

Arguments

:: 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_environmentId - The unique identifier of the runtime environment.

Request Lenses

getEnvironment_environmentId :: Lens' GetEnvironment Text Source #

The unique identifier of the runtime environment.

Destructuring the Response

data GetEnvironmentResponse Source #

See: newGetEnvironmentResponse smart constructor.

Constructors

GetEnvironmentResponse'

Fields

actualCapacity :: Maybe Natural
The number of instances included in the runtime environment. A standalone runtime environment has a maxiumum of one instance. Currently, a high availability runtime environment has a maximum of two instances.
description :: Maybe Text
The description of the runtime environment.
highAvailabilityConfig :: Maybe HighAvailabilityConfig
The desired capacity of the high availability configuration for the runtime environment.
kmsKeyId :: Maybe Text
The identifier of a customer managed key.
loadBalancerArn :: Maybe Text
The Amazon Resource Name (ARN) for the load balancer used with the runtime environment.
pendingMaintenance :: Maybe PendingMaintenance
Indicates the pending maintenance scheduled on this environment.
preferredMaintenanceWindow :: Maybe Text
Configures the maintenance window you want for the runtime environment. If you do not provide a value, a random system-generated value will be assigned.
publiclyAccessible :: Maybe Bool
Whether applications running in this runtime environment are publicly accessible.
statusReason :: Maybe Text
The reason for the reported status.
storageConfigurations :: Maybe [StorageConfiguration]
The storage configurations defined for the runtime environment.
tags :: Maybe (HashMap Text Text)
The tags defined for this runtime environment.
httpStatus :: Int
The response's http status code.
creationTime :: POSIX
The timestamp when the runtime environment was created.
engineType :: EngineType
The target platform for the runtime environment.
engineVersion :: Text
The version of the runtime engine.
environmentArn :: Text
The Amazon Resource Name (ARN) of the runtime environment.
environmentId :: Text
The unique identifier of the runtime environment.
instanceType :: Text
The type of instance underlying the runtime environment.
name :: Text
The name of the runtime environment. Must be unique within the account.
securityGroupIds :: [Text]
The unique identifiers of the security groups assigned to this runtime environment.
status :: EnvironmentLifecycle
The status of the runtime environment.
subnetIds :: [Text]
The unique identifiers of the subnets assigned to this runtime environment.
vpcId :: Text
The unique identifier for the VPC used with this runtime environment.

Instances

Instances details

Generic GetEnvironmentResponse Source #
Instance details Defined in Amazonka.M2.GetEnvironment Associated Types type Rep GetEnvironmentResponse :: Type -> Type # Methods from :: GetEnvironmentResponse -> Rep GetEnvironmentResponse x # to :: Rep GetEnvironmentResponse x -> GetEnvironmentResponse #
Read GetEnvironmentResponse Source #
Instance details Defined in Amazonka.M2.GetEnvironment Methods readsPrec :: Int -> ReadS GetEnvironmentResponse # readList :: ReadS [GetEnvironmentResponse] # readPrec :: ReadPrec GetEnvironmentResponse # readListPrec :: ReadPrec [GetEnvironmentResponse] #
Show GetEnvironmentResponse Source #
Instance details Defined in Amazonka.M2.GetEnvironment Methods showsPrec :: Int -> GetEnvironmentResponse -> ShowS # show :: GetEnvironmentResponse -> String # showList :: [GetEnvironmentResponse] -> ShowS #
NFData GetEnvironmentResponse Source #
Instance details Defined in Amazonka.M2.GetEnvironment Methods rnf :: GetEnvironmentResponse -> () #
Eq GetEnvironmentResponse Source #
Instance details Defined in Amazonka.M2.GetEnvironment Methods (==) :: GetEnvironmentResponse -> GetEnvironmentResponse -> Bool # (/=) :: GetEnvironmentResponse -> GetEnvironmentResponse -> Bool #
type Rep GetEnvironmentResponse Source #
Instance details Defined in Amazonka.M2.GetEnvironment type Rep GetEnvironmentResponse = D1 ('MetaData "GetEnvironmentResponse" "Amazonka.M2.GetEnvironment" "amazonka-m2-2.0-1kXEGTJs74f5RPbatSDeMH" 'False) (C1 ('MetaCons "GetEnvironmentResponse'" 'PrefixI 'True) ((((S1 ('MetaSel ('Just "actualCapacity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "highAvailabilityConfig") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe HighAvailabilityConfig)) :: (S1 ('MetaSel ('Just "kmsKeyId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "loadBalancerArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "pendingMaintenance") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe PendingMaintenance)) :: (S1 ('MetaSel ('Just "preferredMaintenanceWindow") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "publiclyAccessible") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)))) :: (S1 ('MetaSel ('Just "statusReason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "storageConfigurations") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [StorageConfiguration])) :: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))))))) :: (((S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :: (S1 ('MetaSel ('Just "creationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX) :: S1 ('MetaSel ('Just "engineType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 EngineType))) :: (S1 ('MetaSel ('Just "engineVersion") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "environmentArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "environmentId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))) :: ((S1 ('MetaSel ('Just "instanceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "name") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "securityGroupIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Text]))) :: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 EnvironmentLifecycle) :: (S1 ('MetaSel ('Just "subnetIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [Text]) :: S1 ('MetaSel ('Just "vpcId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))))

newGetEnvironmentResponse Source #

Arguments

:: Int	`$sel:httpStatus:GetEnvironmentResponse'`
-> UTCTime	`GetEnvironmentResponse`
-> EngineType	`GetEnvironmentResponse`
-> Text	`GetEnvironmentResponse`
-> Text	`GetEnvironmentResponse`
-> Text	`GetEnvironment`
-> Text	`GetEnvironmentResponse`
-> Text	`GetEnvironmentResponse`
-> EnvironmentLifecycle	`GetEnvironmentResponse`
-> Text	`$sel:vpcId:GetEnvironmentResponse'`
-> GetEnvironmentResponse

Create a value of GetEnvironmentResponse 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:actualCapacity:GetEnvironmentResponse', getEnvironmentResponse_actualCapacity - The number of instances included in the runtime environment. A standalone runtime environment has a maxiumum of one instance. Currently, a high availability runtime environment has a maximum of two instances.

GetEnvironmentResponse, getEnvironmentResponse_description - The description of the runtime environment.

$sel:highAvailabilityConfig:GetEnvironmentResponse', getEnvironmentResponse_highAvailabilityConfig - The desired capacity of the high availability configuration for the runtime environment.

$sel:kmsKeyId:GetEnvironmentResponse', getEnvironmentResponse_kmsKeyId - The identifier of a customer managed key.

$sel:loadBalancerArn:GetEnvironmentResponse', getEnvironmentResponse_loadBalancerArn - The Amazon Resource Name (ARN) for the load balancer used with the runtime environment.

$sel:pendingMaintenance:GetEnvironmentResponse', getEnvironmentResponse_pendingMaintenance - Indicates the pending maintenance scheduled on this environment.

$sel:preferredMaintenanceWindow:GetEnvironmentResponse', getEnvironmentResponse_preferredMaintenanceWindow - Configures the maintenance window you want for the runtime environment. If you do not provide a value, a random system-generated value will be assigned.

$sel:publiclyAccessible:GetEnvironmentResponse', getEnvironmentResponse_publiclyAccessible - Whether applications running in this runtime environment are publicly accessible.

GetEnvironmentResponse, getEnvironmentResponse_statusReason - The reason for the reported status.

$sel:storageConfigurations:GetEnvironmentResponse', getEnvironmentResponse_storageConfigurations - The storage configurations defined for the runtime environment.

$sel:tags:GetEnvironmentResponse', getEnvironmentResponse_tags - The tags defined for this runtime environment.

$sel:httpStatus:GetEnvironmentResponse', getEnvironmentResponse_httpStatus - The response's http status code.

GetEnvironmentResponse, getEnvironmentResponse_creationTime - The timestamp when the runtime environment was created.

GetEnvironmentResponse, getEnvironmentResponse_engineType - The target platform for the runtime environment.

GetEnvironmentResponse, getEnvironmentResponse_engineVersion - The version of the runtime engine.

GetEnvironmentResponse, getEnvironmentResponse_environmentArn - The Amazon Resource Name (ARN) of the runtime environment.

GetEnvironment, getEnvironmentResponse_environmentId - The unique identifier of the runtime environment.

GetEnvironmentResponse, getEnvironmentResponse_instanceType - The type of instance underlying the runtime environment.

GetEnvironmentResponse, getEnvironmentResponse_name - The name of the runtime environment. Must be unique within the account.

$sel:securityGroupIds:GetEnvironmentResponse', getEnvironmentResponse_securityGroupIds - The unique identifiers of the security groups assigned to this runtime environment.

GetEnvironmentResponse, getEnvironmentResponse_status - The status of the runtime environment.

$sel:subnetIds:GetEnvironmentResponse', getEnvironmentResponse_subnetIds - The unique identifiers of the subnets assigned to this runtime environment.

$sel:vpcId:GetEnvironmentResponse', getEnvironmentResponse_vpcId - The unique identifier for the VPC used with this runtime environment.

Response Lenses

getEnvironmentResponse_actualCapacity :: Lens' GetEnvironmentResponse (Maybe Natural) Source #

The number of instances included in the runtime environment. A standalone runtime environment has a maxiumum of one instance. Currently, a high availability runtime environment has a maximum of two instances.

getEnvironmentResponse_description :: Lens' GetEnvironmentResponse (Maybe Text) Source #

The description of the runtime environment.

getEnvironmentResponse_highAvailabilityConfig :: Lens' GetEnvironmentResponse (Maybe HighAvailabilityConfig) Source #

The desired capacity of the high availability configuration for the runtime environment.

getEnvironmentResponse_kmsKeyId :: Lens' GetEnvironmentResponse (Maybe Text) Source #

The identifier of a customer managed key.

getEnvironmentResponse_loadBalancerArn :: Lens' GetEnvironmentResponse (Maybe Text) Source #

The Amazon Resource Name (ARN) for the load balancer used with the runtime environment.

getEnvironmentResponse_pendingMaintenance :: Lens' GetEnvironmentResponse (Maybe PendingMaintenance) Source #

Indicates the pending maintenance scheduled on this environment.

getEnvironmentResponse_preferredMaintenanceWindow :: Lens' GetEnvironmentResponse (Maybe Text) Source #

Configures the maintenance window you want for the runtime environment. If you do not provide a value, a random system-generated value will be assigned.

getEnvironmentResponse_publiclyAccessible :: Lens' GetEnvironmentResponse (Maybe Bool) Source #

Whether applications running in this runtime environment are publicly accessible.

getEnvironmentResponse_statusReason :: Lens' GetEnvironmentResponse (Maybe Text) Source #

The reason for the reported status.

getEnvironmentResponse_storageConfigurations :: Lens' GetEnvironmentResponse (Maybe [StorageConfiguration]) Source #

The storage configurations defined for the runtime environment.

getEnvironmentResponse_tags :: Lens' GetEnvironmentResponse (Maybe (HashMap Text Text)) Source #

The tags defined for this runtime environment.

getEnvironmentResponse_httpStatus :: Lens' GetEnvironmentResponse Int Source #

The response's http status code.

getEnvironmentResponse_creationTime :: Lens' GetEnvironmentResponse UTCTime Source #

The timestamp when the runtime environment was created.