amazonka-compute-optimizer-2.0: Amazon Compute Optimizer 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.ComputeOptimizer.GetEnrollmentStatus

Description

Returns the enrollment (opt in) status of an account to the Compute Optimizer service.

If the account is the management account of an organization, this action also confirms the enrollment status of member accounts of the organization. Use the GetEnrollmentStatusesForOrganization action to get detailed information about the enrollment status of member accounts of an organization.

Synopsis

Creating a Request

data GetEnrollmentStatus Source #

See: newGetEnrollmentStatus smart constructor.

Constructors

GetEnrollmentStatus' 

Instances

Instances details
ToJSON GetEnrollmentStatus Source # 
Instance details

Defined in Amazonka.ComputeOptimizer.GetEnrollmentStatus

ToHeaders GetEnrollmentStatus Source # 
Instance details

Defined in Amazonka.ComputeOptimizer.GetEnrollmentStatus

ToPath GetEnrollmentStatus Source # 
Instance details

Defined in Amazonka.ComputeOptimizer.GetEnrollmentStatus

ToQuery GetEnrollmentStatus Source # 
Instance details

Defined in Amazonka.ComputeOptimizer.GetEnrollmentStatus

AWSRequest GetEnrollmentStatus Source # 
Instance details

Defined in Amazonka.ComputeOptimizer.GetEnrollmentStatus

Associated Types

type AWSResponse GetEnrollmentStatus #

Generic GetEnrollmentStatus Source # 
Instance details

Defined in Amazonka.ComputeOptimizer.GetEnrollmentStatus

Associated Types

type Rep GetEnrollmentStatus :: Type -> Type #

Read GetEnrollmentStatus Source # 
Instance details

Defined in Amazonka.ComputeOptimizer.GetEnrollmentStatus

Show GetEnrollmentStatus Source # 
Instance details

Defined in Amazonka.ComputeOptimizer.GetEnrollmentStatus

NFData GetEnrollmentStatus Source # 
Instance details

Defined in Amazonka.ComputeOptimizer.GetEnrollmentStatus

Methods

rnf :: GetEnrollmentStatus -> () #

Eq GetEnrollmentStatus Source # 
Instance details

Defined in Amazonka.ComputeOptimizer.GetEnrollmentStatus

Hashable GetEnrollmentStatus Source # 
Instance details

Defined in Amazonka.ComputeOptimizer.GetEnrollmentStatus

type AWSResponse GetEnrollmentStatus Source # 
Instance details

Defined in Amazonka.ComputeOptimizer.GetEnrollmentStatus

type Rep GetEnrollmentStatus Source # 
Instance details

Defined in Amazonka.ComputeOptimizer.GetEnrollmentStatus

