QuickSight / Client / update_self_upgrade

update_self_upgrade

QuickSight.Client.update_self_upgrade(**kwargs)

Updates a self-upgrade request for a Quick Suite user by approving, denying, or verifying the request.

See also: AWS API Documentation

Request Syntax

response = client.update_self_upgrade(
    AwsAccountId='string',
    Namespace='string',
    UpgradeRequestId='string',
    Action='APPROVE'|'DENY'|'VERIFY'
)
Parameters:
  • AwsAccountId (string) –

    [REQUIRED]

    The ID of the Amazon Web Services account that contains the self-upgrade request.

  • Namespace (string) –

    [REQUIRED]

    The Quick Suite namespace for the self-upgrade request.

  • UpgradeRequestId (string) –

    [REQUIRED]

    The ID of the self-upgrade request to update.

  • Action (string) –

    [REQUIRED]

    The action to perform on the self-upgrade request. Valid values are APPROVE, DENY, or VERIFY.

Return type:

dict

Returns:

Response Syntax

{
    'SelfUpgradeRequestDetail': {
        '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'
    },
    'RequestId': 'string',
    'Status': 123
}

Response Structure

  • (dict) –

    • SelfUpgradeRequestDetail (dict) –

      Details of the updated 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.

    • 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