describe_network_insights_analyses¶
Operation¶
describe_network_insights_analyses
async
¶
describe_network_insights_analyses(request: DescribeNetworkInsightsAnalysesInput | DescribeNetworkInsightsAnalysesInputDict, /, *, plugins: list[Plugin] | None = None) -> DescribeNetworkInsightsAnalysesOutput
describe_network_insights_analyses(*, plugins: list[Plugin] | None = None, **kwargs: Unpack[DescribeNetworkInsightsAnalysesInputDict]) -> DescribeNetworkInsightsAnalysesOutput
Describes one or more of your network insights analyses.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
DescribeNetworkInsightsAnalysesOutput
|
An instance of |
Input¶
Pass the input fields as keyword arguments, or pass a model or dictionary as the first positional argument. Pass plugins separately as a keyword argument.
Model¶
DescribeNetworkInsightsAnalysesInput
dataclass
¶
Bases: _SerdeShape
Dataclass for DescribeNetworkInsightsAnalysesInput structure.
Attributes¶
analysis_end_time
class-attribute
instance-attribute
¶
analysis_end_time: datetime | None = ...
The time when the network insights analyses ended.
analysis_start_time
class-attribute
instance-attribute
¶
analysis_start_time: datetime | None = ...
The time when the network insights analyses started.
dry_run
class-attribute
instance-attribute
¶
dry_run: bool | None = ...
Checks whether you have the required permissions for the action, without
actually making the request, and provides an error response. If you have
the required permissions, the error response is DryRunOperation.
Otherwise, it is UnauthorizedOperation.
filters
class-attribute
instance-attribute
¶
The filters. The following are the possible values:
-
path-found - A Boolean value that indicates whether a feasible path is found.
-
status - The status of the analysis (running | succeeded | failed).
max_results
class-attribute
instance-attribute
¶
max_results: int | None = ...
The maximum number of results to return with a single call. To retrieve
the remaining results, make another call with the returned nextToken
value.
network_insights_analysis_ids
class-attribute
instance-attribute
¶
The ID of the network insights analyses. You must specify either analysis IDs or a path ID.
Dictionaries¶
DescribeNetworkInsightsAnalysesInputDict
¶
Bases: TypedDict
Dictionary form of DescribeNetworkInsightsAnalysesInput.
Attributes¶
analysis_end_time
instance-attribute
¶
analysis_end_time: datetime | None
The time when the network insights analyses ended.
analysis_start_time
instance-attribute
¶
analysis_start_time: datetime | None
The time when the network insights analyses started.
dry_run
instance-attribute
¶
dry_run: bool | None
Checks whether you have the required permissions for the action, without
actually making the request, and provides an error response. If you have
the required permissions, the error response is DryRunOperation.
Otherwise, it is UnauthorizedOperation.
filters
instance-attribute
¶
filters: Sequence[Filter | FilterDict] | None
The filters. The following are the possible values:
-
path-found - A Boolean value that indicates whether a feasible path is found.
-
status - The status of the analysis (running | succeeded | failed).
max_results
instance-attribute
¶
max_results: int | None
The maximum number of results to return with a single call. To retrieve
the remaining results, make another call with the returned nextToken
value.
network_insights_analysis_ids
instance-attribute
¶
The ID of the network insights analyses. You must specify either analysis IDs or a path ID.
Output¶
DescribeNetworkInsightsAnalysesOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for DescribeNetworkInsightsAnalysesOutput structure.
Attributes¶
network_insights_analyses
class-attribute
instance-attribute
¶
network_insights_analyses: list[NetworkInsightsAnalysis] | None = ...
Information about the network insights analyses.
next_token
class-attribute
instance-attribute
¶
next_token: str | None = ...
The token to use to retrieve the next page of results. This value is
null when there are no more results to return.
response_metadata
class-attribute
instance-attribute
¶
Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.