AWS CLI Command Reference

[ aws . iam ]

create-delegation-request

Description

Creates an IAM delegation request for temporary access delegation.

This API is not available for general use. In order to use this API, a caller first need to go through an onboarding process described in the partner onboarding documentation .

See also: AWS API Documentation

Synopsis

  create-delegation-request
[--owner-account-id <value>]
--description <value>
--permissions <value>
[--request-message <value>]
--requestor-workflow-id <value>
[--redirect-url <value>]
--notification-channel <value>
--session-duration <value>
[--only-send-by-owner | --no-only-send-by-owner]
[--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]

Options

--owner-account-id (string)

The Amazon Web Services account ID this delegation request is targeted to.

If the account ID is not known, this parameter can be omitted, resulting in a request that can be associated by any account. If the account ID passed, then the created delegation request can only be associated with an identity of that target account.

Constraints:

  • pattern: \d{12}

--description (string) [required]

A description of the delegation request.

Constraints:

  • max: 1000
  • pattern: [\u0009\u000A\u000D\u0020-\u007E\u00A1-\u00FF]*

--permissions (structure) [required]

The permissions to be delegated in this delegation request.

PolicyTemplateArn -> (string)

This ARN maps to a pre-registered policy content for this partner. See the `partner onboarding documentation to understand how to create a delegation template.

Constraints:

  • min: 20
  • max: 2048

Parameters -> (list)

A list of policy parameters that define the scope and constraints of the delegated permissions.

Constraints:

  • max: 50

(structure)

Contains information about a policy parameter used to customize delegated permissions.

Name -> (string)

The name of the policy parameter.

Constraints:

  • min: 5
  • max: 256
  • pattern: [ -~]+

Values -> (list)

The allowed values for the policy parameter.

(string)

Constraints:

  • pattern: [ -~]+

Type -> (string)

The data type of the policy parameter value.

Possible values:

  • string
  • stringList

JSON Syntax:

{
  "PolicyTemplateArn": "string",
  "Parameters": [
    {
      "Name": "string",
      "Values": ["string", ...],
      "Type": "string"|"stringList"
    }
    ...
  ]
}

--request-message (string)

A message explaining the reason for the delegation request.

Requesters can utilize this field to add a custom note to the delegation request. This field is different from the description such that this is to be utilized for a custom messaging on a case-by-case basis.

For example, if the current delegation request is in response to a previous request being rejected, this explanation can be added to the request via this field.

Constraints:

  • max: 200
  • pattern: [\u0009\u000A\u000D\u0020-\u007E\u00A1-\u00FF]*

--requestor-workflow-id (string) [required]

The workflow ID associated with the requestor.

This is the unique identifier on the partner side that can be used to track the progress of the request.

IAM maintains a uniqueness check on this workflow id for each request - if a workflow id for an existing request is passed, this API call will fail.

Constraints:

  • min: 5
  • max: 400
  • pattern: [\u0009\u000A\u000D\u0020-\u007E\u00A1-\u00FF]+

--redirect-url (string)

The URL to redirect to after the delegation request is processed.

This URL is used by the IAM console to show a link to the customer to re-load the partner workflow.

Constraints:

  • min: 1
  • max: 255
  • pattern: ^http(s?)://[a-zA-Z0-9._/-]*(\?[a-zA-Z0-9._=&-]*)?(#[a-zA-Z0-9._/-]*)?$

--notification-channel (string) [required]

The notification channel for updates about the delegation request.

At this time,only SNS topic ARNs are accepted for notification. This topic ARN must have a resource policy granting SNS:Publish permission to the IAM service principal (iam.amazonaws.com ). See partner onboarding documentation for more details.

Constraints:

  • min: 2
  • max: 400
  • pattern: ^[a-zA-Z0-9:_.-]+$

--session-duration (integer) [required]

The duration for which the delegated session should remain active, in seconds.

The active time window for the session starts when the customer calls the SendDelegationToken API.

Constraints:

  • min: 300
  • max: 43200

--only-send-by-owner | --no-only-send-by-owner (boolean)

Specifies whether the delegation token should only be sent by the owner.

This flag prevents any party other than the owner from calling SendDelegationToken API for this delegation request. This behavior becomes useful when the delegation request owner needs to be present for subsequent partner interactions, but the delegation request was sent to a more privileged user for approval due to the owner lacking sufficient delegation permissions.

--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

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

Output

ConsoleDeepLink -> (string)

A deep link URL to the Amazon Web Services Management Console for managing the delegation request.

For a console based workflow, partners should redirect the customer to this URL. If the customer is not logged in to any Amazon Web Services account, the Amazon Web Services workflow will automatically direct the customer to log in and then display the delegation request approval page.

Constraints:

  • min: 1
  • max: 255

DelegationRequestId -> (string)

The unique identifier for the created delegation request.

Constraints:

  • min: 16
  • max: 128
  • pattern: [\w-]+
© Copyright 2025, Amazon Web Services. Created using Sphinx.