SecurityAgent / Client / batch_update_security_requirements

batch_update_security_requirements

SecurityAgent.Client.batch_update_security_requirements(**kwargs)

Batch updates security requirements within a customer managed pack.

See also: AWS API Documentation

Request Syntax

response = client.batch_update_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 containing the requirements to update.

  • securityRequirements (list) –

    [REQUIRED]

    The list of security requirement updates to apply.

    • (dict) –

      Contains the details for updating an existing security requirement within a pack. The name is an immutable identifier used to locate the requirement and cannot be modified.

      • name (string) – [REQUIRED]

        The name of the security requirement to update. This is an immutable identifier and cannot be changed once the requirement is created.

      • description (string) –

        The updated description of the security requirement.

      • domain (string) –

        The updated security domain the requirement belongs to.

      • evaluation (string) –

        The updated evaluation criteria used to assess compliance with this requirement.

      • remediation (string) –

        The updated remediation steps when the requirement is not met.

Return type:

dict

Returns:

Response Syntax

{
    'updatedSecurityRequirementNames': [
        'string',
    ],
    'errors': [
        {
            'securityRequirementName': 'string',
            'code': 'string',
            'message': 'string'
        },
    ]
}

Response Structure

  • (dict) –

    • updatedSecurityRequirementNames (list) –

      The list of security requirement names that were successfully updated.

      • (string) –

    • errors (list) –

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

      • (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