libZSservicesZSamazonka-organizationsZSamazonka-organizations
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.Organizations.DescribeOrganization

Description

Retrieves information about the organization that the user's account belongs to.

This operation can be called from any account in the organization.

Even if a policy type is shown as available in the organization, you can disable it separately at the root level with DisablePolicyType. Use ListRoots to see the status of policy types for a specified root.

Synopsis

Creating a Request

data DescribeOrganization Source #

See: newDescribeOrganization smart constructor.

Constructors

DescribeOrganization' 

Instances

Instances details
Eq DescribeOrganization Source # 
Instance details

Defined in Amazonka.Organizations.DescribeOrganization

Read DescribeOrganization Source # 
Instance details

Defined in Amazonka.Organizations.DescribeOrganization

Show DescribeOrganization Source # 
Instance details

Defined in Amazonka.Organizations.DescribeOrganization

Generic DescribeOrganization Source # 
Instance details

Defined in Amazonka.Organizations.DescribeOrganization

Associated Types

type Rep DescribeOrganization :: Type -> Type #

NFData DescribeOrganization Source # 
Instance details

Defined in Amazonka.Organizations.DescribeOrganization

Methods

rnf :: DescribeOrganization -> () #

Hashable DescribeOrganization Source # 
Instance details

Defined in Amazonka.Organizations.DescribeOrganization

ToJSON DescribeOrganization Source # 
Instance details

Defined in Amazonka.Organizations.DescribeOrganization

AWSRequest DescribeOrganization Source # 
Instance details

Defined in Amazonka.Organizations.DescribeOrganization

Associated Types

type AWSResponse DescribeOrganization #

ToHeaders DescribeOrganization Source # 
Instance details

Defined in Amazonka.Organizations.DescribeOrganization

ToPath DescribeOrganization Source # 
Instance details

Defined in Amazonka.Organizations.DescribeOrganization

ToQuery DescribeOrganization Source # 
Instance details

Defined in Amazonka.Organizations.DescribeOrganization

type Rep DescribeOrganization Source # 
Instance details

Defined in Amazonka.Organizations.DescribeOrganization

type Rep DescribeOrganization = D1 ('MetaData "DescribeOrganization" "Amazonka.Organizations.DescribeOrganization" "libZSservicesZSamazonka-organizationsZSamazonka-organizations" 'False) (C1 ('MetaCons "DescribeOrganization'" 'PrefixI 'False) (U1 :: Type -> Type))
type AWSResponse DescribeOrganization Source # 
Instance details

Defined in Amazonka.Organizations.DescribeOrganization

newDescribeOrganization :: DescribeOrganization Source #

Create a value of DescribeOrganization with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

Destructuring the Response

data DescribeOrganizationResponse Source #

See: newDescribeOrganizationResponse smart constructor.

Constructors

DescribeOrganizationResponse' 

Fields

  • organization :: Maybe Organization

    A structure that contains information about the organization.

    The AvailablePolicyTypes part of the response is deprecated, and you shouldn't use it in your apps. It doesn't include any policy type supported by Organizations other than SCPs. To determine which policy types are enabled in your organization, use the ListRoots operation.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Eq DescribeOrganizationResponse Source # 
Instance details

Defined in Amazonka.Organizations.DescribeOrganization

Show DescribeOrganizationResponse Source # 
Instance details

Defined in Amazonka.Organizations.DescribeOrganization

Generic DescribeOrganizationResponse Source # 
Instance details

Defined in Amazonka.Organizations.DescribeOrganization

Associated Types

type Rep DescribeOrganizationResponse :: Type -> Type #

NFData DescribeOrganizationResponse Source # 
Instance details

Defined in Amazonka.Organizations.DescribeOrganization

type Rep DescribeOrganizationResponse Source # 
Instance details

Defined in Amazonka.Organizations.DescribeOrganization

type Rep DescribeOrganizationResponse = D1 ('MetaData "DescribeOrganizationResponse" "Amazonka.Organizations.DescribeOrganization" "libZSservicesZSamazonka-organizationsZSamazonka-organizations" 'False) (C1 ('MetaCons "DescribeOrganizationResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "organization") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Organization)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newDescribeOrganizationResponse Source #

Create a value of DescribeOrganizationResponse 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:organization:DescribeOrganizationResponse', describeOrganizationResponse_organization - A structure that contains information about the organization.

The AvailablePolicyTypes part of the response is deprecated, and you shouldn't use it in your apps. It doesn't include any policy type supported by Organizations other than SCPs. To determine which policy types are enabled in your organization, use the ListRoots operation.

$sel:httpStatus:DescribeOrganizationResponse', describeOrganizationResponse_httpStatus - The response's http status code.

Response Lenses

describeOrganizationResponse_organization :: Lens' DescribeOrganizationResponse (Maybe Organization) Source #

A structure that contains information about the organization.

The AvailablePolicyTypes part of the response is deprecated, and you shouldn't use it in your apps. It doesn't include any policy type supported by Organizations other than SCPs. To determine which policy types are enabled in your organization, use the ListRoots operation.