Skip to content

list_components

list_components(
    resource_group_name: ResourceGroupName,
    *,
    config_overrides: Optional[ApplicationInsightsClientConfig] = None,
    max_results: Optional[MaxEntities] = None,
    next_token: Optional[PaginationToken] = None,
    account_id: Optional[AccountId] = None,
) -> ListComponentsResponse

Lists the auto-grouped, standalone, and custom components of the application.

Parameters:

  • resource_group_name (ResourceGroupName) –

    The name of the resource group.

  • max_results (Optional[MaxEntities], default: None ) –

    The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned NextToken value.

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

    The token to request the next page of results.

  • account_id (Optional[AccountId], default: None ) –

    The Amazon Web Services account ID for the resource group owner.

Raises:

Source code in docs_src/capo_application_insights/_services/application_insights.py
def list_components(
    self,
    resource_group_name: "capo_application_insights.types.resource_group_name.ResourceGroupName",
    *,
    config_overrides: Optional[ApplicationInsightsClientConfig] = None,
    max_results: Optional[
        "capo_application_insights.types.max_entities.MaxEntities"
    ] = None,
    next_token: Optional[
        "capo_application_insights.types.pagination_token.PaginationToken"
    ] = None,
    account_id: Optional[
        "capo_application_insights.types.account_id.AccountId"
    ] = None,
) -> "capo_application_insights.types.list_components_response.ListComponentsResponse":
    """<p>Lists the auto-grouped, standalone, and custom components of the application.</p>

    Args:
        resource_group_name: <p>The name of the resource group.</p>
        max_results: <p>The maximum number of results to return in a single call. To retrieve the remaining results, make another call with the returned <code>NextToken</code> value.</p>
        next_token: <p>The token to request the next page of results.</p>
        account_id: <p>The Amazon Web Services account ID for the resource group owner.</p>

    Raises:
        capo_application_insights.errors.internal_server_exception.InternalServerException: <p>The server encountered an internal error and is unable to complete the request.</p>
        capo_application_insights.errors.resource_not_found_exception.ResourceNotFoundException: <p>The resource does not exist in the customer account.</p>
        capo_application_insights.errors.validation_exception.ValidationException: <p>The parameter is not valid.</p>
        capo_application_insights.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_application_insights.types.list_components_request.ListComponentsRequest]",
    ) -> OperationResponse[
        "capo_application_insights.types.list_components_response.ListComponentsResponse"
    ]:
        import capo_application_insights._operations.ec2_windows_barley_service.list_components

        output, http_response = (
            capo_application_insights._operations.ec2_windows_barley_service.list_components.list_components(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListComponents")
    )
    input_: capo_application_insights.types.list_components_request.ListComponentsRequest = {
        "resource_group_name": resource_group_name
    }
    if max_results is not None:
        input_["max_results"] = max_results
    if next_token is not None:
        input_["next_token"] = next_token
    if account_id is not None:
        input_["account_id"] = account_id

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