QuickSight / Client / list_self_upgrades

list_self_upgrades¶

QuickSight.Client.list_self_upgrades(**kwargs)¶

Lists all self-upgrade requests for a Quick Suite account.

Request Syntax

response = client.list_self_upgrades(
    AwsAccountId='string',
    Namespace='string',
    NextToken='string',
    MaxResults=123
)

Parameters:

AwsAccountId (string) –
[REQUIRED]

The ID of the Amazon Web Services account that contains the self-upgrade requests.
Namespace (string) –
[REQUIRED]

The Quick Suite namespace for the self-upgrade requests.
NextToken (string) – The token for the next set of results, or null if there are no more results.
MaxResults (integer) – The maximum number of results to return.

Return type:

dict

Returns:

Response Syntax

{
    'SelfUpgradeRequestDetails': [
        {
            'UpgradeRequestId': 'string',
            'UserName': 'string',
            'OriginalRole': 'ADMIN'|'AUTHOR'|'READER'|'RESTRICTED_AUTHOR'|'RESTRICTED_READER'|'ADMIN_PRO'|'AUTHOR_PRO'|'READER_PRO',
            'RequestedRole': 'ADMIN'|'AUTHOR'|'READER'|'RESTRICTED_AUTHOR'|'RESTRICTED_READER'|'ADMIN_PRO'|'AUTHOR_PRO'|'READER_PRO',
            'RequestNote': 'string',
            'CreationTime': 123,
            'RequestStatus': 'PENDING'|'APPROVED'|'DENIED'|'UPDATE_FAILED'|'VERIFY_FAILED',
            'lastUpdateAttemptTime': 123,
            'lastUpdateFailureReason': 'string'
        },
    ],
    'NextToken': 'string',
    'RequestId': 'string',
    'Status': 123
}

Response Structure

(dict) –
- SelfUpgradeRequestDetails (list) –
  
  A list of self-upgrade request details.
  - (dict) –
    
    Details of a self-upgrade request.
    - UpgradeRequestId (string) –
      
      The ID of the self-upgrade request.
    - UserName (string) –
      
      The username of the user who initiated the self-upgrade request.
    - OriginalRole (string) –
      
      The original role of the user before the upgrade.
    - RequestedRole (string) –
      
      The role that the user is requesting to upgrade to.
    - RequestNote (string) –
      
      An optional note explaining the reason for the self-upgrade request.
    - CreationTime (integer) –
      
      The time when the self-upgrade request was created.
    - RequestStatus (string) –
      
      The status of the self-upgrade request.
    - lastUpdateAttemptTime (integer) –
      
      The time of the last update attempt for the self-upgrade request.
    - lastUpdateFailureReason (string) –
      
      The reason for the last update failure, if applicable.
- NextToken (string) –
  
  The token for the next set of results, or null if there are no more results.
- RequestId (string) –
  
  The Amazon Web Services request ID for this operation.
- Status (integer) –
  
  The HTTP status of the request.

Exceptions

QuickSight.Client.exceptions.AccessDeniedException
QuickSight.Client.exceptions.InvalidParameterValueException
QuickSight.Client.exceptions.ResourceNotFoundException
QuickSight.Client.exceptions.InvalidNextTokenException
QuickSight.Client.exceptions.ThrottlingException
QuickSight.Client.exceptions.PreconditionNotMetException
QuickSight.Client.exceptions.LimitExceededException
QuickSight.Client.exceptions.InternalFailureException
QuickSight.Client.exceptions.ResourceUnavailableException