RAM / Client / get_permission

get_permission#

RAM.Client.get_permission(**kwargs)#

Gets the contents of an RAM permission in JSON format.

See also: AWS API Documentation

Request Syntax

response = client.get_permission(
    permissionArn='string',
    permissionVersion=123
)
Parameters:

  • permissionArn (string) –

    [REQUIRED]

    Specifies the Amazon Resoure Name (ARN) of the permission whose contents you want to retrieve. To find the ARN for a permission, use either the ListPermissions operation or go to the Permissions library page in the RAM console and then choose the name of the permission. The ARN is displayed on the detail page.

  • permissionVersion (integer) – Specifies identifier for the version of the RAM permission to retrieve. If you don’t specify this parameter, the operation retrieves the default version.

Return type:

dict

Returns:

Response Syntax

{
    'permission': {
        'arn': 'string',
        'version': 'string',
        'defaultVersion': True|False,
        'name': 'string',
        'resourceType': 'string',
        'permission': 'string',
        'creationTime': datetime(2015, 1, 1),
        'lastUpdatedTime': datetime(2015, 1, 1),
        'isResourceTypeDefault': True|False
    }
}

Response Structure

  • (dict) –

    • permission (dict) –

      An object that contains information about the permission.

      • arn (string) –

        The Amazon Resoure Name (ARN) of this RAM permission.

      • version (string) –

        The version of the permission represented in this structure.

      • defaultVersion (boolean) –

        Specifies whether the version of the permission represented in this structure is the default version for this permission.

      • name (string) –

        The name of this permission.

      • resourceType (string) –

        The resource type to which this permission applies.

      • permission (string) –

        The permission’s effect and actions in JSON format. The effect indicates whether the specified actions are allowed or denied. The actions list the operations to which the principal is granted or denied access.

      • 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 version of the permission represented in this structure is the default version for all resources of this resource type.

Exceptions

  • RAM.Client.exceptions.InvalidParameterException

  • RAM.Client.exceptions.MalformedArnException

  • RAM.Client.exceptions.UnknownResourceException

  • RAM.Client.exceptions.ServerInternalException

  • RAM.Client.exceptions.ServiceUnavailableException

  • RAM.Client.exceptions.OperationNotPermittedException