libZSservicesZSamazonka-quicksightZSamazonka-quicksight
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.QuickSight.DescribeNamespace

Description

Describes the current namespace.

Synopsis

Creating a Request

data DescribeNamespace Source #

See: newDescribeNamespace smart constructor.

Constructors

DescribeNamespace' 

Fields

  • awsAccountId :: Text

    The ID for the Amazon Web Services account that contains the Amazon QuickSight namespace that you want to describe.

  • namespace :: Text

    The namespace that you want to describe.

Instances

Instances details
Eq DescribeNamespace Source # 
Instance details

Defined in Amazonka.QuickSight.DescribeNamespace

Methods

(==) :: DescribeNamespace -> DescribeNamespace -> Bool #

(/=) :: DescribeNamespace -> DescribeNamespace -> Bool #

Read DescribeNamespace Source # 
Instance details

Defined in Amazonka.QuickSight.DescribeNamespace

Methods

readsPrec :: Int -> ReadS DescribeNamespace #

readList :: ReadS [DescribeNamespace] #

readPrec :: ReadPrec DescribeNamespace #

readListPrec :: ReadPrec [DescribeNamespace] #

Show DescribeNamespace Source # 
Instance details

Defined in Amazonka.QuickSight.DescribeNamespace

Methods

showsPrec :: Int -> DescribeNamespace -> ShowS #

show :: DescribeNamespace -> String #

showList :: [DescribeNamespace] -> ShowS #

Generic DescribeNamespace Source # 
Instance details

Defined in Amazonka.QuickSight.DescribeNamespace

Associated Types

type Rep DescribeNamespace :: Type -> Type #

Methods

from :: DescribeNamespace -> Rep DescribeNamespace x #

to :: Rep DescribeNamespace x -> DescribeNamespace #

NFData DescribeNamespace Source # 
Instance details

Defined in Amazonka.QuickSight.DescribeNamespace

Methods

rnf :: DescribeNamespace -> () #

Hashable DescribeNamespace Source # 
Instance details

Defined in Amazonka.QuickSight.DescribeNamespace

Methods

hashWithSalt :: Int -> DescribeNamespace -> Int #

hash :: DescribeNamespace -> Int #

AWSRequest DescribeNamespace Source # 
Instance details

Defined in Amazonka.QuickSight.DescribeNamespace

Associated Types

type AWSResponse DescribeNamespace #

Methods

request :: DescribeNamespace -> Request DescribeNamespace #

response :: MonadResource m => Logger -> Service -> Proxy DescribeNamespace -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeNamespace))) #

ToHeaders DescribeNamespace Source # 
Instance details

Defined in Amazonka.QuickSight.DescribeNamespace

Methods

toHeaders :: DescribeNamespace -> [Header] #

ToPath DescribeNamespace Source # 
Instance details

Defined in Amazonka.QuickSight.DescribeNamespace

Methods

toPath :: DescribeNamespace -> ByteString #

ToQuery DescribeNamespace Source # 
Instance details

Defined in Amazonka.QuickSight.DescribeNamespace

Methods

toQuery :: DescribeNamespace -> QueryString #

type Rep DescribeNamespace Source # 
Instance details

Defined in Amazonka.QuickSight.DescribeNamespace

type Rep DescribeNamespace = D1 ('MetaData "DescribeNamespace" "Amazonka.QuickSight.DescribeNamespace" "libZSservicesZSamazonka-quicksightZSamazonka-quicksight" 'False) (C1 ('MetaCons "DescribeNamespace'" 'PrefixI 'True) (S1 ('MetaSel ('Just "awsAccountId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "namespace") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))
type AWSResponse DescribeNamespace Source # 
Instance details

Defined in Amazonka.QuickSight.DescribeNamespace

type AWSResponse DescribeNamespace = DescribeNamespaceResponse

newDescribeNamespace Source #

Arguments

:: Text

$sel:awsAccountId:DescribeNamespace'

-> Text

$sel:namespace:DescribeNamespace'

-> DescribeNamespace 

Create a value of DescribeNamespace 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:awsAccountId:DescribeNamespace', describeNamespace_awsAccountId - The ID for the Amazon Web Services account that contains the Amazon QuickSight namespace that you want to describe.

$sel:namespace:DescribeNamespace', describeNamespace_namespace - The namespace that you want to describe.

Request Lenses

describeNamespace_awsAccountId :: Lens' DescribeNamespace Text Source #

