SupportAuthZ 2026-06-30
- Client: Aws\SupportAuthZ\SupportAuthZClient
- Service ID: supportauthz
- Version: 2026-06-30
This page describes the parameters and results for the operations of the SupportAuthZ (2026-06-30), and shows how to use the Aws\SupportAuthZ\SupportAuthZClient object to call the described operations. This documentation is specific to the 2026-06-30 API version of the service.
Operation Summary
Each of the following operations can be created from a client using
$client->getCommand('CommandName'), where "CommandName" is the
name of one of the following operations. Note: a command is a value that
encapsulates an operation and the parameters used to create an HTTP request.
You can also create and send a command immediately using the magic methods
available on a client object: $client->commandName(/* parameters */).
You can send the command asynchronously (returning a promise) by appending the
word "Async" to the operation name: $client->commandNameAsync(/* parameters */).
- CreateSupportPermit ( array $params = [] )
- Creates a support permit that authorizes an AWS support operator to perform specified actions on specified resources.
- DeleteSupportPermit ( array $params = [] )
- Deletes a support permit, revoking the authorization previously granted to the AWS support operator.
- GetAction ( array $params = [] )
- Retrieves the description of a specific support action.
- GetSupportPermit ( array $params = [] )
- Retrieves the details of a support permit by its ARN or name.
- ListActions ( array $params = [] )
- Lists available support actions for a specified AWS service.
- ListSupportPermitRequests ( array $params = [] )
- Lists permit requests from AWS support operators.
- ListSupportPermits ( array $params = [] )
- Lists all support permits in the caller's account.
- ListTagsForResource ( array $params = [] )
- Lists the tags associated with a support permit resource.
- RejectSupportPermitRequest ( array $params = [] )
- Rejects a permit request from an AWS support operator.
- TagResource ( array $params = [] )
- Adds or overwrites one or more tags for a support permit resource.
- UntagResource ( array $params = [] )
- Removes one or more tags from a support permit resource.
Paginators
Paginators handle automatically iterating over paginated API results. Paginators are associated with specific API operations, and they accept the parameters that the corresponding API operation accepts. You can get a paginator from a client class using getPaginator($paginatorName, $operationParameters). This client supports the following paginators:
Operations
CreateSupportPermit
$result = $client->createSupportPermit([/* ... */]); $promise = $client->createSupportPermitAsync([/* ... */]);
Creates a support permit that authorizes an AWS support operator to perform specified actions on specified resources. The permit is cryptographically signed using a customer-managed AWS KMS key (ECC_NIST_P384, SIGN_VERIFY) to ensure non-repudiation.
Parameter Syntax
$result = $client->createSupportPermit([
'clientToken' => '<string>',
'description' => '<string>',
'name' => '<string>', // REQUIRED
'permit' => [ // REQUIRED
'actions' => [ // REQUIRED
'actions' => ['<string>', ...],
'allActions' => [
],
],
'conditions' => [
[
'allowAfter' => <integer || string || DateTime>,
'allowBefore' => <integer || string || DateTime>,
],
// ...
],
'resources' => [ // REQUIRED
'allResourcesInRegion' => [
],
'resources' => ['<string>', ...],
],
],
'signingKeyInfo' => [ // REQUIRED
'kmsKey' => '<string>',
],
'supportCaseDisplayId' => '<string>',
'tags' => ['<string>', ...],
]);
Parameter Details
Members
- clientToken
-
- Type: string
A unique, case-sensitive identifier to ensure that the operation completes no more than one time. If this token matches a previous request, the service returns the existing permit without creating a duplicate.
- description
-
- Type: string
A human-readable description of why this permit is being created. Maximum length of 1024 characters.
- name
-
- Required: Yes
- Type: string
A customer-chosen name for the support permit. Must be between 1 and 256 alphanumeric characters.
- permit
-
- Required: Yes
- Type: Permit structure
The permit definition specifying the actions, resources, and time-window conditions that the support operator is authorized to use.
- signingKeyInfo
-
- Required: Yes
- Type: SigningKeyInfo structure
The signing key information used to sign the permit. Must reference an AWS KMS key with key usage SIGN_VERIFY and key spec ECC_NIST_P384.
- supportCaseDisplayId
-
- Type: string
The display identifier of the AWS Support case associated with this permit.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
The tags to associate with the support permit on creation.
Result Syntax
[
'arn' => '<string>',
'createdAt' => <DateTime>,
'description' => '<string>',
'name' => '<string>',
'permit' => [
'actions' => [
'actions' => ['<string>', ...],
'allActions' => [
],
],
'conditions' => [
[
'allowAfter' => <DateTime>,
'allowBefore' => <DateTime>,
],
// ...
],
'resources' => [
'allResourcesInRegion' => [
],
'resources' => ['<string>', ...],
],
],
'signingKeyInfo' => [
'kmsKey' => '<string>',
],
'status' => 'ACTIVE|INACTIVE|DELETING',
'supportCaseDisplayId' => '<string>',
'tags' => ['<string>', ...],
]
Result Details
Members
- arn
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) of the support permit.
- createdAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when the permit was created.
- description
-
- Type: string
The description of the support permit.
- name
-
- Required: Yes
- Type: string
The name of the support permit.
- permit
-
- Required: Yes
- Type: Permit structure
The permit definition.
- signingKeyInfo
-
- Required: Yes
- Type: SigningKeyInfo structure
The signing key information for the permit.
- status
-
- Required: Yes
- Type: string
The current status of the support permit.
- supportCaseDisplayId
-
- Type: string
The display identifier of the support case associated with the permit.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
The tags associated with the support permit.
Errors
- ValidationException:
The input fails to satisfy the constraints specified by the service.
- ConflictException:
The request conflicts with the current state of the resource.
- AccessDeniedException:
You don't have sufficient permissions to perform this operation.
- ThrottlingException:
The request rate exceeded the allowed limit. Try again later.
- ServiceQuotaExceededException:
The request exceeds a service quota for your account.
- InternalServerException:
An internal service error occurred. Try again later.
DeleteSupportPermit
$result = $client->deleteSupportPermit([/* ... */]); $promise = $client->deleteSupportPermitAsync([/* ... */]);
Deletes a support permit, revoking the authorization previously granted to the AWS support operator.
Parameter Syntax
$result = $client->deleteSupportPermit([
'supportPermitIdentifier' => '<string>', // REQUIRED
]);
Parameter Details
Members
- supportPermitIdentifier
-
- Required: Yes
- Type: string
The Amazon Resource Name (ARN) or name of the support permit to delete.
Result Syntax
[
'arn' => '<string>',
'createdAt' => <DateTime>,
'description' => '<string>',
'name' => '<string>',
'permit' => [
'actions' => [
'actions' => ['<string>', ...],
'allActions' => [
],
],
'conditions' => [
[
'allowAfter' => <DateTime>,
'allowBefore' => <DateTime>,
],
// ...
],
'resources' => [
'allResourcesInRegion' => [
],
'resources' => ['<string>', ...],
],
],
'signingKeyInfo' => [
'kmsKey' => '<string>',
],
'status' => 'ACTIVE|INACTIVE|DELETING',
'supportCaseDisplayId' => '<string>',
]
Result Details
Members
- arn
-
- Required: Yes
- Type: string
The ARN of the deleted support permit.
- createdAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when the permit was originally created.
- description
-
- Type: string
The description of the deleted support permit.
- name
-
- Required: Yes
- Type: string
The name of the deleted support permit.
- permit
-
- Required: Yes
- Type: Permit structure
The permit definition of the deleted permit.
- signingKeyInfo
-
- Required: Yes
- Type: SigningKeyInfo structure
The signing key information for the deleted permit.
- status
-
- Required: Yes
- Type: string
The status of the support permit. Returns DELETING.
- supportCaseDisplayId
-
- Type: string
The display identifier of the support case associated with the deleted permit.
Errors
- ValidationException:
The input fails to satisfy the constraints specified by the service.
- ResourceNotFoundException:
The specified resource does not exist.
- AccessDeniedException:
You don't have sufficient permissions to perform this operation.
- ThrottlingException:
The request rate exceeded the allowed limit. Try again later.
- InternalServerException:
An internal service error occurred. Try again later.
GetAction
$result = $client->getAction([/* ... */]); $promise = $client->getActionAsync([/* ... */]);
Retrieves the description of a specific support action.
Parameter Syntax
$result = $client->getAction([
'action' => '<string>', // REQUIRED
]);
Parameter Details
Members
- action
-
- Required: Yes
- Type: string
The name of the support action to retrieve.
Result Syntax
[
'action' => '<string>',
'description' => '<string>',
'service' => '<string>',
]
Result Details
Members
- action
-
- Required: Yes
- Type: string
The name of the support action.
- description
-
- Required: Yes
- Type: string
A description of what the support action does.
- service
-
- Required: Yes
- Type: string
The AWS service associated with the support action.
Errors
- ValidationException:
The input fails to satisfy the constraints specified by the service.
- ResourceNotFoundException:
The specified resource does not exist.
- AccessDeniedException:
You don't have sufficient permissions to perform this operation.
- ThrottlingException:
The request rate exceeded the allowed limit. Try again later.
- InternalServerException:
An internal service error occurred. Try again later.
GetSupportPermit
$result = $client->getSupportPermit([/* ... */]); $promise = $client->getSupportPermitAsync([/* ... */]);
Retrieves the details of a support permit by its ARN or name.
Parameter Syntax
$result = $client->getSupportPermit([
'supportPermitIdentifier' => '<string>', // REQUIRED
]);
Parameter Details
Members
- supportPermitIdentifier
-
- Required: Yes
- Type: string
The ARN or name of the support permit to retrieve.
Result Syntax
[
'arn' => '<string>',
'createdAt' => <DateTime>,
'description' => '<string>',
'name' => '<string>',
'permit' => [
'actions' => [
'actions' => ['<string>', ...],
'allActions' => [
],
],
'conditions' => [
[
'allowAfter' => <DateTime>,
'allowBefore' => <DateTime>,
],
// ...
],
'resources' => [
'allResourcesInRegion' => [
],
'resources' => ['<string>', ...],
],
],
'signingKeyInfo' => [
'kmsKey' => '<string>',
],
'status' => 'ACTIVE|INACTIVE|DELETING',
'supportCaseDisplayId' => '<string>',
'tags' => ['<string>', ...],
]
Result Details
Members
- arn
-
- Required: Yes
- Type: string
The ARN of the support permit.
- createdAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when the permit was created.
- description
-
- Type: string
The description of the support permit.
- name
-
- Required: Yes
- Type: string
The name of the support permit.
- permit
-
- Required: Yes
- Type: Permit structure
The permit definition.
- signingKeyInfo
-
- Required: Yes
- Type: SigningKeyInfo structure
The signing key information for the permit.
- status
-
- Required: Yes
- Type: string
The current status of the support permit.
- supportCaseDisplayId
-
- Type: string
The display identifier of the support case associated with the permit.
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
The tags associated with the support permit.
Errors
- ValidationException:
The input fails to satisfy the constraints specified by the service.
- ResourceNotFoundException:
The specified resource does not exist.
- AccessDeniedException:
You don't have sufficient permissions to perform this operation.
- ThrottlingException:
The request rate exceeded the allowed limit. Try again later.
- InternalServerException:
An internal service error occurred. Try again later.
ListActions
$result = $client->listActions([/* ... */]); $promise = $client->listActionsAsync([/* ... */]);
Lists available support actions for a specified AWS service. Use pagination to ensure that the operation returns quickly and successfully.
Parameter Syntax
$result = $client->listActions([
'maxResults' => <integer>,
'nextToken' => '<string>',
'service' => '<string>', // REQUIRED
]);
Parameter Details
Members
- maxResults
-
- Type: int
The maximum number of results to return in a single call. Valid range is 1 to 100.
- nextToken
-
- Type: string
The token for the next page of results.
- service
-
- Required: Yes
- Type: string
The name of the AWS service for which to list available support actions.
Result Syntax
[
'actionSummaries' => [
[
'action' => '<string>',
'description' => '<string>',
'service' => '<string>',
],
// ...
],
'nextToken' => '<string>',
]
Result Details
Members
- actionSummaries
-
- Required: Yes
- Type: Array of ActionSummary structures
The list of support actions.
- nextToken
-
- Type: string
The token for the next page of results, or null if there are no more results.
Errors
- ValidationException:
The input fails to satisfy the constraints specified by the service.
- AccessDeniedException:
You don't have sufficient permissions to perform this operation.
- ThrottlingException:
The request rate exceeded the allowed limit. Try again later.
- InternalServerException:
An internal service error occurred. Try again later.
ListSupportPermitRequests
$result = $client->listSupportPermitRequests([/* ... */]); $promise = $client->listSupportPermitRequestsAsync([/* ... */]);
Lists permit requests from AWS support operators. Use pagination to ensure that the operation returns quickly and successfully.
Parameter Syntax
$result = $client->listSupportPermitRequests([
'maxResults' => <integer>,
'nextToken' => '<string>',
'supportCaseDisplayId' => '<string>',
]);
Parameter Details
Members
- maxResults
-
- Type: int
The maximum number of results to return in a single call. Valid range is 1 to 100.
- nextToken
-
- Type: string
The token for the next page of results.
- supportCaseDisplayId
-
- Type: string
Filters the results by support case display identifier.
Result Syntax
[
'nextToken' => '<string>',
'supportPermitRequests' => [
[
'createdAt' => <DateTime>,
'permit' => [
'actions' => [
'actions' => ['<string>', ...],
'allActions' => [
],
],
'conditions' => [
[
'allowAfter' => <DateTime>,
'allowBefore' => <DateTime>,
],
// ...
],
'resources' => [
'allResourcesInRegion' => [
],
'resources' => ['<string>', ...],
],
],
'requestArn' => '<string>',
'status' => 'PENDING|ACCEPTED|REJECTED|CANCELLED',
'supportCaseDisplayId' => '<string>',
'updatedAt' => <DateTime>,
],
// ...
],
]
Result Details
Members
- nextToken
-
- Type: string
The token for the next page of results, or null if there are no more results.
- supportPermitRequests
-
- Required: Yes
- Type: Array of SupportPermitRequest structures
The list of permit requests.
Errors
- ValidationException:
The input fails to satisfy the constraints specified by the service.
- AccessDeniedException:
You don't have sufficient permissions to perform this operation.
- ThrottlingException:
The request rate exceeded the allowed limit. Try again later.
- InternalServerException:
An internal service error occurred. Try again later.
ListSupportPermits
$result = $client->listSupportPermits([/* ... */]); $promise = $client->listSupportPermitsAsync([/* ... */]);
Lists all support permits in the caller's account. Use pagination to ensure that the operation returns quickly and successfully.
Parameter Syntax
$result = $client->listSupportPermits([
'maxResults' => <integer>,
'nextToken' => '<string>',
'supportPermitStatuses' => ['<string>', ...],
]);
Parameter Details
Members
- maxResults
-
- Type: int
The maximum number of results to return in a single call. Valid range is 1 to 100.
- nextToken
-
- Type: string
The token for the next page of results.
- supportPermitStatuses
-
- Type: Array of strings
Filters the results by support permit status. Valid values: ACTIVE, INACTIVE, DELETING.
Result Syntax
[
'nextToken' => '<string>',
'supportPermits' => [
[
'arn' => '<string>',
'createdAt' => <DateTime>,
'name' => '<string>',
'permit' => [
'actions' => [
'actions' => ['<string>', ...],
'allActions' => [
],
],
'conditions' => [
[
'allowAfter' => <DateTime>,
'allowBefore' => <DateTime>,
],
// ...
],
'resources' => [
'allResourcesInRegion' => [
],
'resources' => ['<string>', ...],
],
],
'signingKeyInfo' => [
'kmsKey' => '<string>',
],
'status' => 'ACTIVE|INACTIVE|DELETING',
'supportCaseDisplayId' => '<string>',
],
// ...
],
]
Result Details
Members
- nextToken
-
- Type: string
The token for the next page of results, or null if there are no more results.
- supportPermits
-
- Required: Yes
- Type: Array of SupportPermitSummary structures
The list of support permits.
Errors
- ValidationException:
The input fails to satisfy the constraints specified by the service.
- AccessDeniedException:
You don't have sufficient permissions to perform this operation.
- ThrottlingException:
The request rate exceeded the allowed limit. Try again later.
- InternalServerException:
An internal service error occurred. Try again later.
ListTagsForResource
$result = $client->listTagsForResource([/* ... */]); $promise = $client->listTagsForResourceAsync([/* ... */]);
Lists the tags associated with a support permit resource.
Parameter Syntax
$result = $client->listTagsForResource([
'resourceArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
- resourceArn
-
- Required: Yes
- Type: string
The ARN of the resource to list tags for.
Result Syntax
[
'tags' => ['<string>', ...],
]
Result Details
Members
- tags
-
- Type: Associative array of custom strings keys (TagKey) to strings
The tags associated with the resource.
Errors
- ValidationException:
The input fails to satisfy the constraints specified by the service.
- ResourceNotFoundException:
The specified resource does not exist.
- AccessDeniedException:
You don't have sufficient permissions to perform this operation.
- ThrottlingException:
The request rate exceeded the allowed limit. Try again later.
- InternalServerException:
An internal service error occurred. Try again later.
RejectSupportPermitRequest
$result = $client->rejectSupportPermitRequest([/* ... */]); $promise = $client->rejectSupportPermitRequestAsync([/* ... */]);
Rejects a permit request from an AWS support operator. The operator cannot proceed with the requested action.
Parameter Syntax
$result = $client->rejectSupportPermitRequest([
'requestArn' => '<string>', // REQUIRED
]);
Parameter Details
Members
- requestArn
-
- Required: Yes
- Type: string
The ARN of the permit request to reject.
Result Syntax
[
'requestArn' => '<string>',
]
Result Details
Members
- requestArn
-
- Required: Yes
- Type: string
The ARN of the rejected permit request.
Errors
- ValidationException:
The input fails to satisfy the constraints specified by the service.
- ConflictException:
The request conflicts with the current state of the resource.
- ResourceNotFoundException:
The specified resource does not exist.
- AccessDeniedException:
You don't have sufficient permissions to perform this operation.
- ThrottlingException:
The request rate exceeded the allowed limit. Try again later.
- InternalServerException:
An internal service error occurred. Try again later.
TagResource
$result = $client->tagResource([/* ... */]); $promise = $client->tagResourceAsync([/* ... */]);
Adds or overwrites one or more tags for a support permit resource.
Parameter Syntax
$result = $client->tagResource([
'resourceArn' => '<string>', // REQUIRED
'tags' => ['<string>', ...], // REQUIRED
]);
Parameter Details
Members
- resourceArn
-
- Required: Yes
- Type: string
The ARN of the resource to tag.
- tags
-
- Required: Yes
- Type: Associative array of custom strings keys (TagKey) to strings
The tags to add to the resource. Maximum of 50 tags.
Result Syntax
[]
Result Details
Errors
- ValidationException:
The input fails to satisfy the constraints specified by the service.
- ResourceNotFoundException:
The specified resource does not exist.
- AccessDeniedException:
You don't have sufficient permissions to perform this operation.
- ThrottlingException:
The request rate exceeded the allowed limit. Try again later.
- InternalServerException:
An internal service error occurred. Try again later.
UntagResource
$result = $client->untagResource([/* ... */]); $promise = $client->untagResourceAsync([/* ... */]);
Removes one or more tags from a support permit resource.
Parameter Syntax
$result = $client->untagResource([
'resourceArn' => '<string>', // REQUIRED
'tagKeys' => ['<string>', ...], // REQUIRED
]);
Parameter Details
Members
- resourceArn
-
- Required: Yes
- Type: string
The ARN of the resource to untag.
- tagKeys
-
- Required: Yes
- Type: Array of strings
The tag keys to remove from the resource.
Result Syntax
[]
Result Details
Errors
- ValidationException:
The input fails to satisfy the constraints specified by the service.
- ResourceNotFoundException:
The specified resource does not exist.
- AccessDeniedException:
You don't have sufficient permissions to perform this operation.
- ThrottlingException:
The request rate exceeded the allowed limit. Try again later.
- InternalServerException:
An internal service error occurred. Try again later.
Shapes
AccessDeniedException
Description
You don't have sufficient permissions to perform this operation.
Members
- message
-
- Required: Yes
- Type: string
ActionSet
Description
The set of actions authorized by a permit. Specify either all actions or a list of specific actions.
Members
- actions
-
- Type: Array of strings
A list of specific support actions to authorize. Maximum of 10 actions.
- allActions
-
- Type: Unit structure
Authorizes all available support actions.
ActionSummary
Description
A summary of a support action.
Members
- action
-
- Required: Yes
- Type: string
The name of the support action.
- description
-
- Required: Yes
- Type: string
A description of what the support action does.
- service
-
- Required: Yes
- Type: string
The AWS service associated with the support action.
Condition
Description
A time-window condition that constrains when a support permit is valid.
Members
- allowAfter
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The earliest time at which the permit becomes valid.
- allowBefore
-
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The latest time at which the permit remains valid.
ConflictException
Description
The request conflicts with the current state of the resource.
Members
- message
-
- Required: Yes
- Type: string
- resourceId
-
- Required: Yes
- Type: string
The identifier of the resource that caused the conflict.
- resourceType
-
- Required: Yes
- Type: string
The type of the resource that caused the conflict.
InternalServerException
Description
An internal service error occurred. Try again later.
Members
- message
-
- Required: Yes
- Type: string
- retryAfterSeconds
-
- Type: int
The number of seconds to wait before retrying the request.
Permit
Description
The permit definition specifying the authorized actions, resources, and time-window conditions for a support operator.
Members
- actions
-
- Required: Yes
- Type: ActionSet structure
The set of actions that the support operator is authorized to perform.
- conditions
-
- Type: Array of Condition structures
The time-window conditions that constrain when the permit is valid. Maximum of 2 conditions.
- resources
-
- Required: Yes
- Type: ResourceSet structure
The set of resources that the support operator is authorized to act upon.
ResourceNotFoundException
Description
The specified resource does not exist.
Members
- message
-
- Required: Yes
- Type: string
- resourceId
-
- Required: Yes
- Type: string
The identifier of the resource that was not found.
- resourceType
-
- Required: Yes
- Type: string
The type of the resource that was not found.
ResourceSet
Description
The set of resources authorized by a permit. Specify either all resources in the Region or a list of specific resources.
Members
- allResourcesInRegion
-
- Type: Unit structure
Authorizes the support operator to act on all resources in the Region.
- resources
-
- Type: Array of strings
A list of specific resource identifiers that the support operator is authorized to act upon. Maximum of 5 resources.
ServiceQuotaExceededException
Description
The request exceeds a service quota for your account.
Members
- message
-
- Required: Yes
- Type: string
- quotaCode
-
- Required: Yes
- Type: string
The quota code of the exceeded quota.
- resourceId
-
- Required: Yes
- Type: string
The identifier of the resource that exceeded the quota.
- resourceType
-
- Required: Yes
- Type: string
The type of the resource that exceeded the quota.
- serviceCode
-
- Required: Yes
- Type: string
The service code of the originating service.
SigningKeyInfo
Description
The signing key used to cryptographically sign a support permit.
Members
- kmsKey
-
- Type: string
The ARN of the AWS KMS key used to sign the permit. The key must have key spec ECC_NIST_P384 and key usage SIGN_VERIFY.
SupportPermitRequest
Description
A permit request from an AWS support operator.
Members
- createdAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when the request was created.
- permit
-
- Required: Yes
- Type: Permit structure
The permit definition requested by the operator.
- requestArn
-
- Required: Yes
- Type: string
The ARN of the permit request.
- status
-
- Required: Yes
- Type: string
The current status of the permit request.
- supportCaseDisplayId
-
- Required: Yes
- Type: string
The display identifier of the support case associated with the request.
- updatedAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when the request was last updated.
SupportPermitSummary
Description
A summary of a support permit.
Members
- arn
-
- Required: Yes
- Type: string
The ARN of the support permit.
- createdAt
-
- Required: Yes
- Type: timestamp (string|DateTime or anything parsable by strtotime)
The timestamp when the permit was created.
- name
-
- Required: Yes
- Type: string
The name of the support permit.
- permit
-
- Required: Yes
- Type: Permit structure
The permit definition.
- signingKeyInfo
-
- Required: Yes
- Type: SigningKeyInfo structure
The signing key information for the permit.
- status
-
- Required: Yes
- Type: string
The current status of the support permit.
- supportCaseDisplayId
-
- Type: string
The display identifier of the support case associated with the permit.
ThrottlingException
Description
The request rate exceeded the allowed limit. Try again later.
Members
- message
-
- Required: Yes
- Type: string
- retryAfterSeconds
-
- Type: int
The number of seconds to wait before retrying the request.
Unit
Members
ValidationException
Description
The input fails to satisfy the constraints specified by the service.
Members
- fieldList
-
- Type: Array of ValidationExceptionField structures
A list of fields that fail validation. Each entry identifies the field and the reason for the constraint violation.
- message
-
- Required: Yes
- Type: string
ValidationExceptionField
Description
Describes one specific validation failure for an input member.
Members
- message
-
- Required: Yes
- Type: string
A detailed description of the validation failure.
- path
-
- Required: Yes
- Type: string
A JSONPointer expression to the structure member whose value failed to satisfy the modeled constraints.