create-support-permit¶

Description¶

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.

Synopsis¶

  create-support-permit
--permit <value>
--name <value>
[--description <value>]
--signing-key-info <value>
[--support-case-display-id <value>]
[--client-token <value>]
[--tags <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]
[--cli-error-format <value>]

Options¶

--permit (structure) [required]

The permit definition specifying the actions, resources, and time-window conditions that the support operator is authorized to use.

actions -> (tagged union structure) [required]

The set of actions that the support operator is authorized to perform.

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: allActions, actions.

allActions -> (structure)

Authorizes all available support actions.

actions -> (list)

A list of specific support actions to authorize. Maximum of 10 actions.

Constraints:

min: 1

max: 10

(string)

Constraints:

min: 3

max: 255

pattern: [a-z][a-z0-9-]*:[A-Za-z0-9_.-]+

resources -> (tagged union structure) [required]

The set of resources that the support operator is authorized to act upon.

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: allResourcesInRegion, resources.

allResourcesInRegion -> (structure)

Authorizes the support operator to act on all resources in the Region.

resources -> (list)

A list of specific resource identifiers that the support operator is authorized to act upon. Maximum of 5 resources.

Constraints:

min: 1

max: 5

(string)

Constraints:

min: 1

max: 512

pattern: [a-zA-Z0-9:/_.-]+

conditions -> (list)

The time-window conditions that constrain when the permit is valid. Maximum of 2 conditions.

Constraints:

min: 0

max: 2

(tagged union structure)

A time-window condition that constrains when a support permit is valid.

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: allowAfter, allowBefore.

allowAfter -> (timestamp)

The earliest time at which the permit becomes valid.

allowBefore -> (timestamp)

The latest time at which the permit remains valid.

Shorthand Syntax:

actions={allActions={},actions=[string,string]},resources={allResourcesInRegion={},resources=[string,string]},conditions=[{allowAfter=timestamp,allowBefore=timestamp},{allowAfter=timestamp,allowBefore=timestamp}]

JSON Syntax:

{
  "actions": {
    "allActions": {

    },
    "actions": ["string", ...]
  },
  "resources": {
    "allResourcesInRegion": {

    },
    "resources": ["string", ...]
  },
  "conditions": [
    {
      "allowAfter": timestamp,
      "allowBefore": timestamp
    }
    ...
  ]
}

--name (string) [required]

A customer-chosen name for the support permit. Must be between 1 and 256 alphanumeric characters.

Constraints:

min: 1

max: 256

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

--description (string)

A human-readable description of why this permit is being created. Maximum length of 1024 characters.

Constraints:

min: 1

max: 1024

--signing-key-info (tagged union structure) [required]

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.

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: kmsKey.

kmsKey -> (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.

Constraints:

min: 1

max: 512

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

Shorthand Syntax:

kmsKey=string

JSON Syntax:

{
  "kmsKey": "string"
}

--support-case-display-id (string)

The display identifier of the AWS Support case associated with this permit.

Constraints:

min: 1

max: 512

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

--client-token (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.

Constraints:

min: 1

max: 128

pattern: [!-~]+

--tags (map)

The tags to associate with the support permit on creation.

Constraints:

min: 0

max: 50

key -> (string)

Constraints:

min: 1

max: 128

value -> (string)

Constraints:

min: 0

max: 256

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options¶

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

json
text
table
yaml
yaml-stream
off

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

on
off
auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

base64
raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

--cli-error-format (string)

The formatting style for error output. By default, errors are displayed in enhanced format.

legacy
json
yaml
text
table
enhanced

Output¶

name -> (string)

The name of the support permit.

Constraints:

min: 1

max: 256

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

arn -> (string)

The Amazon Resource Name (ARN) of the support permit.

Constraints:

min: 1

max: 512

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

description -> (string)

The description of the support permit.

Constraints:

min: 1

max: 1024

permit -> (structure)

The permit definition.

actions -> (tagged union structure) [required]

The set of actions that the support operator is authorized to perform.

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: allActions, actions.

allActions -> (structure)

Authorizes all available support actions.

actions -> (list)

A list of specific support actions to authorize. Maximum of 10 actions.

Constraints:

min: 1

max: 10

(string)

Constraints:

min: 3

max: 255

pattern: [a-z][a-z0-9-]*:[A-Za-z0-9_.-]+

resources -> (tagged union structure) [required]

The set of resources that the support operator is authorized to act upon.

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: allResourcesInRegion, resources.

allResourcesInRegion -> (structure)

Authorizes the support operator to act on all resources in the Region.

resources -> (list)

A list of specific resource identifiers that the support operator is authorized to act upon. Maximum of 5 resources.

Constraints:

min: 1

max: 5

(string)

Constraints:

min: 1

max: 512

pattern: [a-zA-Z0-9:/_.-]+

conditions -> (list)

The time-window conditions that constrain when the permit is valid. Maximum of 2 conditions.

Constraints:

min: 0

max: 2

(tagged union structure)

A time-window condition that constrains when a support permit is valid.

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: allowAfter, allowBefore.

allowAfter -> (timestamp)

The earliest time at which the permit becomes valid.

allowBefore -> (timestamp)

The latest time at which the permit remains valid.

status -> (string)

The current status of the support permit.

Possible values:

ACTIVE

INACTIVE

DELETING

signingKeyInfo -> (tagged union structure)

The signing key information for the permit.

Note
This is a Tagged Union structure. Only one of the following top level keys can be set: kmsKey.

kmsKey -> (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.

Constraints:

min: 1

max: 512

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

createdAt -> (timestamp)

The timestamp when the permit was created.

supportCaseDisplayId -> (string)

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

Constraints:

min: 1

max: 512

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

tags -> (map)

The tags associated with the support permit.

Constraints:

min: 0

max: 50

key -> (string)

Constraints:

min: 1

max: 128

value -> (string)

Constraints:

min: 0

max: 256

Table of Contents

Feedback

User Guide

create-support-permit¶

Description¶

Synopsis¶

Options¶

Note

Note

Note

Note

Global Options¶

Output¶

Note

Note

Note

Note