Skip to content

GetSessionResponse

Source code in docs_src/capo_mpa/types/get_session_response.py
class GetSessionResponse(TypedDict, closed=True):
    session_arn: NotRequired["capo_mpa.types.session_arn.SessionArn"]
    """<p>Amazon Resource Name (ARN) for the session.</p>"""
    approval_team_arn: NotRequired["capo_mpa.types.approval_team_arn.ApprovalTeamArn"]
    """<p>Amazon Resource Name (ARN) for the approval team.</p>"""
    approval_team_name: NotRequired[
        "capo_mpa.types.approval_team_name.ApprovalTeamName"
    ]
    """<p>Name of the approval team.</p>"""
    protected_resource_arn: NotRequired["capo_mpa.types.string.String"]
    """<p>Amazon Resource Name (ARN) for the protected operation.</p>"""
    approval_strategy: NotRequired[
        "capo_mpa.types.approval_strategy_response.ApprovalStrategyResponse"
    ]
    """<p>An <code>ApprovalStrategyResponse</code> object. Contains details for how the team grants approval</p>"""
    number_of_approvers: NotRequired["int"]
    """<p>Total number of approvers in the session.</p>"""
    initiation_time: NotRequired["capo_mpa.types.iso_timestamp.IsoTimestamp"]
    """<p>Timestamp when the session was initiated.</p>"""
    expiration_time: NotRequired["capo_mpa.types.iso_timestamp.IsoTimestamp"]
    """<p>Timestamp when the session will expire.</p>"""
    completion_time: NotRequired["capo_mpa.types.iso_timestamp.IsoTimestamp"]
    """<p>Timestamp when the session completed.</p>"""
    description: NotRequired["capo_mpa.types.description.Description"]
    """<p>Description for the session.</p>"""
    metadata: NotRequired["capo_mpa.types.session_metadata.SessionMetadata"]
    """<p>Metadata for the session.</p>"""
    status: NotRequired["capo_mpa.types.session_status.SessionStatus"]
    """<p>Status for the session. For example, if the team has approved the requested operation.</p>"""
    status_code: NotRequired["capo_mpa.types.session_status_code.SessionStatusCode"]
    """<p>Status code of the session.</p>"""
    status_message: NotRequired["capo_mpa.types.message.Message"]
    """<p>Message describing the status for session.</p>"""
    execution_status: NotRequired[
        "capo_mpa.types.session_execution_status.SessionExecutionStatus"
    ]
    """<p>Status for the protected operation. For example, if the operation is <code>PENDING</code>.</p>"""
    action_name: NotRequired["capo_mpa.types.action_name.ActionName"]
    """<p>Name of the protected operation.</p>"""
    requester_service_principal: NotRequired[
        "capo_mpa.types.service_principal.ServicePrincipal"
    ]
    """<p> <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_policies_elements_principal.html#principal-services">Service principal</a> for the service associated with the protected operation.</p>"""
    requester_principal_arn: NotRequired["capo_mpa.types.string.String"]
    """<p> <a href="https://docs.aws.amazon.com/IAM/latest/UserGuide/intro-structure.html#intro-structure-request">IAM principal</a> that made the operation request.</p>"""
    requester_account_id: NotRequired["capo_mpa.types.account_id.AccountId"]
    """<p>ID for the account that made the operation request.</p>"""
    requester_region: NotRequired["capo_mpa.types.region.Region"]
    """<p>Amazon Web Services Region where the operation request originated.</p>"""
    requester_comment: NotRequired["capo_mpa.types.requester_comment.RequesterComment"]
    """<p>Message from the account that made the operation request</p>"""
    action_completion_strategy: NotRequired[
        "capo_mpa.types.action_completion_strategy.ActionCompletionStrategy"
    ]
    """<p>Strategy for executing the protected operation. <code>AUTO_COMPLETION_UPON_APPROVAL</code> means the operation is automatically executed using the requester's permissions, if approved.</p>"""
    approver_responses: NotRequired[
        "capo_mpa.types.get_session_response_approver_responses.GetSessionResponseApproverResponses"
    ]
    """<p>An array of <code>GetSessionResponseApproverResponse</code> objects. Contains details for approver responses in the session.</p>"""
    additional_security_requirements: NotRequired[
        "capo_mpa.types.additional_security_requirements.AdditionalSecurityRequirements"
    ]
    """<p>A list of <code>AdditionalSecurityRequirement</code> applied to the session.</p>"""

action_completion_strategy instance-attribute

action_completion_strategy: NotRequired[ActionCompletionStrategy]

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

action_name instance-attribute

action_name: NotRequired[ActionName]

Name of the protected operation.

additional_security_requirements instance-attribute

additional_security_requirements: NotRequired[AdditionalSecurityRequirements]

A list of AdditionalSecurityRequirement applied to the session.

approval_strategy instance-attribute

approval_strategy: NotRequired[ApprovalStrategyResponse]

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

approval_team_arn instance-attribute

approval_team_arn: NotRequired[ApprovalTeamArn]

Amazon Resource Name (ARN) for the approval team.

approval_team_name instance-attribute

approval_team_name: NotRequired[ApprovalTeamName]

Name of the approval team.

approver_responses instance-attribute

approver_responses: NotRequired[GetSessionResponseApproverResponses]

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

completion_time instance-attribute

completion_time: NotRequired[IsoTimestamp]

Timestamp when the session completed.

description instance-attribute

description: NotRequired[Description]

Description for the session.

execution_status instance-attribute

execution_status: NotRequired[SessionExecutionStatus]

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

expiration_time instance-attribute

expiration_time: NotRequired[IsoTimestamp]

Timestamp when the session will expire.

initiation_time instance-attribute

initiation_time: NotRequired[IsoTimestamp]

Timestamp when the session was initiated.

metadata instance-attribute

metadata: NotRequired[SessionMetadata]

Metadata for the session.

number_of_approvers instance-attribute

number_of_approvers: NotRequired[int]

Total number of approvers in the session.

protected_resource_arn instance-attribute

protected_resource_arn: NotRequired[String]

Amazon Resource Name (ARN) for the protected operation.

requester_account_id instance-attribute

requester_account_id: NotRequired[AccountId]

ID for the account that made the operation request.

requester_comment instance-attribute

requester_comment: NotRequired[RequesterComment]

Message from the account that made the operation request

requester_principal_arn instance-attribute

requester_principal_arn: NotRequired[String]

IAM principal that made the operation request.

requester_region instance-attribute

requester_region: NotRequired[Region]

Amazon Web Services Region where the operation request originated.

requester_service_principal instance-attribute

requester_service_principal: NotRequired[ServicePrincipal]

Service principal for the service associated with the protected operation.

session_arn instance-attribute

session_arn: NotRequired[SessionArn]

Amazon Resource Name (ARN) for the session.

status instance-attribute

status: NotRequired[SessionStatus]

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

status_code instance-attribute

status_code: NotRequired[SessionStatusCode]

Status code of the session.

status_message instance-attribute

status_message: NotRequired[Message]

Message describing the status for session.