amazonka-organizations-2.0: Amazon Organizations SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.Organizations.DescribeAccount

Description

Retrieves Organizations-related information about the specified account.

This operation can be called only from the organization's management account or by a member account that is a delegated administrator for an Amazon Web Services service.

Synopsis

Creating a Request

data DescribeAccount Source #

See: newDescribeAccount smart constructor.

Constructors

DescribeAccount' 

Fields

  • accountId :: Text

    The unique identifier (ID) of the Amazon Web Services account that you want information about. You can get the ID from the ListAccounts or ListAccountsForParent operations.

    The regex pattern for an account ID string requires exactly 12 digits.

Instances

Instances details
ToJSON DescribeAccount Source # 
Instance details

Defined in Amazonka.Organizations.DescribeAccount

Methods

toJSON :: DescribeAccount -> Value #

toEncoding :: DescribeAccount -> Encoding #

toJSONList :: [DescribeAccount] -> Value #

toEncodingList :: [DescribeAccount] -> Encoding #

ToHeaders DescribeAccount Source # 
Instance details

Defined in Amazonka.Organizations.DescribeAccount

Methods

toHeaders :: DescribeAccount -> [Header] #

ToPath DescribeAccount Source # 
Instance details

Defined in Amazonka.Organizations.DescribeAccount

Methods

toPath :: DescribeAccount -> ByteString #

ToQuery DescribeAccount Source # 
Instance details

Defined in Amazonka.Organizations.DescribeAccount

Methods

toQuery :: DescribeAccount -> QueryString #

AWSRequest DescribeAccount Source # 
Instance details

Defined in Amazonka.Organizations.DescribeAccount

Associated Types

type AWSResponse DescribeAccount #

Methods

request :: (Service -> Service) -> DescribeAccount -> Request DescribeAccount #

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeAccount -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeAccount))) #

Generic DescribeAccount Source # 
Instance details

Defined in Amazonka.Organizations.DescribeAccount

Associated Types

type Rep DescribeAccount :: Type -> Type #

Methods

from :: DescribeAccount -> Rep DescribeAccount x #

to :: Rep DescribeAccount x -> DescribeAccount #

Read DescribeAccount Source # 
Instance details

Defined in Amazonka.Organizations.DescribeAccount

Methods

readsPrec :: Int -> ReadS DescribeAccount #

readList :: ReadS [DescribeAccount] #

readPrec :: ReadPrec DescribeAccount #

readListPrec :: ReadPrec [DescribeAccount] #

Show DescribeAccount Source # 
Instance details

Defined in Amazonka.Organizations.DescribeAccount

Methods

showsPrec :: Int -> DescribeAccount -> ShowS #

show :: DescribeAccount -> String #

showList :: [DescribeAccount] -> ShowS #

NFData DescribeAccount Source # 
Instance details

Defined in Amazonka.Organizations.DescribeAccount

Methods

rnf :: DescribeAccount -> () #

Eq DescribeAccount Source # 
Instance details

Defined in Amazonka.Organizations.DescribeAccount

Methods

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

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

Hashable DescribeAccount Source # 
Instance details

Defined in Amazonka.Organizations.DescribeAccount

Methods

hashWithSalt :: Int -> DescribeAccount -> Int #

hash :: DescribeAccount -> Int #

type AWSResponse DescribeAccount Source # 
Instance details

Defined in Amazonka.Organizations.DescribeAccount

type AWSResponse DescribeAccount = DescribeAccountResponse
type Rep DescribeAccount Source # 
Instance details

Defined in Amazonka.Organizations.DescribeAccount

type Rep DescribeAccount = D1 ('MetaData "DescribeAccount" "Amazonka.Organizations.DescribeAccount" "amazonka-organizations-2.0-JONpdX4PtttLcKxQshpOlA" 'False) (C1 ('MetaCons "DescribeAccount'" 'PrefixI 'True) (S1 ('MetaSel ('Just "accountId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDescribeAccount Source #

Arguments

:: Text

DescribeAccount

-> DescribeAccount 

Create a value of DescribeAccount 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:

DescribeAccount, describeAccount_accountId - The unique identifier (ID) of the Amazon Web Services account that you want information about. You can get the ID from the ListAccounts or ListAccountsForParent operations.

The regex pattern for an account ID string requires exactly 12 digits.

Request Lenses

describeAccount_accountId :: Lens' DescribeAccount Text Source #

The unique identifier (ID) of the Amazon Web Services account that you want information about. You can get the ID from the ListAccounts or ListAccountsForParent operations.

The regex pattern for an account ID string requires exactly 12 digits.

Destructuring the Response

data DescribeAccountResponse Source #

See: newDescribeAccountResponse smart constructor.

Constructors

DescribeAccountResponse' 

Fields

Instances

Instances details
Generic DescribeAccountResponse Source # 
Instance details

Defined in Amazonka.Organizations.DescribeAccount

Associated Types

type Rep DescribeAccountResponse :: Type -> Type #

Methods

from :: DescribeAccountResponse -> Rep DescribeAccountResponse x #

to :: Rep DescribeAccountResponse x -> DescribeAccountResponse #

Show DescribeAccountResponse Source # 
Instance details

Defined in Amazonka.Organizations.DescribeAccount

Methods

showsPrec :: Int -> DescribeAccountResponse -> ShowS #

show :: DescribeAccountResponse -> String #

showList :: [DescribeAccountResponse] -> ShowS #

NFData DescribeAccountResponse Source # 
Instance details

Defined in Amazonka.Organizations.DescribeAccount

Methods

rnf :: DescribeAccountResponse -> () #

Eq DescribeAccountResponse Source # 
Instance details

Defined in Amazonka.Organizations.DescribeAccount

Methods

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

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

type Rep DescribeAccountResponse Source # 
Instance details

Defined in Amazonka.Organizations.DescribeAccount

type Rep DescribeAccountResponse = D1 ('MetaData "DescribeAccountResponse" "Amazonka.Organizations.DescribeAccount" "amazonka-organizations-2.0-JONpdX4PtttLcKxQshpOlA" 'False) (C1 ('MetaCons "DescribeAccountResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "account") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Account)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDescribeAccountResponse Source #

Arguments

:: Int

$sel:httpStatus:DescribeAccountResponse'

-> DescribeAccountResponse 

Create a value of DescribeAccountResponse 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:account:DescribeAccountResponse', describeAccountResponse_account - A structure that contains information about the requested account.

$sel:httpStatus:DescribeAccountResponse', describeAccountResponse_httpStatus - The response's http status code.

Response Lenses

describeAccountResponse_account :: Lens' DescribeAccountResponse (Maybe Account) Source #

A structure that contains information about the requested account.

describeAccountResponse_httpStatus :: Lens' DescribeAccountResponse Int Source #

The response's http status code.