AWS SDK Version 4 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the CreateDelegationRequest operation. 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.

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.IdentityManagement.AmazonIdentityManagementServiceRequest
      Amazon.IdentityManagement.Model.CreateDelegationRequestRequest

Namespace: Amazon.IdentityManagement.Model
Assembly: AWSSDK.IdentityManagement.dll
Version: 3.x.y.z

Syntax

C#
public class CreateDelegationRequestRequest : AmazonIdentityManagementServiceRequest
         IAmazonWebServiceRequest

The CreateDelegationRequestRequest type exposes the following members

Constructors

Properties

NameTypeDescription
Public Property Description System.String

Gets and sets the property Description.

A description of the delegation request.

Public Property NotificationChannel System.String

Gets and sets the property NotificationChannel.

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.

Public Property OnlySendByOwner System.Nullable<System.Boolean>

Gets and sets the property OnlySendByOwner.

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.

Public Property OwnerAccountId System.String

Gets and sets the property OwnerAccountId.

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.

Public Property Permissions Amazon.IdentityManagement.Model.DelegationPermission

Gets and sets the property Permissions.

The permissions to be delegated in this delegation request.

Public Property RedirectUrl System.String

Gets and sets the property RedirectUrl.

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.

Public Property RequestMessage System.String

Gets and sets the property RequestMessage.

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.

Public Property RequestorWorkflowId System.String

Gets and sets the property RequestorWorkflowId.

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.

Public Property SessionDuration System.Nullable<System.Int32>

Gets and sets the property SessionDuration.

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.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.7.2 and newer