{-# 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.Connect.DescribeInstance
-- Copyright   : (c) 2013-2023 Brendan Hay
-- License     : Mozilla Public License, v. 2.0.
-- Maintainer  : Brendan Hay
-- Stability   : auto-generated
-- Portability : non-portable (GHC extensions)
--
-- This API is in preview release for Amazon Connect and is subject to
-- change.
--
-- Returns the current state of the specified instance identifier. It
-- tracks the instance while it is being created and returns an error
-- status, if applicable.
--
-- If an instance is not created successfully, the instance status reason
-- field returns details relevant to the reason. The instance in a failed
-- state is returned only for 24 hours after the CreateInstance API was
-- invoked.
module Amazonka.Connect.DescribeInstance
  ( -- * Creating a Request
    DescribeInstance (..),
    newDescribeInstance,

    -- * Request Lenses
    describeInstance_instanceId,

    -- * Destructuring the Response
    DescribeInstanceResponse (..),
    newDescribeInstanceResponse,

    -- * Response Lenses
    describeInstanceResponse_instance,
    describeInstanceResponse_httpStatus,
  )
where

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

-- | /See:/ 'newDescribeInstance' smart constructor.
data DescribeInstance = DescribeInstance'
  { -- | The identifier of the Amazon Connect instance. You can find the
    -- instanceId in the ARN of the instance.
    DescribeInstance -> Text
instanceId :: Prelude.Text
  }
  deriving (DescribeInstance -> DescribeInstance -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: DescribeInstance -> DescribeInstance -> Bool
$c/= :: DescribeInstance -> DescribeInstance -> Bool
== :: DescribeInstance -> DescribeInstance -> Bool
$c== :: DescribeInstance -> DescribeInstance -> Bool
Prelude.Eq, ReadPrec [DescribeInstance]
ReadPrec DescribeInstance
Int -> ReadS DescribeInstance
ReadS [DescribeInstance]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [DescribeInstance]
$creadListPrec :: ReadPrec [DescribeInstance]
readPrec :: ReadPrec DescribeInstance
$creadPrec :: ReadPrec DescribeInstance
readList :: ReadS [DescribeInstance]
$creadList :: ReadS [DescribeInstance]
readsPrec :: Int -> ReadS DescribeInstance
$creadsPrec :: Int -> ReadS DescribeInstance
Prelude.Read, Int -> DescribeInstance -> ShowS
[DescribeInstance] -> ShowS
DescribeInstance -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [DescribeInstance] -> ShowS
$cshowList :: [DescribeInstance] -> ShowS
show :: DescribeInstance -> String
$cshow :: DescribeInstance -> String
showsPrec :: Int -> DescribeInstance -> ShowS
$cshowsPrec :: Int -> DescribeInstance -> ShowS
Prelude.Show, forall x. Rep DescribeInstance x -> DescribeInstance
forall x. DescribeInstance -> Rep DescribeInstance x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep DescribeInstance x -> DescribeInstance
$cfrom :: forall x. DescribeInstance -> Rep DescribeInstance x
Prelude.Generic)

-- |
-- Create a value of 'DescribeInstance' 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:
--
-- 'instanceId', 'describeInstance_instanceId' - The identifier of the Amazon Connect instance. You can find the
-- instanceId in the ARN of the instance.
newDescribeInstance ::
  -- | 'instanceId'
  Prelude.Text ->
  DescribeInstance
newDescribeInstance :: Text -> DescribeInstance
newDescribeInstance Text
pInstanceId_ =
  DescribeInstance' {$sel:instanceId:DescribeInstance' :: Text
instanceId = Text
pInstanceId_}

-- | The identifier of the Amazon Connect instance. You can find the
-- instanceId in the ARN of the instance.
describeInstance_instanceId :: Lens.Lens' DescribeInstance Prelude.Text
describeInstance_instanceId :: Lens' DescribeInstance Text
describeInstance_instanceId = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeInstance' {Text
instanceId :: Text
$sel:instanceId:DescribeInstance' :: DescribeInstance -> Text
instanceId} -> Text
instanceId) (\s :: DescribeInstance
s@DescribeInstance' {} Text
a -> DescribeInstance
s {$sel:instanceId:DescribeInstance' :: Text
instanceId = Text
a} :: DescribeInstance)

instance Core.AWSRequest DescribeInstance where
  type
    AWSResponse DescribeInstance =
      DescribeInstanceResponse
  request :: (Service -> Service)
-> DescribeInstance -> Request DescribeInstance
request Service -> Service
overrides =
    forall a. ToRequest a => Service -> a -> Request a
Request.get (Service -> Service
overrides Service
defaultService)
  response :: forall (m :: * -> *).
MonadResource m =>
(ByteStringLazy -> IO ByteStringLazy)
-> Service
-> Proxy DescribeInstance
-> ClientResponse ClientBody
-> m (Either Error (ClientResponse (AWSResponse DescribeInstance)))
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 Instance -> Int -> DescribeInstanceResponse
DescribeInstanceResponse'
            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
"Instance")
            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 DescribeInstance where
  hashWithSalt :: Int -> DescribeInstance -> Int
hashWithSalt Int
_salt DescribeInstance' {Text
instanceId :: Text
$sel:instanceId:DescribeInstance' :: DescribeInstance -> Text
..} =
    Int
