Class: Aws::MPA::Types::GetSessionResponse

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-mpa/lib/aws-sdk-mpa/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[:description, :metadata, :requester_comment]

Instance Attribute Summary collapse

Instance Attribute Details

#action_completion_strategy ⇒ String

Strategy for executing the protected operation. AUTO_COMPLETION_UPON_APPROVAL means the operation is automatically executed using the requester's permissions, if approved.

Returns:

  • (String) 


800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
 
# File 'gems/aws-sdk-mpa/lib/aws-sdk-mpa/types.rb', line 800

class GetSessionResponse < Struct.new(
  :session_arn,
  :approval_team_arn,
  :approval_team_name,
  :protected_resource_arn,
  :approval_strategy,
  :number_of_approvers,
  :initiation_time,
  :expiration_time,
  :completion_time,
  :description,
  :metadata,
  :status,
  :status_code,
  :status_message,
  :execution_status,
  :action_name,
  :requester_service_principal,
  :requester_principal_arn,
  :requester_account_id,
  :requester_region,
  :requester_comment,
  :action_completion_strategy,
  :approver_responses,
  :additional_security_requirements)
  SENSITIVE = [:description, :metadata, :requester_comment]
  include Aws::Structure
end

#action_name ⇒ String

Name of the protected operation.

Returns:

  • (String) 


800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
 
# File 'gems/aws-sdk-mpa/lib/aws-sdk-mpa/types.rb', line 800

class GetSessionResponse < Struct.new(
  :session_arn,
  :approval_team_arn,
  :approval_team_name,
  :protected_resource_arn,
  :approval_strategy,
  :number_of_approvers,
  :initiation_time,
  :expiration_time,
  :completion_time,
  :description,
  :metadata,
  :status,
  :status_code,
  :status_message,
  :execution_status,
  :action_name,
  :requester_service_principal,
  :requester_principal_arn,
  :requester_account_id,
  :requester_region,
  :requester_comment,
  :action_completion_strategy,
  :approver_responses,
  :additional_security_requirements)
  SENSITIVE = [:description, :metadata, :requester_comment]
  include Aws::Structure
end

#additional_security_requirements ⇒ Array<String>

A list of AdditionalSecurityRequirement applied to the session.

Returns:

  • (Array<String>) 


800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
 
# File 'gems/aws-sdk-mpa/lib/aws-sdk-mpa/types.rb', line 800

class GetSessionResponse < Struct.new(
  :session_arn,
  :approval_team_arn,
  :approval_team_name,
  :protected_resource_arn,
  :approval_strategy,
  :number_of_approvers,
  :initiation_time,
  :expiration_time,
  :completion_time,
  :description,
  :metadata,
  :status,
  :status_code,
  :status_message,
  :execution_status,
  :action_name,
  :requester_service_principal,
  :requester_principal_arn,
  :requester_account_id,
  :requester_region,
  :requester_comment,
  :action_completion_strategy,
  :approver_responses,
  :additional_security_requirements)
  SENSITIVE = [:description, :metadata, :requester_comment]
  include Aws::Structure
end

#approval_strategy ⇒ Types::ApprovalStrategyResponse

An ApprovalStrategyResponse object. Contains details for how the team grants approval

Returns:



800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
 
# File 'gems/aws-sdk-mpa/lib/aws-sdk-mpa/types.rb', line 800

class GetSessionResponse < Struct.new(
  :session_arn,
  :approval_team_arn,
  :approval_team_name,
  :protected_resource_arn,
  :approval_strategy,
  :number_of_approvers,
  :initiation_time,
  :expiration_time,
  :completion_time,
  :description,
  :metadata,
  :status,
  :status_code,
  :status_message,
  :execution_status,
  :action_name,
  :requester_service_principal,
  :requester_principal_arn,
  :requester_account_id,
  :requester_region,
  :requester_comment,
  :action_completion_strategy,
  :approver_responses,
  :additional_security_requirements)
  SENSITIVE = [:description, :metadata, :requester_comment]
  include Aws::Structure
end

#approval_team_arn ⇒ String

Amazon Resource Name (ARN) for the approval team.

Returns:

  • (String) 


800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
 
# File 'gems/aws-sdk-mpa/lib/aws-sdk-mpa/types.rb', line 800

