SecurityIncidentResponse / Client / create_membership

create_membership

SecurityIncidentResponse.Client.create_membership(**kwargs)

Creates a new membership.

See also: AWS API Documentation

Request Syntax

response = client.create_membership(
    clientToken='string',
    membershipName='string',
    incidentResponseTeam=[
        {
            'name': 'string',
            'jobTitle': 'string',
            'email': 'string'
        },
    ],
    optInFeatures=[
        {
            'featureName': 'Triage',
            'isEnabled': True|False
        },
    ],
    tags={
        'string': 'string'
    },
    coverEntireOrganization=True|False
)
Parameters:

  • clientToken (string) –

    Note

    The clientToken field is an idempotency key used to ensure that repeated attempts for a single action will be ignored by the server during retries. A caller supplied unique ID (typically a UUID) should be provided.

    This field is autopopulated if not provided.

  • membershipName (string) –

    [REQUIRED]

    Required element used in combination with CreateMembership to create a name for the membership.

  • incidentResponseTeam (list) –

    [REQUIRED]

    Required element used in combination with CreateMembership to add customer incident response team members and trusted partners to the membership.

    • (dict) –

      • name (string) – [REQUIRED]

      • jobTitle (string) – [REQUIRED]

      • email (string) – [REQUIRED]

  • optInFeatures (list) –

    Optional element to enable the monitoring and investigation opt-in features for the service.

    • (dict) –

      • featureName (string) – [REQUIRED]

      • isEnabled (boolean) – [REQUIRED]

  • tags (dict) –

    Optional element for customer configured tags.

    • (string) –

      • (string) –

  • coverEntireOrganization (boolean) –

    The coverEntireOrganization parameter is a boolean flag that determines whether the membership should be applied to the entire Amazon Web Services Organization. When set to true, the membership will be created for all accounts within the organization. When set to false, the membership will only be created for specified accounts.

    This parameter is optional. If not specified, the default value is false.

    • If set to true: The membership will automatically include all existing and future accounts in the Amazon Web Services Organization.

    • If set to false: The membership will only apply to explicitly specified accounts.

Return type:

dict

Returns:

Response Syntax

{
    'membershipId': 'string'
}

Response Structure

  • (dict) –

    • membershipId (string) –

      Response element for CreateMembership providing the newly created membership ID.

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