{-# LANGUAGE DeriveGeneric #-}
{-# LANGUAGE DuplicateRecordFields #-}
{-# LANGUAGE NamedFieldPuns #-}
{-# LANGUAGE OverloadedStrings #-}
{-# LANGUAGE RecordWildCards #-}
{-# LANGUAGE StrictData #-}
{-# LANGUAGE TypeFamilies #-}
{-# LANGUAGE NoImplicitPrelude #-}
{-# OPTIONS_GHC -fno-warn-unused-binds #-}
{-# OPTIONS_GHC -fno-warn-unused-imports #-}
{-# OPTIONS_GHC -fno-warn-unused-matches #-}

-- Derived from AWS service descriptions, licensed under Apache 2.0.

-- |
-- Module      : Amazonka.IotTwinMaker.ListSyncJobs
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- List all SyncJobs.
module Amazonka.IotTwinMaker.ListSyncJobs
  ( -- * Creating a Request
    ListSyncJobs (..),
    newListSyncJobs,

    -- * Request Lenses
    listSyncJobs_maxResults,
    listSyncJobs_nextToken,
    listSyncJobs_workspaceId,

    -- * Destructuring the Response
    ListSyncJobsResponse (..),
    newListSyncJobsResponse,

    -- * Response Lenses
    listSyncJobsResponse_nextToken,
    listSyncJobsResponse_syncJobSummaries,
    listSyncJobsResponse_httpStatus,
  )
where

import qualified Amazonka.Core as Core
import qualified Amazonka.Core.Lens.Internal as Lens
import qualified Amazonka.Data as Data
import Amazonka.IotTwinMaker.Types
import qualified Amazonka.Prelude as Prelude
import qualified Amazonka.Request as Request
import qualified Amazonka.Response as Response

-- | /See:/ 'newListSyncJobs' smart constructor.
data ListSyncJobs = ListSyncJobs'
  { -- | The maximum number of results to return at one time. The default is 50.
    --
    -- Valid Range: Minimum value of 0. Maximum value of 200.
    ListSyncJobs -> Maybe Natural
maxResults :: Prelude.Maybe Prelude.Natural,
    -- | The string that specifies the next page of results.
    ListSyncJobs -> Maybe Text
nextToken :: Prelude.Maybe Prelude.Text,
    -- | The ID of the workspace that contains the sync job.
    ListSyncJobs -> Text
workspaceId :: Prelude.Text
  }
  deriving (ListSyncJobs -> ListSyncJobs -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: ListSyncJobs -> ListSyncJobs -> Bool
$c/= :: ListSyncJobs -> ListSyncJobs -> Bool
== :: ListSyncJobs -> ListSyncJobs -> Bool
$c== :: ListSyncJobs -> ListSyncJobs -> Bool
Prelude.Eq, ReadPrec [ListSyncJobs]
ReadPrec ListSyncJobs
Int -> ReadS ListSyncJobs
ReadS [ListSyncJobs]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [ListSyncJobs]
$creadListPrec :: ReadPrec [ListSyncJobs]
readPrec :: ReadPrec ListSyncJobs
$creadPrec :: ReadPrec ListSyncJobs
readList :: ReadS [ListSyncJobs]
$creadList :: ReadS [ListSyncJobs]
readsPrec :: Int -> ReadS ListSyncJobs
$creadsPrec :: Int -> ReadS ListSyncJobs
Prelude.Read, Int -> ListSyncJobs -> ShowS
[ListSyncJobs] -> ShowS
ListSyncJobs -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [ListSyncJobs] -> ShowS
$cshowList :: [ListSyncJobs] -> ShowS
show :: ListSyncJobs -> String
$cshow :: ListSyncJobs -> String
showsPrec :: Int -> ListSyncJobs -> ShowS
$cshowsPrec :: Int -> ListSyncJobs -> ShowS
Prelude.Show, forall x. Rep ListSyncJobs x -> ListSyncJobs
forall x. ListSyncJobs -> Rep ListSyncJobs x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep ListSyncJobs x -> ListSyncJobs
$cfrom :: forall x. ListSyncJobs -> Rep ListSyncJobs x
Prelude.Generic)

-- |
-- Create a value of 'ListSyncJobs' with all optional fields omitted.
--
-- Use <https://hackage.haskell.org/package/generic-lens generic-lens> or <https://hackage.haskell.org/package/optics optics> to modify other optional fields.
--
-- The following record fields are available, with the corresponding lenses provided
-- for backwards compatibility:
--
-- 'maxResults', 'listSyncJobs_maxResults' - The maximum number of results to return at one time. The default is 50.
--
-- Valid Range: Minimum value of 0. Maximum value of 200.
--
-- 'nextToken', 'listSyncJobs_nextToken' - The string that specifies the next page of results.
--
-- 'workspaceId', 'listSyncJobs_workspaceId' - The ID of the workspace that contains the sync job.
newListSyncJobs ::
  -- | 'workspaceId'
  Prelude.Text ->
  ListSyncJobs
newListSyncJobs :: Text -> ListSyncJobs
newListSyncJobs Text
pWorkspaceId_ =
  ListSyncJobs'
    { $sel:maxResults:ListSyncJobs' :: Maybe Natural
maxResults = forall a. Maybe a
Prelude.Nothing,
      $sel:nextToken:ListSyncJobs' :: Maybe Text
nextToken = forall a. Maybe a
Prelude.Nothing,
      $sel:workspaceId:ListSyncJobs' :: Text
workspaceId = Text
pWorkspaceId_
    }

-- | The maximum number of results to return at one time. The default is 50.
--
-- Valid Range: Minimum value of 0. Maximum value of 200.
listSyncJobs_maxResults :: Lens.Lens' ListSyncJobs (Prelude.Maybe Prelude.Natural)
listSyncJobs_maxResults :: Lens' ListSyncJobs (Maybe Natural)
listSyncJobs_maxResults = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListSyncJobs' {Maybe Natural
maxResults :: Maybe Natural
$sel:maxResults:ListSyncJobs' :: ListSyncJobs -> Maybe Natural
maxResults} -> Maybe Natural
maxResults) (\s :: ListSyncJobs
s@ListSyncJobs' {} Maybe Natural
a -> ListSyncJobs
s {$sel:maxResults:ListSyncJobs' :: Maybe Natural
maxResults = Maybe Natural
a} :: ListSyncJobs)

-- | The string that specifies the next page of results.
listSyncJobs_nextToken :: Lens.Lens' ListSyncJobs (Prelude.Maybe Prelude.Text)
listSyncJobs_nextToken :: Lens' ListSyncJobs (Maybe Text)
listSyncJobs_nextToken = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListSyncJobs' {Maybe Text
nextToken :: Maybe Text
$sel:nextToken:ListSyncJobs' :: ListSyncJobs -> Maybe Text
nextToken} -> Maybe Text
nextToken) (\s :: ListSyncJobs
s@ListSyncJobs' {} Maybe Text
a -> ListSyncJobs
s {$sel:nextToken:ListSyncJobs' :: Maybe Text
nextToken = Maybe Text
a} :: ListSyncJobs)

-- | The ID of the workspace that contains the sync job.
listSyncJobs_workspaceId :: Lens.Lens' ListSyncJobs Prelude.Text
listSyncJobs_workspaceId :: Lens' ListSyncJobs Text
listSyncJobs_workspaceId = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListSyncJobs' {Text
workspaceId :: Text
$sel:workspaceId:ListSyncJobs' :: ListSyncJobs -> Text
workspaceId} -> Text
workspaceId) (\s :: ListSyncJobs
s@ListSyncJobs' {} Text
a -> ListSyncJobs
s {$sel:workspaceId:ListSyncJobs' :: Text
workspaceId = Text
a} :: ListSyncJobs)

instance Core.AWSRequest ListSyncJobs where
  type AWSResponse ListSyncJobs = ListSyncJobsResponse
  request :: (Service -> Service) -> ListSyncJobs -> Request ListSyncJobs
request Service -> Service
overrides =
    forall a. (ToRequest a, ToJSON a) => Service -> a -> Request a
Request.postJSON (Service -> Service
overrides Service
defaultService)
  response :: forall (m :: * -> *).
MonadResource m =>
(ByteStringLazy -> IO ByteStringLazy)
-> Service
-> Proxy ListSyncJobs
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse ListSyncJobs)))
response =
    forall (m :: * -> *) a.
MonadResource m =>
(Int -> ResponseHeaders -> Object -> Either String (AWSResponse a))
-> (ByteStringLazy -> IO ByteStringLazy)
-> Service
-> Proxy a
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse a)))
Response.receiveJSON
      ( \Int
s ResponseHeaders
h Object
x ->
          Maybe Text -> Maybe [SyncJobSummary] -> Int -> ListSyncJobsResponse
ListSyncJobsResponse'
            forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> (Object
x forall a. FromJSON a => Object -> Key -> Either String (Maybe a)
Data..?> Key
"nextToken")
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> ( Object
x
                            forall a. FromJSON a => Object -> Key -> Either String (Maybe a)
Data..?> Key
"syncJobSummaries"
                            forall (f :: * -> *) a. Functor f => f (Maybe a) -> a -> f a
Core..!@ forall a. Monoid a => a
Prelude.mempty
                        )
            forall (f :: * -> *) a b. Applicative f => f (a -> b) -> f a -> f b
Prelude.<*> (forall (f :: * -> *) a. Applicative f => a -> f a
Prelude.pure (forall a. Enum a => a -> Int
Prelude.fromEnum Int
s))
      )

