Skip to content

IAM  >  Operations  >  get_delegation_request

get_delegation_request

Operation

get_delegation_request async 

get_delegation_request(input: GetDelegationRequestInput, plugins: list[Plugin] | None = None) -> GetDelegationRequestOutput

Retrieves information about a specific delegation request.

If a delegation request has no owner or owner account, GetDelegationRequest 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 GetDelegationRequest 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.

Parameters:

Name Type Description Default
input GetDelegationRequestInput

An instance of GetDelegationRequestInput.

 required
plugins list[Plugin] | None

A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.

 None

Returns:

Type Description
GetDelegationRequestOutput

An instance of GetDelegationRequestOutput.

Input

GetDelegationRequestInput dataclass

Bases: _SerdeShape

Dataclass for GetDelegationRequestInput structure.

Attributes

delegation_permission_check class-attribute instance-attribute 
delegation_permission_check: bool = ...

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

If set to true, the GetDelegationRequest 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.

delegation_request_id class-attribute instance-attribute 
delegation_request_id: str | None = ...

The unique identifier of the delegation request to retrieve.

Output

GetDelegationRequestOutput dataclass

Bases: _SerdeShape

Dataclass for GetDelegationRequestOutput structure.

Attributes

delegation_request class-attribute instance-attribute 
delegation_request: DelegationRequest | None = ...

The delegation request object containing all details about the request.

permission_check_result class-attribute instance-attribute 
permission_check_result: str | None = ...

The result of the permission check, indicating whether the caller has sufficient permissions to cover the requested permissions. This is an approximate result.

  • ALLOWED : The caller has sufficient permissions cover all the requested permissions.

  • DENIED : The caller does not have sufficient permissions to cover all the requested permissions.

  • UNSURE : It is not possible to determine whether the caller has all the permissions needed. This output is most likely for cases when the caller has permissions with conditions.

permission_check_status class-attribute instance-attribute 
permission_check_status: str | None = ...

The status of the permission check for the delegation request.

This value indicates the status of the process to check whether the caller has sufficient permissions to cover the requested actions in the delegation request. Since this is an asynchronous process, there are three potential values:

  • IN_PROGRESS : The permission check process has started.

  • COMPLETED : The permission check process has completed. The PermissionCheckResult will include the result.

  • FAILED : The permission check process has failed.

response_metadata class-attribute instance-attribute 
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.