create_group ¶

def create_group(
    self,
    identity_store_id: "capo_identitystore.types.identity_store_id.IdentityStoreId",
    *,
    config_overrides: Optional[identitystoreClientConfig] = None,
    display_name: Optional[
        "capo_identitystore.types.group_display_name.GroupDisplayName"
    ] = None,
    description: Optional[
        "capo_identitystore.types.sensitive_string_type.SensitiveStringType"
    ] = None,
) -> "capo_identitystore.types.create_group_response.CreateGroupResponse":
    """<p>Creates a group within the specified identity store.</p>

    Args:
        identity_store_id: <p>The globally unique identifier for the identity store.</p> <p>You can specify the identity store by ID or by Amazon Resource Name (ARN). For example, identity store ID <code>d-1234567890</code> or identity store ARN <code>arn:aws:identitystore::111122223333:identitystore/d-1234567890</code>.</p>
        display_name: <p>A string containing the name of the group. This value is commonly displayed when the group is referenced. <code>Administrator</code> and <code>AWSAdministrators</code> are reserved names and can't be used for users or groups.</p>
        description: <p>A string containing the description of the group.</p>

    Raises:
        capo_identitystore.errors.access_denied_exception.AccessDeniedException: <p>You do not have sufficient access to perform this action.</p>
        capo_identitystore.errors.internal_server_exception.InternalServerException: <p>The request processing has failed because of an unknown error, exception or failure with an internal server.</p>
        capo_identitystore.errors.throttling_exception.ThrottlingException: <p>Indicates that the principal has crossed the throttling limits of the API operations.</p>
        capo_identitystore.errors.conflict_exception.ConflictException: <p>This request cannot be completed for one of the following reasons:</p> <ul> <li> <p>Performing the requested operation would violate an existing uniqueness claim in the identity store. Resolve the conflict before retrying this request.</p> </li> <li> <p>The requested resource was being concurrently modified by another request.</p> </li> </ul>
        capo_identitystore.errors.resource_not_found_exception.ResourceNotFoundException: <p>Indicates that a requested resource is not found.</p>
        capo_identitystore.errors.service_quota_exceeded_exception.ServiceQuotaExceededException: <p>The request would cause the number of users or groups in the identity store to exceed the maximum allowed.</p>
        capo_identitystore.errors.validation_exception.ValidationException: <p>The request failed because it contains a syntax error.</p>
        capo_identitystore.errors.UnknownServiceError: The service returned an error code this client does not model.
    """

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

        output, http_response = (
            capo_identitystore._operations.aws_identity_store.create_group.create_group(
                req.options, req.input
            )
        )
        return OperationResponse(output=output, response=http_response)

    def _redact_input(
        input_: "capo_identitystore.types.create_group_request.CreateGroupRequest",
    ) -> dict[str, Any]:
        import capo_identitystore.types.create_group_request

        return capo_identitystore.types.create_group_request.redact_sensitive(
            input_
        )

    interceptors_, options_ = self.operation_options(
        config_overrides,
        OperationLogging("CreateGroup", redact_input=_redact_input),
    )
    input_: capo_identitystore.types.create_group_request.CreateGroupRequest = {
        "identity_store_id": identity_store_id
    }
    if display_name is not None:
        input_["display_name"] = display_name
    if description is not None:
        input_["description"] = description

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