{-# 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.CognitoIdentityProvider.DescribeUserPoolDomain -- Copyright : (c) 2013-2023 Brendan Hay -- License : Mozilla Public License, v. 2.0. -- Maintainer : Brendan Hay -- Stability : auto-generated -- Portability : non-portable (GHC extensions) -- -- Gets information about a domain. module Amazonka.CognitoIdentityProvider.DescribeUserPoolDomain ( -- * Creating a Request DescribeUserPoolDomain (..), newDescribeUserPoolDomain, -- * Request Lenses describeUserPoolDomain_domain, -- * Destructuring the Response DescribeUserPoolDomainResponse (..), newDescribeUserPoolDomainResponse, -- * Response Lenses describeUserPoolDomainResponse_domainDescription, describeUserPoolDomainResponse_httpStatus, ) where import Amazonka.CognitoIdentityProvider.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:/ 'newDescribeUserPoolDomain' smart constructor. data DescribeUserPoolDomain = DescribeUserPoolDomain' { -- | The domain string. For custom domains, this is the fully-qualified -- domain name, such as @auth.example.com@. For Amazon Cognito prefix -- domains, this is the prefix alone, such as @auth@. domain :: Prelude.Text } deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic) -- | -- Create a value of 'DescribeUserPoolDomain' with all optional fields omitted. -- -- Use or to modify other optional fields. -- -- The following record fields are available, with the corresponding lenses provided -- for backwards compatibility: -- -- 'domain', 'describeUserPoolDomain_domain' - The domain string. For custom domains, this is the fully-qualified -- domain name, such as @auth.example.com@. For Amazon Cognito prefix -- domains, this is the prefix alone, such as @auth@. newDescribeUserPoolDomain :: -- | 'domain' Prelude.Text -> DescribeUserPoolDomain newDescribeUserPoolDomain pDomain_ = DescribeUserPoolDomain' {domain = pDomain_} -- | The domain string. For custom domains, this is the fully-qualified -- domain name, such as @auth.example.com@. For Amazon Cognito prefix -- domains, this is the prefix alone, such as @auth@. describeUserPoolDomain_domain :: Lens.Lens' DescribeUserPoolDomain Prelude.Text describeUserPoolDomain_domain = Lens.lens (\DescribeUserPoolDomain' {domain} -> domain) (\s@DescribeUserPoolDomain' {} a -> s {domain = a} :: DescribeUserPoolDomain) instance Core.AWSRequest DescribeUserPoolDomain where type AWSResponse DescribeUserPoolDomain = DescribeUserPoolDomainResponse request overrides = Request.postJSON (overrides defaultService) response = Response.receiveJSON ( \s h x -> DescribeUserPoolDomainResponse' Prelude.<$> (x Data..?> "DomainDescription") Prelude.<*> (Prelude.pure (Prelude.fromEnum s)) ) instance Prelude.Hashable DescribeUserPoolDomain where hashWithSalt _salt DescribeUserPoolDomain' {..} = _salt `Prelude.hashWithSalt` domain instance Prelude.NFData DescribeUserPoolDomain where rnf DescribeUserPoolDomain' {..} = Prelude.rnf domain instance Data.ToHeaders DescribeUserPoolDomain where toHeaders = Prelude.const ( Prelude.mconcat [ "X-Amz-Target" Data.=# ( "AWSCognitoIdentityProviderService.DescribeUserPoolDomain" :: Prelude.ByteString ), "Content-Type" Data.=# ( "application/x-amz-json-1.1" :: Prelude.ByteString ) ] ) instance Data.ToJSON DescribeUserPoolDomain where toJSON DescribeUserPoolDomain' {..} = Data.object ( Prelude.catMaybes [Prelude.Just ("Domain" Data..= domain)] ) instance Data.ToPath DescribeUserPoolDomain where toPath = Prelude.const "/" instance Data.ToQuery DescribeUserPoolDomain where toQuery = Prelude.const Prelude.mempty -- | /See:/ 'newDescribeUserPoolDomainResponse' smart constructor. data DescribeUserPoolDomainResponse = DescribeUserPoolDomainResponse' { -- | A domain description object containing information about the domain. domainDescription :: Prelude.Maybe DomainDescriptionType, -- | The response's http status code. httpStatus :: Prelude.Int } deriving (Prelude.Eq, Prelude.Read, Prelude.Show, Prelude.Generic) -- | -- Create a value of 'DescribeUserPoolDomainResponse' with all optional fields omitted. -- -- Use or to modify other optional fields. -- -- The following record fields are available, with the corresponding lenses provided -- for backwards compatibility: -- -- 'domainDescription', 'describeUserPoolDomainResponse_domainDescription' - A domain description object containing information about the domain. -- -- 'httpStatus', 'describeUserPoolDomainResponse_httpStatus' - The response's http status code. newDescribeUserPoolDomainResponse :: -- | 'httpStatus' Prelude.Int -> DescribeUserPoolDomainResponse newDescribeUserPoolDomainResponse pHttpStatus_ = DescribeUserPoolDomainResponse' { domainDescription = Prelude.Nothing, httpStatus = pHttpStatus_ } -- | A domain description object containing information about the domain. describeUserPoolDomainResponse_domainDescription :: Lens.Lens' DescribeUserPoolDomainResponse (Prelude.Maybe DomainDescriptionType) describeUserPoolDomainResponse_domainDescription = Lens.lens (\DescribeUserPoolDomainResponse' {domainDescription} -> domainDescription) (\s@DescribeUserPoolDomainResponse' {} a -> s {domainDescription = a} :: DescribeUserPoolDomainResponse) -- | The response's http status code. describeUserPoolDomainResponse_httpStatus :: Lens.Lens' DescribeUserPoolDomainResponse Prelude.Int describeUserPoolDomainResponse_httpStatus = Lens.lens (\DescribeUserPoolDomainResponse' {httpStatus} -> httpStatus) (\s@DescribeUserPoolDomainResponse' {} a -> s {httpStatus = a} :: DescribeUserPoolDomainResponse) instance Prelude.NFData DescribeUserPoolDomainResponse where rnf DescribeUserPoolDomainResponse' {..} = Prelude.rnf domainDescription `Prelude.seq` Prelude.rnf httpStatus