instance Prelude.Hashable ListSyncJobs where
  hashWithSalt :: Int -> ListSyncJobs -> Int
hashWithSalt Int
_salt ListSyncJobs' {Maybe Natural
Maybe Text
Text
workspaceId :: Text
nextToken :: Maybe Text
maxResults :: Maybe Natural
$sel:workspaceId:ListSyncJobs' :: ListSyncJobs -> Text
$sel:nextToken:ListSyncJobs' :: ListSyncJobs -> Maybe Text
$sel:maxResults:ListSyncJobs' :: ListSyncJobs -> Maybe Natural
..} =
    Int
_salt
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Natural
maxResults
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Maybe Text
nextToken
      forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
workspaceId

instance Prelude.NFData ListSyncJobs where
  rnf :: ListSyncJobs -> ()
rnf ListSyncJobs' {Maybe Natural
Maybe Text
Text
workspaceId :: Text
nextToken :: Maybe Text
maxResults :: Maybe Natural
$sel:workspaceId:ListSyncJobs' :: ListSyncJobs -> Text
$sel:nextToken:ListSyncJobs' :: ListSyncJobs -> Maybe Text
$sel:maxResults:ListSyncJobs' :: ListSyncJobs -> Maybe Natural
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe Natural
maxResults
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
nextToken
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Text
workspaceId

