SecurityAgent / Client / import_security_requirements

import_security_requirements

SecurityAgent.Client.import_security_requirements(**kwargs)

Imports security requirements from uploaded documents into a customer managed security requirement pack. The import process asynchronously extracts and generates structured security requirements from the provided source files.

See also: AWS API Documentation

Request Syntax

response = client.import_security_requirements(
    packId='string',
    input={
        'documents': [
            {
                'name': 'string',
                'format': 'MD'|'PDF'|'TXT'|'DOCX'|'DOC',
                'content': b'bytes'
            },
        ]
    }
)

Parameters:

• packId (string) –

  [REQUIRED]

  The unique identifier of the security requirement pack to import requirements into.

• input (dict) –

  [REQUIRED]

  The import source containing the documents to extract security requirements from.

  Note

  This is a Tagged Union structure. Only one of the following top level keys can be set: documents.

  • documents (list) –

    The list of documents to extract security requirements from.

    • (dict) –

      A document used as source material for importing security requirements.

      • name (string) – [REQUIRED]

        The file name of the document.

      • format (string) – [REQUIRED]

        The format of the document. Valid values are MD, PDF, TXT, DOCX, and DOC.

      • content (bytes) – [REQUIRED]

        The binary content of the document.

Return type:

dict

Returns:

Response Syntax

{
    'packId': 'string',
    'importStatus': 'PENDING'|'IN_PROGRESS'|'FAILED'|'COMPLETED'
}

Response Structure

• (dict) –

  • packId (string) –

    The unique identifier of the security requirement pack.

  • importStatus (string) –

    The status of the import workflow.

Exceptions

• SecurityAgent.Client.exceptions.ValidationException

• SecurityAgent.Client.exceptions.ResourceNotFoundException

• SecurityAgent.Client.exceptions.InternalServerException

• SecurityAgent.Client.exceptions.ConflictException

• SecurityAgent.Client.exceptions.ThrottlingException

• SecurityAgent.Client.exceptions.AccessDeniedException

• SecurityAgent.Client.exceptions.ServiceQuotaExceededException