RAM / Client / list_permissions

list_permissions

RAM.Client.list_permissions(**kwargs)

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

Note

Always check the NextToken response parameter for a null value when calling a paginated operation. These operations can occasionally return an empty set of results even when there are more results available. The NextToken response parameter value is null only when there are no more results to display.

See also: AWS API Documentation

Request Syntax

response = client.list_permissions(
    resourceType='string',
    resourceOwner='SELF'|'OTHER-ACCOUNTS',
    nextToken='string',
    maxResults=123,
    permissionType='ALL'|'AWS_MANAGED'|'CUSTOMER_MANAGED',
    permissionStatus='ATTACHABLE'|'UNATTACHABLE'|'DELETING'|'DELETED'|'DEPRECATED'
)
Parameters:

  • resourceType (string) –

    Specifies that you want to list only those permissions that apply to the specified resource type. This parameter is not case sensitive.

    For example, to list only permissions that apply to Amazon EC2 subnets, specify ec2:subnet. You can use the ListResourceTypes operation to get the specific string required.

  • resourceOwner (string) –

    Specifies that you want to list only permissions owned by a specific entity:

    • SELF – returns only permissions owned by the calling account.

    • OTHER-ACCOUNTS – returns only permissions shared with the calling account by other accounts.

  • nextToken (string) – 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.

  • maxResults (integer) – 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.

  • permissionType (string) –

    Specifies that you want to list only permissions of this type:

    • AWS – returns only Amazon Web Services managed permissions.

    • LOCAL – returns only customer managed permissions

    • ALL – returns both Amazon Web Services managed permissions and customer managed permissions.

    If you don’t specify this parameter, the default is All.

  • permissionStatus (string) – Specifies that you want to filter the results to include only permissions with the specified status. For example, use ATTACHABLE to list only permissions that can be associated with resource shares, or DEPRECATED to list only deprecated permissions.

Return type:

dict

Returns:

Response Syntax

{
    'permissions': [
        {
            'arn': 'string',
            'version': 'string',
            'defaultVersion': True|False,
            'name': 'string',
            'resourceType': 'string',
            'status': 'string',
            'creationTime': datetime(2015, 1, 1),
            'lastUpdatedTime': datetime(2015, 1, 1),
            'isResourceTypeDefault': True|False,
            'permissionType': 'CUSTOMER_MANAGED'|'AWS_MANAGED',
            'featureSet': 'CREATED_FROM_POLICY'|'PROMOTING_TO_STANDARD'|'STANDARD',
            'permissionTemplateParameters': [
                {
                    'name': 'string',
                    'type': 'STRING'|'STRING_LIST',
                    'description': 'string',
                    'values': [
                        'string',
                    ]
                },
            ],
            'tags': [
                {
                    'key': 'string',
                    'value': 'string'
                },
            ],
            'resourceOwner': 'SELF'|'OTHER-ACCOUNTS'
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • permissions (list) –

      An array of objects with information about the permissions.

      • (dict) –

        Information about an RAM permission.

        • arn (string) –

          The Amazon Resource Name (ARN) of the permission you want information about.

        • version (string) –

          The version of the permission associated with this resource share.

        • defaultVersion (boolean) –

          Specifies whether the version of the managed permission used by this resource share is the default version for this managed permission.

        • name (string) –

          The name of this managed permission.

        • resourceType (string) –

          The type of resource to which this permission applies. This takes the form of: service-code: resource-code, and is case-insensitive. For example, an Amazon EC2 Subnet would be represented by the string ec2:subnet.

        • status (string) –

          The current status of the permission.

        • creationTime (datetime) –

          The date and time when the permission was created.

        • lastUpdatedTime (datetime) –

          The date and time when the permission was last updated.

        • isResourceTypeDefault (boolean) –

          Specifies whether the managed permission associated with this resource share is the default managed permission for all resources of this resource type.

        • permissionType (string) –

          The type of managed permission. This can be one of the following values:

          • AWS_MANAGED – Amazon Web Services created and manages this managed permission. You can associate it with your resource shares, but you can’t modify it.

          • CUSTOMER_MANAGED – You, or another principal in your account created this managed permission. You can associate it with your resource shares and create new versions that have different permissions.

        • featureSet (string) –

          Indicates what features are available for this resource share. This parameter can have one of the following values:

          • STANDARD – A resource share that supports all functionality. These resource shares are visible to all principals you share the resource share with. You can modify these resource shares in RAM using the console or APIs. This resource share might have been created by RAM, or it might have been CREATED_FROM_POLICY and then promoted.

          • CREATED_FROM_POLICY – The customer manually shared a resource by attaching a resource-based policy. That policy did not match any existing managed permissions, so RAM created this customer managed permission automatically on the customer’s behalf based on the attached policy document. This type of resource share is visible only to the Amazon Web Services account that created it. You can’t modify it in RAM unless you promote it. For more information, see PromoteResourceShareCreatedFromPolicy.

          • PROMOTING_TO_STANDARD – This resource share was originally CREATED_FROM_POLICY, but the customer ran the PromoteResourceShareCreatedFromPolicy and that operation is still in progress. This value changes to STANDARD when complete.

        • permissionTemplateParameters (list) –

          The list of template parameters defined for this permission, including their names, types, descriptions, and values. This field is present only if the permission is a template with declared parameters. When returned in the context of a permission association, the values are also included.

          • (dict) –

            Contains the declaration of a template parameter for a customer managed permission. When returned in the context of a permission association, it also includes the values assigned to that parameter.

            • name (string) –

              The name of the template parameter.

            • type (string) –

              The type of the template parameter. This can be one of the following values:

              • STRING – A single string value.

              • STRING_LIST – One or more string values.

            • description (string) –

              A description of the template parameter.

            • values (list) –

              The values assigned to this template parameter in the context of a permission association. This field is present only when the parameter has been assigned values (for example, in the response from ListPermissionAssociations or ListResourceSharePermissions).

              • (string) –

        • tags (list) –

          A list of the tag key value pairs currently attached to the permission.

          • (dict) –

            A structure containing a tag. A tag is metadata that you can attach to your resources to help organize and categorize them. You can also use them to help you secure your resources. For more information, see Controlling access to Amazon Web Services resources using tags.

            For more information about tags, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference Guide.

            • key (string) –

              The key, or name, attached to the tag. Every tag must have a key. Key names are case sensitive.

            • value (string) –

              The string value attached to the tag. The value can be an empty string. Key values are case sensitive.

        • resourceOwner (string) –

          The owner of the permission. This can be one of the following values:

          • SELF – The permission is owned by the current account.

          • OTHER-ACCOUNTS – The permission is owned by another account and shared with the current account.

    • nextToken (string) –

      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.

Exceptions