amazonka-quicksight-2.0: Amazon QuickSight 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.QuickSight.DescribeAccountSubscription

Description

Use the DescribeAccountSubscription operation to receive a description of an Amazon QuickSight account's subscription. A successful API call returns an AccountInfo object that includes an account's name, subscription status, authentication type, edition, and notification email address.

Synopsis

Creating a Request

data DescribeAccountSubscription Source #

See: newDescribeAccountSubscription smart constructor.

Constructors

DescribeAccountSubscription' 

Fields

  • awsAccountId :: Text

    The Amazon Web Services account ID associated with your Amazon QuickSight account.

Instances

Instances details
ToHeaders DescribeAccountSubscription Source # 
Instance details

Defined in Amazonka.QuickSight.DescribeAccountSubscription

ToPath DescribeAccountSubscription Source # 
Instance details

Defined in Amazonka.QuickSight.DescribeAccountSubscription

ToQuery DescribeAccountSubscription Source # 
Instance details

Defined in Amazonka.QuickSight.DescribeAccountSubscription

AWSRequest DescribeAccountSubscription Source # 
Instance details

Defined in Amazonka.QuickSight.DescribeAccountSubscription

Generic DescribeAccountSubscription Source # 
Instance details

Defined in Amazonka.QuickSight.DescribeAccountSubscription

Associated Types

type Rep DescribeAccountSubscription :: Type -> Type #

Read DescribeAccountSubscription Source # 
Instance details

Defined in Amazonka.QuickSight.DescribeAccountSubscription

Show DescribeAccountSubscription Source # 
Instance details

Defined in Amazonka.QuickSight.DescribeAccountSubscription

NFData DescribeAccountSubscription Source # 
Instance details

Defined in Amazonka.QuickSight.DescribeAccountSubscription

Eq DescribeAccountSubscription Source # 
Instance details

Defined in Amazonka.QuickSight.DescribeAccountSubscription

Hashable DescribeAccountSubscription Source # 
Instance details

Defined in Amazonka.QuickSight.DescribeAccountSubscription

type AWSResponse DescribeAccountSubscription Source # 
Instance details

Defined in Amazonka.QuickSight.DescribeAccountSubscription

type Rep DescribeAccountSubscription Source # 
Instance details

Defined in Amazonka.QuickSight.DescribeAccountSubscription

type Rep DescribeAccountSubscription = D1 ('MetaData "DescribeAccountSubscription" "Amazonka.QuickSight.DescribeAccountSubscription" "amazonka-quicksight-2.0-9P6nV9koXl6GTlt8ZjS7C9" 'False) (C1 ('MetaCons "DescribeAccountSubscription'" 'PrefixI 'True) (S1 ('MetaSel ('Just "awsAccountId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))

newDescribeAccountSubscription Source #

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

DescribeAccountSubscription, describeAccountSubscription_awsAccountId - The Amazon Web Services account ID associated with your Amazon QuickSight account.

Request Lenses

describeAccountSubscription_awsAccountId :: Lens' DescribeAccountSubscription Text Source #

The Amazon Web Services account ID associated with your Amazon QuickSight account.

Destructuring the Response

data DescribeAccountSubscriptionResponse Source #

Constructors

DescribeAccountSubscriptionResponse' 

Fields

  • accountInfo :: Maybe AccountInfo

    A structure that contains the following elements:

    • Your Amazon QuickSight account name.
    • The edition of Amazon QuickSight that your account is using.
    • The notification email address that is associated with the Amazon QuickSight account.
    • The authentication type of the Amazon QuickSight account.
    • The status of the Amazon QuickSight account's subscription.
  • requestId :: Maybe Text

    The Amazon Web Services request ID for this operation.

  • status :: Int

    The HTTP status of the request.

Instances

Instances details
Generic DescribeAccountSubscriptionResponse Source # 
Instance details

Defined in Amazonka.QuickSight.DescribeAccountSubscription

Read DescribeAccountSubscriptionResponse Source # 
Instance details

Defined in Amazonka.QuickSight.DescribeAccountSubscription

Show DescribeAccountSubscriptionResponse Source # 
Instance details

Defined in Amazonka.QuickSight.DescribeAccountSubscription

NFData DescribeAccountSubscriptionResponse Source # 
Instance details

Defined in Amazonka.QuickSight.DescribeAccountSubscription

Eq DescribeAccountSubscriptionResponse Source # 
Instance details

Defined in Amazonka.QuickSight.DescribeAccountSubscription

type Rep DescribeAccountSubscriptionResponse Source # 
Instance details

Defined in Amazonka.QuickSight.DescribeAccountSubscription

type Rep DescribeAccountSubscriptionResponse = D1 ('MetaData "DescribeAccountSubscriptionResponse" "Amazonka.QuickSight.DescribeAccountSubscription" "amazonka-quicksight-2.0-9P6nV9koXl6GTlt8ZjS7C9" 'False) (C1 ('MetaCons "DescribeAccountSubscriptionResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "accountInfo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe AccountInfo)) :*: (S1 ('MetaSel ('Just "requestId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newDescribeAccountSubscriptionResponse Source #

Create a value of DescribeAccountSubscriptionResponse 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:accountInfo:DescribeAccountSubscriptionResponse', describeAccountSubscriptionResponse_accountInfo - A structure that contains the following elements:

  • Your Amazon QuickSight account name.
  • The edition of Amazon QuickSight that your account is using.
  • The notification email address that is associated with the Amazon QuickSight account.
  • The authentication type of the Amazon QuickSight account.
  • The status of the Amazon QuickSight account's subscription.

$sel:requestId:DescribeAccountSubscriptionResponse', describeAccountSubscriptionResponse_requestId - The Amazon Web Services request ID for this operation.

DescribeAccountSubscriptionResponse, describeAccountSubscriptionResponse_status - The HTTP status of the request.

Response Lenses

describeAccountSubscriptionResponse_accountInfo :: Lens' DescribeAccountSubscriptionResponse (Maybe AccountInfo) Source #

A structure that contains the following elements:

  • Your Amazon QuickSight account name.
  • The edition of Amazon QuickSight that your account is using.
  • The notification email address that is associated with the Amazon QuickSight account.
  • The authentication type of the Amazon QuickSight account.
  • The status of the Amazon QuickSight account's subscription.