AWS CLI Command Reference

[ aws . quicksight ]

describe-account-subscription

Description

Use the DescribeAccountSubscription operation to receive a description of a 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.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  describe-account-subscription
--aws-account-id <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--aws-account-id (string)

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

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Output

AccountInfo -> (structure)

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.

AccountName -> (string)

The account name that you provided for the Amazon QuickSight subscription in your Amazon Web Services account. You create this name when you sign up for Amazon QuickSight. It’s unique over all of Amazon Web Services, and it appears only when users sign in.

Edition -> (string)

The edition of your Amazon QuickSight account.

NotificationEmail -> (string)

The email address that will be used for Amazon QuickSight to send notifications regarding your Amazon Web Services account or Amazon QuickSight subscription.

AuthenticationType -> (string)

The way that your Amazon QuickSight account is authenticated.

AccountSubscriptionStatus -> (string)

The status of your account subscription.

Status -> (integer)

The HTTP status of the request.

RequestId -> (string)

The Amazon Web Services request ID for this operation.

© Copyright 2018, Amazon Web Services. Created using Sphinx.