QuickSight / Client / get_flow_permissions

get_flow_permissions¶

QuickSight.Client.get_flow_permissions(**kwargs)¶

Get permissions for a flow.

Request Syntax

response = client.get_flow_permissions(
    AwsAccountId='string',
    FlowId='string'
)

Parameters:

AwsAccountId (string) –
[REQUIRED]

The ID of the Amazon Web Services account that contains the flow that you are getting permissions for.
FlowId (string) –
[REQUIRED]

The unique identifier of the flow to get permissions from.

Return type:

dict

Returns:

Response Syntax

{
    'Arn': 'string',
    'FlowId': 'string',
    'Permissions': [
        {
            'Actions': [
                'string',
            ],
            'Principal': 'string'
        },
    ],
    'RequestId': 'string',
    'Status': 123
}

Response Structure

(dict) –
- Arn (string) –
  
  The Amazon Resource Name (ARN) of the flow you are getting permissions against.
- FlowId (string) –
  
  The unique identifier of the flow with permissions.
- Permissions (list) –
  
  A structure that contains the permissions for the flow.
  - (dict) –
    
    A structure that contains the permission information for one principal against one flow.
    - Actions (list) –
      
      A list of actions that the principal can perform against the flow.
      
      The following are the list of values to set a principal as a flow owner:
      - quicksight:PublishFlow
      - quicksight:GetFlow
      - quicksight:UpdateFlowPermissions
      - quicksight:GetFlowSession
      - quicksight:StartFlowSession
      - quicksight:StopFlowSession
      - quicksight:UpdateFlowSession
      - quicksight:UnpublishFlow
      - quicksight:GetFlowStages
      - quicksight:DeleteFlow
      - quicksight:DescribeFlowPermissions
      - quicksight:UpdateFlow
      - quicksight:CreatePresignedUrl
      The following are the list of values to set a principal as a flow viewer:
      - quicksight:GetFlow
      - quicksight:UpdateFlowSession
      - quicksight:StartFlowSession
      - quicksight:StopFlowSession
      - quicksight:GetFlowSession
      - quicksight:CreatePresignedUrl
      - quicksight:GetFlowStages
      - (string) –
    - Principal (string) –
      
      The Amazon Resource Name (ARN) of the principal. This can be an Amazon QuickSight user, group or namespace associated with the flow. Namespace principal can only be set as a viewer and will grant everyone in the same namespace viewer permissions.
- RequestId (string) –
  
  The Amazon Web Services request ID for this operation.
- Status (integer) –
  
  The HTTP status of the request.

Exceptions

QuickSight.Client.exceptions.ThrottlingException
QuickSight.Client.exceptions.InvalidParameterValueException
QuickSight.Client.exceptions.InternalFailureException
QuickSight.Client.exceptions.AccessDeniedException