search_groups ¶

def search_groups(
    self,
    directory_id: "capo_directory_service_data.types.directory_id.DirectoryId",
    search_string: "capo_directory_service_data.types.search_string.SearchString",
    search_attributes: "capo_directory_service_data.types.ldap_display_name_list.LdapDisplayNameList",
    *,
    config_overrides: Optional[DirectoryServiceDataClientConfig] = None,
    realm: Optional["capo_directory_service_data.types.realm.Realm"] = None,
    next_token: Optional[
        "capo_directory_service_data.types.next_token.NextToken"
    ] = None,
    max_results: Optional[
        "capo_directory_service_data.types.max_results.MaxResults"
    ] = None,
) -> "capo_directory_service_data.types.search_groups_result.SearchGroupsResult":
    """<p> Searches the specified directory for a group. You can find groups that match the <code>SearchString</code> parameter with the value of their attributes included in the <code>SearchString</code> parameter. </p> <p> This operation supports pagination with the use of the <code>NextToken</code> request and response parameters. If more results are available, the <code>SearchGroups.NextToken</code> member contains a token that you pass in the next call to <code>SearchGroups</code>. This retrieves the next set of items. </p> <p> You can also specify a maximum number of return results with the <code>MaxResults</code> parameter. </p>

    Args:
        directory_id: <p> The identifier (ID) of the directory that's associated with the group. </p>
        search_string: <p> The attribute value that you want to search for. </p> <note> <p> Wildcard <code>(*)</code> searches aren't supported. For a list of supported attributes, see <a href="https://docs.aws.amazon.com/directoryservice/latest/admin-guide/ad_data_attributes.html">Directory Service Data Attributes</a>. </p> </note>
        search_attributes: <p> One or more data attributes that are used to search for a group. For a list of supported attributes, see <a href="https://docs.aws.amazon.com/directoryservice/latest/admin-guide/ad_data_attributes.html">Directory Service Data Attributes</a>. </p>
        realm: <p> The domain name that's associated with the group. </p> <note> <p> This parameter is optional, so you can return groups outside of your Managed Microsoft AD domain. When no value is defined, only your Managed Microsoft AD groups are returned. </p> <p> This value is case insensitive. </p> </note>
        next_token: <p> An encoded paging token for paginated calls that can be passed back to retrieve the next page. </p>
        max_results: <p> The maximum number of results to be returned per request. </p>

    Raises:
        capo_directory_service_data.errors.access_denied_exception.AccessDeniedException: <p> You don't have permission to perform the request or access the directory. It can also occur when the <code>DirectoryId</code> doesn't exist or the user, member, or group might be outside of your organizational unit (OU). </p> <p> Make sure that you have the authentication and authorization to perform the action. Review the directory information in the request, and make sure that the object isn't outside of your OU. </p>
        capo_directory_service_data.errors.directory_unavailable_exception.DirectoryUnavailableException: <p> The request could not be completed due to a problem in the configuration or current state of the specified directory. </p>
        capo_directory_service_data.errors.internal_server_exception.InternalServerException: <p> The operation didn't succeed because an internal error occurred. Try again later. </p>
        capo_directory_service_data.errors.throttling_exception.ThrottlingException: <p> The limit on the number of requests per second has been exceeded. </p>
        capo_directory_service_data.errors.validation_exception.ValidationException: <p> The request isn't valid. Review the details in the error message to update the invalid parameters or values in your request. </p>
        capo_directory_service_data.errors.UnknownServiceError: The service returned an error code this client does not model.

    Examples:
        To search for groups
        The following command searches the examplecorp.com domain for groups with the GroupType security.

        >>> client.search_groups(directory_id='d-12233abcde', max_results=123, next_token='123456', realm='examplecorp.com', search_attributes=['GroupScope'], search_string='Security')
    """

    def _handler(
        req: "OperationRequest[capo_directory_service_data.types.search_groups_request.SearchGroupsRequest]",
    ) -> OperationResponse[
        "capo_directory_service_data.types.search_groups_result.SearchGroupsResult"
    ]:
        import capo_directory_service_data._operations.directory_service_data.search_groups

        output, http_response = (
            capo_directory_service_data._operations.directory_service_data.search_groups.search_groups(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_input(
        input_: "capo_directory_service_data.types.search_groups_request.SearchGroupsRequest",
    ) -> dict[str, Any]:
        import capo_directory_service_data.types.search_groups_request

        return capo_directory_service_data.types.search_groups_request.redact_sensitive(
            input_
        )

    def _redact_output(
        output: "capo_directory_service_data.types.search_groups_result.SearchGroupsResult",
    ) -> dict[str, Any]:
        import capo_directory_service_data.types.search_groups_result

        return (
            capo_directory_service_data.types.search_groups_result.redact_sensitive(
                output
            )
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging(
            "SearchGroups", redact_input=_redact_input, redact_output=_redact_output
        ),
    )
    input_: capo_directory_service_data.types.search_groups_request.SearchGroupsRequest = {
        "directory_id": directory_id,
        "search_string": search_string,
        "search_attributes": search_attributes,
    }
    if realm is not None:
        input_["realm"] = realm
    if next_token is not None:
        input_["next_token"] = next_token
    if max_results is not None:
        input_["max_results"] = max_results

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