class GetSessionResponse < Struct.new(
  :session_arn,
  :approval_team_arn,
  :approval_team_name,
  :protected_resource_arn,
  :approval_strategy,
  :number_of_approvers,
  :initiation_time,
  :expiration_time,
  :completion_time,
  :description,
  :metadata,
  :status,
  :status_code,
  :status_message,
  :execution_status,
  :action_name,
  :requester_service_principal,
  :requester_principal_arn,
  :requester_account_id,
  :requester_region,
  :requester_comment,
  :action_completion_strategy,
  :approver_responses,
  :additional_security_requirements)
  SENSITIVE = [:description, :metadata, :requester_comment]
  include Aws::Structure
end

#approval_team_name ⇒ String

Name of the approval team.

Returns:

  • (String) 


800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
 
# File 'gems/aws-sdk-mpa/lib/aws-sdk-mpa/types.rb', line 800

class GetSessionResponse < Struct.new(
  :session_arn,
  :approval_team_arn,
  :approval_team_name,
  :protected_resource_arn,
  :approval_strategy,
  :number_of_approvers,
  :initiation_time,
  :expiration_time,
  :completion_time,
  :description,
  :metadata,
  :status,
  :status_code,
  :status_message,
  :execution_status,
  :action_name,
  :requester_service_principal,
  :requester_principal_arn,
  :requester_account_id,
  :requester_region,
  :requester_comment,
  :action_completion_strategy,
  :approver_responses,
  :additional_security_requirements)
  SENSITIVE = [:description, :metadata, :requester_comment]
  include Aws::Structure
end

#approver_responses ⇒ Array<Types::GetSessionResponseApproverResponse>

An array of GetSessionResponseApproverResponse objects. Contains details for approver responses in the session.

Returns:



800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
 
# File 'gems/aws-sdk-mpa/lib/aws-sdk-mpa/types.rb', line 800

class GetSessionResponse < Struct.new(
  :session_arn,
  :approval_team_arn,
  :approval_team_name,
  :protected_resource_arn,
  :approval_strategy,
  :number_of_approvers,
  :initiation_time,
  :expiration_time,
  :completion_time,
  :description,
  :metadata,
  :status,
  :status_code,
  :status_message,
  :execution_status,
  :action_name,
  :requester_service_principal,
  :requester_principal_arn,
  :requester_account_id,
  :requester_region,
  :requester_comment,
  :action_completion_strategy,
  :approver_responses,
  :additional_security_requirements)
  SENSITIVE = [:description, :metadata, :requester_comment]
  include Aws::Structure
end

#completion_time ⇒ Time

Timestamp when the session completed.

Returns:

  • (Time) 


800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
 
# File 'gems/aws-sdk-mpa/lib/aws-sdk-mpa/types.rb', line 800

class GetSessionResponse < Struct.new(
  :session_arn,
  :approval_team_arn,
  :approval_team_name,
  :protected_resource_arn,
  :approval_strategy,
  :number_of_approvers,
  :initiation_time,
  :expiration_time,
  :completion_time,
  :description,
  :metadata,
  :status,
  :status_code,
  :status_message,
  :execution_status,
  :action_name,
  :requester_service_principal,
  :requester_principal_arn,
  :requester_account_id,
  :requester_region,
  :requester_comment,
  :action_completion_strategy,
  :approver_responses,
  :additional_security_requirements)
  SENSITIVE = [:description, :metadata, :requester_comment]
  include Aws::Structure
end

#description ⇒ String

Description for the session.

Returns:

  • (String) 


800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
 
# File 'gems/aws-sdk-mpa/lib/aws-sdk-mpa/types.rb', line 800

class GetSessionResponse < Struct.new(
  :session_arn,
  :approval_team_arn,
  :approval_team_name,
  :protected_resource_arn,
  :approval_strategy,
  :number_of_approvers,
  :initiation_time,
  :expiration_time,
  :completion_time,
  :description,
  :metadata,
  :status,
  :status_code,
  :status_message,
  :execution_status,
  :action_name,
  :requester_service_principal,
  :requester_principal_arn,
  :requester_account_id,
  :requester_region,
  :requester_comment,
  :action_completion_strategy,
  :approver_responses,
  :additional_security_requirements)
  SENSITIVE = [:description, :metadata, :requester_comment]
  include Aws::Structure
end

#execution_status ⇒ String

Status for the protected operation. For example, if the operation is PENDING.

Returns:

  • (String) 


800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
 
# File 'gems/aws-sdk-mpa/lib/aws-sdk-mpa/types.rb', line 800

