SecurityAgent / Client / batch_get_threat_models

batch_get_threat_models

SecurityAgent.Client.batch_get_threat_models(**kwargs)

Retrieves information about one or more threat models in an agent space.

See also: AWS API Documentation

Request Syntax

response = client.batch_get_threat_models(
    threatModelIds=[
        'string',
    ],
    agentSpaceId='string'
)

Parameters:

• threatModelIds (list) –

  [REQUIRED]

  The list of threat model identifiers to retrieve.

  • (string) –

• agentSpaceId (string) –

  [REQUIRED]

  The unique identifier of the agent space that contains the threat models.

Return type:

dict

Returns:

Response Syntax

{
    'threatModels': [
        {
            'threatModelId': 'string',
            'agentSpaceId': 'string',
            'title': 'string',
            'description': 'string',
            'assets': {
                'endpoints': [
                    {
                        'uri': 'string'
                    },
                ],
                'actors': [
                    {
                        'identifier': 'string',
                        'uris': [
                            'string',
                        ],
                        'authentication': {
                            'providerType': 'SECRETS_MANAGER'|'AWS_LAMBDA'|'AWS_IAM_ROLE'|'AWS_INTERNAL',
                            'value': 'string'
                        },
                        'description': 'string'
                    },
                ],
                'documents': [
                    {
                        's3Location': 'string',
                        'artifactId': 'string',
                        'integratedDocument': {
                            'integrationId': 'string',
                            'resourceId': 'string'
                        }
                    },
                ],
                'sourceCode': [
                    {
                        's3Location': 'string'
                    },
                ],
                'integratedRepositories': [
                    {
                        'integrationId': 'string',
                        'providerResourceId': 'string'
                    },
                ]
            },
            'scopeDocs': [
                {
                    's3Location': 'string',
                    'artifactId': 'string',
                    'integratedDocument': {
                        'integrationId': 'string',
                        'resourceId': 'string'
                    }
                },
            ],
            'serviceRole': 'string',
            'logConfig': {
                'logGroup': 'string',
                'logStream': 'string'
            },
            'createdAt': datetime(2015, 1, 1),
            'updatedAt': datetime(2015, 1, 1)
        },
    ],
    'notFound': [
        'string',
    ]
}

Response Structure

• (dict) –

  Output for the BatchGetThreatModels operation.

  • threatModels (list) –

    The list of threat models that were found.

    • (dict) –

      Represents a threat model configuration that defines the parameters for automated threat analysis, including target assets and logging configuration.

      • threatModelId (string) –

        The unique identifier of the threat model.

      • agentSpaceId (string) –

        The unique identifier of the agent space that contains the threat model.

      • title (string) –

        The title of the threat model.

      • description (string) –

        A description of the application or system being threat modeled.

      • assets (dict) –

        The assets included in the threat model.

        • endpoints (list) –

          The list of endpoints to test during the pentest.

          • (dict) –

            Represents a target endpoint for penetration testing.

            • uri (string) –

              The URI of the endpoint.

        • actors (list) –

          The list of actors used during penetration testing.

          • (dict) –

            Represents an actor used during penetration testing. An actor defines a user or entity that interacts with the target application, including authentication credentials and target URIs.

            • identifier (string) –

              The unique identifier for the actor.

            • uris (list) –

              The list of URIs that the actor targets during testing.

              • (string) –

            • authentication (dict) –

              The authentication configuration for the actor.

              • providerType (string) –

                The type of authentication provider. Valid values include SECRETS_MANAGER, AWS_LAMBDA, AWS_IAM_ROLE, and AWS_INTERNAL.

              • value (string) –

                The authentication value, such as a secret ARN, Lambda function ARN, or IAM role ARN, depending on the provider type.

            • description (string) –

              A description of the actor.

        • documents (list) –

          The list of documents that provide context for the pentest.

          • (dict) –

            Represents a document that provides context for security testing.

            • s3Location (string) –

              The Amazon S3 location of the document.

            • artifactId (string) –

              The unique identifier of the artifact associated with the document.

            • integratedDocument (dict) –

              A reference to a document in an integrated third-party provider.

              • integrationId (string) –

                The identifier of the integration that provides access to the document.

              • resourceId (string) –

                The provider-specific resource identifier for the document.

        • sourceCode (list) –

          The list of source code repositories to analyze during the pentest.

          • (dict) –

            Represents a source code repository used for security analysis during a pentest.

            • s3Location (string) –

              The Amazon S3 location of the source code repository archive.

        • integratedRepositories (list) –

          The list of integrated repositories associated with the pentest.

          • (dict) –

            Represents a code repository that is integrated with the service through a third-party provider.

            • integrationId (string) –

              The unique identifier of the integration that provides access to the repository.

            • providerResourceId (string) –

              The provider-specific resource identifier for the repository.

      • scopeDocs (list) –

        The scoped documents for the agent to focus on during threat modeling.

        • (dict) –

          Represents a document that provides context for security testing.

          • s3Location (string) –

            The Amazon S3 location of the document.

          • artifactId (string) –

            The unique identifier of the artifact associated with the document.

          • integratedDocument (dict) –

            A reference to a document in an integrated third-party provider.

            • integrationId (string) –

              The identifier of the integration that provides access to the document.

            • resourceId (string) –

              The provider-specific resource identifier for the document.

      • serviceRole (string) –

        The IAM service role used for the threat model.

      • logConfig (dict) –

        The CloudWatch Logs configuration for the threat model.

        • logGroup (string) –

          The name of the CloudWatch log group.

        • logStream (string) –

          The name of the CloudWatch log stream.

      • createdAt (datetime) –

        The date and time the threat model was created, in UTC format.

      • updatedAt (datetime) –

        The date and time the threat model was last updated, in UTC format.

  • notFound (list) –

    The list of threat model identifiers that were not found.

    • (string) –