Get Delegation Request

iam_get_delegation_request

R Documentation

Retrieves information about a specific delegation request¶

Description¶

Retrieves information about a specific delegation request.

If a delegation request has no owner or owner account, get_delegation_request for that delegation request can be called by any account. If the owner account is assigned but there is no owner id, only identities within that owner account can call get_delegation_request for the delegation request. Once the delegation request is fully owned, the owner of the request gets a default permission to get that delegation request. For more details, see Managing Permissions for Delegation Requests.

Usage¶

iam_get_delegation_request(DelegationRequestId,
  DelegationPermissionCheck)

Arguments¶

DelegationRequestId

[required] The unique identifier of the delegation request to retrieve.

DelegationPermissionCheck

Specifies whether to perform a permission check for the delegation request.

If set to true, the get_delegation_request API call will start a permission check process. This process calculates whether the caller has sufficient permissions to cover the asks from this delegation request.

Setting this parameter to true does not guarantee an answer in the response. See the PermissionCheckStatus and the PermissionCheckResult response attributes for further details.

Value¶

A list with the following syntax:

list(
  DelegationRequest = list(
    DelegationRequestId = "string",
    OwnerAccountId = "string",
    Description = "string",
    RequestMessage = "string",
    Permissions = list(
      PolicyTemplateArn = "string",
      Parameters = list(
        list(
          Name = "string",
          Values = list(
            "string"
          ),
          Type = "string"|"stringList"
        )
      )
    ),
    PermissionPolicy = "string",
    RolePermissionRestrictionArns = list(
      "string"
    ),
    OwnerId = "string",
    ApproverId = "string",
    State = "UNASSIGNED"|"ASSIGNED"|"PENDING_APPROVAL"|"FINALIZED"|"ACCEPTED"|"REJECTED"|"EXPIRED",
    ExpirationTime = as.POSIXct(
      "2015-01-01"
    ),
    RequestorId = "string",
    RequestorName = "string",
    CreateDate = as.POSIXct(
      "2015-01-01"
    ),
    SessionDuration = 123,
    RedirectUrl = "string",
    Notes = "string",
    RejectionReason = "string",
    OnlySendByOwner = TRUE|FALSE,
    UpdatedTime = as.POSIXct(
      "2015-01-01"
    )
  ),
  PermissionCheckStatus = "COMPLETE"|"IN_PROGRESS"|"FAILED",
  PermissionCheckResult = "ALLOWED"|"DENIED"|"UNSURE"
)

Request syntax¶

svc$get_delegation_request(
  DelegationRequestId = "string",
  DelegationPermissionCheck = TRUE|FALSE
)