instance Data.ToHeaders ListSyncJobs where
  toHeaders :: ListSyncJobs -> ResponseHeaders
toHeaders =
    forall a b. a -> b -> a
Prelude.const
      ( forall a. Monoid a => [a] -> a
Prelude.mconcat
          [ HeaderName
"Content-Type"
              forall a. ToHeader a => HeaderName -> a -> ResponseHeaders
Data.=# ( ByteString
"application/x-amz-json-1.1" ::
                          Prelude.ByteString
                      )
          ]
      )

instance Data.ToJSON ListSyncJobs where
  toJSON :: ListSyncJobs -> Value
toJSON ListSyncJobs' {Maybe Natural
Maybe Text
Text
workspaceId :: Text
nextToken :: Maybe Text
maxResults :: Maybe Natural
$sel:workspaceId:ListSyncJobs' :: ListSyncJobs -> Text
$sel:nextToken:ListSyncJobs' :: ListSyncJobs -> Maybe Text
$sel:maxResults:ListSyncJobs' :: ListSyncJobs -> Maybe Natural
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Key
"maxResults" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Natural
maxResults,
            (Key
"nextToken" forall kv v. (KeyValue kv, ToJSON v) => Key -> v -> kv
Data..=) forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
Prelude.<$> Maybe Text
nextToken
          ]
      )

instance Data.ToPath ListSyncJobs where
  toPath :: ListSyncJobs -> ByteString
toPath ListSyncJobs' {Maybe Natural
Maybe Text
Text
workspaceId :: Text
nextToken :: Maybe Text
maxResults :: Maybe Natural
$sel:workspaceId:ListSyncJobs' :: ListSyncJobs -> Text
$sel:nextToken:ListSyncJobs' :: ListSyncJobs -> Maybe Text
$sel:maxResults:ListSyncJobs' :: ListSyncJobs -> Maybe Natural
..} =
    forall a. Monoid a => [a] -> a
