Class: Aws::IAM::Types::DelegationRequest

Inherits:

Struct

• Object
• Struct
• Aws::IAM::Types::DelegationRequest

Defined in:

gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb

Overview

Contains information about a delegation request, including its status, permissions, and associated metadata.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #approver_id ⇒ String

  The Amazon Resource Name (ARN).

• #create_date ⇒ Time

  Creation date (timestamp) of this delegation request.

• #delegation_request_id ⇒ String

  The unique identifier for the delegation request.

• #description ⇒ String

  Description of the delegation request.

• #notes ⇒ String

  Notes added to this delegation request, if this request was updated via the [UpdateDelegationRequest][1] API.

• #only_send_by_owner ⇒ Boolean

  A flag indicating whether the [SendDelegationToken][1] must be called by the owner of this delegation request.

• #owner_account_id ⇒ String

  Amazon Web Services account ID of the owner of the delegation request.

• #owner_id ⇒ String

  ARN of the owner of this delegation request.

• #permission_policy ⇒ String

  JSON content of the associated permission policy of this delegation request.

• #permissions ⇒ Types::DelegationPermission

  Contains information about the permissions being delegated in a delegation request.

• #redirect_url ⇒ String

  A URL to be redirected to once the delegation request is approved.

• #rejection_reason ⇒ String

  Reasons for rejecting this delegation request, if this request was rejected.

• #request_message ⇒ String

  A custom message that is added to the delegation request by the partner.

• #requestor_id ⇒ String

  Identity of the requestor of this delegation request.

• #requestor_name ⇒ String

  A friendly name of the requestor.

• #role_permission_restriction_arns ⇒ Array<String>

  If the PermissionPolicy includes role creation permissions, this element will include the list of permissions boundary policies associated with the role creation.

• #session_duration ⇒ Integer

  The life-time of the requested session credential.

• #state ⇒ String

  The state of this delegation request.

• #updated_time ⇒ Time

  Last updated timestamp of the request.

Instance Attribute Details

#approver_id ⇒ String

The Amazon Resource Name (ARN). ARNs are unique identifiers for Amazon Web Services resources.

For more information about ARNs, go to Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

Returns:

• (String)

# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 2216

class DelegationRequest < Struct.new(
  :delegation_request_id,
  :owner_account_id,
  :description,
  :request_message,
  :permissions,
  :permission_policy,
  :role_permission_restriction_arns,
  :owner_id,
  :approver_id,
  :state,
  :requestor_id,
  :requestor_name,
  :create_date,
  :session_duration,
  :redirect_url,
  :notes,
  :rejection_reason,
  :only_send_by_owner,
  :updated_time)
  SENSITIVE = []
  include Aws::Structure
end

#create_date ⇒ Time

Creation date (timestamp) of this delegation request.

Returns:

• (Time)

# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 2216

class DelegationRequest < Struct.new(
  :delegation_request_id,
  :owner_account_id,
  :description,
  :request_message,
  :permissions,
  :permission_policy,
  :role_permission_restriction_arns,
  :owner_id,
  :approver_id,
  :state,
  :requestor_id,
  :requestor_name,
  :create_date,
  :session_duration,
  :redirect_url,
  :notes,
  :rejection_reason,
  :only_send_by_owner,
  :updated_time)
  SENSITIVE = []
  include Aws::Structure
end

#delegation_request_id ⇒ String

The unique identifier for the delegation request.

Returns:

• (String)

# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 2216

class DelegationRequest < Struct.new(
  :delegation_request_id,
  :owner_account_id,
  :description,
  :request_message,
  :permissions,
  :permission_policy,
  :role_permission_restriction_arns,
  :owner_id,
  :approver_id,
  :state,
  :requestor_id,
  :requestor_name,
  :create_date,
  :session_duration,
  :redirect_url,
  :notes,
  :rejection_reason,
  :only_send_by_owner,
  :updated_time)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

Description of the delegation request. This is a message that is provided by the Amazon Web Services partner that filed the delegation request.

Returns:

• (String)

# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 2216

class DelegationRequest < Struct.new(
  :delegation_request_id,
  :owner_account_id,
  :description,
  :request_message,
  :permissions,
  :permission_policy,
  :role_permission_restriction_arns,
  :owner_id,
  :approver_id,
  :state,
  :requestor_id,
  :requestor_name,
  :create_date,
  :session_duration,
  :redirect_url,
  :notes,
  :rejection_reason,
  :only_send_by_owner,
  :updated_time)
  SENSITIVE = []
  include Aws::Structure
end

#notes ⇒ String

Notes added to this delegation request, if this request was updated via the UpdateDelegationRequest API.

Returns:

• (String)

# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 2216

