Retrieves the contents of a managed permission in JSON format.
Request Syntax
POST /getpermission HTTP/1.1
Content-type: application/json
{
"permissionArn": "string",
"permissionVersion": number
}URI Request Parameters
The request does not use any URI parameters.
Request Body
The request accepts the following data in JSON format.
- permissionArn
-
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 AWS RAM console and then choose the name of the permission. The ARN is displayed on the detail page. Type: String
Required: Yes
- permissionVersion
-
Specifies the version number of the AWS 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.
Type: Integer
Required: No
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"permission": {
"arn": "string",
"creationTime": number,
"defaultVersion": boolean,
"featureSet": "string",
"isResourceTypeDefault": boolean,
"lastUpdatedTime": number,
"name": "string",
"permission": "string",
"permissionType": "string",
"resourceType": "string",
"status": "string",
"tags": [
{
"key": "string",
"value": "string"
}
],
"version": "string"
}
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- permission
-
An object with details about the permission.
Type: ResourceSharePermissionDetail object
Errors
For information about the errors that are common to all actions, see Common Errors.
- InvalidParameterException
-
The operation failed because a parameter you specified isn't valid.
HTTP Status Code: 400
- MalformedArnException
-
The operation failed because the specified Amazon Resource Name (ARN) has a format that isn't valid.
HTTP Status Code: 400
- OperationNotPermittedException
-
The operation failed because the requested operation isn't permitted.
HTTP Status Code: 400
- ServerInternalException
-
The operation failed because the service could not respond to the request due to an internal problem. Try again later.
HTTP Status Code: 500
- ServiceUnavailableException
-
The operation failed because the service isn't available. Try again later.
HTTP Status Code: 503
- UnknownResourceException
-
The operation failed because a specified resource couldn't be found.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
