EC2 / Client / describe_network_insights_access_scope_analyses

describe_network_insights_access_scope_analyses

EC2.Client.describe_network_insights_access_scope_analyses(**kwargs)

Describes the specified Network Access Scope analyses.

See also: AWS API Documentation

Request Syntax

response = client.describe_network_insights_access_scope_analyses(
    NetworkInsightsAccessScopeAnalysisIds=[
        'string',
    ],
    NetworkInsightsAccessScopeId='string',
    AnalysisStartTimeBegin=datetime(2015, 1, 1),
    AnalysisStartTimeEnd=datetime(2015, 1, 1),
    Filters=[
        {
            'Name': 'string',
            'Values': [
                'string',
            ]
        },
    ],
    MaxResults=123,
    DryRun=True|False,
    NextToken='string'
)

Parameters:

• NetworkInsightsAccessScopeAnalysisIds (list) –

  The IDs of the Network Access Scope analyses.

  • (string) –

• NetworkInsightsAccessScopeId (string) – The ID of the Network Access Scope.

• AnalysisStartTimeBegin (datetime) – Filters the results based on the start time. The analysis must have started on or after this time.

• AnalysisStartTimeEnd (datetime) – Filters the results based on the start time. The analysis must have started on or before this time.

• Filters (list) –

  There are no supported filters.

  • (dict) –

    A filter name and value pair that is used to return a more specific list of results from a describe operation. Filters can be used to match a set of resources by specific criteria, such as tags, attributes, or IDs.

    If you specify multiple filters, the filters are joined with an AND, and the request returns only results that match all of the specified filters.

    • Name (string) –

      The name of the filter. Filter names are case-sensitive.

    • Values (list) –

      The filter values. Filter values are case-sensitive. If you specify multiple values for a filter, the values are joined with an OR, and the request returns all results that match any of the specified values.

      • (string) –

• MaxResults (integer) – The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned nextToken value.

• DryRun (boolean) – 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.

• NextToken (string) – The token for the next page of results.

Return type:

dict

Returns:

Response Syntax

{
    'NetworkInsightsAccessScopeAnalyses': [
        {
            'NetworkInsightsAccessScopeAnalysisId': 'string',
            'NetworkInsightsAccessScopeAnalysisArn': 'string',
            'NetworkInsightsAccessScopeId': 'string',
            'Status': 'running'|'succeeded'|'failed',
            'StatusMessage': 'string',
            'WarningMessage': 'string',
            'StartDate': datetime(2015, 1, 1),
            'EndDate': datetime(2015, 1, 1),
            'FindingsFound': 'true'|'false'|'unknown',
            'AnalyzedEniCount': 123,
            'Tags': [
                {
                    'Key': 'string',
                    'Value': 'string'
                },
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) –

  • NetworkInsightsAccessScopeAnalyses (list) –

    The Network Access Scope analyses.

    • (dict) –

      Describes a Network Access Scope analysis.

      • NetworkInsightsAccessScopeAnalysisId (string) –

        The ID of the Network Access Scope analysis.

      • NetworkInsightsAccessScopeAnalysisArn (string) –

        The Amazon Resource Name (ARN) of the Network Access Scope analysis.

      • NetworkInsightsAccessScopeId (string) –

        The ID of the Network Access Scope.

      • Status (string) –

        The status.

      • StatusMessage (string) –

        The status message.

      • WarningMessage (string) –

        The warning message.

      • StartDate (datetime) –

        The analysis start date.

      • EndDate (datetime) –

        The analysis end date.

      • FindingsFound (string) –

        Indicates whether there are findings.

      • AnalyzedEniCount (integer) –

        The number of network interfaces analyzed.

      • Tags (list) –

        The tags.

        • (dict) –

          Describes a tag.

          • Key (string) –

            The key of the tag.

            Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.

          • Value (string) –

            The value of the tag.

            Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.

  • NextToken (string) –

    The token to use to retrieve the next page of results. This value is null when there are no more results to return.