{-# 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.MGN.DescribeJobs
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- Returns a list of Jobs. Use the JobsID and fromDate and toData filters
-- to limit which jobs are returned. The response is sorted by
-- creationDataTime - latest date first. Jobs are normally created by the
-- StartTest, StartCutover, and TerminateTargetInstances APIs. Jobs are
-- also created by DiagnosticLaunch and TerminateDiagnosticInstances, which
-- are APIs available only to *Support* and only used in response to
-- relevant support tickets.
--
-- This operation returns paginated results.
module Amazonka.MGN.DescribeJobs
  ( -- * Creating a Request
    DescribeJobs (..),
    newDescribeJobs,

    -- * Request Lenses
    describeJobs_filters,
    describeJobs_maxResults,
    describeJobs_nextToken,

    -- * Destructuring the Response
    DescribeJobsResponse (..),
    newDescribeJobsResponse,

    -- * Response Lenses
    describeJobsResponse_items,
    describeJobsResponse_nextToken,
    describeJobsResponse_httpStatus,
  )
where

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

-- | /See:/ 'newDescribeJobs' smart constructor.
data DescribeJobs = DescribeJobs'
  { -- | Request to describe Job log filters.
    DescribeJobs -> Maybe DescribeJobsRequestFilters
filters :: Prelude.Maybe DescribeJobsRequestFilters,
    -- | Request to describe job log items by max results.
    DescribeJobs -> Maybe Natural
maxResults :: Prelude.Maybe Prelude.Natural,
    -- | Request to describe job log items by next token.
    DescribeJobs -> Maybe Text
nextToken :: Prelude.Maybe Prelude.Text
  }
  deriving (DescribeJobs -> DescribeJobs -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: DescribeJobs -> DescribeJobs -> Bool
$c/= :: DescribeJobs -> DescribeJobs -> Bool
== :: DescribeJobs -> DescribeJobs -> Bool
$c== :: DescribeJobs -> DescribeJobs -> Bool
Prelude.Eq, ReadPrec [DescribeJobs]
ReadPrec DescribeJobs
Int -> ReadS DescribeJobs
ReadS [DescribeJobs]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [DescribeJobs]
$creadListPrec :: ReadPrec [DescribeJobs]
readPrec :: ReadPrec DescribeJobs
$creadPrec :: ReadPrec DescribeJobs
readList :: ReadS [DescribeJobs]
$creadList :: ReadS [DescribeJobs]
readsPrec :: Int -> ReadS DescribeJobs
$creadsPrec :: Int -> ReadS DescribeJobs
Prelude.Read, Int -> DescribeJobs -> ShowS
[DescribeJobs] -> ShowS
DescribeJobs -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [DescribeJobs] -> ShowS
$cshowList :: [DescribeJobs] -> ShowS
show :: DescribeJobs -> String
$cshow :: DescribeJobs -> String
showsPrec :: Int -> DescribeJobs -> ShowS
$cshowsPrec :: Int -> DescribeJobs -> ShowS
Prelude.Show, forall x. Rep DescribeJobs x -> DescribeJobs
forall x. DescribeJobs -> Rep DescribeJobs x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep DescribeJobs x -> DescribeJobs
$cfrom :: forall x. DescribeJobs -> Rep DescribeJobs x
Prelude.Generic)

-- |
-- Create a value of 'DescribeJobs' 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:
--
-- 'filters', 'describeJobs_filters' - Request to describe Job log filters.
--
-- 'maxResults', 'describeJobs_maxResults' - Request to describe job log items by max results.
--
-- 'nextToken', 'describeJobs_nextToken' - Request to describe job log items by next token.
newDescribeJobs ::
  DescribeJobs
newDescribeJobs :: DescribeJobs
newDescribeJobs =
  DescribeJobs'
    { $sel:filters:DescribeJobs' :: Maybe DescribeJobsRequestFilters
filters = forall a. Maybe a
Prelude.Nothing,
      $sel:maxResults:DescribeJobs' :: Maybe Natural
maxResults = forall a. Maybe a
Prelude.Nothing,
      $sel:nextToken:DescribeJobs' :: Maybe Text
nextToken = forall a. Maybe a
Prelude.Nothing
    }

-- | Request to describe Job log filters.
describeJobs_filters :: Lens.Lens' DescribeJobs (Prelude.Maybe DescribeJobsRequestFilters)
describeJobs_filters :: Lens' DescribeJobs (Maybe DescribeJobsRequestFilters)
describeJobs_filters = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeJobs' {Maybe DescribeJobsRequestFilters
filters :: Maybe DescribeJobsRequestFilters
$sel:filters:DescribeJobs' :: DescribeJobs -> Maybe DescribeJobsRequestFilters
filters} -> Maybe DescribeJobsRequestFilters
filters) (\s :: DescribeJobs
s@DescribeJobs' {} Maybe DescribeJobsRequestFilters
a -> DescribeJobs
s {$sel:filters:DescribeJobs' :: Maybe DescribeJobsRequestFilters
filters = Maybe DescribeJobsRequestFilters
a} :: DescribeJobs)

