AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Class: Aws::ManagedGrafana::Types::ListPermissionsRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-managedgrafana/lib/aws-sdk-managedgrafana/types.rb

Overview

Note:

When making an API call, you may pass ListPermissionsRequest data as a hash:

{
  group_id: "SsoId",
  max_results: 1,
  next_token: "PaginationToken",
  user_id: "SsoId",
  user_type: "SSO_USER", # accepts SSO_USER, SSO_GROUP
  workspace_id: "WorkspaceId", # required
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#group_idString

(Optional) Limits the results to only the group that matches this ID.

Returns:

  • (String)


600
601
602
603
604
605
606
607
608
609
# File 'gems/aws-sdk-managedgrafana/lib/aws-sdk-managedgrafana/types.rb', line 600

class ListPermissionsRequest < Struct.new(
  :group_id,
  :max_results,
  :next_token,
  :user_id,
  :user_type,
  :workspace_id)
  SENSITIVE = []
  include Aws::Structure
end

#max_resultsInteger

The maximum number of results to include in the response.

Returns:

  • (Integer)


600
601
602
603
604
605
606
607
608
609
# File 'gems/aws-sdk-managedgrafana/lib/aws-sdk-managedgrafana/types.rb', line 600

class ListPermissionsRequest < Struct.new(
  :group_id,
  :max_results,
  :next_token,
  :user_id,
  :user_type,
  :workspace_id)
  SENSITIVE = []
  include Aws::Structure
end

#next_tokenString

The token to use when requesting the next set of results. You received this token from a previous ListPermissions operation.

Returns:

  • (String)


600
601
602
603
604
605
606
607
608
609
# File 'gems/aws-sdk-managedgrafana/lib/aws-sdk-managedgrafana/types.rb', line 600

class ListPermissionsRequest < Struct.new(
  :group_id,
  :max_results,
  :next_token,
  :user_id,
  :user_type,
  :workspace_id)
  SENSITIVE = []
  include Aws::Structure
end

#user_idString

(Optional) Limits the results to only the user that matches this ID.

Returns:

  • (String)


600
601
602
603
604
605
606
607
608
609
# File 'gems/aws-sdk-managedgrafana/lib/aws-sdk-managedgrafana/types.rb', line 600

class ListPermissionsRequest < Struct.new(
  :group_id,
  :max_results,
  :next_token,
  :user_id,
  :user_type,
  :workspace_id)
  SENSITIVE = []
  include Aws::Structure
end

#user_typeString

(Optional) If you specify SSO_USER, then only the permissions of Amazon Web Services SSO users are returned. If you specify SSO_GROUP, only the permissions of Amazon Web Services SSO groups are returned.

Returns:

  • (String)


600
601
602
603
604
605
606
607
608
609
# File 'gems/aws-sdk-managedgrafana/lib/aws-sdk-managedgrafana/types.rb', line 600

class ListPermissionsRequest < Struct.new(
  :group_id,
  :max_results,
  :next_token,
  :user_id,
  :user_type,
  :workspace_id)
  SENSITIVE = []
  include Aws::Structure
end

#workspace_idString

The ID of the workspace to list permissions for. This parameter is required.

Returns:

  • (String)


600
601
602
603
604
605
606
607
608
609
# File 'gems/aws-sdk-managedgrafana/lib/aws-sdk-managedgrafana/types.rb', line 600

class ListPermissionsRequest < Struct.new(
  :group_id,
  :max_results,
  :next_token,
  :user_id,
  :user_type,
  :workspace_id)
  SENSITIVE = []
  include Aws::Structure
end