support_permits

Creates, updates, deletes, gets or lists a support_permits resource.

Overview

Name	support_permits
Type	Resource
Id	aws.supportauthz.support_permits

Fields

The following fields are returned by SELECT queries:

get_support_permit

Name	Datatype	Description
name	string	The name of the support permit. (pattern: <code>[a-zA-Z0-9]{1,256}</code>)
arn	string	The ARN of the support permit. (pattern: <code>arn:[a-z0-9-]+:[a-z0-9-]+:[a-z0-9-]*:[0-9]{12}:.+</code>)
created_at	string (date-time)	The timestamp when the permit was created.
description	string	The description of the support permit.
permit	object	The permit definition specifying the authorized actions, resources, and time-window conditions for a support operator.
signing_key_info	object	The signing key used to cryptographically sign a support permit.
status	string	The status of a support permit. (ACTIVE, INACTIVE, DELETING)
support_case_display_id	string	The display identifier of the support case associated with the permit. (pattern: <code>[a-zA-Z0-9:/-]{1,512}</code>)
tags	object	The tags associated with the support permit.

list_support_permits

Name	Datatype	Description
name	string	The name of the support permit. (pattern: <code>[a-zA-Z0-9]{1,256}</code>)
arn	string	The ARN of the support permit. (pattern: <code>arn:[a-z0-9-]+:[a-z0-9-]+:[a-z0-9-]*:[0-9]{12}:.+</code>)
created_at	string (date-time)	The timestamp when the permit was created.
permit	object	The permit definition specifying the authorized actions, resources, and time-window conditions for a support operator.
signing_key_info	object	The signing key used to cryptographically sign a support permit.
status	string	The status of a support permit. (ACTIVE, INACTIVE, DELETING)
support_case_display_id	string	The display identifier of the support case associated with the permit. (pattern: <code>[a-zA-Z0-9:/-]{1,512}</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_support_permit	select	support_permit_identifier, region		Retrieves the details of a support permit by its ARN or name.
list_support_permits	select	region	nextToken, maxResults, supportPermitStatuses	Lists all support permits in the caller's account. Use pagination to ensure that the operation returns quickly and successfully.
create_support_permit	insert	region, permit, name, signingKeyInfo		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.
delete_support_permit	delete	support_permit_identifier, region		Deletes a support permit, revoking the authorization previously granted to the AWS support operator.
reject_support_permit_request	exec	request_arn, region		Rejects a permit request from an AWS support operator. The operator cannot proceed with the requested action.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)
request_arn	string	The ARN of the permit request to reject.
support_permit_identifier	string	The Amazon Resource Name (ARN) or name of the support permit to delete.
maxResults	integer	The maximum number of results to return in a single call. Valid range is 1 to 100.
nextToken	string	The token for the next page of results.
supportPermitStatuses	array	Filters the results by support permit status. Valid values: ACTIVE, INACTIVE, DELETING.

SELECT examples

get_support_permit

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

SELECT
name,
arn,
created_at,
description,
permit,
signing_key_info,
status,
support_case_display_id,
tags
FROM aws.supportauthz.support_permits
WHERE support_permit_identifier = '{{ support_permit_identifier }}' -- required
AND region = '{{ region }}' -- required
;

list_support_permits

Lists all support permits in the caller's account. Use pagination to ensure that the operation returns quickly and successfully.

SELECT
name,
arn,
created_at,
permit,
signing_key_info,
status,
support_case_display_id
FROM aws.supportauthz.support_permits
WHERE region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
AND maxResults = '{{ maxResults }}'
AND supportPermitStatuses = '{{ supportPermitStatuses }}'
;

INSERT examples

create_support_permit

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.

INSERT INTO aws.supportauthz.support_permits (
permit,
name,
description,
signingKeyInfo,
supportCaseDisplayId,
clientToken,
tags,
region
)
SELECT 
'{{ permit }}' /* required */,
'{{ name }}' /* required */,
'{{ description }}',
'{{ signingKeyInfo }}' /* required */,
'{{ supportCaseDisplayId }}',
'{{ clientToken }}',
'{{ tags }}',
'{{ region }}'
RETURNING
name,
arn,
created_at,
description,
permit,
signing_key_info,
status,
support_case_display_id,
tags
;

Manifest

# Description fields are for documentation purposes
- name: support_permits
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the support_permits resource.
  - name: permit
    description: |
      The permit definition specifying the authorized actions, resources, and time-window conditions for a support operator.
    value:
      actions:
        allActions: "{{ allActions }}"
        actions:
          - "{{ actions }}"
      resources:
        allResourcesInRegion: "{{ allResourcesInRegion }}"
        resources:
          - "{{ resources }}"
      conditions:
        - allowAfter: "{{ allowAfter }}"
          allowBefore: "{{ allowBefore }}"
  - name: name
    value: "{{ name }}"
  - name: description
    value: "{{ description }}"
  - name: signingKeyInfo
    description: |
      The signing key used to cryptographically sign a support permit.
    value:
      kmsKey: "{{ kmsKey }}"
  - name: supportCaseDisplayId
    value: "{{ supportCaseDisplayId }}"
  - name: clientToken
    value: "{{ clientToken }}"
  - name: tags
    value: "{{ tags }}"

DELETE examples

delete_support_permit

Deletes a support permit, revoking the authorization previously granted to the AWS support operator.

DELETE FROM aws.supportauthz.support_permits
WHERE support_permit_identifier = '{{ support_permit_identifier }}' --required
AND region = '{{ region }}' --required
;

Lifecycle Methods

reject_support_permit_request

Rejects a permit request from an AWS support operator. The operator cannot proceed with the requested action.

EXEC aws.supportauthz.support_permits.reject_support_permit_request 
@request_arn='{{ request_arn }}' --required, 
@region='{{ region }}' --required
;