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

Amazonka.IotTwinMaker.CreateSyncJob

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

This action creates a SyncJob.

Synopsis

data CreateSyncJob = CreateSyncJob' {
- tags :: Maybe (HashMap Text Text)
- workspaceId :: Text
- syncSource :: Text
- syncRole :: Text
}
newCreateSyncJob :: Text -> Text -> Text -> CreateSyncJob
createSyncJob_tags :: Lens' CreateSyncJob (Maybe (HashMap Text Text))
createSyncJob_workspaceId :: Lens' CreateSyncJob Text
createSyncJob_syncSource :: Lens' CreateSyncJob Text
createSyncJob_syncRole :: Lens' CreateSyncJob Text
data CreateSyncJobResponse = CreateSyncJobResponse' {
- httpStatus :: Int
- arn :: Text
- creationDateTime :: POSIX
- state :: SyncJobState
}
newCreateSyncJobResponse :: Int -> Text -> UTCTime -> SyncJobState -> CreateSyncJobResponse
createSyncJobResponse_httpStatus :: Lens' CreateSyncJobResponse Int
createSyncJobResponse_arn :: Lens' CreateSyncJobResponse Text
createSyncJobResponse_creationDateTime :: Lens' CreateSyncJobResponse UTCTime
createSyncJobResponse_state :: Lens' CreateSyncJobResponse SyncJobState

Creating a Request

data CreateSyncJob Source #

See: newCreateSyncJob smart constructor.

Constructors

CreateSyncJob'
Fields tags :: Maybe (HashMap Text Text) The SyncJob tags. workspaceId :: Text The workspace Id. syncSource :: Text The sync source. Currently the only supported syncSoucre is `SITEWISE` . syncRole :: Text The SyncJob IAM role. This IAM role is used by the sync job to read from the syncSource, and create, update or delete the corresponding resources.

Instances

Instances details

