Skip to content

get_group async

get_group(
    group_identifier: GroupIdentifier,
    *,
    config_overrides: Optional[AsyncsyntheticsClientConfig] = None,
) -> GetGroupResponse

Returns information about one group. Groups are a global resource, so you can use this operation from any Region.

Parameters:

  • group_identifier (GroupIdentifier) –

    Specifies the group to return information for. You can specify the group name, the ARN, or the group ID as the GroupIdentifier.

Raises:

Source code in docs_src/capo_synthetics/_services/async_synthetics.py
async def get_group(
    self,
    group_identifier: "capo_synthetics.types.group_identifier.GroupIdentifier",
    *,
    config_overrides: Optional[AsyncsyntheticsClientConfig] = None,
) -> "capo_synthetics.types.get_group_response.GetGroupResponse":
    """<p>Returns information about one group. Groups are a global resource, so you can use this operation from any Region.</p>

    Args:
        group_identifier: <p>Specifies the group to return information for. You can specify the group name, the ARN, or the group ID as the <code>GroupIdentifier</code>.</p>

    Raises:
        capo_synthetics.errors.conflict_exception.ConflictException: <p>A conflicting operation is already in progress.</p>
        capo_synthetics.errors.internal_server_exception.InternalServerException: <p>An unknown internal error occurred.</p>
        capo_synthetics.errors.resource_not_found_exception.ResourceNotFoundException: <p>One of the specified resources was not found.</p>
        capo_synthetics.errors.validation_exception.ValidationException: <p>A parameter could not be validated.</p>
        capo_synthetics.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    async def _handler(
        req: "AsyncOperationRequest[capo_synthetics.types.get_group_request.GetGroupRequest]",
    ) -> AsyncOperationResponse[
        "capo_synthetics.types.get_group_response.GetGroupResponse"
    ]:
        import capo_synthetics._operations.synthetics.get_group

        (
            output,
            http_response,
        ) = await capo_synthetics._operations.synthetics.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_synthetics.types.get_group_request.GetGroupRequest = {
        "group_identifier": group_identifier
    }

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