-- | Request to describe job log items by max results.
describeJobs_maxResults :: Lens.Lens' DescribeJobs (Prelude.Maybe Prelude.Natural)
describeJobs_maxResults :: Lens' DescribeJobs (Maybe Natural)
describeJobs_maxResults = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeJobs' {Maybe Natural
maxResults :: Maybe Natural
$sel:maxResults:DescribeJobs' :: DescribeJobs -> Maybe Natural
maxResults} -> Maybe Natural
maxResults) (\s :: DescribeJobs
s@DescribeJobs' {} Maybe Natural
a -> DescribeJobs
s {$sel:maxResults:DescribeJobs' :: Maybe Natural
maxResults = Maybe Natural
a} :: DescribeJobs)

-- | Request to describe job log items by next token.
describeJobs_nextToken :: Lens.Lens' DescribeJobs (Prelude.Maybe Prelude.Text)
describeJobs_nextToken :: Lens' DescribeJobs (Maybe Text)
describeJobs_nextToken = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeJobs' {Maybe Text
nextToken :: Maybe Text
$sel:nextToken:DescribeJobs' :: DescribeJobs -> Maybe Text
nextToken} -> Maybe Text
nextToken) (\s :: DescribeJobs
s@DescribeJobs' {} Maybe Text
a -> DescribeJobs
s {$sel:nextToken:DescribeJobs' :: Maybe Text
nextToken = Maybe Text
a} :: DescribeJobs)

instance Core.AWSPager DescribeJobs where
  page :: DescribeJobs -> AWSResponse DescribeJobs -> Maybe DescribeJobs
page DescribeJobs
rq AWSResponse DescribeJobs
rs
    | forall a. AWSTruncated a => a -> Bool
Core.stop
        ( AWSResponse DescribeJobs
rs
            forall s a. s -> Getting (First a) s a -> Maybe a
Lens.^? Lens' DescribeJobsResponse (Maybe Text)
describeJobsResponse_nextToken
            forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall a b. Prism (Maybe a) (Maybe b) a b
Lens._Just
        ) =
        forall a. Maybe a
Prelude.Nothing
    | forall a. AWSTruncated a => a -> Bool
Core.stop
        ( AWSResponse DescribeJobs
rs
            forall s a. s -> Getting (First a) s a -> Maybe a
Lens.^? Lens' DescribeJobsResponse (Maybe [Job])
describeJobsResponse_items
            forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall a b. Prism (Maybe a) (Maybe b) a b
Lens._Just
        ) =
        forall a. Maybe a
Prelude.Nothing
    | Bool
Prelude.otherwise =
        forall a. a -> Maybe a
Prelude.Just
          forall a b. (a -> b) -> a -> b
Prelude.$ DescribeJobs
rq
          forall a b. a -> (a -> b) -> b