Prelude.mconcat
      [ ByteString
"/workspaces/",
        forall a. ToByteString a => a -> ByteString
Data.toBS Text
workspaceId,
        ByteString
"/sync-jobs-list"
      ]

instance Data.ToQuery ListSyncJobs where
  toQuery :: ListSyncJobs -> QueryString
toQuery = forall a b. a -> b -> a
Prelude.const forall a. Monoid a => a
Prelude.mempty

-- | /See:/ 'newListSyncJobsResponse' smart constructor.
data ListSyncJobsResponse = ListSyncJobsResponse'
  { -- | The string that specifies the next page of results.
    ListSyncJobsResponse -> Maybe Text
nextToken :: Prelude.Maybe Prelude.Text,
    -- | The listed SyncJob summaries.
    ListSyncJobsResponse -> Maybe [SyncJobSummary]
syncJobSummaries :: Prelude.Maybe [SyncJobSummary],
    -- | The response's http status code.
    ListSyncJobsResponse -> Int
httpStatus :: Prelude.Int
  }
  deriving (ListSyncJobsResponse -> ListSyncJobsResponse -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: ListSyncJobsResponse -> ListSyncJobsResponse -> Bool
$c/= :: ListSyncJobsResponse -> ListSyncJobsResponse -> Bool
== :: ListSyncJobsResponse -> ListSyncJobsResponse -> Bool
$c== :: ListSyncJobsResponse -> ListSyncJobsResponse -> Bool
Prelude.Eq, ReadPrec [ListSyncJobsResponse]
ReadPrec ListSyncJobsResponse
Int -> ReadS ListSyncJobsResponse
ReadS [ListSyncJobsResponse]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [ListSyncJobsResponse]
$creadListPrec :: ReadPrec [ListSyncJobsResponse]
readPrec :: ReadPrec ListSyncJobsResponse
$creadPrec :: ReadPrec ListSyncJobsResponse
readList :: ReadS [ListSyncJobsResponse]
$creadList :: ReadS [ListSyncJobsResponse]
readsPrec :: Int -> ReadS ListSyncJobsResponse
$creadsPrec :: Int -> ReadS ListSyncJobsResponse
Prelude.Read, Int -> ListSyncJobsResponse -> ShowS
[ListSyncJobsResponse] -> ShowS
ListSyncJobsResponse -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [ListSyncJobsResponse] -> ShowS
$cshowList :: [ListSyncJobsResponse] -> ShowS
show :: ListSyncJobsResponse -> String
$cshow :: ListSyncJobsResponse -> String
showsPrec :: Int -> ListSyncJobsResponse -> ShowS
$cshowsPrec :: Int -> ListSyncJobsResponse -> ShowS
Prelude.Show, forall x. Rep ListSyncJobsResponse x -> ListSyncJobsResponse
forall x. ListSyncJobsResponse -> Rep ListSyncJobsResponse x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep ListSyncJobsResponse x -> ListSyncJobsResponse
$cfrom :: forall x. ListSyncJobsResponse -> Rep ListSyncJobsResponse x
Prelude.Generic)

-- |
-- Create a value of 'ListSyncJobsResponse' with all optional fields omitted.
--
-- Use <https://hackage.haskell.org/package/generic-lens generic-lens> or <https://hackage.haskell.org/package/optics optics> to modify other optional fields.
--
-- The following record fields are available, with the corresponding lenses provided
-- for backwards compatibility:
--
-- 'nextToken', 'listSyncJobsResponse_nextToken' - The string that specifies the next page of results.
--
-- 'syncJobSummaries', 'listSyncJobsResponse_syncJobSummaries' - The listed SyncJob summaries.
--
-- 'httpStatus', 'listSyncJobsResponse_httpStatus' - The response's http status code.
newListSyncJobsResponse ::
  -- | 'httpStatus'
  Prelude.Int ->
  ListSyncJobsResponse
