networkinsights_start_analysis
Initiate analysis of AWS network access scope with specified region and scope ID. Optional dry run checks permissions, tagging allows annotation, and client token ensures request idempotency.
Instructions
Start a Network Access Scope analysis.
Parameters:
aws_region (str): AWS region - use 'us-east-1' if not specified.
scope_id (str): The NetworkInsightsAccessScopeId to analyze.
dry_run (bool): If True, checks permissions without starting.
tag_specifications (list): TagSpecification dicts for annotating the analysis.
client_token (str): Idempotency token for the request.
Returns:
str: JSON representation of the NetworkInsightsAccessScopeAnalysis object.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| aws_region | Yes | ||
| client_token | No | ||
| dry_run | No | ||
| scope_id | Yes | ||
| tag_specifications | No |
Input Schema (JSON Schema)
{
"properties": {
"aws_region": {
"title": "Aws Region",
"type": "string"
},
"client_token": {
"default": null,
"title": "Client Token",
"type": "string"
},
"dry_run": {
"default": false,
"title": "Dry Run",
"type": "boolean"
},
"scope_id": {
"title": "Scope Id",
"type": "string"
},
"tag_specifications": {
"default": null,
"items": {
"additionalProperties": true,
"type": "object"
},
"title": "Tag Specifications",
"type": "array"
}
},
"required": [
"aws_region",
"scope_id"
],
"title": "networkinsights_start_analysisArguments",
"type": "object"
}