Prelude.& Lens' DescribeJobs (Maybe Text)
describeJobs_nextToken
          forall s t a b. ASetter s t a b -> b -> s -> t
Lens..~ AWSResponse DescribeJobs
rs
          forall s a. s -> Getting (First a) s a -> Maybe a
Lens.^? Lens' DescribeJobsResponse (Maybe Text)
describeJobsResponse_nextToken
          forall b c a. (b -> c) -> (a -> b) -> a -> c
Prelude.. forall a b. Prism (Maybe a) (Maybe b) a b
Lens._Just

instance Core.AWSRequest DescribeJobs where
  type AWSResponse DescribeJobs = DescribeJobsResponse
  request :: (Service -> Service) -> DescribeJobs -> Request DescribeJobs
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 DescribeJobs
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse DescribeJobs)))
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 [Job] -> Maybe Text -> Int -> DescribeJobsResponse
DescribeJobsResponse'
            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
"items" 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.<*> (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.<*> (forall (f :: * -> *) a. Applicative f => a -> f a
Prelude.pure (forall a. Enum a => a -> Int
Prelude.fromEnum Int
s))
      )

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

instance Prelude.NFData DescribeJobs where
  rnf :: DescribeJobs -> ()
rnf DescribeJobs' {Maybe Natural
Maybe Text
Maybe DescribeJobsRequestFilters
nextToken :: Maybe Text
maxResults :: Maybe Natural
filters :: Maybe DescribeJobsRequestFilters
$sel:nextToken:DescribeJobs' :: DescribeJobs -> Maybe Text
$sel:maxResults:DescribeJobs' :: DescribeJobs -> Maybe Natural
$sel:filters:DescribeJobs' :: DescribeJobs -> Maybe DescribeJobsRequestFilters
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe DescribeJobsRequestFilters
filters
      seq :: forall a b. a -> b -> b
`Prelude.seq` 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

instance Data.ToHeaders DescribeJobs where
  toHeaders :: DescribeJobs -> 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 DescribeJobs where
  toJSON :: DescribeJobs -> Value
toJSON DescribeJobs' {Maybe Natural
Maybe Text
Maybe DescribeJobsRequestFilters
nextToken :: Maybe Text
maxResults :: Maybe Natural
filters :: Maybe DescribeJobsRequestFilters
$sel:nextToken:DescribeJobs' :: DescribeJobs -> Maybe Text
$sel:maxResults:DescribeJobs' :: DescribeJobs -> Maybe Natural
$sel:filters:DescribeJobs' :: DescribeJobs -> Maybe DescribeJobsRequestFilters
..} =
    [Pair] -> Value
