Amazonka.RAM.ListPermissions

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

Creating a Request

data ListPermissions

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

ToJSON ListPermissions

Defined in Amazonka.RAM.ListPermissions

Methods

toJSON :: ListPermissions -> Value

toEncoding :: ListPermissions -> Encoding

toJSONList :: [ListPermissions] -> Value

toEncodingList :: [ListPermissions] -> Encoding

ToHeaders ListPermissions

Defined in Amazonka.RAM.ListPermissions

Methods

toHeaders :: ListPermissions -> [Header]

ToPath ListPermissions

Defined in Amazonka.RAM.ListPermissions

Methods

toPath :: ListPermissions -> ByteString

ToQuery ListPermissions

Defined in Amazonka.RAM.ListPermissions

Methods

toQuery :: ListPermissions -> QueryString

AWSRequest ListPermissions

Defined in Amazonka.RAM.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

Defined in Amazonka.RAM.ListPermissions

Associated Types

type Rep ListPermissions :: Type -> Type

Methods

from :: ListPermissions -> Rep ListPermissions x

to :: Rep ListPermissions x -> ListPermissions

Read ListPermissions

Defined in Amazonka.RAM.ListPermissions

Methods

readsPrec :: Int -> ReadS ListPermissions

readList :: ReadS [ListPermissions]

readPrec :: ReadPrec ListPermissions

readListPrec :: ReadPrec [ListPermissions]

Show ListPermissions

Defined in Amazonka.RAM.ListPermissions

Methods

showsPrec :: Int -> ListPermissions -> ShowS

show :: ListPermissions -> String

showList :: [ListPermissions] -> ShowS

NFData ListPermissions

Defined in Amazonka.RAM.ListPermissions

Methods

rnf :: ListPermissions -> ()

Eq ListPermissions

Defined in Amazonka.RAM.ListPermissions

Methods

(==) :: ListPermissions -> ListPermissions -> Bool

(/=) :: ListPermissions -> ListPermissions -> Bool

Hashable ListPermissions

Defined in Amazonka.RAM.ListPermissions

Methods

hashWithSalt :: Int -> ListPermissions -> Int

hash :: ListPermissions -> Int

type AWSResponse ListPermissions

Defined in Amazonka.RAM.ListPermissions

type AWSResponse ListPermissions = ListPermissionsResponse

type Rep ListPermissions

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

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)

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)

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)

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

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

Generic ListPermissionsResponse

Defined in Amazonka.RAM.ListPermissions

Associated Types

type Rep ListPermissionsResponse :: Type -> Type

Methods

from :: ListPermissionsResponse -> Rep ListPermissionsResponse x

to :: Rep ListPermissionsResponse x -> ListPermissionsResponse

Read ListPermissionsResponse

Defined in Amazonka.RAM.ListPermissions

Methods

readsPrec :: Int -> ReadS ListPermissionsResponse

readList :: ReadS [ListPermissionsResponse]

readPrec :: ReadPrec ListPermissionsResponse

readListPrec :: ReadPrec [ListPermissionsResponse]

Show ListPermissionsResponse

Defined in Amazonka.RAM.ListPermissions

Methods

showsPrec :: Int -> ListPermissionsResponse -> ShowS

show :: ListPermissionsResponse -> String

showList :: [ListPermissionsResponse] -> ShowS

NFData ListPermissionsResponse

Defined in Amazonka.RAM.ListPermissions

Methods

rnf :: ListPermissionsResponse -> ()

Eq ListPermissionsResponse

Defined in Amazonka.RAM.ListPermissions

Methods

(==) :: ListPermissionsResponse -> ListPermissionsResponse -> Bool

(/=) :: ListPermissionsResponse -> ListPermissionsResponse -> Bool

type Rep ListPermissionsResponse

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

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 - 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)

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])

An array of objects with information about the permissions.

listPermissionsResponse_httpStatus :: Lens' ListPermissionsResponse Int

The response's http status code.