list_profiling_groups `async` ¶

list_profiling_groups(
    *,
    config_overrides: Optional[AsyncCodeGuruProfilerClientConfig] = None,
    next_token: Optional[PaginationToken] = None,
    max_results: Optional[MaxResults] = None,
    include_description: Optional[bool] = None,
) -> ListProfilingGroupsResponse

Returns a list of profiling groups. The profiling groups are returned as ProfilingGroupDescription objects.

Parameters:

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

The nextToken value returned from a previous paginated ListProfilingGroups request where maxResults was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the nextToken value.

This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.
max_results (Optional[MaxResults], default: None ) –

The maximum number of profiling groups results returned by ListProfilingGroups in paginated output. When this parameter is used, ListProfilingGroups only returns maxResults results in a single page along with a nextToken response element. The remaining results of the initial request can be seen by sending another ListProfilingGroups request with the returned nextToken value.
include_description (Optional[bool], default: None ) –

A Boolean value indicating whether to include a description. If true, then a list of ProfilingGroupDescription objects that contain detailed information about profiling groups is returned. If false, then a list of profiling group names is returned.

Raises:

InternalServerException –

The server encountered an internal error and is unable to complete the request.
ThrottlingException –

The request was denied due to request throttling.
UnknownServiceError –

The service returned an error code this client does not model.

Source code in docs_src/capo_codeguruprofiler/_services/async_code_guru_profiler.py

async def list_profiling_groups(
    self,
    *,
    config_overrides: Optional[AsyncCodeGuruProfilerClientConfig] = None,
    next_token: Optional[
        "capo_codeguruprofiler.types.pagination_token.PaginationToken"
    ] = None,
    max_results: Optional[
        "capo_codeguruprofiler.types.max_results.MaxResults"
    ] = None,
    include_description: Optional[bool] = None,
) -> "capo_codeguruprofiler.types.list_profiling_groups_response.ListProfilingGroupsResponse":
    """<p> Returns a list of profiling groups. The profiling groups are returned as <a href="https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ProfilingGroupDescription.html"> <code>ProfilingGroupDescription</code> </a> objects. </p>

    Args:
        next_token: <p>The <code>nextToken</code> value returned from a previous paginated <code>ListProfilingGroups</code> request where <code>maxResults</code> was used and the results exceeded the value of that parameter. Pagination continues from the end of the previous results that returned the <code>nextToken</code> value. </p> <note> <p>This token should be treated as an opaque identifier that is only used to retrieve the next items in a list and not for other programmatic purposes.</p> </note>
        max_results: <p>The maximum number of profiling groups results returned by <code>ListProfilingGroups</code> in paginated output. When this parameter is used, <code>ListProfilingGroups</code> only returns <code>maxResults</code> results in a single page along with a <code>nextToken</code> response element. The remaining results of the initial request can be seen by sending another <code>ListProfilingGroups</code> request with the returned <code>nextToken</code> value. </p>
        include_description: <p>A <code>Boolean</code> value indicating whether to include a description. If <code>true</code>, then a list of <a href="https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ProfilingGroupDescription.html"> <code>ProfilingGroupDescription</code> </a> objects that contain detailed information about profiling groups is returned. If <code>false</code>, then a list of profiling group names is returned.</p>

    Raises:
        capo_codeguruprofiler.errors.internal_server_exception.InternalServerException: <p>The server encountered an internal error and is unable to complete the request.</p>
        capo_codeguruprofiler.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
        capo_codeguruprofiler.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_codeguruprofiler.types.list_profiling_groups_request.ListProfilingGroupsRequest]",
    ) -> AsyncOperationResponse[
        "capo_codeguruprofiler.types.list_profiling_groups_response.ListProfilingGroupsResponse"
    ]:
        import capo_codeguruprofiler._operations.code_guru_profiler.list_profiling_groups

        (
            output,
            http_response,
        ) = await capo_codeguruprofiler._operations.code_guru_profiler.list_profiling_groups.async_list_profiling_groups(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("ListProfilingGroups")
    )
    input_: capo_codeguruprofiler.types.list_profiling_groups_request.ListProfilingGroupsRequest = {}
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results
    if include_description is not None:
        input_["include_description"] = include_description

    response = await aexecute_pipeline(
        AsyncOperationRequest(input=input_, options=options_),
        handler=_handler,
        interceptors=list(interceptors_),
    )
    await response.response.aclose()
    return response.output

list_profiling_groups async ¶

list_profiling_groups `async` ¶