SecurityAgent / Client / batch_create_security_requirements

batch_create_security_requirements

SecurityAgent.Client.batch_create_security_requirements(**kwargs)

Batch creates security requirements in a customer managed pack.

See also: AWS API Documentation

Request Syntax

response = client.batch_create_security_requirements(
    packId='string',
    securityRequirements=[
        {
            'name': 'string',
            'description': 'string',
            'domain': 'string',
            'evaluation': 'string',
            'remediation': 'string'
        },
    ]
)
Parameters:

  • packId (string) –

    [REQUIRED]

    The unique identifier of the security requirement pack to add requirements to.

  • securityRequirements (list) –

    [REQUIRED]

    The list of security requirements to create.

    • (dict) –

      Contains the details for a security requirement to create within a pack.

      • name (string) – [REQUIRED]

        The name of the security requirement.

      • description (string) – [REQUIRED]

        A description of the security requirement.

      • domain (string) – [REQUIRED]

        The security domain the requirement belongs to.

      • evaluation (string) – [REQUIRED]

        The evaluation criteria used to assess compliance with this requirement.

      • remediation (string) –

        The recommended remediation steps when the requirement is not met.

Return type:

dict

Returns:

Response Syntax

{
    'securityRequirements': [
        {
            'packId': 'string',
            'name': 'string',
            'description': 'string',
            'domain': 'string',
            'evaluation': 'string',
            'remediation': 'string',
            'createdAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1)
        },
    ],
    'errors': [
        {
            'securityRequirementName': 'string',
            'code': 'string',
            'message': 'string'
        },
    ]
}

Response Structure

  • (dict) –

    • securityRequirements (list) –

      The list of security requirements that were successfully created.

      • (dict) –

        Contains information about a successfully created security requirement.

        • packId (string) –

          The unique identifier of the pack containing the security requirement.

        • name (string) –

          The name of the security requirement.

        • description (string) –

          A description of the security requirement.

        • domain (string) –

          The security domain the requirement belongs to.

        • evaluation (string) –

          The evaluation criteria used to assess compliance with this requirement.

        • remediation (string) –

          The recommended remediation steps when the requirement is not met.

        • createdAt (datetime) –

          The date and time the security requirement was created, in UTC format.

        • updatedAt (datetime) –

          The date and time the security requirement was last updated, in UTC format.

    • errors (list) –

      The list of errors for security requirements that failed to be created.

      • (dict) –

        Contains information about an error that occurred for a specific security requirement during a batch operation.

        • securityRequirementName (string) –

          The name of the security requirement that caused the error.

        • code (string) –

          The error code.

        • message (string) –

          The error message.

Exceptions