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 |
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.
Synopsis
- data DescribeGatewayInformation = DescribeGatewayInformation' {
- gatewayARN :: Text
- newDescribeGatewayInformation :: Text -> DescribeGatewayInformation
- describeGatewayInformation_gatewayARN :: Lens' DescribeGatewayInformation Text
- data DescribeGatewayInformationResponse = DescribeGatewayInformationResponse' {
- cloudWatchLogGroupARN :: Maybe Text
- deprecationDate :: Maybe Text
- ec2InstanceId :: Maybe Text
- ec2InstanceRegion :: Maybe Text
- endpointType :: Maybe Text
- gatewayARN :: Maybe Text
- gatewayCapacity :: Maybe GatewayCapacity
- gatewayId :: Maybe Text
- gatewayName :: Maybe Text
- gatewayNetworkInterfaces :: Maybe [NetworkInterface]
- gatewayState :: Maybe Text
- gatewayTimezone :: Maybe Text
- gatewayType :: Maybe Text
- hostEnvironment :: Maybe HostEnvironment
- hostEnvironmentId :: Maybe Text
- lastSoftwareUpdate :: Maybe Text
- nextUpdateAvailabilityDate :: Maybe Text
- softwareUpdatesEndDate :: Maybe Text
- supportedGatewayCapacities :: Maybe [GatewayCapacity]
- tags :: Maybe [Tag]
- vPCEndpoint :: Maybe Text
- httpStatus :: Int
- newDescribeGatewayInformationResponse :: Int -> DescribeGatewayInformationResponse
- describeGatewayInformationResponse_cloudWatchLogGroupARN :: Lens' DescribeGatewayInformationResponse (Maybe Text)
- describeGatewayInformationResponse_deprecationDate :: Lens' DescribeGatewayInformationResponse (Maybe Text)
- describeGatewayInformationResponse_ec2InstanceId :: Lens' DescribeGatewayInformationResponse (Maybe Text)
- describeGatewayInformationResponse_ec2InstanceRegion :: Lens' DescribeGatewayInformationResponse (Maybe Text)
- describeGatewayInformationResponse_endpointType :: Lens' DescribeGatewayInformationResponse (Maybe Text)
- describeGatewayInformationResponse_gatewayARN :: Lens' DescribeGatewayInformationResponse (Maybe Text)
- describeGatewayInformationResponse_gatewayCapacity :: Lens' DescribeGatewayInformationResponse (Maybe GatewayCapacity)
- describeGatewayInformationResponse_gatewayId :: Lens' DescribeGatewayInformationResponse (Maybe Text)
- describeGatewayInformationResponse_gatewayName :: Lens' DescribeGatewayInformationResponse (Maybe Text)
- describeGatewayInformationResponse_gatewayNetworkInterfaces :: Lens' DescribeGatewayInformationResponse (Maybe [NetworkInterface])
- describeGatewayInformationResponse_gatewayState :: Lens' DescribeGatewayInformationResponse (Maybe Text)
- describeGatewayInformationResponse_gatewayTimezone :: Lens' DescribeGatewayInformationResponse (Maybe Text)
- describeGatewayInformationResponse_gatewayType :: Lens' DescribeGatewayInformationResponse (Maybe Text)
- describeGatewayInformationResponse_hostEnvironment :: Lens' DescribeGatewayInformationResponse (Maybe HostEnvironment)
- describeGatewayInformationResponse_hostEnvironmentId :: Lens' DescribeGatewayInformationResponse (Maybe Text)
- describeGatewayInformationResponse_lastSoftwareUpdate :: Lens' DescribeGatewayInformationResponse (Maybe Text)
- describeGatewayInformationResponse_nextUpdateAvailabilityDate :: Lens' DescribeGatewayInformationResponse (Maybe Text)
- describeGatewayInformationResponse_softwareUpdatesEndDate :: Lens' DescribeGatewayInformationResponse (Maybe Text)
- describeGatewayInformationResponse_supportedGatewayCapacities :: Lens' DescribeGatewayInformationResponse (Maybe [GatewayCapacity])
- describeGatewayInformationResponse_tags :: Lens' DescribeGatewayInformationResponse (Maybe [Tag])
- describeGatewayInformationResponse_vPCEndpoint :: Lens' DescribeGatewayInformationResponse (Maybe Text)
- describeGatewayInformationResponse_httpStatus :: Lens' DescribeGatewayInformationResponse Int
Creating a Request
data DescribeGatewayInformation Source #
A JSON object containing the ID of the gateway.
See: newDescribeGatewayInformation
smart constructor.
Instances
newDescribeGatewayInformation Source #
Create a value of DescribeGatewayInformation
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:
DescribeGatewayInformation
, describeGatewayInformation_gatewayARN
- Undocumented member.
Request Lenses
describeGatewayInformation_gatewayARN :: Lens' DescribeGatewayInformation Text Source #
Undocumented member.
Destructuring the Response
data DescribeGatewayInformationResponse Source #
A JSON object containing the following fields:
See: newDescribeGatewayInformationResponse
smart constructor.
DescribeGatewayInformationResponse' | |
|
Instances
newDescribeGatewayInformationResponse Source #
Create a value of DescribeGatewayInformationResponse
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:cloudWatchLogGroupARN:DescribeGatewayInformationResponse'
, describeGatewayInformationResponse_cloudWatchLogGroupARN
- The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that
is used to monitor events in the gateway. This field only only exist and
returns once it have been chosen and set by the SGW service, based on
the OS version of the gateway VM
$sel:deprecationDate:DescribeGatewayInformationResponse'
, describeGatewayInformationResponse_deprecationDate
- Date after which this gateway will not receive software updates for new
features and bug fixes.
DescribeGatewayInformationResponse
, describeGatewayInformationResponse_ec2InstanceId
- The ID of the Amazon EC2 instance that was used to launch the gateway.
DescribeGatewayInformationResponse
, describeGatewayInformationResponse_ec2InstanceRegion
- The Amazon Web Services Region where the Amazon EC2 instance is located.
$sel:endpointType:DescribeGatewayInformationResponse'
, describeGatewayInformationResponse_endpointType
- The type of endpoint for your gateway.
Valid Values: STANDARD
| FIPS
DescribeGatewayInformation
, describeGatewayInformationResponse_gatewayARN
- Undocumented member.
$sel:gatewayCapacity:DescribeGatewayInformationResponse'
, describeGatewayInformationResponse_gatewayCapacity
- Specifies the size of the gateway's metadata cache.
DescribeGatewayInformationResponse
, describeGatewayInformationResponse_gatewayId
- 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.
DescribeGatewayInformationResponse
, describeGatewayInformationResponse_gatewayName
- The name you configured for your gateway.
$sel:gatewayNetworkInterfaces:DescribeGatewayInformationResponse'
, describeGatewayInformationResponse_gatewayNetworkInterfaces
- A NetworkInterface array that contains descriptions of the gateway
network interfaces.
$sel:gatewayState:DescribeGatewayInformationResponse'
, describeGatewayInformationResponse_gatewayState
- A value that indicates the operating state of the gateway.
$sel:gatewayTimezone:DescribeGatewayInformationResponse'
, describeGatewayInformationResponse_gatewayTimezone
- A value that indicates the time zone configured for the gateway.
DescribeGatewayInformationResponse
, describeGatewayInformationResponse_gatewayType
- The type of the gateway.
DescribeGatewayInformationResponse
, describeGatewayInformationResponse_hostEnvironment
- The type of hardware or software platform on which the gateway is
running.
DescribeGatewayInformationResponse
, describeGatewayInformationResponse_hostEnvironmentId
- A unique identifier for the specific instance of the host platform
running the gateway. This value is only available for certain host
environments, and its format depends on the host environment type.
$sel:lastSoftwareUpdate:DescribeGatewayInformationResponse'
, describeGatewayInformationResponse_lastSoftwareUpdate
- 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. This only only exist and returns once it have
been chosen and set by the SGW service, based on the OS version of the
gateway VM
$sel:nextUpdateAvailabilityDate:DescribeGatewayInformationResponse'
, describeGatewayInformationResponse_nextUpdateAvailabilityDate
- 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.
$sel:softwareUpdatesEndDate:DescribeGatewayInformationResponse'
, describeGatewayInformationResponse_softwareUpdatesEndDate
- Date after which this gateway will not receive software updates for new
features.
$sel:supportedGatewayCapacities:DescribeGatewayInformationResponse'
, describeGatewayInformationResponse_supportedGatewayCapacities
- A list of the metadata cache sizes that the gateway can support based on
its current hardware specifications.
DescribeGatewayInformationResponse
, describeGatewayInformationResponse_tags
- A list of up to 50 tags assigned to the gateway, sorted alphabetically
by key name. Each tag is a key-value pair. For a gateway with more than
10 tags assigned, you can view all tags using the ListTagsForResource
API operation.
$sel:vPCEndpoint:DescribeGatewayInformationResponse'
, describeGatewayInformationResponse_vPCEndpoint
- The configuration settings for the virtual private cloud (VPC) endpoint
for your gateway.
$sel:httpStatus:DescribeGatewayInformationResponse'
, describeGatewayInformationResponse_httpStatus
- The response's http status code.
Response Lenses
describeGatewayInformationResponse_cloudWatchLogGroupARN :: Lens' DescribeGatewayInformationResponse (Maybe Text) Source #
The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that is used to monitor events in the gateway. This field only only exist and returns once it have been chosen and set by the SGW service, based on the OS version of the gateway VM
describeGatewayInformationResponse_deprecationDate :: Lens' DescribeGatewayInformationResponse (Maybe Text) Source #
Date after which this gateway will not receive software updates for new features and bug fixes.
describeGatewayInformationResponse_ec2InstanceId :: Lens' DescribeGatewayInformationResponse (Maybe Text) Source #
The ID of the Amazon EC2 instance that was used to launch the gateway.
describeGatewayInformationResponse_ec2InstanceRegion :: Lens' DescribeGatewayInformationResponse (Maybe Text) Source #
The Amazon Web Services Region where the Amazon EC2 instance is located.
describeGatewayInformationResponse_endpointType :: Lens' DescribeGatewayInformationResponse (Maybe Text) Source #
The type of endpoint for your gateway.
Valid Values: STANDARD
| FIPS
describeGatewayInformationResponse_gatewayARN :: Lens' DescribeGatewayInformationResponse (Maybe Text) Source #
Undocumented member.
describeGatewayInformationResponse_gatewayCapacity :: Lens' DescribeGatewayInformationResponse (Maybe GatewayCapacity) Source #
Specifies the size of the gateway's metadata cache.
describeGatewayInformationResponse_gatewayId :: 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.
describeGatewayInformationResponse_gatewayName :: Lens' DescribeGatewayInformationResponse (Maybe Text) Source #
The name you configured for your gateway.
describeGatewayInformationResponse_gatewayNetworkInterfaces :: Lens' DescribeGatewayInformationResponse (Maybe [NetworkInterface]) Source #
A NetworkInterface array that contains descriptions of the gateway network interfaces.
describeGatewayInformationResponse_gatewayState :: Lens' DescribeGatewayInformationResponse (Maybe Text) Source #
A value that indicates the operating state of the gateway.
describeGatewayInformationResponse_gatewayTimezone :: Lens' DescribeGatewayInformationResponse (Maybe Text) Source #
A value that indicates the time zone configured for the gateway.
describeGatewayInformationResponse_gatewayType :: Lens' DescribeGatewayInformationResponse (Maybe Text) Source #
The type of the gateway.
describeGatewayInformationResponse_hostEnvironment :: Lens' DescribeGatewayInformationResponse (Maybe HostEnvironment) Source #
The type of hardware or software platform on which the gateway is running.
describeGatewayInformationResponse_hostEnvironmentId :: Lens' DescribeGatewayInformationResponse (Maybe Text) Source #
A unique identifier for the specific instance of the host platform running the gateway. This value is only available for certain host environments, and its format depends on the host environment type.
describeGatewayInformationResponse_lastSoftwareUpdate :: 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. This only only exist and returns once it have been chosen and set by the SGW service, based on the OS version of the gateway VM
describeGatewayInformationResponse_nextUpdateAvailabilityDate :: 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.
describeGatewayInformationResponse_softwareUpdatesEndDate :: Lens' DescribeGatewayInformationResponse (Maybe Text) Source #
Date after which this gateway will not receive software updates for new features.
describeGatewayInformationResponse_supportedGatewayCapacities :: Lens' DescribeGatewayInformationResponse (Maybe [GatewayCapacity]) Source #
A list of the metadata cache sizes that the gateway can support based on its current hardware specifications.
describeGatewayInformationResponse_tags :: Lens' DescribeGatewayInformationResponse (Maybe [Tag]) Source #
A list of up to 50 tags assigned to the gateway, sorted alphabetically
by key name. Each tag is a key-value pair. For a gateway with more than
10 tags assigned, you can view all tags using the ListTagsForResource
API operation.
describeGatewayInformationResponse_vPCEndpoint :: Lens' DescribeGatewayInformationResponse (Maybe Text) Source #
The configuration settings for the virtual private cloud (VPC) endpoint for your gateway.
describeGatewayInformationResponse_httpStatus :: Lens' DescribeGatewayInformationResponse Int Source #
The response's http status code.