SecurityIncidentResponse / Client / get_membership

get_membership#

SecurityIncidentResponse.Client.get_membership(**kwargs)#

Grants permission to get details of a designated service membership.

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-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'|'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'|'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
        },
    ]
}

Response Structure

(dict) –
- membershipId (string) –
  
  Response element for GetMembership that provides the queried membership ID.
- accountId (string) –
  
  Response element for GetMembership that provides the configured account for managing the membership.
- region (string) –
  
  Response element for GetMembership that provides the configured region for managing 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) –

Exceptions

SecurityIncidentResponse.Client.exceptions.ServiceQuotaExceededException
SecurityIncidentResponse.Client.exceptions.AccessDeniedException
SecurityIncidentResponse.Client.exceptions.ValidationException
SecurityIncidentResponse.Client.exceptions.SecurityIncidentResponseNotActiveException
SecurityIncidentResponse.Client.exceptions.InternalServerException
SecurityIncidentResponse.Client.exceptions.ConflictException
SecurityIncidentResponse.Client.exceptions.ResourceNotFoundException
SecurityIncidentResponse.Client.exceptions.ThrottlingException
SecurityIncidentResponse.Client.exceptions.InvalidTokenException