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:
Source code in docs_src/capo_xray/_services/x_ray.py
| def get_group(
self,
*,
config_overrides: Optional[XRayClientConfig] = 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.
"""
def _handler(
req: "OperationRequest[capo_xray.types.get_group_request.GetGroupRequest]",
) -> OperationResponse["capo_xray.types.get_group_result.GetGroupResult"]:
import capo_xray._operations.awsx_ray.get_group
output, http_response = capo_xray._operations.awsx_ray.get_group.get_group(
req.options, req.input
)
return OperationResponse(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 = execute_pipeline(
OperationRequest(input=input_, options=options_),
handler=_handler,
interceptors=list(interceptors_),
)
response.response.close()
return response.output
|