create_group ¶

create_group(
    organization_id: OrganizationId,
    name: GroupName,
    *,
    config_overrides: Optional[WorkMailClientConfig] = None,
    hidden_from_global_address_list: Optional[Boolean] = None,
) -> CreateGroupResponse

Creates a group that can be used in WorkMail by calling the RegisterToWorkMail operation.

Parameters:

organization_id (OrganizationId) –

The organization under which the group is to be created.
name (GroupName) –

The name of the group.
hidden_from_global_address_list (Optional[Boolean], default: None ) –

If this parameter is enabled, the group will be hidden from the address book.

Raises:

DirectoryServiceAuthenticationFailedException –

The directory service doesn't recognize the credentials supplied by WorkMail.
DirectoryUnavailableException –

The directory is unavailable. It might be located in another Region or deleted.
InvalidParameterException –

One or more of the input parameters don't match the service's restrictions.
NameAvailabilityException –

The user, group, or resource name isn't unique in WorkMail.
OrganizationNotFoundException –

An operation received a valid organization identifier that either doesn't belong or exist in the system.
OrganizationStateException –

The organization must have a valid state to perform certain operations on the organization or its members.
ReservedNameException –

This user, group, or resource name is not allowed in WorkMail.
UnsupportedOperationException –

You can't perform a write operation against a read-only directory.
UnknownServiceError –

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

Source code in docs_src/capo_workmail/_services/work_mail.py

def create_group(
    self,
    organization_id: "capo_workmail.types.organization_id.OrganizationId",
    name: "capo_workmail.types.group_name.GroupName",
    *,
    config_overrides: Optional[WorkMailClientConfig] = None,
    hidden_from_global_address_list: Optional[
        "capo_workmail.types.boolean.Boolean"
    ] = None,
) -> "capo_workmail.types.create_group_response.CreateGroupResponse":
    """<p>Creates a group that can be used in WorkMail by calling the <a>RegisterToWorkMail</a> operation.</p>

    Args:
        organization_id: <p>The organization under which the group is to be created.</p>
        name: <p>The name of the group.</p>
        hidden_from_global_address_list: <p>If this parameter is enabled, the group will be hidden from the address book.</p>

    Raises:
        capo_workmail.errors.directory_service_authentication_failed_exception.DirectoryServiceAuthenticationFailedException: <p>The directory service doesn't recognize the credentials supplied by WorkMail.</p>
        capo_workmail.errors.directory_unavailable_exception.DirectoryUnavailableException: <p>The directory is unavailable. It might be located in another Region or deleted.</p>
        capo_workmail.errors.invalid_parameter_exception.InvalidParameterException: <p>One or more of the input parameters don't match the service's restrictions.</p>
        capo_workmail.errors.name_availability_exception.NameAvailabilityException: <p>The user, group, or resource name isn't unique in WorkMail.</p>
        capo_workmail.errors.organization_not_found_exception.OrganizationNotFoundException: <p>An operation received a valid organization identifier that either doesn't belong or exist in the system.</p>
        capo_workmail.errors.organization_state_exception.OrganizationStateException: <p>The organization must have a valid state to perform certain operations on the organization or its members.</p>
        capo_workmail.errors.reserved_name_exception.ReservedNameException: <p>This user, group, or resource name is not allowed in WorkMail.</p>
        capo_workmail.errors.unsupported_operation_exception.UnsupportedOperationException: <p>You can't perform a write operation against a read-only directory.</p>
        capo_workmail.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

    def _handler(
        req: "OperationRequest[capo_workmail.types.create_group_request.CreateGroupRequest]",
    ) -> OperationResponse[
        "capo_workmail.types.create_group_response.CreateGroupResponse"
    ]:
        import capo_workmail._operations.work_mail_service.create_group

        output, http_response = (
            capo_workmail._operations.work_mail_service.create_group.create_group(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    interceptors_, options_ = self.operation_options(
        config_overrides, OperationLogging("CreateGroup")
    )
    input_: capo_workmail.types.create_group_request.CreateGroupRequest = {
        "organization_id": organization_id,
        "name": name,
    }
    if hidden_from_global_address_list is not None:
        input_["hidden_from_global_address_list"] = hidden_from_global_address_list

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