Skip to content

describe_profiling_group

describe_profiling_group(
    profiling_group_name: ProfilingGroupName,
    *,
    config_overrides: Optional[CodeGuruProfilerClientConfig] = None,
) -> DescribeProfilingGroupResponse

Returns a ProfilingGroupDescription object that contains information about the requested profiling group.

Parameters:

  • profiling_group_name (ProfilingGroupName) –

    The name of the profiling group to get information about.

Raises:

Source code in docs_src/capo_codeguruprofiler/_services/code_guru_profiler.py
def describe_profiling_group(
    self,
    profiling_group_name: "capo_codeguruprofiler.types.profiling_group_name.ProfilingGroupName",
    *,
    config_overrides: Optional[CodeGuruProfilerClientConfig] = None,
) -> "capo_codeguruprofiler.types.describe_profiling_group_response.DescribeProfilingGroupResponse":
    """<p> Returns a <a href="https://docs.aws.amazon.com/codeguru/latest/profiler-api/API_ProfilingGroupDescription.html"> <code>ProfilingGroupDescription</code> </a> object that contains information about the requested profiling group. </p>

    Args:
        profiling_group_name: <p> The name of the profiling group to get information about. </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.resource_not_found_exception.ResourceNotFoundException: <p>The resource specified in the request does not exist.</p>
        capo_codeguruprofiler.errors.throttling_exception.ThrottlingException: <p>The request was denied due to request throttling.</p>
        capo_codeguruprofiler.errors.validation_exception.ValidationException: <p>The parameter is not valid.</p>
        capo_codeguruprofiler.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_codeguruprofiler.types.describe_profiling_group_request.DescribeProfilingGroupRequest]",
    ) -> OperationResponse[
        "capo_codeguruprofiler.types.describe_profiling_group_response.DescribeProfilingGroupResponse"
    ]:
        import capo_codeguruprofiler._operations.code_guru_profiler.describe_profiling_group

        output, http_response = (
            capo_codeguruprofiler._operations.code_guru_profiler.describe_profiling_group.describe_profiling_group(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("DescribeProfilingGroup")
    )
    input_: capo_codeguruprofiler.types.describe_profiling_group_request.DescribeProfilingGroupRequest = {
        "profiling_group_name": profiling_group_name
    }

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