class GetSessionResponse < Struct.new(
  :session_arn,
  :approval_team_arn,
  :approval_team_name,
  :protected_resource_arn,
  :approval_strategy,
  :number_of_approvers,
  :initiation_time,
  :expiration_time,
  :completion_time,
  :description,
  :metadata,
  :status,
  :status_code,
  :status_message,
  :execution_status,
  :action_name,
  :requester_service_principal,
  :requester_principal_arn,
  :requester_account_id,
  :requester_region,
  :requester_comment,
  :action_completion_strategy,
  :approver_responses,
  :additional_security_requirements)
  SENSITIVE = [:description, :metadata, :requester_comment]
  include Aws::Structure
end

#expiration_time ⇒ Time

Timestamp when the session will expire.

Returns:

  • (Time) 


800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
 
# File 'gems/aws-sdk-mpa/lib/aws-sdk-mpa/types.rb', line 800

class GetSessionResponse < Struct.new(
  :session_arn,
  :approval_team_arn,
  :approval_team_name,
  :protected_resource_arn,
  :approval_strategy,
  :number_of_approvers,
  :initiation_time,
  :expiration_time,
  :completion_time,
  :description,
  :metadata,
  :status,
  :status_code,
  :status_message,
  :execution_status,
  :action_name,
  :requester_service_principal,
  :requester_principal_arn,
  :requester_account_id,
  :requester_region,
  :requester_comment,
  :action_completion_strategy,
  :approver_responses,
  :additional_security_requirements)
  SENSITIVE = [:description, :metadata, :requester_comment]
  include Aws::Structure
end

#initiation_time ⇒ Time

Timestamp when the session was initiated.

Returns:

  • (Time) 


800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
 
# File 'gems/aws-sdk-mpa/lib/aws-sdk-mpa/types.rb', line 800

class GetSessionResponse < Struct.new(
  :session_arn,
  :approval_team_arn,
  :approval_team_name,
  :protected_resource_arn,
  :approval_strategy,
  :number_of_approvers,
  :initiation_time,
  :expiration_time,
  :completion_time,
  :description,
  :metadata,
  :status,
  :status_code,
  :status_message,
  :execution_status,
  :action_name,
  :requester_service_principal,
  :requester_principal_arn,
  :requester_account_id,
  :requester_region,
  :requester_comment,
  :action_completion_strategy,
  :approver_responses,
  :additional_security_requirements)
  SENSITIVE = [:description, :metadata, :requester_comment]
  include Aws::Structure
end

#metadata ⇒ Hash<String,String>

Metadata for the session.

Returns:

  • (Hash<String,String>) 


800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
 
# File 'gems/aws-sdk-mpa/lib/aws-sdk-mpa/types.rb', line 800

class GetSessionResponse < Struct.new(
  :session_arn,
  :approval_team_arn,
  :approval_team_name,
  :protected_resource_arn,
  :approval_strategy,
  :number_of_approvers,
  :initiation_time,
  :expiration_time,
  :completion_time,
  :description,
  :metadata,
  :status,
  :status_code,
  :status_message,
  :execution_status,
  :action_name,
  :requester_service_principal,
  :requester_principal_arn,
  :requester_account_id,
  :requester_region,
  :requester_comment,
  :action_completion_strategy,
  :approver_responses,
  :additional_security_requirements)
  SENSITIVE = [:description, :metadata, :requester_comment]
  include Aws::Structure
end

#number_of_approvers ⇒ Integer

Total number of approvers in the session.

Returns:

  • (Integer) 


800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
 
# File 'gems/aws-sdk-mpa/lib/aws-sdk-mpa/types.rb', line 800

class GetSessionResponse < Struct.new(
  :session_arn,
  :approval_team_arn,
  :approval_team_name,
  :protected_resource_arn,
  :approval_strategy,
  :number_of_approvers,
  :initiation_time,
  :expiration_time,
  :completion_time,
  :description,
  :metadata,
  :status,
  :status_code,
  :status_message,
  :execution_status,
  :action_name,
  :requester_service_principal,
  :requester_principal_arn,
  :requester_account_id,
  :requester_region,
  :requester_comment,
  :action_completion_strategy,
  :approver_responses,
  :additional_security_requirements)
  SENSITIVE = [:description, :metadata, :requester_comment]
  include Aws::Structure
end

#protected_resource_arn ⇒ String

Amazon Resource Name (ARN) for the protected operation.

Returns:

  • (String) 


800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
 
