Copyright | (c) 2013-2017 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
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.
- 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)
- dgirsGatewayName :: Lens' DescribeGatewayInformationResponse (Maybe Text)
- dgirsGatewayId :: Lens' DescribeGatewayInformationResponse (Maybe Text)
- dgirsGatewayType :: Lens' DescribeGatewayInformationResponse (Maybe Text)
- dgirsGatewayTimezone :: Lens' DescribeGatewayInformationResponse (Maybe Text)
- dgirsResponseStatus :: 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:
dgiGatewayARN
- Undocumented member.
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:
dgirsGatewayState
- A value that indicates the operating state of the gateway.dgirsGatewayARN
- Undocumented member.dgirsGatewayNetworkInterfaces
- ANetworkInterface
array that contains descriptions of the gateway network interfaces.dgirsNextUpdateAvailabilityDate
- 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
- 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.dgirsGatewayName
- The name you configured for your gateway.dgirsGatewayId
- The unique identifier assigned to your gateway during activation. This ID becomes part of the gateway Amazon Resource Name (ARN), which you use as input for other operations.dgirsGatewayType
- The type of the gateway.dgirsGatewayTimezone
- A value that indicates the time zone configured for the gateway.dgirsResponseStatus
- -- | The response status code.
data DescribeGatewayInformationResponse Source #
A JSON object containing the following fields:
See: describeGatewayInformationResponse
smart constructor.
Response Lenses
dgirsGatewayState :: Lens' DescribeGatewayInformationResponse (Maybe Text) Source #
A value 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.
dgirsGatewayName :: Lens' DescribeGatewayInformationResponse (Maybe Text) Source #
The name you configured for your gateway.
dgirsGatewayId :: Lens' DescribeGatewayInformationResponse (Maybe Text) Source #
The unique identifier assigned to your gateway during activation. This ID becomes part of the gateway Amazon Resource Name (ARN), which you use as input for other operations.
dgirsGatewayType :: Lens' DescribeGatewayInformationResponse (Maybe Text) Source #
The type of the gateway.
dgirsGatewayTimezone :: Lens' DescribeGatewayInformationResponse (Maybe Text) Source #
A value that indicates the time zone configured for the gateway.
dgirsResponseStatus :: Lens' DescribeGatewayInformationResponse Int Source #
- - | The response status code.