SecurityAgent / Client / batch_delete_code_reviews

batch_delete_code_reviews¶

SecurityAgent.Client.batch_delete_code_reviews(**kwargs)¶

Deletes one or more code reviews from an agent space.

Request Syntax

response = client.batch_delete_code_reviews(
    codeReviewIds=[
        'string',
    ],
    agentSpaceId='string'
)

Parameters:

codeReviewIds (list) –
[REQUIRED]

The list of code review identifiers to delete.
- (string) –
agentSpaceId (string) –
[REQUIRED]

The unique identifier of the agent space that contains the code reviews to delete.

Return type:

dict

Returns:

Response Syntax

{
    'deleted': [
        'string',
    ],
    'failed': [
        {
            'codeReviewId': 'string',
            'reason': 'string'
        },
    ]
}

Response Structure

(dict) –

Output for the BatchDeleteCodeReviews operation.
- deleted (list) –
  
  The list of identifiers of the code reviews that were successfully deleted.
  - (string) –
- failed (list) –
  
  The list of code reviews that failed to delete, including the reason for each failure.
  - (dict) –
    
    Contains information about a code review that failed to delete.
    - codeReviewId (string) –
      
      The unique identifier of the code review that failed to delete.
    - reason (string) –
      
      The reason the code review failed to delete.