# File 'gems/aws-sdk-mpa/lib/aws-sdk-mpa/types.rb', line 800

class GetSessionResponse < Struct.new(
  :session_arn,
  :approval_team_arn,
  :approval_team_name,
  :protected_resource_arn,
  :approval_strategy,
  :number_of_approvers,
  :initiation_time,
  :expiration_time,
  :completion_time,
  :description,
  :metadata,
  :status,
  :status_code,
  :status_message,
  :execution_status,
  :action_name,
  :requester_service_principal,
  :requester_principal_arn,
  :requester_account_id,
  :requester_region,
  :requester_comment,
  :action_completion_strategy,
  :approver_responses,
  :additional_security_requirements)
  SENSITIVE = [:description, :metadata, :requester_comment]
  include Aws::Structure
end

#requester_account_id ⇒ String

ID for the account that made the operation request.

Returns:

  • (String) 


800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
 
# File 'gems/aws-sdk-mpa/lib/aws-sdk-mpa/types.rb', line 800

class GetSessionResponse < Struct.new(
  :session_arn,
  :approval_team_arn,
  :approval_team_name,
  :protected_resource_arn,
  :approval_strategy,
  :number_of_approvers,
  :initiation_time,
  :expiration_time,
  :completion_time,
  :description,
  :metadata,
  :status,
  :status_code,
  :status_message,
  :execution_status,
  :action_name,
  :requester_service_principal,
  :requester_principal_arn,
  :requester_account_id,
  :requester_region,
  :requester_comment,
  :action_completion_strategy,
  :approver_responses,
  :additional_security_requirements)
  SENSITIVE = [:description, :metadata, :requester_comment]
  include Aws::Structure
end

#requester_comment ⇒ String

Message from the account that made the operation request

Returns:

  • (String) 


800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
 
# File 'gems/aws-sdk-mpa/lib/aws-sdk-mpa/types.rb', line 800

class GetSessionResponse < Struct.new(
  :session_arn,
  :approval_team_arn,
  :approval_team_name,
  :protected_resource_arn,
  :approval_strategy,
  :number_of_approvers,
  :initiation_time,
  :expiration_time,
  :completion_time,
  :description,
  :metadata,
  :status,
  :status_code,
  :status_message,
  :execution_status,
  :action_name,
  :requester_service_principal,
  :requester_principal_arn,
  :requester_account_id,
  :requester_region,
  :requester_comment,
  :action_completion_strategy,
  :approver_responses,
  :additional_security_requirements)
  SENSITIVE = [:description, :metadata, :requester_comment]
  include Aws::Structure
end

#requester_principal_arn ⇒ String

IAM principal that made the operation request.

Returns:

  • (String) 


800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
 
# File 'gems/aws-sdk-mpa/lib/aws-sdk-mpa/types.rb', line 800

class GetSessionResponse < Struct.new(
  :session_arn,
  :approval_team_arn,
  :approval_team_name,
  :protected_resource_arn,
  :approval_strategy,
  :number_of_approvers,
  :initiation_time,
  :expiration_time,
  :completion_time,
  :description,
  :metadata,
  :status,
  :status_code,
  :status_message,
  :execution_status,
  :action_name,
  :requester_service_principal,
  :requester_principal_arn,
  :requester_account_id,
  :requester_region,
  :requester_comment,
  :action_completion_strategy,
  :approver_responses,
  :additional_security_requirements)
  SENSITIVE = [:description, :metadata, :requester_comment]
  include Aws::Structure
end

#requester_region ⇒ String

Amazon Web Services Region where the operation request originated.

Returns:

  • (String) 


800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
 
# File 'gems/aws-sdk-mpa/lib/aws-sdk-mpa/types.rb', line 800

class GetSessionResponse < Struct.new(
  :session_arn,
  :approval_team_arn,
  :approval_team_name,
  :protected_resource_arn,
  :approval_strategy,
  :number_of_approvers,
  :initiation_time,
  :expiration_time,
  :completion_time,
  :description,
  :metadata,
  :status,
  :status_code,
  :status_message,
  :execution_status,
  :action_name,
  :requester_service_principal,
  :requester_principal_arn,
  :requester_account_id,
  :requester_region,
  :requester_comment,
  :action_completion_strategy,
  :approver_responses,
  :additional_security_requirements)
  SENSITIVE = [:description, :metadata, :requester_comment]
  include Aws::Structure
end

#requester_service_principal ⇒ String

