GetPermission - AWS RAM

GetPermission

Gets the contents of an AWS RAM 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 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 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 identifier for the version of the AWS RAM permission to retrieve. If you don't specify this parameter, the operation retrieves the default version.

Type: Integer

Required: No

Response Syntax

HTTP/1.1 200 Content-type: application/json { "permission": { "arn": "string", "creationTime": number, "defaultVersion": boolean, "isResourceTypeDefault": boolean, "lastUpdatedTime": number, "name": "string", "permission": "string", "resourceType": "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 that contains information about the permission.

Type: ResourceSharePermissionDetail object

Errors

For information about the errors that are common to all actions, see Common Errors.

InvalidParameterException

A parameter is not valid.

HTTP Status Code: 400

MalformedArnException

The format of an Amazon Resource Name (ARN) is not valid.

HTTP Status Code: 400

OperationNotPermittedException

The requested operation is not permitted.

HTTP Status Code: 400

ServerInternalException

The service could not respond to the request due to an internal problem.

HTTP Status Code: 500

ServiceUnavailableException

The service is not available.

HTTP Status Code: 503

UnknownResourceException

A specified resource was not 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: