Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Grafana.ListPermissions

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Lists the users and groups who have the Grafana Admin and Editor roles in this workspace. If you use this operation without specifying userId or groupId, the operation returns the roles of all users and groups. If you specify a userId or a groupId, only the roles for that user or group are returned. If you do this, you can specify only one userId or one groupId.

This operation returns paginated results.

Synopsis

data ListPermissions = ListPermissions' {
- groupId :: Maybe Text
- maxResults :: Maybe Natural
- nextToken :: Maybe Text
- userId :: Maybe Text
- userType :: Maybe UserType
- workspaceId :: Text
}
newListPermissions :: Text -> ListPermissions
listPermissions_groupId :: Lens' ListPermissions (Maybe Text)
listPermissions_maxResults :: Lens' ListPermissions (Maybe Natural)
listPermissions_nextToken :: Lens' ListPermissions (Maybe Text)
listPermissions_userId :: Lens' ListPermissions (Maybe Text)
listPermissions_userType :: Lens' ListPermissions (Maybe UserType)
listPermissions_workspaceId :: Lens' ListPermissions Text
data ListPermissionsResponse = ListPermissionsResponse' {
- nextToken :: Maybe Text
- httpStatus :: Int
- permissions :: [PermissionEntry]
}
newListPermissionsResponse :: Int -> ListPermissionsResponse
listPermissionsResponse_nextToken :: Lens' ListPermissionsResponse (Maybe Text)
listPermissionsResponse_httpStatus :: Lens' ListPermissionsResponse Int
listPermissionsResponse_permissions :: Lens' ListPermissionsResponse [PermissionEntry]

Creating a Request

data ListPermissions Source #

See: newListPermissions smart constructor.

Constructors

ListPermissions'

Fields

groupId :: Maybe Text
(Optional) Limits the results to only the group that matches this ID.
maxResults :: Maybe Natural
The maximum number of results to include in the response.
nextToken :: Maybe Text
The token to use when requesting the next set of results. You received this token from a previous ListPermissions operation.
userId :: Maybe Text
(Optional) Limits the results to only the user that matches this ID.
userType :: Maybe UserType
(Optional) If you specify SSO_USER, then only the permissions of IAM Identity Center users are returned. If you specify SSO_GROUP, only the permissions of IAM Identity Center groups are returned.
workspaceId :: Text
The ID of the workspace to list permissions for. This parameter is required.

Instances

Instances details

