amazonka-ram-2.0: Amazon Resource Access Manager SDK.
Copyright(c) 2013-2023 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellSafe-Inferred
LanguageHaskell2010

Amazonka.RAM.ListPermissions

Description

Retrieves a list of available RAM permissions that you can use for the supported resource types.

Synopsis

Creating a Request

data ListPermissions Source #

See: newListPermissions smart constructor.

Constructors

ListPermissions' 

Fields

  • maxResults :: Maybe Natural

    Specifies the total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the number you specify, the NextToken response element is returned with a value (not null). Include the specified value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that the service might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

  • nextToken :: Maybe Text

    Specifies that you want to receive the next page of results. Valid only if you received a NextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's NextToken response to request the next page of results.

  • resourceType :: Maybe Text

    Specifies that you want to list permissions for only the specified resource type. For example, to list only permissions that apply to EC2 subnets, specify ec2:Subnet. You can use the ListResourceTypes operation to get the specific string required.

Instances

Instances details
ToJSON ListPermissions Source # 
Instance details

Defined in Amazonka.RAM.ListPermissions

ToHeaders ListPermissions Source # 
Instance details

Defined in Amazonka.RAM.ListPermissions

ToPath ListPermissions Source # 
Instance details

Defined in Amazonka.RAM.ListPermissions

ToQuery ListPermissions Source # 
Instance details

Defined in Amazonka.RAM.ListPermissions

AWSRequest ListPermissions Source # 
Instance details

Defined in Amazonka.RAM.ListPermissions

Associated Types

type AWSResponse ListPermissions #

Generic ListPermissions Source # 
Instance details

Defined in Amazonka.RAM.ListPermissions

Associated Types

type Rep ListPermissions :: Type -> Type #

Read ListPermissions Source # 
Instance details

Defined in Amazonka.RAM.ListPermissions

Show ListPermissions Source # 
Instance details

Defined in Amazonka.RAM.ListPermissions

NFData ListPermissions Source # 
Instance details

Defined in Amazonka.RAM.ListPermissions

Methods

rnf :: ListPermissions -> () #

Eq ListPermissions Source # 
Instance details

Defined in Amazonka.RAM.ListPermissions

Hashable ListPermissions Source # 
Instance details

Defined in Amazonka.RAM.ListPermissions

type AWSResponse ListPermissions Source # 
Instance details

Defined in Amazonka.RAM.ListPermissions

type Rep ListPermissions Source # 
Instance details

Defined in Amazonka.RAM.ListPermissions

type Rep ListPermissions = D1 ('MetaData "ListPermissions" "Amazonka.RAM.ListPermissions" "amazonka-ram-2.0-2ZD9k8USaHb58ZVl9MaFYL" 'False) (C1 ('MetaCons "ListPermissions'" 'PrefixI 'True) (S1 ('MetaSel ('Just "maxResults") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Natural)) :*: (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "resourceType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newListPermissions :: ListPermissions Source #

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:maxResults:ListPermissions', listPermissions_maxResults - Specifies the total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the number you specify, the NextToken response element is returned with a value (not null). Include the specified value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that the service might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

ListPermissions, listPermissions_nextToken - Specifies that you want to receive the next page of results. Valid only if you received a NextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's NextToken response to request the next page of results.

ListPermissions, listPermissions_resourceType - Specifies that you want to list permissions for only the specified resource type. For example, to list only permissions that apply to EC2 subnets, specify ec2:Subnet. You can use the ListResourceTypes operation to get the specific string required.

Request Lenses

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

Specifies the total number of results that you want included on each page of the response. If you do not include this parameter, it defaults to a value that is specific to the operation. If additional items exist beyond the number you specify, the NextToken response element is returned with a value (not null). Include the specified value as the NextToken request parameter in the next call to the operation to get the next part of the results. Note that the service might return fewer results than the maximum even when there are more results available. You should check NextToken after every operation to ensure that you receive all of the results.

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

Specifies that you want to receive the next page of results. Valid only if you received a NextToken response in the previous request. If you did, it indicates that more output is available. Set this parameter to the value provided by the previous call's NextToken response to request the next page of results.

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

Specifies that you want to list permissions for only the specified resource type. For example, to list only permissions that apply to EC2 subnets, specify ec2:Subnet. You can use the ListResourceTypes operation to get the specific string required.

Destructuring the Response

data ListPermissionsResponse Source #

See: newListPermissionsResponse smart constructor.

Constructors

ListPermissionsResponse' 

Fields

  • nextToken :: Maybe Text

    If present, this value indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null. This indicates that this is the last page of results.

  • permissions :: Maybe [ResourceSharePermissionSummary]

    An array of objects with information about the permissions.

  • httpStatus :: Int

    The response's http status code.

Instances

Instances details
Generic ListPermissionsResponse Source # 
Instance details

Defined in Amazonka.RAM.ListPermissions

Associated Types

type Rep ListPermissionsResponse :: Type -> Type #

Read ListPermissionsResponse Source # 
Instance details

Defined in Amazonka.RAM.ListPermissions

Show ListPermissionsResponse Source # 
Instance details

Defined in Amazonka.RAM.ListPermissions

NFData ListPermissionsResponse Source # 
Instance details

Defined in Amazonka.RAM.ListPermissions

Methods

rnf :: ListPermissionsResponse -> () #

Eq ListPermissionsResponse Source # 
Instance details

Defined in Amazonka.RAM.ListPermissions

type Rep ListPermissionsResponse Source # 
Instance details

Defined in Amazonka.RAM.ListPermissions

type Rep ListPermissionsResponse = D1 ('MetaData "ListPermissionsResponse" "Amazonka.RAM.ListPermissions" "amazonka-ram-2.0-2ZD9k8USaHb58ZVl9MaFYL" 'False) (C1 ('MetaCons "ListPermissionsResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "nextToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "permissions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [ResourceSharePermissionSummary])) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newListPermissionsResponse Source #

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 - If present, this value indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null. This indicates that this is the last page of results.

$sel:permissions:ListPermissionsResponse', listPermissionsResponse_permissions - An array of objects with information about the permissions.

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

Response Lenses

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

If present, this value indicates that more output is available than is included in the current response. Use this value in the NextToken request parameter in a subsequent call to the operation to get the next part of the output. You should repeat this until the NextToken response element comes back as null. This indicates that this is the last page of results.

listPermissionsResponse_permissions :: Lens' ListPermissionsResponse (Maybe [ResourceSharePermissionSummary]) Source #

An array of objects with information about the permissions.