get_group `async` ¶

get_group(
    *,
    config_overrides: Optional[AsyncXRayClientConfig] = None,
    group_name: Optional[GroupName] = None,
    group_arn: Optional[GroupARN] = None,
) -> GetGroupResult

Retrieves group resource details.

Parameters:

group_name (Optional[GroupName], default: None ) –

The case-sensitive name of the group.
group_arn (Optional[GroupARN], default: None ) –

The ARN of the group that was generated on creation.

Raises:

InvalidRequestException –

The request is missing required parameters or has invalid parameters.
ThrottledException –

The request exceeds the maximum number of requests per second.
UnknownServiceError –

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

Source code in docs_src/capo_xray/_services/async_x_ray.py

async def get_group(
    self,
    *,
    config_overrides: Optional[AsyncXRayClientConfig] = None,
    group_name: Optional["capo_xray.types.group_name.GroupName"] = None,
    group_arn: Optional["capo_xray.types.group_arn.GroupARN"] = None,
) -> "capo_xray.types.get_group_result.GetGroupResult":
    """<p>Retrieves group resource details.</p>

    Args:
        group_name: <p>The case-sensitive name of the group.</p>
        group_arn: <p>The ARN of the group that was generated on creation.</p>

    Raises:
        capo_xray.errors.invalid_request_exception.InvalidRequestException: <p>The request is missing required parameters or has invalid parameters.</p>
        capo_xray.errors.throttled_exception.ThrottledException: <p>The request exceeds the maximum number of requests per second.</p>
        capo_xray.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_xray.types.get_group_request.GetGroupRequest]",
    ) -> AsyncOperationResponse["capo_xray.types.get_group_result.GetGroupResult"]:
        import capo_xray._operations.awsx_ray.get_group

        (
            output,
            http_response,
        ) = await capo_xray._operations.awsx_ray.get_group.async_get_group(
            req.options, req.input
        )
        return AsyncOperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("GetGroup")
    )
    input_: capo_xray.types.get_group_request.GetGroupRequest = {}
    if group_name is not None:
        input_["group_name"] = group_name
    if group_arn is not None:
        input_["group_arn"] = group_arn

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

get_group async ¶

get_group `async` ¶