Skip to content

GetMembershipResponse

Source code in docs_src/capo_security_ir/types/get_membership_response.py
class GetMembershipResponse(TypedDict, closed=True):
    membership_id: "capo_security_ir.types.membership_id.MembershipId"
    """<p>Response element for GetMembership that provides the queried membership ID.</p>"""
    account_id: NotRequired["capo_security_ir.types.aws_account_id.AWSAccountId"]
    """<p>Response element for GetMembership that provides the account configured to manage the membership.</p>"""
    region: NotRequired["capo_security_ir.types.aws_region.AwsRegion"]
    """<p>Response element for GetMembership that provides the region configured to manage the membership.</p>"""
    membership_name: NotRequired[
        "capo_security_ir.types.membership_name.MembershipName"
    ]
    """<p>Response element for GetMembership that provides the configured membership name.</p>"""
    membership_arn: NotRequired["capo_security_ir.types.membership_arn.MembershipArn"]
    """<p>Response element for GetMembership that provides the membership ARN.</p>"""
    membership_status: NotRequired[
        "capo_security_ir.types.membership_status.MembershipStatus"
    ]
    """<p>Response element for GetMembership that provides the current membership status.</p>"""
    membership_activation_timestamp: NotRequired["datetime.datetime"]
    """<p>Response element for GetMembership that provides the configured membership activation timestamp.</p>"""
    membership_deactivation_timestamp: NotRequired["datetime.datetime"]
    """<p>Response element for GetMembership that provides the configured membership name deactivation timestamp. </p>"""
    customer_type: NotRequired["capo_security_ir.types.customer_type.CustomerType"]
    """<p>Response element for GetMembership that provides the configured membership type. Options include <code> Standalone | Organizations</code>. </p>"""
    number_of_accounts_covered: NotRequired["int"]
    """<p>Response element for GetMembership that provides the number of accounts in the membership.</p>"""
    incident_response_team: NotRequired[
        "capo_security_ir.types.incident_response_team.IncidentResponseTeam"
    ]
    """<p>Response element for GetMembership that provides the configured membership incident response team members. </p>"""
    opt_in_features: NotRequired["capo_security_ir.types.opt_in_features.OptInFeatures"]
    """<p>Response element for GetMembership that provides the if opt-in features have been enabled.</p>"""
    membership_accounts_configurations: NotRequired[
        "capo_security_ir.types.membership_accounts_configurations.MembershipAccountsConfigurations"
    ]
    """<p>The <code>membershipAccountsConfigurations</code> field contains the configuration details for member accounts within the Amazon Web Services Organizations membership structure. </p> <p>This field returns a structure containing information about:</p> <ul> <li> <p>Account configurations for member accounts</p> </li> <li> <p>Membership settings and preferences</p> </li> <li> <p>Account-level permissions and roles</p> </li> </ul>"""

account_id instance-attribute

account_id: NotRequired[AWSAccountId]

Response element for GetMembership that provides the account configured to manage the membership.

customer_type instance-attribute

customer_type: NotRequired[CustomerType]

Response element for GetMembership that provides the configured membership type. Options include Standalone | Organizations.

incident_response_team instance-attribute

incident_response_team: NotRequired[IncidentResponseTeam]

Response element for GetMembership that provides the configured membership incident response team members.

membership_accounts_configurations instance-attribute

membership_accounts_configurations: NotRequired[MembershipAccountsConfigurations]

The membershipAccountsConfigurations field contains the configuration details for member accounts within the Amazon Web Services Organizations membership structure.

This field returns a structure containing information about:

  • Account configurations for member accounts

  • Membership settings and preferences

  • Account-level permissions and roles

membership_activation_timestamp instance-attribute

membership_activation_timestamp: NotRequired[datetime]

Response element for GetMembership that provides the configured membership activation timestamp.

membership_arn instance-attribute

membership_arn: NotRequired[MembershipArn]

Response element for GetMembership that provides the membership ARN.

membership_deactivation_timestamp instance-attribute

membership_deactivation_timestamp: NotRequired[datetime]

Response element for GetMembership that provides the configured membership name deactivation timestamp.

membership_id instance-attribute

membership_id: MembershipId

Response element for GetMembership that provides the queried membership ID.

membership_name instance-attribute

membership_name: NotRequired[MembershipName]

Response element for GetMembership that provides the configured membership name.

membership_status instance-attribute

membership_status: NotRequired[MembershipStatus]

Response element for GetMembership that provides the current membership status.

number_of_accounts_covered instance-attribute

number_of_accounts_covered: NotRequired[int]

Response element for GetMembership that provides the number of accounts in the membership.

opt_in_features instance-attribute

opt_in_features: NotRequired[OptInFeatures]

Response element for GetMembership that provides the if opt-in features have been enabled.

region instance-attribute

region: NotRequired[AwsRegion]

Response element for GetMembership that provides the region configured to manage the membership.