Copyright | (c) 2013-2015 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
This operation returns metadata about a gateway such as its name, network interfaces, configured time zone, and the state (whether the gateway is running or not). To specify which gateway to describe, use the Amazon Resource Name (ARN) of the gateway in your request.
See: AWS API Reference for DescribeGatewayInformation.
- describeGatewayInformation :: Text -> DescribeGatewayInformation
- data DescribeGatewayInformation
- dgiGatewayARN :: Lens' DescribeGatewayInformation Text
- describeGatewayInformationResponse :: Int -> DescribeGatewayInformationResponse
- data DescribeGatewayInformationResponse
- dgirsGatewayState :: Lens' DescribeGatewayInformationResponse (Maybe Text)
- dgirsGatewayARN :: Lens' DescribeGatewayInformationResponse (Maybe Text)
- dgirsGatewayNetworkInterfaces :: Lens' DescribeGatewayInformationResponse [NetworkInterface]
- dgirsNextUpdateAvailabilityDate :: Lens' DescribeGatewayInformationResponse (Maybe Text)
- dgirsLastSoftwareUpdate :: Lens' DescribeGatewayInformationResponse (Maybe Text)
- dgirsGatewayId :: Lens' DescribeGatewayInformationResponse (Maybe Text)
- dgirsGatewayType :: Lens' DescribeGatewayInformationResponse (Maybe Text)
- dgirsGatewayTimezone :: Lens' DescribeGatewayInformationResponse (Maybe Text)
- dgirsStatus :: Lens' DescribeGatewayInformationResponse Int
Creating a Request
describeGatewayInformation Source
Creates a value of DescribeGatewayInformation
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data DescribeGatewayInformation Source
A JSON object containing the id of the gateway.
See: describeGatewayInformation
smart constructor.
Request Lenses
dgiGatewayARN :: Lens' DescribeGatewayInformation Text Source
Undocumented member.
Destructuring the Response
describeGatewayInformationResponse Source
Creates a value of DescribeGatewayInformationResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data DescribeGatewayInformationResponse Source
A JSON object containing the following fields:
See: describeGatewayInformationResponse
smart constructor.
Response Lenses
dgirsGatewayState :: Lens' DescribeGatewayInformationResponse (Maybe Text) Source
One of the values that indicates the operating state of the gateway.
dgirsGatewayARN :: Lens' DescribeGatewayInformationResponse (Maybe Text) Source
Undocumented member.
dgirsGatewayNetworkInterfaces :: Lens' DescribeGatewayInformationResponse [NetworkInterface] Source
A NetworkInterface array that contains descriptions of the gateway network interfaces.
dgirsNextUpdateAvailabilityDate :: Lens' DescribeGatewayInformationResponse (Maybe Text) Source
The date on which an update to the gateway is available. This date is in the time zone of the gateway. If the gateway is not available for an update this field is not returned in the response.
dgirsLastSoftwareUpdate :: Lens' DescribeGatewayInformationResponse (Maybe Text) Source
The date on which the last software update was applied to the gateway. If the gateway has never been updated, this field does not return a value in the response.
dgirsGatewayId :: Lens' DescribeGatewayInformationResponse (Maybe Text) Source
The gateway ID.
dgirsGatewayType :: Lens' DescribeGatewayInformationResponse (Maybe Text) Source
The type of the gateway.
dgirsGatewayTimezone :: Lens' DescribeGatewayInformationResponse (Maybe Text) Source
One of the values that indicates the time zone configured for the gateway.
dgirsStatus :: Lens' DescribeGatewayInformationResponse Int Source
The response status code.