class DelegationRequest < Struct.new(
  :delegation_request_id,
  :owner_account_id,
  :description,
  :request_message,
  :permissions,
  :permission_policy,
  :role_permission_restriction_arns,
  :owner_id,
  :approver_id,
  :state,
  :requestor_id,
  :requestor_name,
  :create_date,
  :session_duration,
  :redirect_url,
  :notes,
  :rejection_reason,
  :only_send_by_owner,
  :updated_time)
  SENSITIVE = []
  include Aws::Structure
end

#only_send_by_owner ⇒ Boolean

A flag indicating whether the SendDelegationToken must be called by the owner of this delegation request. This is set by the requesting partner.

Returns:

• (Boolean)

# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 2216

class DelegationRequest < Struct.new(
  :delegation_request_id,
  :owner_account_id,
  :description,
  :request_message,
  :permissions,
  :permission_policy,
  :role_permission_restriction_arns,
  :owner_id,
  :approver_id,
  :state,
  :requestor_id,
  :requestor_name,
  :create_date,
  :session_duration,
  :redirect_url,
  :notes,
  :rejection_reason,
  :only_send_by_owner,
  :updated_time)
  SENSITIVE = []
  include Aws::Structure
end

#owner_account_id ⇒ String

Amazon Web Services account ID of the owner of the delegation request.

Returns:

• (String)

# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 2216

class DelegationRequest < Struct.new(
  :delegation_request_id,
  :owner_account_id,
  :description,
  :request_message,
  :permissions,
  :permission_policy,
  :role_permission_restriction_arns,
  :owner_id,
  :approver_id,
  :state,
  :requestor_id,
  :requestor_name,
  :create_date,
  :session_duration,
  :redirect_url,
  :notes,
  :rejection_reason,
  :only_send_by_owner,
  :updated_time)
  SENSITIVE = []
  include Aws::Structure
end

#owner_id ⇒ String

ARN of the owner of this delegation request.

Returns:

• (String)

# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 2216

class DelegationRequest < Struct.new(
  :delegation_request_id,
  :owner_account_id,
  :description,
  :request_message,
  :permissions,
  :permission_policy,
  :role_permission_restriction_arns,
  :owner_id,
  :approver_id,
  :state,
  :requestor_id,
  :requestor_name,
  :create_date,
  :session_duration,
  :redirect_url,
  :notes,
  :rejection_reason,
  :only_send_by_owner,
  :updated_time)
  SENSITIVE = []
  include Aws::Structure
end

#permission_policy ⇒ String

JSON content of the associated permission policy of this delegation request.

Returns:

• (String)

# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 2216

class DelegationRequest < Struct.new(
  :delegation_request_id,
  :owner_account_id,
  :description,
  :request_message,
  :permissions,
  :permission_policy,
  :role_permission_restriction_arns,
  :owner_id,
  :approver_id,
  :state,
  :requestor_id,
  :requestor_name,
  :create_date,
  :session_duration,
  :redirect_url,
  :notes,
  :rejection_reason,
  :only_send_by_owner,
  :updated_time)
  SENSITIVE = []
  include Aws::Structure
end

#permissions ⇒ Types::DelegationPermission

Contains information about the permissions being delegated in a delegation request.

Returns:

• (Types::DelegationPermission)

# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 2216

class DelegationRequest < Struct.new(
  :delegation_request_id,
  :owner_account_id,
  :description,
  :request_message,
  :permissions,
  :permission_policy,
  :role_permission_restriction_arns,
  :owner_id,
  :approver_id,
  :state,
  :requestor_id,
  :requestor_name,
  :create_date,
  :session_duration,
  :redirect_url,
  :notes,
  :rejection_reason,
  :only_send_by_owner,
  :updated_time)
  SENSITIVE = []
  include Aws::Structure
end

#redirect_url ⇒ String

A URL to be redirected to once the delegation request is approved. Partners provide this URL when creating the delegation request.

Returns:

• (String)

# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 2216

class DelegationRequest < Struct.new(
  :delegation_request_id,
  :owner_account_id,
  :description,
  :request_message,
  :permissions,
  :permission_policy,
  :role_permission_restriction_arns,
  :owner_id,
  :approver_id,
  :state,
  :requestor_id,
  :requestor_name,
  :create_date,
  :session_duration,
  :redirect_url,
  :notes,
  :rejection_reason,
  :only_send_by_owner,
  :updated_time)
  SENSITIVE = []
  include Aws::Structure
end

#rejection_reason ⇒ String

Reasons for rejecting this delegation request, if this request was rejected. See also RejectDelegationRequest API documentation.

Returns:

• (String)

# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 2216

class DelegationRequest < Struct.new(
  :delegation_request_id,
  :owner_account_id,
  :description,
  :request_message,
  :permissions,
  :permission_policy,
  :role_permission_restriction_arns,
  :owner_id,
  :approver_id,
  :state,
  :requestor_id,
  :requestor_name,
  :create_date,
  :session_duration,
  :redirect_url,
  :notes,
  :rejection_reason,
  :only_send_by_owner,
  :updated_time)
  SENSITIVE = []
  include Aws::Structure
