SecurityAgent / Client / create_agent_space

create_agent_space¶

SecurityAgent.Client.create_agent_space(**kwargs)¶

Creates a new agent space. An agent space is a dedicated workspace for securing a specific application.

Request Syntax

response = client.create_agent_space(
    name='string',
    description='string',
    awsResources={
        'vpcs': [
            {
                'vpcArn': 'string',
                'securityGroupArns': [
                    'string',
                ],
                'subnetArns': [
                    'string',
                ]
            },
        ],
        'logGroups': [
            'string',
        ],
        's3Buckets': [
            'string',
        ],
        'secretArns': [
            'string',
        ],
        'lambdaFunctionArns': [
            'string',
        ],
        'iamRoles': [
            'string',
        ]
    },
    targetDomainIds=[
        'string',
    ],
    codeReviewSettings={
        'controlsScanning': True|False,
        'generalPurposeScanning': True|False
    },
    kmsKeyId='string',
    tags={
        'string': 'string'
    }
)

Parameters:

name (string) –
[REQUIRED]

The name of the agent space.
description (string) – A description of the agent space.
awsResources (dict) –
The AWS resources to associate with the agent space.
- vpcs (list) –
  
  The VPC configurations associated with the agent space.
  - (dict) –
    
    The VPC configuration for a pentest, specifying the VPC, security groups, and subnets to use during testing.
    - vpcArn (string) –
      
      The Amazon Resource Name (ARN) of the VPC.
    - securityGroupArns (list) –
      
      The Amazon Resource Names (ARNs) of the security groups for the VPC configuration.
      - (string) –
        
        ARN or ID of a security group.
    - subnetArns (list) –
      
      The Amazon Resource Names (ARNs) of the subnets for the VPC configuration.
      - (string) –
        
        ARN or ID of a subnet.
- logGroups (list) –
  
  The Amazon Resource Names (ARNs) of the CloudWatch log groups associated with the agent space.
  - (string) –
    
    Log group ARN or name for agent space AWS resources.
- s3Buckets (list) –
  
  The Amazon Resource Names (ARNs) of the S3 buckets associated with the agent space.
  - (string) –
    
    S3 bucket ARN or name for agent space AWS resources.
- secretArns (list) –
  
  The Amazon Resource Names (ARNs) of the Secrets Manager secrets associated with the agent space.
  - (string) –
    
    Secret ARN or name for agent space AWS resources.
- lambdaFunctionArns (list) –
  
  The Amazon Resource Names (ARNs) of the Lambda functions associated with the agent space.
  - (string) –
    
    Lambda function ARN or name for agent space AWS resources.
- iamRoles (list) –
  
  The IAM roles associated with the agent space.
  - (string) –
    
    ARN of an IAM role that the service can assume to access customer resources.
targetDomainIds (list) –
The list of target domain identifiers to associate with the agent space.
- (string) –
codeReviewSettings (dict) –
The code review settings for the agent space.
- controlsScanning (boolean) – [REQUIRED]
  
  Indicates whether controls scanning is enabled for code reviews.
- generalPurposeScanning (boolean) – [REQUIRED]
  
  Indicates whether general-purpose scanning is enabled for code reviews.
kmsKeyId (string) – The identifier of the AWS KMS key to use for encrypting data in the agent space.
tags (dict) –
The tags to associate with the agent space.
- (string) –
  
  Key for a resource tag.
  - (string) –
    
    Value for a resource tag.

Return type:

dict

Returns:

Response Syntax

{
    'agentSpaceId': 'string',
    'name': 'string',
    'description': 'string',
    'awsResources': {
        'vpcs': [
            {
                'vpcArn': 'string',
                'securityGroupArns': [
                    'string',
                ],
                'subnetArns': [
                    'string',
                ]
            },
        ],
        'logGroups': [
            'string',
        ],
        's3Buckets': [
            'string',
        ],
        'secretArns': [
            'string',
        ],
        'lambdaFunctionArns': [
            'string',
        ],
        'iamRoles': [
            'string',
        ]
    },
    'targetDomainIds': [
        'string',
    ],
    'codeReviewSettings': {
        'controlsScanning': True|False,
        'generalPurposeScanning': True|False
    },
    'kmsKeyId': 'string',
    'createdAt': datetime(2015, 1, 1),
    'updatedAt': datetime(2015, 1, 1)
}

Response Structure

(dict) –

Output for the CreateAgentSpace operation.
- agentSpaceId (string) –
  
  The unique identifier of the created agent space.
- name (string) –
  
  The name of the agent space.
- description (string) –
  
  The description of the agent space.
- awsResources (dict) –
  
  The AWS resources associated with the agent space.
  - vpcs (list) –
    
    The VPC configurations associated with the agent space.
    - (dict) –
      
      The VPC configuration for a pentest, specifying the VPC, security groups, and subnets to use during testing.
      - vpcArn (string) –
        
        The Amazon Resource Name (ARN) of the VPC.
      - securityGroupArns (list) –
        
        The Amazon Resource Names (ARNs) of the security groups for the VPC configuration.
        
        (string) –
        
        ARN or ID of a security group.
      - subnetArns (list) –
        
        The Amazon Resource Names (ARNs) of the subnets for the VPC configuration.
        
        (string) –
        
        ARN or ID of a subnet.
  - logGroups (list) –
    
    The Amazon Resource Names (ARNs) of the CloudWatch log groups associated with the agent space.
    - (string) –
      
      Log group ARN or name for agent space AWS resources.
  - s3Buckets (list) –
    
    The Amazon Resource Names (ARNs) of the S3 buckets associated with the agent space.
    - (string) –
      
      S3 bucket ARN or name for agent space AWS resources.
  - secretArns (list) –
    
    The Amazon Resource Names (ARNs) of the Secrets Manager secrets associated with the agent space.
    - (string) –
      
      Secret ARN or name for agent space AWS resources.
  - lambdaFunctionArns (list) –
    
    The Amazon Resource Names (ARNs) of the Lambda functions associated with the agent space.
    - (string) –
      
      Lambda function ARN or name for agent space AWS resources.
  - iamRoles (list) –
    
    The IAM roles associated with the agent space.
    - (string) –
      
      ARN of an IAM role that the service can assume to access customer resources.
- targetDomainIds (list) –
  
  The list of target domain identifiers associated with the agent space.
  - (string) –
- codeReviewSettings (dict) –
  
  The code review settings for the agent space.
  - controlsScanning (boolean) –
    
    Indicates whether controls scanning is enabled for code reviews.
  - generalPurposeScanning (boolean) –
    
    Indicates whether general-purpose scanning is enabled for code reviews.
- kmsKeyId (string) –
  
  The identifier of the AWS KMS key used to encrypt data in the agent space.
- createdAt (datetime) –
  
  The date and time the agent space was created, in UTC format.
- updatedAt (datetime) –
  
  The date and time the agent space was last updated, in UTC format.