Data.object
      ( forall a. [Maybe a] -> [a]
Prelude.catMaybes
          [ (Key
"filters" 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 DescribeJobsRequestFilters
filters,
            (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 DescribeJobs where
  toPath :: DescribeJobs -> ByteString
toPath = forall a b. a -> b -> a
Prelude.const ByteString
"/DescribeJobs"

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

-- | /See:/ 'newDescribeJobsResponse' smart constructor.
data DescribeJobsResponse = DescribeJobsResponse'
  { -- | Request to describe Job log items.
    DescribeJobsResponse -> Maybe [Job]
items :: Prelude.Maybe [Job],
    -- | Request to describe Job response by next token.
    DescribeJobsResponse -> Maybe Text
nextToken :: Prelude.Maybe Prelude.Text,
    -- | The response's http status code.
    DescribeJobsResponse -> Int
httpStatus :: Prelude.Int
  }
  deriving (DescribeJobsResponse -> DescribeJobsResponse -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: DescribeJobsResponse -> DescribeJobsResponse -> Bool
$c/= :: DescribeJobsResponse -> DescribeJobsResponse -> Bool
== :: DescribeJobsResponse -> DescribeJobsResponse -> Bool
$c== :: DescribeJobsResponse -> DescribeJobsResponse -> Bool
Prelude.Eq, Int -> DescribeJobsResponse -> ShowS
[DescribeJobsResponse] -> ShowS
DescribeJobsResponse -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [DescribeJobsResponse] -> ShowS
$cshowList :: [DescribeJobsResponse] -> ShowS
show :: DescribeJobsResponse -> String
$cshow :: DescribeJobsResponse -> String
showsPrec :: Int -> DescribeJobsResponse -> ShowS
$cshowsPrec :: Int -> DescribeJobsResponse -> ShowS
Prelude.Show, forall x. Rep DescribeJobsResponse x -> DescribeJobsResponse
forall x. DescribeJobsResponse -> Rep DescribeJobsResponse x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep DescribeJobsResponse x -> DescribeJobsResponse
$cfrom :: forall x. DescribeJobsResponse -> Rep DescribeJobsResponse x
Prelude.Generic)

-- |
-- Create a value of 'DescribeJobsResponse' 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:
--
-- 'items', 'describeJobsResponse_items' - Request to describe Job log items.
--
-- 'nextToken', 'describeJobsResponse_nextToken' - Request to describe Job response by next token.
--
-- 'httpStatus', 'describeJobsResponse_httpStatus' - The response's http status code.
newDescribeJobsResponse ::
  -- | 'httpStatus'
  Prelude.Int ->
  DescribeJobsResponse
newDescribeJobsResponse :: Int -> DescribeJobsResponse
newDescribeJobsResponse Int
pHttpStatus_ =
  DescribeJobsResponse'
    { $sel:items:DescribeJobsResponse' :: Maybe [Job]
items = forall a. Maybe a
Prelude.Nothing,
      $sel:nextToken:DescribeJobsResponse' :: Maybe Text
nextToken = forall a. Maybe a
Prelude.Nothing,
      $sel:httpStatus:DescribeJobsResponse' :: Int
httpStatus = Int
pHttpStatus_
    }

-- | Request to describe Job log items.
describeJobsResponse_items :: Lens.Lens' DescribeJobsResponse (Prelude.Maybe [Job])
describeJobsResponse_items :: Lens' DescribeJobsResponse (Maybe [Job])
describeJobsResponse_items = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeJobsResponse' {Maybe [Job]
items :: Maybe [Job]
$sel:items:DescribeJobsResponse' :: DescribeJobsResponse -> Maybe [Job]
items} -> Maybe [Job]
items) (\s :: DescribeJobsResponse
s@DescribeJobsResponse' {} Maybe [Job]
a -> DescribeJobsResponse
s {$sel:items:DescribeJobsResponse' :: Maybe [Job]
items = Maybe [Job]
a} :: DescribeJobsResponse) 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

-- | Request to describe Job response by next token.
describeJobsResponse_nextToken :: Lens.Lens' DescribeJobsResponse (Prelude.Maybe Prelude.Text)
describeJobsResponse_nextToken :: Lens' DescribeJobsResponse (Maybe Text)
describeJobsResponse_nextToken = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeJobsResponse' {Maybe Text
nextToken :: Maybe Text
$sel:nextToken:DescribeJobsResponse' :: DescribeJobsResponse -> Maybe Text
nextToken} -> Maybe Text
nextToken) (\s :: DescribeJobsResponse
s@DescribeJobsResponse' {} Maybe Text
a -> DescribeJobsResponse
s {$sel:nextToken:DescribeJobsResponse' :: Maybe Text
nextToken = Maybe Text
a} :: DescribeJobsResponse)

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

instance Prelude.NFData DescribeJobsResponse where
  rnf :: DescribeJobsResponse -> ()
rnf DescribeJobsResponse' {Int
Maybe [Job]
Maybe Text
httpStatus :: Int
nextToken :: Maybe Text
items :: Maybe [Job]
$sel:httpStatus:DescribeJobsResponse' :: DescribeJobsResponse -> Int
$sel:nextToken:DescribeJobsResponse' :: DescribeJobsResponse -> Maybe Text
$sel:items:DescribeJobsResponse' :: DescribeJobsResponse -> Maybe [Job]
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe [Job]
items
      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 Int
httpStatus