Skip to content

get_group 

get_group(
    *,
    config_overrides: Optional[ResourceGroupsClientConfig] = None,
    group_name: Optional[GroupName] = None,
    group: Optional[GroupStringV2] = None,
) -> GetGroupOutput

Returns information about a specified resource group.

Minimum permissions

To run this command, you must have the following permissions:

  • resource-groups:GetGroup

Parameters:

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

    Deprecated - don't use this parameter. Use Group instead.

  • group (Optional[GroupStringV2], default: None ) –

    The name or the Amazon resource name (ARN) of the resource group to retrieve.

Raises:

Source code in docs_src/capo_resource_groups/_services/resource_groups.py 
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
def get_group(
    self,
    *,
    config_overrides: Optional[ResourceGroupsClientConfig] = None,
    group_name: Optional["capo_resource_groups.types.group_name.GroupName"] = None,
    group: Optional[
        "capo_resource_groups.types.group_string_v2.GroupStringV2"
    ] = None,
) -> "capo_resource_groups.types.get_group_output.GetGroupOutput":
    """<p>Returns information about a specified resource group.</p> <p> <b>Minimum permissions</b> </p> <p>To run this command, you must have the following permissions:</p> <ul> <li> <p> <code>resource-groups:GetGroup</code> </p> </li> </ul>

    Args:
        group_name: <p>Deprecated - don't use this parameter. Use <code>Group</code> instead.</p>
        group: <p>The name or the Amazon resource name (ARN) of the resource group to retrieve.</p>

    Raises:
        capo_resource_groups.errors.bad_request_exception.BadRequestException: <p>The request includes one or more parameters that violate validation rules.</p>
        capo_resource_groups.errors.forbidden_exception.ForbiddenException: <p>The caller isn't authorized to make the request. Check permissions.</p>
        capo_resource_groups.errors.internal_server_error_exception.InternalServerErrorException: <p>An internal error occurred while processing the request. Try again later.</p>
        capo_resource_groups.errors.method_not_allowed_exception.MethodNotAllowedException: <p>The request uses an HTTP method that isn't allowed for the specified resource.</p>
        capo_resource_groups.errors.not_found_exception.NotFoundException: <p>One or more of the specified resources don't exist.</p>
        capo_resource_groups.errors.too_many_requests_exception.TooManyRequestsException: <p>You've exceeded throttling limits by making too many requests in a period of time.</p>
        capo_resource_groups.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_resource_groups.types.get_group_input.GetGroupInput]",
    ) -> OperationResponse[
        "capo_resource_groups.types.get_group_output.GetGroupOutput"
    ]:
        import capo_resource_groups._operations.ardi.get_group

        output, http_response = (
            capo_resource_groups._operations.ardi.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_resource_groups.types.get_group_input.GetGroupInput = {}
    if group_name is not None:
        input_["group_name"] = group_name
    if group is not None:
        input_["group"] = group

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