Skip to content

describe_network_insights_access_scopes

describe_network_insights_access_scopes(
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    network_insights_access_scope_ids: Optional[
        NetworkInsightsAccessScopeIdList
    ] = None,
    filters: Optional[FilterList] = None,
    max_results: Optional[NetworkInsightsMaxResults] = None,
    dry_run: Optional[Boolean] = None,
    next_token: Optional[NextToken] = None,
) -> DescribeNetworkInsightsAccessScopesResult

Describes the specified Network Access Scopes.

Parameters:

  • network_insights_access_scope_ids (Optional[NetworkInsightsAccessScopeIdList], default: None ) –

    The IDs of the Network Access Scopes.

  • filters (Optional[FilterList], default: None ) –

    There are no supported filters.

  • max_results (Optional[NetworkInsightsMaxResults], default: 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.

  • dry_run (Optional[Boolean], default: 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.

  • next_token (Optional[NextToken], default: None ) –

    The token for the next page of results.

Raises:

Source code in docs_src/capo_ec2/_services/ec2.py
def describe_network_insights_access_scopes(
    self,
    *,
    config_overrides: Optional[EC2ClientConfig] = None,
    network_insights_access_scope_ids: Optional[
        "capo_ec2.types.network_insights_access_scope_id_list.NetworkInsightsAccessScopeIdList"
    ] = None,
    filters: Optional["capo_ec2.types.filter_list.FilterList"] = None,
    max_results: Optional[
        "capo_ec2.types.network_insights_max_results.NetworkInsightsMaxResults"
    ] = None,
    dry_run: Optional["capo_ec2.types.boolean.Boolean"] = None,
    next_token: Optional["capo_ec2.types.next_token.NextToken"] = None,
) -> "capo_ec2.types.describe_network_insights_access_scopes_result.DescribeNetworkInsightsAccessScopesResult":
    """<p>Describes the specified Network Access Scopes.</p>

    Args:
        network_insights_access_scope_ids: <p>The IDs of the Network Access Scopes.</p>
        filters: <p>There are no supported filters.</p>
        max_results: <p>The maximum number of results to return with a single call. To retrieve the remaining results, make another call with the returned <code>nextToken</code> value.</p>
        dry_run: <p>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 <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p>
        next_token: <p>The token for the next page of results.</p>

    Raises:
        capo_ec2.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_ec2.types.describe_network_insights_access_scopes_request.DescribeNetworkInsightsAccessScopesRequest]",
    ) -> OperationResponse[
        "capo_ec2.types.describe_network_insights_access_scopes_result.DescribeNetworkInsightsAccessScopesResult"
    ]:
        import capo_ec2._operations.amazon_ec2.describe_network_insights_access_scopes

        output, http_response = (
            capo_ec2._operations.amazon_ec2.describe_network_insights_access_scopes.describe_network_insights_access_scopes(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeNetworkInsightsAccessScopes")
    )
    input_: capo_ec2.types.describe_network_insights_access_scopes_request.DescribeNetworkInsightsAccessScopesRequest = {}
    if network_insights_access_scope_ids is not None:
        input_["network_insights_access_scope_ids"] = (
            network_insights_access_scope_ids
        )
    if filters is not None:
        input_["filters"] = filters
    if max_results is not None:
        input_["max_results"] = max_results
    if dry_run is not None:
        input_["dry_run"] = dry_run
    if next_token is not None:
        input_["next_token"] = next_token

    response = execute_pipeline(
        OperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    response.response.close()
    return response.output