_salt forall a. Hashable a => Int -> a -> Int
`Prelude.hashWithSalt` Text
instanceId

instance Prelude.NFData DescribeInstance where
  rnf :: DescribeInstance -> ()
rnf DescribeInstance' {Text
instanceId :: Text
$sel:instanceId:DescribeInstance' :: DescribeInstance -> Text
..} = forall a. NFData a => a -> ()
Prelude.rnf Text
instanceId

instance Data.ToHeaders DescribeInstance where
  toHeaders :: DescribeInstance -> 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.ToPath DescribeInstance where
  toPath :: DescribeInstance -> ByteString
toPath DescribeInstance' {Text
instanceId :: Text
$sel:instanceId:DescribeInstance' :: DescribeInstance -> Text
..} =
    forall a. Monoid a => [a] -> a
Prelude.mconcat
      [ByteString
"/instance/", forall a. ToByteString a => a -> ByteString
Data.toBS Text
instanceId]

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

-- | /See:/ 'newDescribeInstanceResponse' smart constructor.
data DescribeInstanceResponse = DescribeInstanceResponse'
  { -- | The name of the instance.
    DescribeInstanceResponse -> Maybe Instance
instance' :: Prelude.Maybe Instance,
    -- | The response's http status code.
    DescribeInstanceResponse -> Int
httpStatus :: Prelude.Int
  }
  deriving (DescribeInstanceResponse -> DescribeInstanceResponse -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: DescribeInstanceResponse -> DescribeInstanceResponse -> Bool
$c/= :: DescribeInstanceResponse -> DescribeInstanceResponse -> Bool
== :: DescribeInstanceResponse -> DescribeInstanceResponse -> Bool
$c== :: DescribeInstanceResponse -> DescribeInstanceResponse -> Bool
Prelude.Eq, Int -> DescribeInstanceResponse -> ShowS
[DescribeInstanceResponse] -> ShowS
DescribeInstanceResponse -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [DescribeInstanceResponse] -> ShowS
$cshowList :: [DescribeInstanceResponse] -> ShowS
show :: DescribeInstanceResponse -> String
$cshow :: DescribeInstanceResponse -> String
showsPrec :: Int -> DescribeInstanceResponse -> ShowS
$cshowsPrec :: Int -> DescribeInstanceResponse -> ShowS
Prelude.Show, forall x.
Rep DescribeInstanceResponse x -> DescribeInstanceResponse
forall x.
DescribeInstanceResponse -> Rep DescribeInstanceResponse x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x.
Rep DescribeInstanceResponse x -> DescribeInstanceResponse
$cfrom :: forall x.
DescribeInstanceResponse -> Rep DescribeInstanceResponse x
Prelude.Generic)

-- |
-- Create a value of 'DescribeInstanceResponse' 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:
--
-- 'instance'', 'describeInstanceResponse_instance' - The name of the instance.
--
-- 'httpStatus', 'describeInstanceResponse_httpStatus' - The response's http status code.
newDescribeInstanceResponse ::
  -- | 'httpStatus'
  Prelude.Int ->
  DescribeInstanceResponse
newDescribeInstanceResponse :: Int -> DescribeInstanceResponse
newDescribeInstanceResponse Int
pHttpStatus_ =
  DescribeInstanceResponse'
    { $sel:instance':DescribeInstanceResponse' :: Maybe Instance
instance' =
        forall a. Maybe a
Prelude.Nothing,
      $sel:httpStatus:DescribeInstanceResponse' :: Int
httpStatus = Int
pHttpStatus_
    }

-- | The name of the instance.
describeInstanceResponse_instance :: Lens.Lens' DescribeInstanceResponse (Prelude.Maybe Instance)
describeInstanceResponse_instance :: Lens' DescribeInstanceResponse (Maybe Instance)
describeInstanceResponse_instance = forall s a b t. (s -> a) -> (s -> b -> t) -> Lens s t a b
Lens.lens (\DescribeInstanceResponse' {Maybe Instance
instance' :: Maybe Instance
$sel:instance':DescribeInstanceResponse' :: DescribeInstanceResponse -> Maybe Instance
instance'} -> Maybe Instance
instance') (\s :: DescribeInstanceResponse
s@DescribeInstanceResponse' {} Maybe Instance
a -> DescribeInstanceResponse
s {$sel:instance':DescribeInstanceResponse' :: Maybe Instance
instance' = Maybe Instance
a} :: DescribeInstanceResponse)

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

instance Prelude.NFData DescribeInstanceResponse where
  rnf :: DescribeInstanceResponse -> ()
rnf DescribeInstanceResponse' {Int
Maybe Instance
httpStatus :: Int
instance' :: Maybe Instance
$sel:httpStatus:DescribeInstanceResponse' :: DescribeInstanceResponse -> Int
$sel:instance':DescribeInstanceResponse' :: DescribeInstanceResponse -> Maybe Instance
..} =
    forall a. NFData a => a -> ()
Prelude.rnf Maybe Instance
instance'
      seq :: forall a b. a -> b -> b
`Prelude.seq` forall a. NFData a => a -> ()
Prelude.rnf Int
httpStatus