The ID for the Amazon Web Services account that contains the Amazon QuickSight namespace that you want to describe.

describeNamespace_namespace :: Lens' DescribeNamespace Text Source #

The namespace that you want to describe.

Destructuring the Response

data DescribeNamespaceResponse Source #

See: newDescribeNamespaceResponse smart constructor.

Constructors

DescribeNamespaceResponse' 

Fields

  • requestId :: Maybe Text

    The Amazon Web Services request ID for this operation.

  • namespace :: Maybe NamespaceInfoV2

    The information about the namespace that you're describing. The response includes the namespace ARN, name, Amazon Web Services Region, creation status, and identity store. DescribeNamespace also works for namespaces that are in the process of being created. For incomplete namespaces, this API operation lists the namespace error types and messages associated with the creation process.

  • status :: Int

    The HTTP status of the request.

Instances

Instances details
Eq DescribeNamespaceResponse Source # 
Instance details

Defined in Amazonka.QuickSight.DescribeNamespace

Methods

(==) :: DescribeNamespaceResponse -> DescribeNamespaceResponse -> Bool #

(/=) :: DescribeNamespaceResponse -> DescribeNamespaceResponse -> Bool #

Read DescribeNamespaceResponse Source # 
Instance details

Defined in Amazonka.QuickSight.DescribeNamespace

Methods

readsPrec :: Int -> ReadS DescribeNamespaceResponse #

readList :: ReadS [DescribeNamespaceResponse] #

readPrec :: ReadPrec DescribeNamespaceResponse #

readListPrec :: ReadPrec [DescribeNamespaceResponse] #

Show DescribeNamespaceResponse Source # 
Instance details

Defined in Amazonka.QuickSight.DescribeNamespace

Methods

showsPrec :: Int -> DescribeNamespaceResponse -> ShowS #

show :: DescribeNamespaceResponse -> String #

showList :: [DescribeNamespaceResponse] -> ShowS #

Generic DescribeNamespaceResponse Source # 
Instance details

Defined in Amazonka.QuickSight.DescribeNamespace

Associated Types

type Rep DescribeNamespaceResponse :: Type -> Type #

Methods

from :: DescribeNamespaceResponse -> Rep DescribeNamespaceResponse x #

to :: Rep DescribeNamespaceResponse x -> DescribeNamespaceResponse #

NFData DescribeNamespaceResponse Source # 
Instance details

Defined in Amazonka.QuickSight.DescribeNamespace

Methods

rnf :: DescribeNamespaceResponse -> () #

type Rep DescribeNamespaceResponse Source # 
Instance details

Defined in Amazonka.QuickSight.DescribeNamespace

type Rep DescribeNamespaceResponse = D1 ('MetaData "DescribeNamespaceResponse" "Amazonka.QuickSight.DescribeNamespace" "libZSservicesZSamazonka-quicksightZSamazonka-quicksight" 'False) (C1 ('MetaCons "DescribeNamespaceResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "requestId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "namespace") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe NamespaceInfoV2)) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeNamespaceResponse Source #

Arguments

:: Int

$sel:status:DescribeNamespaceResponse'

-> DescribeNamespaceResponse 

Create a value of DescribeNamespaceResponse 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:requestId:DescribeNamespaceResponse', describeNamespaceResponse_requestId - The Amazon Web Services request ID for this operation.

$sel:namespace:DescribeNamespace', describeNamespaceResponse_namespace - The information about the namespace that you're describing. The response includes the namespace ARN, name, Amazon Web Services Region, creation status, and identity store. DescribeNamespace also works for namespaces that are in the process of being created. For incomplete namespaces, this API operation lists the namespace error types and messages associated with the creation process.

$sel:status:DescribeNamespaceResponse', describeNamespaceResponse_status - The HTTP status of the request.

Response Lenses

describeNamespaceResponse_requestId :: Lens' DescribeNamespaceResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

describeNamespaceResponse_namespace :: Lens' DescribeNamespaceResponse (Maybe NamespaceInfoV2) Source #

The information about the namespace that you're describing. The response includes the namespace ARN, name, Amazon Web Services Region, creation status, and identity store. DescribeNamespace also works for namespaces that are in the process of being created. For incomplete namespaces, this API operation lists the namespace error types and messages associated with the creation process.

describeNamespaceResponse_status :: Lens' DescribeNamespaceResponse Int Source #

The HTTP status of the request.