end

#request_message ⇒ String

A custom message that is added to the delegation request by the partner.

This element is different from the Description element such that this is a request specific message injected by the partner. The Description is typically a generic explanation of what the delegation request is targeted to do.

Returns:

• (String)

# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 2216

class DelegationRequest < Struct.new(
  :delegation_request_id,
  :owner_account_id,
  :description,
  :request_message,
  :permissions,
  :permission_policy,
  :role_permission_restriction_arns,
  :owner_id,
  :approver_id,
  :state,
  :requestor_id,
  :requestor_name,
  :create_date,
  :session_duration,
  :redirect_url,
  :notes,
  :rejection_reason,
  :only_send_by_owner,
  :updated_time)
  SENSITIVE = []
  include Aws::Structure
end

#requestor_id ⇒ String

Identity of the requestor of this delegation request. This will be an Amazon Web Services account ID.

Returns:

• (String)

# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 2216

class DelegationRequest < Struct.new(
  :delegation_request_id,
  :owner_account_id,
  :description,
  :request_message,
  :permissions,
  :permission_policy,
  :role_permission_restriction_arns,
  :owner_id,
  :approver_id,
  :state,
  :requestor_id,
  :requestor_name,
  :create_date,
  :session_duration,
  :redirect_url,
  :notes,
  :rejection_reason,
  :only_send_by_owner,
  :updated_time)
  SENSITIVE = []
  include Aws::Structure
end

#requestor_name ⇒ String

A friendly name of the requestor.

Returns:

• (String)

# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 2216

class DelegationRequest < Struct.new(
  :delegation_request_id,
  :owner_account_id,
  :description,
  :request_message,
  :permissions,
  :permission_policy,
  :role_permission_restriction_arns,
  :owner_id,
  :approver_id,
  :state,
  :requestor_id,
  :requestor_name,
  :create_date,
  :session_duration,
  :redirect_url,
  :notes,
  :rejection_reason,
  :only_send_by_owner,
  :updated_time)
  SENSITIVE = []
  include Aws::Structure
end

#role_permission_restriction_arns ⇒ Array<String>

If the PermissionPolicy includes role creation permissions, this element will include the list of permissions boundary policies associated with the role creation. See Permissions boundaries for IAM entities for more details about IAM permission boundaries.

Returns:

• (Array<String>)

# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 2216

class DelegationRequest < Struct.new(
  :delegation_request_id,
  :owner_account_id,
  :description,
  :request_message,
  :permissions,
  :permission_policy,
  :role_permission_restriction_arns,
  :owner_id,
  :approver_id,
  :state,
  :requestor_id,
  :requestor_name,
  :create_date,
  :session_duration,
  :redirect_url,
  :notes,
  :rejection_reason,
  :only_send_by_owner,
  :updated_time)
  SENSITIVE = []
  include Aws::Structure
end

#session_duration ⇒ Integer

The life-time of the requested session credential.

Returns:

• (Integer)

# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 2216

class DelegationRequest < Struct.new(
  :delegation_request_id,
  :owner_account_id,
  :description,
  :request_message,
  :permissions,
  :permission_policy,
  :role_permission_restriction_arns,
  :owner_id,
  :approver_id,
  :state,
  :requestor_id,
  :requestor_name,
  :create_date,
  :session_duration,
  :redirect_url,
  :notes,
  :rejection_reason,
  :only_send_by_owner,
  :updated_time)
  SENSITIVE = []
  include Aws::Structure
end

#state ⇒ String

The state of this delegation request.

See the Understanding the Request Lifecycle for an explanation of how these states are transitioned.

Returns:

• (String)

# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 2216

class DelegationRequest < Struct.new(
  :delegation_request_id,
  :owner_account_id,
  :description,
  :request_message,
  :permissions,
  :permission_policy,
  :role_permission_restriction_arns,
  :owner_id,
  :approver_id,
  :state,
  :requestor_id,
  :requestor_name,
  :create_date,
  :session_duration,
  :redirect_url,
  :notes,
  :rejection_reason,
  :only_send_by_owner,
  :updated_time)
  SENSITIVE = []
  include Aws::Structure
end

#updated_time ⇒ Time

Last updated timestamp of the request.

Returns:

• (Time)

# File 'gems/aws-sdk-iam/lib/aws-sdk-iam/types.rb', line 2216

class DelegationRequest < Struct.new(
  :delegation_request_id,
  :owner_account_id,
  :description,
  :request_message,
  :permissions,
  :permission_policy,
  :role_permission_restriction_arns,
  :owner_id,
  :approver_id,
  :state,
  :requestor_id,
  :requestor_name,
  :create_date,
  :session_duration,
  :redirect_url,
  :notes,
  :rejection_reason,
  :only_send_by_owner,
  :updated_time)
  SENSITIVE = []
  include Aws::Structure
end