QuickSight / Client / describe_app

describe_app¶

QuickSight.Client.describe_app(**kwargs)¶

Describes an app.

Request Syntax

response = client.describe_app(
    AwsAccountId='string',
    AppId='string'
)

Parameters:

AwsAccountId (string) –
[REQUIRED]

The ID of the Amazon Web Services account that contains the app.
AppId (string) –
[REQUIRED]

The ID of the app that you want to describe.

Return type:

dict

Returns:

Response Syntax

{
    'App': {
        'AppId': 'string',
        'Arn': 'string',
        'Name': 'string',
        'CreatedTime': datetime(2015, 1, 1),
        'LastUpdatedTime': datetime(2015, 1, 1),
        'Visibility': 'PRIVATE'|'PUBLIC'
    },
    'RequestId': 'string'
}

Response Structure

(dict) –
- App (dict) –
  
  The information about the app.
  - AppId (string) –
    
    The ID of the app.
  - Arn (string) –
    
    The Amazon Resource Name (ARN) of the app.
  - Name (string) –
    
    The display name of the app.
  - CreatedTime (datetime) –
    
    The time that the app was created.
  - LastUpdatedTime (datetime) –
    
    The time that the app was last updated.
  - Visibility (string) –
    
    The sharing status of the app: PUBLIC if the app is shared publicly, or PRIVATE if it is private.
- RequestId (string) –
  
  The Amazon Web Services request ID for this operation.

Exceptions

QuickSight.Client.exceptions.ThrottlingException
QuickSight.Client.exceptions.InvalidParameterException
QuickSight.Client.exceptions.InternalFailureException
QuickSight.Client.exceptions.ResourceNotFoundException
QuickSight.Client.exceptions.AccessDeniedException