SecurityIncidentResponse / Client / get_membership

get_membership

SecurityIncidentResponse.Client.get_membership(**kwargs)

Returns the attributes of a membership.

See also: AWS API Documentation

Request Syntax

response = client.get_membership(
    membershipId='string'
)

Parameters:

membershipId (string) –

[REQUIRED]

Required element for GetMembership to identify the membership ID to query.

Return type:

dict

Returns:

Response Syntax

{
    'membershipId': 'string',
    'accountId': 'string',
    'region': 'af-south-1'|'ap-east-1'|'ap-east-2'|'ap-northeast-1'|'ap-northeast-2'|'ap-northeast-3'|'ap-south-1'|'ap-south-2'|'ap-southeast-1'|'ap-southeast-2'|'ap-southeast-3'|'ap-southeast-4'|'ap-southeast-5'|'ap-southeast-7'|'ca-central-1'|'ca-west-1'|'cn-north-1'|'cn-northwest-1'|'eu-central-1'|'eu-central-2'|'eu-north-1'|'eu-south-1'|'eu-south-2'|'eu-west-1'|'eu-west-2'|'eu-west-3'|'il-central-1'|'me-central-1'|'me-south-1'|'mx-central-1'|'sa-east-1'|'us-east-1'|'us-east-2'|'us-west-1'|'us-west-2',
    'membershipName': 'string',
    'membershipArn': 'string',
    'membershipStatus': 'Active'|'Cancelled'|'Terminated',
    'membershipActivationTimestamp': datetime(2015, 1, 1),
    'membershipDeactivationTimestamp': datetime(2015, 1, 1),
    'customerType': 'Standalone'|'Organization',
    'numberOfAccountsCovered': 123,
    'incidentResponseTeam': [
        {
            'name': 'string',
            'jobTitle': 'string',
            'email': 'string'
        },
    ],
    'optInFeatures': [
        {
            'featureName': 'Triage',
            'isEnabled': True|False
        },
    ],
    'membershipAccountsConfigurations': {
        'coverEntireOrganization': True|False,
        'organizationalUnits': [
            'string',
        ]
    }
}

Response Structure

• (dict) –

  • membershipId (string) –

    Response element for GetMembership that provides the queried membership ID.

  • accountId (string) –

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

  • region (string) –

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

  • membershipName (string) –

    Response element for GetMembership that provides the configured membership name.

  • membershipArn (string) –

    Response element for GetMembership that provides the membership ARN.

  • membershipStatus (string) –

    Response element for GetMembership that provides the current membership status.

  • membershipActivationTimestamp (datetime) –

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

  • membershipDeactivationTimestamp (datetime) –

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

  • customerType (string) –

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

  • numberOfAccountsCovered (integer) –

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

  • incidentResponseTeam (list) –

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

    • (dict) –

      • name (string) –

      • jobTitle (string) –

      • email (string) –

  • optInFeatures (list) –

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

    • (dict) –

      • featureName (string) –

      • isEnabled (boolean) –

  • membershipAccountsConfigurations (dict) –

    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

    • coverEntireOrganization (boolean) –

      The coverEntireOrganization field is a boolean value that determines whether the membership configuration applies to all accounts within an Amazon Web Services Organization.

      When set to true, the configuration will be applied across all accounts in the organization. When set to false, the configuration will only apply to specifically designated accounts under the AWS Organizational Units specificied.

    • organizationalUnits (list) –

      A list of organizational unit IDs that follow the pattern ou-[0-9a-z]{4,32}-[a-z0-9]{8,32}. These IDs represent the organizational units within an Amazon Web Services Organizations structure that are covered by the membership.

      Each organizational unit ID in the list must:

      • Begin with the prefix ‘ou-’

      • Contain between 4 and 32 alphanumeric characters in the first segment

      • Contain between 8 and 32 alphanumeric characters in the second segment

      • (string) –

Exceptions

• SecurityIncidentResponse.Client.exceptions.ServiceQuotaExceededException

• SecurityIncidentResponse.Client.exceptions.AccessDeniedException

• SecurityIncidentResponse.Client.exceptions.ValidationException

• SecurityIncidentResponse.Client.exceptions.SecurityIncidentResponseNotActiveException

• SecurityIncidentResponse.Client.exceptions.InternalServerException

• SecurityIncidentResponse.Client.exceptions.ThrottlingException

• SecurityIncidentResponse.Client.exceptions.ConflictException

• SecurityIncidentResponse.Client.exceptions.ResourceNotFoundException

• SecurityIncidentResponse.Client.exceptions.InvalidTokenException