SecurityAgent / Client / list_security_requirements

list_security_requirements

SecurityAgent.Client.list_security_requirements(**kwargs)

Lists security requirements within a pack.

See also: AWS API Documentation

Request Syntax

response = client.list_security_requirements(
    packId='string',
    nextToken='string',
    maxResults=123
)
Parameters:

  • packId (string) –

    [REQUIRED]

    The unique identifier of the security requirement pack to list requirements for.

  • nextToken (string) – The pagination token from a previous request to retrieve the next page of results.

  • maxResults (integer) – The maximum number of results to return in a single request.

Return type:

dict

Returns:

Response Syntax

{
    'securityRequirementSummaries': [
        {
            'packId': 'string',
            'name': 'string',
            'description': 'string',
            'createdAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1)
        },
    ],
    'nextToken': 'string'
}

Response Structure

  • (dict) –

    • securityRequirementSummaries (list) –

      The list of security requirement summaries.

      • (dict) –

        Contains summary information about a 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.

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

    • nextToken (string) –

      The pagination token to use in a subsequent request to retrieve the next page of results.

Exceptions