Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

GetSupportPermit

Retrieves the details of a support permit by its ARN or name.

Request Syntax


GET /support-permits/supportPermitIdentifier HTTP/1.1

URI Request Parameters

The request uses the following URI parameters.

supportPermitIdentifier

The ARN or name of the support permit to retrieve.

Length Constraints: Minimum length of 1. Maximum length of 512.

Pattern: [a-zA-Z0-9:/-]{1,512}

Required: Yes

Request Body

The request does not have a request body.

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "arn": "string",
   "createdAt": number,
   "description": "string",
   "name": "string",
   "permit": { 
      "actions": { ... },
      "conditions": [ 
         { ... }
      ],
      "resources": { ... }
   },
   "signingKeyInfo": { ... },
   "status": "string",
   "supportCaseDisplayId": "string",
   "tags": { 
      "string" : "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.

arn

The ARN of the support permit.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 512.

Pattern: arn:[a-z0-9-]+:[a-z0-9-]+:[a-z0-9-]*:[0-9]{12}:.+

createdAt

The timestamp when the permit was created.

Type: Timestamp

description

The description of the support permit.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

name

The name of the support permit.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 256.

Pattern: [a-zA-Z0-9]{1,256}

permit

The permit definition.

Type: Permit object

signingKeyInfo

The signing key information for the permit.

Type: SigningKeyInfo object

Note: This object is a Union. Only one member of this object can be specified or returned.

status

The current status of the support permit.

Type: String

Valid Values: ACTIVE | INACTIVE | DELETING

supportCaseDisplayId

The display identifier of the support case associated with the permit.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 512.

Pattern: [a-zA-Z0-9:/-]{1,512}

tags

The tags associated with the support permit.

Type: String to string map

Map Entries: Minimum number of 0 items. Maximum number of 50 items.

Key Length Constraints: Minimum length of 1. Maximum length of 128.

Value Length Constraints: Minimum length of 0. Maximum length of 256.

Errors

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

AccessDeniedException

You don't have sufficient permissions to perform this operation.

HTTP Status Code: 403

InternalServerException

An internal service error occurred. Try again later.

retryAfterSeconds: The number of seconds to wait before retrying the request.

HTTP Status Code: 500

ResourceNotFoundException

The specified resource does not exist.

resourceId: The identifier of the resource that was not found.
resourceType: The type of the resource that was not found.

HTTP Status Code: 404

ThrottlingException

The request rate exceeded the allowed limit. Try again later.

retryAfterSeconds: The number of seconds to wait before retrying the request.

HTTP Status Code: 429

ValidationException

The input fails to satisfy the constraints specified by the service.

fieldList: A list of fields that fail validation. Each entry identifies the field and the reason for the constraint violation.

HTTP Status Code: 400