get_group `async` ¶

get_group(
    group_name: groupNameType,
    *,
    config_overrides: Optional[AsyncIAMClientConfig] = None,
    marker: Optional[markerType] = None,
    max_items: Optional[maxItemsType] = None,
) -> GetGroupResponse

Returns a list of IAM users that are in the specified IAM group. You can paginate the results using the MaxItems and Marker parameters.

Parameters:

group_name (groupNameType) –

The name of the group.

This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
marker (Optional[markerType], default: None ) –

Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the Marker element in the response that you received to indicate where the next call should start.
max_items (Optional[maxItemsType], default: None ) –

Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the IsTruncated response element is true.

If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the IsTruncated response element returns true, and Marker contains a value to include in the subsequent call that tells the service where to continue from.

Raises:

NoSuchEntityException –

The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.
ServiceFailureException –

The request processing has failed because of an unknown error, exception or failure.
UnknownServiceError –

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

Source code in docs_src/capo_iam/_services/async_iam.py

async def get_group(
    self,
    group_name: "capo_iam.types.group_name_type.groupNameType",
    *,
    config_overrides: Optional[AsyncIAMClientConfig] = None,
    marker: Optional["capo_iam.types.marker_type.markerType"] = None,
    max_items: Optional["capo_iam.types.max_items_type.maxItemsType"] = None,
) -> "capo_iam.types.get_group_response.GetGroupResponse":
    """<p> Returns a list of IAM users that are in the specified IAM group. You can paginate the results using the <code>MaxItems</code> and <code>Marker</code> parameters.</p>

    Args:
        group_name: <p>The name of the group.</p> <p>This parameter allows (through its <a href="http://wikipedia.org/wiki/regex">regex pattern</a>) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-</p>
        marker: <p>Use this parameter only when paginating results and only after you receive a response indicating that the results are truncated. Set it to the value of the <code>Marker</code> element in the response that you received to indicate where the next call should start.</p>
        max_items: <p>Use this only when paginating results to indicate the maximum number of items you want in the response. If additional items exist beyond the maximum you specify, the <code>IsTruncated</code> response element is <code>true</code>.</p> <p>If you do not include this parameter, the number of items defaults to 100. Note that IAM might return fewer results, even when there are more results available. In that case, the <code>IsTruncated</code> response element returns <code>true</code>, and <code>Marker</code> contains a value to include in the subsequent call that tells the service where to continue from.</p>

    Raises:
        capo_iam.errors.no_such_entity_exception.NoSuchEntityException: <p>The request was rejected because it referenced a resource entity that does not exist. The error message describes the resource.</p>
        capo_iam.errors.service_failure_exception.ServiceFailureException: <p>The request processing has failed because of an unknown error, exception or failure.</p>
        capo_iam.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

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

        (
            output,
            http_response,
        ) = await capo_iam._operations.aws_identity_management_v20100508.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_iam.types.get_group_request.GetGroupRequest = {
        "group_name": group_name
    }
    if marker is not None:
        input_["marker"] = marker
    if max_items is not None:
        input_["max_items"] = max_items

    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` ¶