| Copyright | (c) 2013-2021 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 |
Amazonka.IoTSiteWise.CreateGateway
Description
Creates a gateway, which is a virtual or edge device that delivers industrial data streams from local servers to IoT SiteWise. For more information, see Ingesting data using a gateway in the IoT SiteWise User Guide.
Synopsis
- data CreateGateway = CreateGateway' {}
- newCreateGateway :: Text -> GatewayPlatform -> CreateGateway
- createGateway_tags :: Lens' CreateGateway (Maybe (HashMap Text Text))
- createGateway_gatewayName :: Lens' CreateGateway Text
- createGateway_gatewayPlatform :: Lens' CreateGateway GatewayPlatform
- data CreateGatewayResponse = CreateGatewayResponse' {
- httpStatus :: Int
- gatewayId :: Text
- gatewayArn :: Text
- newCreateGatewayResponse :: Int -> Text -> Text -> CreateGatewayResponse
- createGatewayResponse_httpStatus :: Lens' CreateGatewayResponse Int
- createGatewayResponse_gatewayId :: Lens' CreateGatewayResponse Text
- createGatewayResponse_gatewayArn :: Lens' CreateGatewayResponse Text
Creating a Request
data CreateGateway Source #
See: newCreateGateway smart constructor.
Constructors
| CreateGateway' | |
Fields
| |
Instances
Arguments
| :: Text | |
| -> GatewayPlatform | |
| -> CreateGateway |
Create a value of CreateGateway 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:tags:CreateGateway', createGateway_tags - A list of key-value pairs that contain metadata for the gateway. For
more information, see
Tagging your IoT SiteWise resources
in the IoT SiteWise User Guide.
$sel:gatewayName:CreateGateway', createGateway_gatewayName - A unique, friendly name for the gateway.
$sel:gatewayPlatform:CreateGateway', createGateway_gatewayPlatform - The gateway's platform. You can only specify one platform in a gateway.
Request Lenses
createGateway_tags :: Lens' CreateGateway (Maybe (HashMap Text Text)) Source #
A list of key-value pairs that contain metadata for the gateway. For more information, see Tagging your IoT SiteWise resources in the IoT SiteWise User Guide.
createGateway_gatewayName :: Lens' CreateGateway Text Source #
A unique, friendly name for the gateway.
createGateway_gatewayPlatform :: Lens' CreateGateway GatewayPlatform Source #
The gateway's platform. You can only specify one platform in a gateway.
Destructuring the Response
data CreateGatewayResponse Source #
See: newCreateGatewayResponse smart constructor.
Constructors
| CreateGatewayResponse' | |
Fields
| |
Instances
newCreateGatewayResponse Source #
Arguments
| :: Int | |
| -> Text | |
| -> Text | |
| -> CreateGatewayResponse |
Create a value of CreateGatewayResponse 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:httpStatus:CreateGatewayResponse', createGatewayResponse_httpStatus - The response's http status code.
$sel:gatewayId:CreateGatewayResponse', createGatewayResponse_gatewayId - The ID of the gateway device. You can use this ID when you call other
IoT SiteWise APIs.
$sel:gatewayArn:CreateGatewayResponse', createGatewayResponse_gatewayArn - The
ARN
of the gateway, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:gateway/${GatewayId}Response Lenses
createGatewayResponse_httpStatus :: Lens' CreateGatewayResponse Int Source #
The response's http status code.
createGatewayResponse_gatewayId :: Lens' CreateGatewayResponse Text Source #
The ID of the gateway device. You can use this ID when you call other IoT SiteWise APIs.
createGatewayResponse_gatewayArn :: Lens' CreateGatewayResponse Text Source #
The ARN of the gateway, which has the following format.
arn:${Partition}:iotsitewise:${Region}:${Account}:gateway/${GatewayId}