Amazonka.IoTSiteWise.CreateGateway

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.

Creating a Request

data CreateGateway

See: newCreateGateway smart constructor.

Constructors

CreateGateway'

Fields

• tags :: Maybe (HashMap Text Text)

  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.

• gatewayName :: Text

  A unique, friendly name for the gateway.

• gatewayPlatform :: GatewayPlatform

  The gateway's platform. You can only specify one platform in a gateway.

Instances

ToJSON CreateGateway

Defined in Amazonka.IoTSiteWise.CreateGateway

Methods

toJSON :: CreateGateway -> Value

toEncoding :: CreateGateway -> Encoding

toJSONList :: [CreateGateway] -> Value

toEncodingList :: [CreateGateway] -> Encoding

ToHeaders CreateGateway

Defined in Amazonka.IoTSiteWise.CreateGateway

Methods

toHeaders :: CreateGateway -> [Header]

ToPath CreateGateway

Defined in Amazonka.IoTSiteWise.CreateGateway

Methods

toPath :: CreateGateway -> ByteString

ToQuery CreateGateway

Defined in Amazonka.IoTSiteWise.CreateGateway

Methods

toQuery :: CreateGateway -> QueryString

AWSRequest CreateGateway

Defined in Amazonka.IoTSiteWise.CreateGateway

Associated Types

type AWSResponse CreateGateway

Methods

request :: (Service -> Service) -> CreateGateway -> Request CreateGateway

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateGateway -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateGateway)))

Generic CreateGateway

Defined in Amazonka.IoTSiteWise.CreateGateway

Associated Types

type Rep CreateGateway :: Type -> Type

Methods

from :: CreateGateway -> Rep CreateGateway x

to :: Rep CreateGateway x -> CreateGateway

Read CreateGateway

Defined in Amazonka.IoTSiteWise.CreateGateway

Methods

readsPrec :: Int -> ReadS CreateGateway

readList :: ReadS [CreateGateway]

readPrec :: ReadPrec CreateGateway

readListPrec :: ReadPrec [CreateGateway]

Show CreateGateway

Defined in Amazonka.IoTSiteWise.CreateGateway

Methods

showsPrec :: Int -> CreateGateway -> ShowS

show :: CreateGateway -> String

showList :: [CreateGateway] -> ShowS

NFData CreateGateway

Defined in Amazonka.IoTSiteWise.CreateGateway

Methods

rnf :: CreateGateway -> ()

Eq CreateGateway

Defined in Amazonka.IoTSiteWise.CreateGateway

Methods

(==) :: CreateGateway -> CreateGateway -> Bool

(/=) :: CreateGateway -> CreateGateway -> Bool

Hashable CreateGateway

Defined in Amazonka.IoTSiteWise.CreateGateway

Methods

hashWithSalt :: Int -> CreateGateway -> Int

hash :: CreateGateway -> Int

type AWSResponse CreateGateway

Defined in Amazonka.IoTSiteWise.CreateGateway

type AWSResponse CreateGateway = CreateGatewayResponse

type Rep CreateGateway

Defined in Amazonka.IoTSiteWise.CreateGateway

type Rep CreateGateway = D1 ('MetaData "CreateGateway" "Amazonka.IoTSiteWise.CreateGateway" "amazonka-iotsitewise-2.0-AK8rDlpQ5oPJsrLUUxJgY" 'False) (C1 ('MetaCons "CreateGateway'" 'PrefixI 'True) (S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :*: (S1 ('MetaSel ('Just "gatewayName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "gatewayPlatform") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 GatewayPlatform))))

newCreateGateway

Arguments

:: Text

CreateGateway

-> GatewayPlatform

CreateGateway

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

CreateGateway, createGateway_gatewayName - A unique, friendly name for the gateway.

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))

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

A unique, friendly name for the gateway.

createGateway_gatewayPlatform :: Lens' CreateGateway GatewayPlatform

The gateway's platform. You can only specify one platform in a gateway.

Destructuring the Response

data CreateGatewayResponse

See: newCreateGatewayResponse smart constructor.

Constructors

CreateGatewayResponse'

Fields

• httpStatus :: Int

  The response's http status code.

• gatewayId :: Text

  The ID of the gateway device. You can use this ID when you call other IoT SiteWise APIs.

• gatewayArn :: Text

  The ARN of the gateway, which has the following format.

  arn:${Partition}:iotsitewise:${Region}:${Account}:gateway/${GatewayId}

Instances

Generic CreateGatewayResponse

Defined in Amazonka.IoTSiteWise.CreateGateway

Associated Types

type Rep CreateGatewayResponse :: Type -> Type

Methods

from :: CreateGatewayResponse -> Rep CreateGatewayResponse x

to :: Rep CreateGatewayResponse x -> CreateGatewayResponse

Read CreateGatewayResponse

Defined in Amazonka.IoTSiteWise.CreateGateway

Methods

readsPrec :: Int -> ReadS CreateGatewayResponse

readList :: ReadS [CreateGatewayResponse]

readPrec :: ReadPrec CreateGatewayResponse

readListPrec :: ReadPrec [CreateGatewayResponse]

Show CreateGatewayResponse

Defined in Amazonka.IoTSiteWise.CreateGateway

Methods

showsPrec :: Int -> CreateGatewayResponse -> ShowS

show :: CreateGatewayResponse -> String

showList :: [CreateGatewayResponse] -> ShowS

NFData CreateGatewayResponse

Defined in Amazonka.IoTSiteWise.CreateGateway

Methods

rnf :: CreateGatewayResponse -> ()

Eq CreateGatewayResponse

Defined in Amazonka.IoTSiteWise.CreateGateway

Methods

(==) :: CreateGatewayResponse -> CreateGatewayResponse -> Bool

(/=) :: CreateGatewayResponse -> CreateGatewayResponse -> Bool

type Rep CreateGatewayResponse

Defined in Amazonka.IoTSiteWise.CreateGateway

type Rep CreateGatewayResponse = D1 ('MetaData "CreateGatewayResponse" "Amazonka.IoTSiteWise.CreateGateway" "amazonka-iotsitewise-2.0-AK8rDlpQ5oPJsrLUUxJgY" 'False) (C1 ('MetaCons "CreateGatewayResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :*: (S1 ('MetaSel ('Just "gatewayId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "gatewayArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newCreateGatewayResponse

Arguments

:: Int

$sel:httpStatus:CreateGatewayResponse'

-> Text

CreateGatewayResponse

-> Text

$sel:gatewayArn:CreateGatewayResponse'

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

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

The response's http status code.

createGatewayResponse_gatewayId :: Lens' CreateGatewayResponse Text

The ID of the gateway device. You can use this ID when you call other IoT SiteWise APIs.

createGatewayResponse_gatewayArn :: Lens' CreateGatewayResponse Text

The ARN of the gateway, which has the following format.

arn:${Partition}:iotsitewise:${Region}:${Account}:gateway/${GatewayId}