AWS CLI Command Reference

[ aws . ram ]

get-permission

Description

Retrieves the contents of a managed permission in JSON format.

If the permission has template parameters, you can include the permissionTemplateParameters parameter in your request. The operation then renders the returned policy with the specified values in place of the template parameter placeholders. If you omit permissionTemplateParameters , the operation returns the raw policy template with @{parameterName} placeholders unchanged.

See also: AWS API Documentation

Synopsis

  get-permission
--permission-arn <value>
[--permission-version <value>]
[--permission-template-parameters <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]
[--help]

Options

--permission-arn (string) [required]

Specifies the Amazon Resource 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.

--permission-version (integer)

Specifies the version number of the RAM permission to retrieve. If you don’t specify this parameter, the operation retrieves the default version.

To see the list of available versions, use ListPermissionVersions .

--permission-template-parameters (list)

Specifies the template parameter values to use when rendering the permission’s policy template. Each entry supplies a parameter name and its values. When you provide this parameter, the response contains the rendered policy with the specified values in place of the template parameter placeholders.

For STRING type parameters, provide a single value. For STRING_LIST type parameters, provide one or more values.

You can specify this parameter only for permissions that declare template parameters. You must provide values for all parameters declared in the permission template.

(structure)

Contains the name and values to assign to a template parameter when associating a permission template with a resource share.

name -> (string)

The name of the template parameter to assign a value to. This must match a parameter name declared in the permission template.

values -> (list)

The values to assign to the template parameter. For STRING type parameters, provide a single value. For STRING_LIST type parameters, provide one or more values.

(string)

Shorthand Syntax:

name=string,values=string,string ...

JSON Syntax:

[
  {
    "name": "string",
    "values": ["string", ...]
  }
  ...
]

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

  • json
  • text
  • table
  • yaml
  • yaml-stream
  • off

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

  • legacy
  • json
  • yaml
  • text
  • table
  • enhanced

--help (boolean)

Display help for the command/subcommand.

Examples

Note

To use the following examples, you must have the AWS CLI installed and configured. See the Getting started guide in the AWS CLI User Guide for more information.

Unless otherwise stated, all examples have unix-like quotation rules. These examples will need to be adapted to your terminal’s quoting rules. See Using quotation marks with strings in the AWS CLI User Guide .

To retrieve the details for a RAM managed permission

The following get-permission example displays the details for the default version of the specified RAM managed permission.

aws ram get-permission \
    --permission-arn arn:aws:ram::aws:permission/AWSRAMPermissionGlueTableReadWriteForDatabase

Output:

{
    "permission": {
        "arn": "arn:aws:ram::aws:permission/AWSRAMPermissionGlueTableReadWriteForDatabase",
        "version": "2",
        "defaultVersion": true,
        "name": "AWSRAMPermissionGlueTableReadWriteForDatabase",
        "resourceType": "glue:Database",
        "permission": "{\"Effect\":\"Allow\",\"Action\":[\"glue:GetTable\", \"glue:UpdateTable\", \"glue:DeleteTable\", \"glue:BatchDeleteTable\", \"glue:BatchDeleteTableVersion\", \"glue:GetTableVersion\", \"glue:GetTableVersions\", \"glue:GetPartition\", \"glue:GetPartitions\", \"glue:BatchGetPartition\", \"glue:BatchCreatePartition\", \"glue:CreatePartition\", \"glue:UpdatePartition\", \"glue:BatchDeletePartition\", \"glue:DeletePartition\", \"glue:GetTables\", \"glue:SearchTables\"]}",
        "creationTime": 1624912434.431,
        "lastUpdatedTime": 1624912434.431,
        "isResourceTypeDefault": false
    }
}

For more information, see Viewing managed permissions in the AWS RAM User Guide.

Output

permission -> (structure)

An object with details about the permission.

arn -> (string)

The Amazon Resource Name (ARN) of this RAM managed permission.

version -> (string)

The version of the permission described in this response.

defaultVersion -> (boolean)

Specifies whether the version of the permission represented in this response 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.

permissionTemplateParameters -> (list)

The list of template parameter declarations defined for this permission. Each declaration includes the parameter name, type, and description. This field is present only if the permission is a template with declared parameters.

Constraints:

  • max: 100

(structure)

Describes a template parameter declaration for a customer managed permission. Each declaration defines a named placeholder that can be used in the permission’s policy template.

name -> (string)

The name of the template parameter. This name is used as the placeholder in the policy template using the syntax @{parameterName} .

type -> (string)

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

  • STRING – A single string value that is substituted directly into the template.
  • STRING_LIST – One or more string values that expand to an array in the rendered policy.

Possible values:

  • STRING
  • STRING_LIST

description -> (string)

A description of the template parameter that helps consumers understand what value to provide.

creationTime -> (timestamp)

The date and time when the permission was created.

lastUpdatedTime -> (timestamp)

The date and time when the permission was last updated.

isResourceTypeDefault -> (boolean)

Specifies whether the version of the permission represented in this response is the default version 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.

Possible values:

  • CUSTOMER_MANAGED
  • AWS_MANAGED

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.

Possible values:

  • CREATED_FROM_POLICY
  • PROMOTING_TO_STANDARD
  • STANDARD

status -> (string)

The current status of the association between the permission and the resource share. The following are the possible values:

  • ATTACHABLE – This permission or version can be associated with resource shares.
  • UNATTACHABLE – This permission or version can’t currently be associated with resource shares.
  • DELETING – This permission or version is in the process of being deleted.
  • DELETED – This permission or version is deleted.
  • DEPRECATED – The permission owner deprecated this permission. It can’t be associated with new resource shares, but existing associations continue to function.

Possible values:

  • ATTACHABLE
  • UNATTACHABLE
  • DELETING
  • DELETED
  • DEPRECATED

tags -> (list)

The tag key and value pairs attached to the resource share.

(structure)

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.

Possible values:

  • SELF
  • OTHER-ACCOUNTS
© Copyright 2026, Amazon Web Services. Created using Sphinx.