Service principal for the service associated with the protected operation.

Returns:

  • (String) 


800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
 
# File 'gems/aws-sdk-mpa/lib/aws-sdk-mpa/types.rb', line 800

class GetSessionResponse < Struct.new(
  :session_arn,
  :approval_team_arn,
  :approval_team_name,
  :protected_resource_arn,
  :approval_strategy,
  :number_of_approvers,
  :initiation_time,
  :expiration_time,
  :completion_time,
  :description,
  :metadata,
  :status,
  :status_code,
  :status_message,
  :execution_status,
  :action_name,
  :requester_service_principal,
  :requester_principal_arn,
  :requester_account_id,
  :requester_region,
  :requester_comment,
  :action_completion_strategy,
  :approver_responses,
  :additional_security_requirements)
  SENSITIVE = [:description, :metadata, :requester_comment]
  include Aws::Structure
end

#session_arn ⇒ String

Amazon Resource Name (ARN) for the session.

Returns:

  • (String) 


800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
 
# File 'gems/aws-sdk-mpa/lib/aws-sdk-mpa/types.rb', line 800

class GetSessionResponse < Struct.new(
  :session_arn,
  :approval_team_arn,
  :approval_team_name,
  :protected_resource_arn,
  :approval_strategy,
  :number_of_approvers,
  :initiation_time,
  :expiration_time,
  :completion_time,
  :description,
  :metadata,
  :status,
  :status_code,
  :status_message,
  :execution_status,
  :action_name,
  :requester_service_principal,
  :requester_principal_arn,
  :requester_account_id,
  :requester_region,
  :requester_comment,
  :action_completion_strategy,
  :approver_responses,
  :additional_security_requirements)
  SENSITIVE = [:description, :metadata, :requester_comment]
  include Aws::Structure
end

#status ⇒ String

Status for the session. For example, if the team has approved the requested operation.

Returns:

  • (String) 


800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
 
# File 'gems/aws-sdk-mpa/lib/aws-sdk-mpa/types.rb', line 800

class GetSessionResponse < Struct.new(
  :session_arn,
  :approval_team_arn,
  :approval_team_name,
  :protected_resource_arn,
  :approval_strategy,
  :number_of_approvers,
  :initiation_time,
  :expiration_time,
  :completion_time,
  :description,
  :metadata,
  :status,
  :status_code,
  :status_message,
  :execution_status,
  :action_name,
  :requester_service_principal,
  :requester_principal_arn,
  :requester_account_id,
  :requester_region,
  :requester_comment,
  :action_completion_strategy,
  :approver_responses,
  :additional_security_requirements)
  SENSITIVE = [:description, :metadata, :requester_comment]
  include Aws::Structure
end

#status_code ⇒ String

Status code of the session.

Returns:

  • (String) 


800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
 
# File 'gems/aws-sdk-mpa/lib/aws-sdk-mpa/types.rb', line 800

class GetSessionResponse < Struct.new(
  :session_arn,
  :approval_team_arn,
  :approval_team_name,
  :protected_resource_arn,
  :approval_strategy,
  :number_of_approvers,
  :initiation_time,
  :expiration_time,
  :completion_time,
  :description,
  :metadata,
  :status,
  :status_code,
  :status_message,
  :execution_status,
  :action_name,
  :requester_service_principal,
  :requester_principal_arn,
  :requester_account_id,
  :requester_region,
  :requester_comment,
  :action_completion_strategy,
  :approver_responses,
  :additional_security_requirements)
  SENSITIVE = [:description, :metadata, :requester_comment]
  include Aws::Structure
end

#status_message ⇒ String

Message describing the status for session.

Returns:

  • (String) 


800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
 
# File 'gems/aws-sdk-mpa/lib/aws-sdk-mpa/types.rb', line 800

class GetSessionResponse < Struct.new(
  :session_arn,
  :approval_team_arn,
  :approval_team_name,
  :protected_resource_arn,
  :approval_strategy,
  :number_of_approvers,
  :initiation_time,
  :expiration_time,
  :completion_time,
  :description,
  :metadata,
  :status,
  :status_code,
  :status_message,
  :execution_status,
  :action_name,
  :requester_service_principal,
  :requester_principal_arn,
  :requester_account_id,
  :requester_region,
  :requester_comment,
  :action_completion_strategy,
  :approver_responses,
  :additional_security_requirements)
  SENSITIVE = [:description, :metadata, :requester_comment]
  include Aws::Structure
end