newListSyncJobsResponse :: Int -> ListSyncJobsResponse
newListSyncJobsResponse Int
pHttpStatus_ =
  ListSyncJobsResponse'
    { $sel:nextToken:ListSyncJobsResponse' :: Maybe Text
nextToken = forall a. Maybe a
Prelude.Nothing,
      $sel:syncJobSummaries:ListSyncJobsResponse' :: Maybe [SyncJobSummary]
syncJobSummaries = forall a. Maybe a
Prelude.Nothing,
      $sel:httpStatus:ListSyncJobsResponse' :: Int
httpStatus = Int
pHttpStatus_
    }

-- | The string that specifies the next page of results.
listSyncJobsResponse_nextToken :: Lens.Lens' ListSyncJobsResponse (Prelude.Maybe Prelude.Text)
listSyncJobsResponse_nextToken :: Lens' ListSyncJobsResponse (Maybe Text)
listSyncJobsResponse_nextToken = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListSyncJobsResponse' {Maybe Text
nextToken :: Maybe Text
$sel:nextToken:ListSyncJobsResponse' :: ListSyncJobsResponse -> Maybe Text
nextToken} -> Maybe Text
nextToken) (\s :: ListSyncJobsResponse
s@ListSyncJobsResponse' {} Maybe Text
a -> ListSyncJobsResponse
s {$sel:nextToken:ListSyncJobsResponse' :: Maybe Text
nextToken = Maybe Text
a} :: ListSyncJobsResponse)

-- | The listed SyncJob summaries.
listSyncJobsResponse_syncJobSummaries :: Lens.Lens' ListSyncJobsResponse (Prelude.Maybe [SyncJobSummary])
listSyncJobsResponse_syncJobSummaries :: Lens' ListSyncJobsResponse (Maybe [SyncJobSummary])
listSyncJobsResponse_syncJobSummaries = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListSyncJobsResponse' {Maybe [SyncJobSummary]
syncJobSummaries :: Maybe [SyncJobSummary]
$sel:syncJobSummaries:ListSyncJobsResponse' :: ListSyncJobsResponse -> Maybe [SyncJobSummary]
syncJobSummaries} -> Maybe [SyncJobSummary]
syncJobSummaries) (\s :: ListSyncJobsResponse
s@ListSyncJobsResponse' {} Maybe [SyncJobSummary]
a -> ListSyncJobsResponse
s {$sel:syncJobSummaries:ListSyncJobsResponse' :: Maybe [SyncJobSummary]
syncJobSummaries = Maybe [SyncJobSummary]
a} :: ListSyncJobsResponse) forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall (f :: * -> *) (g :: * -> *) s t a b.
(Functor f, Functor g) =>
AnIso s t a b -> Iso (f s) (g t) (f a) (g b)
Lens.mapping forall s t a b. (Coercible s a, Coercible t b) => Iso s t a b
Lens.coerced

-- | The response's http status code.
listSyncJobsResponse_httpStatus :: Lens.Lens' ListSyncJobsResponse Prelude.Int
listSyncJobsResponse_httpStatus :: Lens' ListSyncJobsResponse Int
listSyncJobsResponse_httpStatus = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\ListSyncJobsResponse' {Int
httpStatus :: Int
$sel:httpStatus:ListSyncJobsResponse' :: ListSyncJobsResponse -> Int
httpStatus} -> Int
httpStatus) (\s :: ListSyncJobsResponse
s@ListSyncJobsResponse' {} Int
a -> ListSyncJobsResponse
s {$sel:httpStatus:ListSyncJobsResponse' :: Int
httpStatus = Int
a} :: ListSyncJobsResponse)

instance Prelude.NFData ListSyncJobsResponse where
  rnf :: ListSyncJobsResponse -> ()
rnf ListSyncJobsResponse' {Int
Maybe [SyncJobSummary]
Maybe Text
httpStatus :: Int
syncJobSummaries :: Maybe [SyncJobSummary]
nextToken :: Maybe Text
$sel:httpStatus:ListSyncJobsResponse' :: ListSyncJobsResponse -> Int
$sel:syncJobSummaries:ListSyncJobsResponse' :: ListSyncJobsResponse -> Maybe [SyncJobSummary]
$sel:nextToken:ListSyncJobsResponse' :: ListSyncJobsResponse -> Maybe Text
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe Text
nextToken
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Maybe [SyncJobSummary]
syncJobSummaries
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Int
httpStatus