ToHeaders ListPermissions Source #
Instance details Defined in Amazonka.Grafana.ListPermissions Methods toHeaders :: ListPermissions -> [Header] #
ToPath ListPermissions Source #
Instance details Defined in Amazonka.Grafana.ListPermissions Methods toPath :: ListPermissions -> ByteString #
ToQuery ListPermissions Source #
Instance details Defined in Amazonka.Grafana.ListPermissions Methods toQuery :: ListPermissions -> QueryString #
AWSPager ListPermissions Source #
Instance details Defined in Amazonka.Grafana.ListPermissions Methods page :: ListPermissions -> AWSResponse ListPermissions -> Maybe ListPermissions #
AWSRequest ListPermissions Source #
Instance details Defined in Amazonka.Grafana.ListPermissions Associated Types type AWSResponse ListPermissions # Methods request :: (Service -> Service) -> ListPermissions -> Request ListPermissions # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy ListPermissions -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse ListPermissions))) #
Generic ListPermissions Source #
Instance details Defined in Amazonka.Grafana.ListPermissions Associated Types type Rep ListPermissions :: Type -> Type # Methods from :: ListPermissions -> Rep ListPermissions x # to :: Rep ListPermissions x -> ListPermissions #
Read ListPermissions Source #
Instance details Defined in Amazonka.Grafana.ListPermissions Methods readsPrec :: Int -> ReadS ListPermissions # readList :: ReadS [ListPermissions] # readPrec :: ReadPrec ListPermissions # readListPrec :: ReadPrec [ListPermissions] #
Show ListPermissions Source #
Instance details Defined in Amazonka.Grafana.ListPermissions Methods showsPrec :: Int -> ListPermissions -> ShowS # show :: ListPermissions -> String # showList :: [ListPermissions] -> ShowS #
NFData ListPermissions Source #
Instance details Defined in Amazonka.Grafana.ListPermissions Methods rnf :: ListPermissions -> () #
Eq ListPermissions Source #
Instance details Defined in Amazonka.Grafana.ListPermissions Methods (==) :: ListPermissions -> ListPermissions -> Bool # (/=) :: ListPermissions -> ListPermissions -> Bool #
Hashable ListPermissions Source #
Instance details Defined in Amazonka.Grafana.ListPermissions Methods hashWithSalt :: Int -> ListPermissions -> Int # hash :: ListPermissions -> Int #
type AWSResponse ListPermissions Source #
Instance details Defined in Amazonka.Grafana.ListPermissions type AWSResponse ListPermissions = ListPermissionsResponse
type Rep ListPermissions Source #
Instance details Defined in Amazonka.Grafana.ListPermissions type Rep ListPermissions = D1 ('MetaData "ListPermissions" "Amazonka.Grafana.ListPermissions" "amazonka-grafana-2.0-1hXXW2cgZWZJGJ3AoD5xOB" 'False) (C1 ('MetaCons "ListPermissions'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "groupId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :: S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "userId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "userType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe UserType)) :*: S1 ('MetaSel ('Just "workspaceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newListPermissions Source #

Arguments

:: Text	`$sel:workspaceId:ListPermissions'`
-> ListPermissions

Create a value of ListPermissions with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:groupId:ListPermissions', listPermissions_groupId - (Optional) Limits the results to only the group that matches this ID.

$sel:maxResults:ListPermissions', listPermissions_maxResults - The maximum number of results to include in the response.

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

$sel:userId:ListPermissions', listPermissions_userId - (Optional) Limits the results to only the user that matches this ID.

$sel:userType:ListPermissions', listPermissions_userType - (Optional) If you specify SSO_USER, then only the permissions of IAM Identity Center users are returned. If you specify SSO_GROUP, only the permissions of IAM Identity Center groups are returned.

$sel:workspaceId:ListPermissions', listPermissions_workspaceId - The ID of the workspace to list permissions for. This parameter is required.

Request Lenses

listPermissions_groupId :: Lens' ListPermissions (Maybe Text) Source #

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

listPermissions_maxResults :: Lens' ListPermissions (Maybe Natural) Source #

The maximum number of results to include in the response.

listPermissions_nextToken :: Lens' ListPermissions (Maybe Text) Source #

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

listPermissions_userId :: Lens' ListPermissions (Maybe Text) Source #

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

listPermissions_userType :: Lens' ListPermissions (Maybe UserType) Source #

(Optional) If you specify SSO_USER, then only the permissions of IAM Identity Center users are returned. If you specify SSO_GROUP, only the permissions of IAM Identity Center groups are returned.

listPermissions_workspaceId :: Lens' ListPermissions Text Source #

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

Destructuring the Response

data ListPermissionsResponse Source #

See: newListPermissionsResponse smart constructor.

Constructors

ListPermissionsResponse'
Fields nextToken :: Maybe Text The token to use in a subsequent `ListPermissions` operation to return the next set of results. httpStatus :: Int The response's http status code. permissions :: [PermissionEntry] The permissions returned by the operation.

Instances

Instances details

Generic ListPermissionsResponse Source #
Instance details Defined in Amazonka.Grafana.ListPermissions Associated Types type Rep ListPermissionsResponse :: Type -> Type # Methods from :: ListPermissionsResponse -> Rep ListPermissionsResponse x # to :: Rep ListPermissionsResponse x -> ListPermissionsResponse #
Read ListPermissionsResponse Source #
Instance details Defined in Amazonka.Grafana.ListPermissions Methods readsPrec :: Int -> ReadS ListPermissionsResponse # readList :: ReadS [ListPermissionsResponse] # readPrec :: ReadPrec ListPermissionsResponse # readListPrec :: ReadPrec [ListPermissionsResponse] #
Show ListPermissionsResponse Source #
Instance details Defined in Amazonka.Grafana.ListPermissions Methods showsPrec :: Int -> ListPermissionsResponse -> ShowS # show :: ListPermissionsResponse -> String # showList :: [ListPermissionsResponse] -> ShowS #
NFData ListPermissionsResponse Source #
Instance details Defined in Amazonka.Grafana.ListPermissions Methods rnf :: ListPermissionsResponse -> () #
Eq ListPermissionsResponse Source #
Instance details Defined in Amazonka.Grafana.ListPermissions Methods (==) :: ListPermissionsResponse -> ListPermissionsResponse -> Bool # (/=) :: ListPermissionsResponse -> ListPermissionsResponse -> Bool #
type Rep ListPermissionsResponse Source #
Instance details Defined in Amazonka.Grafana.ListPermissions type Rep ListPermissionsResponse = D1 ('MetaData "ListPermissionsResponse" "Amazonka.Grafana.ListPermissions" "amazonka-grafana-2.0-1hXXW2cgZWZJGJ3AoD5xOB" 'False) (C1 ('MetaCons "ListPermissionsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int) :: S1 ('MetaSel ('Just "permissions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [PermissionEntry]))))

newListPermissionsResponse Source #

Arguments

:: Int	`$sel:httpStatus:ListPermissionsResponse'`
-> ListPermissionsResponse

Create a value of ListPermissionsResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

ListPermissions, listPermissionsResponse_nextToken - The token to use in a subsequent ListPermissions operation to return the next set of results.

$sel:httpStatus:ListPermissionsResponse', listPermissionsResponse_httpStatus - The response's http status code.

$sel:permissions:ListPermissionsResponse', listPermissionsResponse_permissions - The permissions returned by the operation.

Response Lenses

listPermissionsResponse_nextToken :: Lens' ListPermissionsResponse (Maybe Text) Source #

The token to use in a subsequent ListPermissions operation to return the next set of results.

listPermissionsResponse_httpStatus :: Lens' ListPermissionsResponse Int Source #

The response's http status code.

listPermissionsResponse_permissions :: Lens' ListPermissionsResponse [PermissionEntry] Source #

The permissions returned by the operation.