ToJSON CreateSyncJob Source #
Instance details Defined in Amazonka.IotTwinMaker.CreateSyncJob Methods toJSON :: CreateSyncJob -> Value # toEncoding :: CreateSyncJob -> Encoding # toJSONList :: [CreateSyncJob] -> Value # toEncodingList :: [CreateSyncJob] -> Encoding #
ToHeaders CreateSyncJob Source #
Instance details Defined in Amazonka.IotTwinMaker.CreateSyncJob Methods toHeaders :: CreateSyncJob -> [Header] #
ToPath CreateSyncJob Source #
Instance details Defined in Amazonka.IotTwinMaker.CreateSyncJob Methods toPath :: CreateSyncJob -> ByteString #
ToQuery CreateSyncJob Source #
Instance details Defined in Amazonka.IotTwinMaker.CreateSyncJob Methods toQuery :: CreateSyncJob -> QueryString #
AWSRequest CreateSyncJob Source #
Instance details Defined in Amazonka.IotTwinMaker.CreateSyncJob Associated Types type AWSResponse CreateSyncJob # Methods request :: (Service -> Service) -> CreateSyncJob -> Request CreateSyncJob # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateSyncJob -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateSyncJob))) #
Generic CreateSyncJob Source #
Instance details Defined in Amazonka.IotTwinMaker.CreateSyncJob Associated Types type Rep CreateSyncJob :: Type -> Type # Methods from :: CreateSyncJob -> Rep CreateSyncJob x # to :: Rep CreateSyncJob x -> CreateSyncJob #
Read CreateSyncJob Source #
Instance details Defined in Amazonka.IotTwinMaker.CreateSyncJob Methods readsPrec :: Int -> ReadS CreateSyncJob # readList :: ReadS [CreateSyncJob] # readPrec :: ReadPrec CreateSyncJob # readListPrec :: ReadPrec [CreateSyncJob] #
Show CreateSyncJob Source #
Instance details Defined in Amazonka.IotTwinMaker.CreateSyncJob Methods showsPrec :: Int -> CreateSyncJob -> ShowS # show :: CreateSyncJob -> String # showList :: [CreateSyncJob] -> ShowS #
NFData CreateSyncJob Source #
Instance details Defined in Amazonka.IotTwinMaker.CreateSyncJob Methods rnf :: CreateSyncJob -> () #
Eq CreateSyncJob Source #
Instance details Defined in Amazonka.IotTwinMaker.CreateSyncJob Methods (==) :: CreateSyncJob -> CreateSyncJob -> Bool # (/=) :: CreateSyncJob -> CreateSyncJob -> Bool #
Hashable CreateSyncJob Source #
Instance details Defined in Amazonka.IotTwinMaker.CreateSyncJob Methods hashWithSalt :: Int -> CreateSyncJob -> Int # hash :: CreateSyncJob -> Int #
type AWSResponse CreateSyncJob Source #
Instance details Defined in Amazonka.IotTwinMaker.CreateSyncJob type AWSResponse CreateSyncJob = CreateSyncJobResponse
type Rep CreateSyncJob Source #
Instance details Defined in Amazonka.IotTwinMaker.CreateSyncJob type Rep CreateSyncJob = D1 ('MetaData "CreateSyncJob" "Amazonka.IotTwinMaker.CreateSyncJob" "amazonka-iottwinmaker-2.0-F9krWmdiZsuIxDlP9hNtjs" 'False) (C1 ('MetaCons "CreateSyncJob'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))) :: S1 ('MetaSel ('Just "workspaceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "syncSource") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "syncRole") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))

newCreateSyncJob Source #

Arguments

:: Text	`CreateSyncJob`
-> Text	`CreateSyncJob`
-> Text	`$sel:syncRole:CreateSyncJob'`
-> CreateSyncJob

Create a value of CreateSyncJob 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:CreateSyncJob', createSyncJob_tags - The SyncJob tags.

CreateSyncJob, createSyncJob_workspaceId - The workspace Id.

CreateSyncJob, createSyncJob_syncSource - The sync source.

Currently the only supported syncSoucre is SITEWISE .

$sel:syncRole:CreateSyncJob', createSyncJob_syncRole - The SyncJob IAM role. This IAM role is used by the sync job to read from the syncSource, and create, update or delete the corresponding resources.

Request Lenses

createSyncJob_tags :: Lens' CreateSyncJob (Maybe (HashMap Text Text)) Source #

The SyncJob tags.

createSyncJob_workspaceId :: Lens' CreateSyncJob Text Source #

The workspace Id.

createSyncJob_syncSource :: Lens' CreateSyncJob Text Source #

The sync source.

Currently the only supported syncSoucre is SITEWISE .

createSyncJob_syncRole :: Lens' CreateSyncJob Text Source #

The SyncJob IAM role. This IAM role is used by the sync job to read from the syncSource, and create, update or delete the corresponding resources.

Destructuring the Response

data CreateSyncJobResponse Source #

See: newCreateSyncJobResponse smart constructor.

Constructors

CreateSyncJobResponse'
Fields httpStatus :: Int The response's http status code. arn :: Text The SyncJob ARN. creationDateTime :: POSIX The date and time for the SyncJob creation. state :: SyncJobState The SyncJob response state.

Instances

Instances details

Generic CreateSyncJobResponse Source #
Instance details Defined in Amazonka.IotTwinMaker.CreateSyncJob Associated Types type Rep CreateSyncJobResponse :: Type -> Type # Methods from :: CreateSyncJobResponse -> Rep CreateSyncJobResponse x # to :: Rep CreateSyncJobResponse x -> CreateSyncJobResponse #
Read CreateSyncJobResponse Source #
Instance details Defined in Amazonka.IotTwinMaker.CreateSyncJob Methods readsPrec :: Int -> ReadS CreateSyncJobResponse # readList :: ReadS [CreateSyncJobResponse] # readPrec :: ReadPrec CreateSyncJobResponse # readListPrec :: ReadPrec [CreateSyncJobResponse] #
Show CreateSyncJobResponse Source #
Instance details Defined in Amazonka.IotTwinMaker.CreateSyncJob Methods showsPrec :: Int -> CreateSyncJobResponse -> ShowS # show :: CreateSyncJobResponse -> String # showList :: [CreateSyncJobResponse] -> ShowS #
NFData CreateSyncJobResponse Source #
Instance details Defined in Amazonka.IotTwinMaker.CreateSyncJob Methods rnf :: CreateSyncJobResponse -> () #
Eq CreateSyncJobResponse Source #
Instance details Defined in Amazonka.IotTwinMaker.CreateSyncJob Methods (==) :: CreateSyncJobResponse -> CreateSyncJobResponse -> Bool # (/=) :: CreateSyncJobResponse -> CreateSyncJobResponse -> Bool #
type Rep CreateSyncJobResponse Source #
Instance details Defined in Amazonka.IotTwinMaker.CreateSyncJob type Rep CreateSyncJobResponse = D1 ('MetaData "CreateSyncJobResponse" "Amazonka.IotTwinMaker.CreateSyncJob" "amazonka-iottwinmaker-2.0-F9krWmdiZsuIxDlP9hNtjs" 'False) (C1 ('MetaCons "CreateSyncJobResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :: S1 ('MetaSel ('Just "arn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "creationDateTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 POSIX) :*: S1 ('MetaSel ('Just "state") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 SyncJobState))))

newCreateSyncJobResponse Source #

Arguments

:: Int	`$sel:httpStatus:CreateSyncJobResponse'`
-> Text	`CreateSyncJobResponse`
-> UTCTime	`CreateSyncJobResponse`
-> SyncJobState	`CreateSyncJobResponse`
-> CreateSyncJobResponse

Create a value of CreateSyncJobResponse 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:CreateSyncJobResponse', createSyncJobResponse_httpStatus - The response's http status code.

CreateSyncJobResponse, createSyncJobResponse_arn - The SyncJob ARN.

CreateSyncJobResponse, createSyncJobResponse_creationDateTime - The date and time for the SyncJob creation.

CreateSyncJobResponse, createSyncJobResponse_state - The SyncJob response state.

Response Lenses

createSyncJobResponse_httpStatus :: Lens' CreateSyncJobResponse Int Source #

The response's http status code.

createSyncJobResponse_arn :: Lens' CreateSyncJobResponse Text Source #

The SyncJob ARN.

createSyncJobResponse_creationDateTime :: Lens' CreateSyncJobResponse UTCTime Source #

The date and time for the SyncJob creation.

createSyncJobResponse_state :: Lens' CreateSyncJobResponse SyncJobState Source #

The SyncJob response state.