type Rep GetEnrollmentStatus = D1 ('MetaData "GetEnrollmentStatus" "Amazonka.ComputeOptimizer.GetEnrollmentStatus" "amazonka-compute-optimizer-2.0-5JAMFRZoNrnJ0UCJqIgHbk" 'False) (C1 ('MetaCons "GetEnrollmentStatus'" 'PrefixI 'False) (U1 :: Type -> Type))

newGetEnrollmentStatus :: GetEnrollmentStatus Source #

Create a value of GetEnrollmentStatus with all optional fields omitted.

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

Destructuring the Response

data GetEnrollmentStatusResponse Source #

See: newGetEnrollmentStatusResponse smart constructor.

Constructors

GetEnrollmentStatusResponse' 

Fields

  • lastUpdatedTimestamp :: Maybe POSIX

    The Unix epoch timestamp, in seconds, of when the account enrollment status was last updated.

  • memberAccountsEnrolled :: Maybe Bool

    Confirms the enrollment status of member accounts of the organization, if the account is a management account of an organization.

  • numberOfMemberAccountsOptedIn :: Maybe Int

    The count of organization member accounts that are opted in to the service, if your account is an organization management account.

  • status :: Maybe Status

    The enrollment status of the account.

  • statusReason :: Maybe Text

    The reason for the enrollment status of the account.

    For example, an account might show a status of Pending because member accounts of an organization require more time to be enrolled in the service.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic GetEnrollmentStatusResponse Source # 
Instance details

Defined in Amazonka.ComputeOptimizer.GetEnrollmentStatus

Associated Types

type Rep GetEnrollmentStatusResponse :: Type -> Type #

Read GetEnrollmentStatusResponse Source # 
Instance details

Defined in Amazonka.ComputeOptimizer.GetEnrollmentStatus

Show GetEnrollmentStatusResponse Source # 
Instance details

Defined in Amazonka.ComputeOptimizer.GetEnrollmentStatus

NFData GetEnrollmentStatusResponse Source # 
Instance details

Defined in Amazonka.ComputeOptimizer.GetEnrollmentStatus

Eq GetEnrollmentStatusResponse Source # 
Instance details

Defined in Amazonka.ComputeOptimizer.GetEnrollmentStatus

type Rep GetEnrollmentStatusResponse Source # 
Instance details

Defined in Amazonka.ComputeOptimizer.GetEnrollmentStatus

type Rep GetEnrollmentStatusResponse = D1 ('MetaData "GetEnrollmentStatusResponse" "Amazonka.ComputeOptimizer.GetEnrollmentStatus" "amazonka-compute-optimizer-2.0-5JAMFRZoNrnJ0UCJqIgHbk" 'False) (C1 ('MetaCons "GetEnrollmentStatusResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "lastUpdatedTimestamp") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: (S1 ('MetaSel ('Just "memberAccountsEnrolled") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Bool)) :*: S1 ('MetaSel ('Just "numberOfMemberAccountsOptedIn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)))) :*: (S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Status)) :*: (S1 ('MetaSel ('Just "statusReason") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))))

newGetEnrollmentStatusResponse Source #

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

GetEnrollmentStatusResponse, getEnrollmentStatusResponse_lastUpdatedTimestamp - The Unix epoch timestamp, in seconds, of when the account enrollment status was last updated.

$sel:memberAccountsEnrolled:GetEnrollmentStatusResponse', getEnrollmentStatusResponse_memberAccountsEnrolled - Confirms the enrollment status of member accounts of the organization, if the account is a management account of an organization.

$sel:numberOfMemberAccountsOptedIn:GetEnrollmentStatusResponse', getEnrollmentStatusResponse_numberOfMemberAccountsOptedIn - The count of organization member accounts that are opted in to the service, if your account is an organization management account.

GetEnrollmentStatusResponse, getEnrollmentStatusResponse_status - The enrollment status of the account.

GetEnrollmentStatusResponse, getEnrollmentStatusResponse_statusReason - The reason for the enrollment status of the account.

For example, an account might show a status of Pending because member accounts of an organization require more time to be enrolled in the service.

$sel:httpStatus:GetEnrollmentStatusResponse', getEnrollmentStatusResponse_httpStatus - The response's http status code.

Response Lenses

getEnrollmentStatusResponse_lastUpdatedTimestamp :: Lens' GetEnrollmentStatusResponse (Maybe UTCTime) Source #

The Unix epoch timestamp, in seconds, of when the account enrollment status was last updated.

getEnrollmentStatusResponse_memberAccountsEnrolled :: Lens' GetEnrollmentStatusResponse (Maybe Bool) Source #

Confirms the enrollment status of member accounts of the organization, if the account is a management account of an organization.

getEnrollmentStatusResponse_numberOfMemberAccountsOptedIn :: Lens' GetEnrollmentStatusResponse (Maybe Int) Source #

The count of organization member accounts that are opted in to the service, if your account is an organization management account.

getEnrollmentStatusResponse_statusReason :: Lens' GetEnrollmentStatusResponse (Maybe Text) Source #

The reason for the enrollment status of the account.

For example, an account might show a status of Pending because member accounts of an organization require more time to be enrolled in the service.